Modules
In 0.4.0 and later, the library has been divided into smaller modules. These modules can be added to a project based on requirement.
Group Id: com.bloxbean.cardano
For simple setup, you can use cardano-client-lib and one of the backend provider as dependency.
| Modules | Artifact Id | Description |
|---|---|---|
| cardano-client-lib | cardano-client-lib | This is a top level module which includes all other modules except backend provider modules. (Recommended for most application) |
| Backend Api | cardano-client-backend | Defines backend apis which are implemented by provider specific module. |
| Blockfrost Backend | cardano-client-backend-blockfrost | Provides integration with Blockfrost |
| Koios Backend | cardano-client-backend-koios | Provides integration with Koios |
| Ogmios/Kupo Backend | cardano-client-backend-ogmios | Provides integration with Ogmios and Kupo. Supported Apis : submitTransaction, evaluateTx, Kupo support (UtxoService) |
For fine-grained dependency management, add one or more below modules as required.
| Modules | Artifact Id | Description |
|---|---|---|
| common | cardano-client-common | Contains common utilities (HexUtil, JsonUtil, Cbor Utils etc). This module doesn't depend on any other module. Dependencies: None |
| crypto | cardano-client-crypto | Provides implementation for standards like Bip32, Bip39, CIP1852 and other crypto primitives Dependencies: common |
| address | cardano-client-address | Supports derivation of various types of Cardano addresses (Base, Enterprise, Pointer, Stake etc) Dependencies: common, crypto, transaction-common |
| metadata | cardano-client-metadata | Provides simple api to generate and serialize generic metadata Dependencies: common, crypto |
| transaction-common | cardano-client-transaction-common | A small module with some transaction specific common classes which are required in other modules. This module is there for backward compatibility. So you should not add this module directly in your application. Dependencies: common, crypto |
| core | cardano-client-core | Contains low level transaction serialization logic and other common apis / interfaces (Account, Coin selections, UtxoSupplier, ProtocolParamSupplier etc.). Also contains high-level api like PaymentTransaction for backward compatibility. But HL api may be removed to a separate module in future release Dependencies: common, crypto, transaction-common, address, metadata |
| function | cardano-client-function | Provides Composable Function Apis. A simple, flexible way to build transactions through re-usable functions. Dependencies: core |
| cip | cardano-client-cip | A umbrella module which provides a simple way to get available cip implementations (cip25, cip8 etc.) Dependencies: cip8, cip20, cip25, cip27, cip30 |
| cip8 | cardano-client-cip8 | CIP 8 - Message Signing Dependencies: common, crypto |
| cip20 | cardano-client-cip20 | CIP 20 - Transaction message/comment metadata Dependencies: metadata |
| cip25 | cardano-client-cip25 | CIP 25 - Media NFT Metadata Standard Dependencies: metadata |
| cip27 | cardano-client-cip27 | CIP 27 - CNFT Community Royalties Standard Dependencies: cip25 |
| cip30 | cardano-client-cip30 | CIP 30 - Cardano dApp-Wallet Web Bridge Dependencies: cip8, core |