Introduction

A client library for Cardano in Java. This library simplifies the interaction with Cardano blockchain from a Java application.

info

Latest Stable Version: 0.5.1

Recent Posts

• Introducing QuickTx API to build transactions
• Composable functions to build transactions
• Demo:- Test Aiken Smart Contract Using Java Offchain Code with Yaci DevKit

Old Posts

Note: Some of the APIs mentioned in the below posts are deprecated. Please refer to the latest documentation for the latest APIs.

• Cardano-client-lib : A Java Library to interact with Cardano - Part I
• Cardano-client-lib: Transaction with Metadata in Java - Part II
• Cardano-client-lib: Minting a new Native Token in Java - Part III

Examples

Cardano-client-lib examples repository

JavaDoc

Documentation

Features

Address Generation

• Address Generation (Base Address, Enterprise Address)
• Generate Address from Mnemonic phase

Transaction Serialization & Signing

• API to build Payment transaction (ADA & Native Tokens)
• CBOR serialization of transaction
• Transaction signing

QuickTx API

• Build and submit transaction with simple declarative style API
• Supports
  • Payment transaction
  • Token Minting and token transfer
  • Plutus smart contract call
  • Token minting with Plutus contract
  • Staking operations
  • Governance transactions (Preview)

Composable Functions

• Composable functions to build transaction
• Supports
  • Payment transaction
  • Token Minting and token transfer
  • Plutus smart contract call
  • Token minting with Plutus contract

High Level api (Deprecated)

• To build and submit
  • Payment transaction
  • Token Minting and token transfer transaction

Examples with Composable Functions

CIP Implementations

• CIP20 - Transaction Message/Comment metada
• CIP25 - NFT Metadata Standard
• CIP8 - Message Signing
• CIP30 - dApp signData & verify
• CIP27 - CNFT Community Royalties Standard
• CIP68 - Datum Metadata Standard

Metadata Builder

• Helper to build Metadata
• Converter to convert JSON (No Schema) to Metadata format

Token Minting

• Token Minting transaction builder
• Native script (ScriptAll, ScriptAny, ScriptAtLeast, ScriptPubKey, RequireTimeAfter, RequireTimeBefore)
• Policy Id generation

Backend Integration

The library also provides integration with Cardano node through different backend services. Out of box, the library currently supports integration with following providers through the Backend api.

• Blockfrost
  • Module : cardano-client-backend-blockfrost README
  • Status : Stable
• Koios
  • Module : cardano-client-backend-koios README
  • Status : Stable
• Ogmios
  • Module : cardano-client-backend-koios README
  • Status : Stable
  • Supported Apis : submitTransaction, evaluateTx, Kupo support (UtxoService)

Following Backend apis are currently available

• TransactionService (Submit transaction, Get transaction, Evaluate ExUnits for Script Txn)
• AddressService (Get address details)
• UtxoService (Get utxos for an address)
• AssetService
• BlockService
• NetworkInfoService
• EpochService
• MetadataService