Cardano Client Lib
A client library for Cardano in Java. This library simplifies the interaction with Cardano blockchain from a Java application.
Latest Stable Version: 0.7.1
Preview Release Available: 0.8.0-preview1 introduces TxFlow (multi-step transaction orchestration), TxPlan (YAML transactions), MpfTrie (verified data structures), and the Unified Tx API.
Overview
Cardano Client Lib provides a comprehensive set of tools for building Cardano applications in Java:
- Transaction Building - Build and submit transactions with simple declarative APIs
- Token Minting - Mint native tokens and NFTs with built-in policy script support
- Smart Contracts - Interact with Plutus smart contracts
- Address Generation - Generate addresses from mnemonics
- Multiple Backends - Connect via Blockfrost, Koios, or Ogmios
Quick Links
- Getting Started - Learn the basic concepts
- QuickTx API - Build transactions with declarative API
- API Reference - Detailed API documentation
- Examples - Code examples repository
What’s New (0.8.0 Preview)
- Unified Tx API -
ScriptTxmerged intoTx— one class for all transaction types - TxFlow - Multi-step transaction orchestration with UTXO chaining and rollback handling
- TxPlan - YAML-based transaction definitions with variable substitution
- MpfTrie - Merkle Patricia Forestry with RocksDB for on-chain proof verification
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
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
CIP Implementations
- CIP20 - Transaction Message/Comment metadata
- CIP25 - NFT Metadata Standard
- CIP8 - Message Signing
- CIP30 - dApp signData & verify
- CIP27 - CNFT Community Royalties Standard
- CIP68 - Datum Metadata Standard
Backend Integration
The library provides integration with Cardano node through different backend services:
| Provider | Module | Status |
|---|---|---|
| Blockfrost | cardano-client-backend-blockfrost | Stable |
| Koios | cardano-client-backend-koios | Stable |
| Ogmios | cardano-client-backend-ogmios | Stable |
| Yaci Store | cardano-client-backend-blockfrost | Stable |
| Yaci DevKit | cardano-client-backend-blockfrost | Stable |
Available Backend APIs
- 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
Last updated on