SDK, API, and integration reference
Supported source libraries
cbtc-lib: CBTC workflows and examples.canton-lib: shared Canton API clients and utilities.
Pin approved release tags and keep their compatibility row together.
Integration layers
Generated Canton clients
Authenticate, query contracts, submit commands, and read updates
CBTC workflow functions
Balance, transfer, mint, redeem, account, and credential operations
BitSafe API client
Retrieve approved account and Bitcoin workflow data
Examples
Executable references for supported tasks
Recommended integration pattern
Load configuration through a typed layer.
Create authenticated Canton and BitSafe clients.
Verify the party with a read-only query.
Query current contracts and runtime rules.
Validate the business request.
Submit one command with a unique reference where supported.
Read the authoritative result.
Reconcile Canton, application, and Bitcoin identifiers.
API reference policy
Generated type and method documentation should remain in the repository or generated reference site. Public task guides should link to exact release documentation instead of copying full schemas.
Examples to preserve
Balance checks, sending, incoming and outgoing offers, accepting or cancelling offers, credentials, minting, redemption, account inspection, batch transfers, and UTXO management.
Related pages
Next step
👉 Validate the integration: CBTC developer Quick Start.
Last updated