search
githubEdit

Integration Guides

👥 Audience: App Developers integrating CBTC into DeFi protocols, wallets, custody solutions, or trading systems.

⚠️ API Disclaimer: CBTC APIs are subject to change. Label all examples with the SDK version and DAR version they were tested against.

hashtag
Overview

This page provides integration patterns for common CBTC use cases. Each pattern includes architecture notes, key considerations, and pointers to relevant code. For API details, see the API Reference. For authentication setup, see the Authentication Guide.

hashtag
Integration Pattern 1: DeFi Protocol

Use case: Build a DEX, lending platform, or liquidity pool using CBTC as collateral.

hashtag
Architecture

  1. Your protocol runs on a Canton participant node with CBTC DAR files installed

  2. Users deposit CBTC into your protocol's Canton party via a Transfer choice

  3. Your protocol logic (Daml contracts) manages positions, collateral, and settlement

  4. Users withdraw CBTC back to their own party when exiting

hashtag
Key Considerations

  • UTXO management: Each transfer creates UTXOs. Keep below 10 per party. Use cbtc-lib consolidation functions.

  • Instrument ID: Fetch dynamically — see Instrument ID Management

  • Privacy: Canton transactions are private by default. Only parties to a contract see its details. This eliminates MEV.

  • Transfer costs: ~$3–5 per CBTC transfer on Canton currently. Factor this into your protocol economics.

hashtag
Example Partners

  • Bron — BTC-CBTC and CC-CBTC swapping on Canton

  • Elk Capital Markets / Triangle — OTC and app-based CBTC trading

  • Silvana — DEX/trading venue on Canton (status to be confirmed)

hashtag
Integration Pattern 2: Wallet or Custody Solution

Use case: Support CBTC in an institutional-grade wallet or custody platform.

hashtag
Architecture

  1. Wallet connects to a Canton participant via the Ledger API

  2. Authentication via OIDC (Keycloak supported, Auth0 community example available)

  3. CBTC balances queried via state-queries endpoint

  4. Transfers executed via Transfer choice on CBTC token contracts

hashtag
Supported Wallets (Current Ecosystem)

  • Loop Wallet — Canton-native wallet with CBTC support

  • Console / Zoro Wallet — Canton wallet with API access

  • Bron Wallet — Multi-party wallet with testnet support

  • WalletConnect — For dApp-to-wallet connections

hashtag
Key Considerations

  • External signing: Available for integration with custody providers (DFNS, Fordefi, Ledger)

  • Party creation at scale: If creating 10+ parties, use the Ledger API directly rather than wallet UI — see Canton docsarrow-up-right

  • CORS: If your wallet makes browser-based API calls, configure CORS on your ingress

hashtag
Integration Pattern 3: Trading System

Use case: Build spot trading, perpetual contracts, options, or structured products with CBTC.

hashtag
Why Canton for Trading

  • No public mempool — positions are not visible to other participants, eliminating front-running and sandwich attacks (MEV)

  • Private transactions — only parties to a trade see the details

  • Audit-ready — Canton's privacy model supports selective disclosure for compliance

hashtag
Architecture

  1. Trading engine runs as Daml contracts on Canton

  2. CBTC used as settlement or collateral asset

  3. Counterparty discovery and matching handled by your protocol

  4. Settlement is atomic — either both sides complete or neither does

hashtag
Example: Options on CBTC

CBTC holders can write covered CALL options, earning premium income while maintaining BTC exposure. Settlement uses Canton's atomic dual-token transfer — the buyer receives the underlying asset while the seller receives payment, atomically.

hashtag
Integration Pattern 4: Minting Integration

Use case: Offer CBTC minting as a service to your users.

hashtag
Three Options

Option
Description
Effort

1. Direct API

Install CBTC DAR, call Canton APIs to mint/redeem

Low — a few hours

2. Self-hosted UI

Install DAR + BitSafe minting UI locally

Medium — more maintenance

3. Hosted UI (not yet scoped)

Use BitSafe's centrally hosted UI against your validator. Not currently scoped for development.

TBD

For Option 1, see the Minting and Burning Guide and API Reference.

For Options 2 and 3, contact BitSafe for setup details.

hashtag
Getting Started

  1. Set up testnet first — see Testnet Guide

  2. Install DAR files — GitHubarrow-up-right

  3. Use cbtc-lib — GitHubarrow-up-right for type-safe Rust integration

  4. Review examples — GitHub examplesarrow-up-right Need help? Reach out via #cbtc-ecosystem (Slack) or [email protected]envelope

🔴 ⚙️ Engineering Review Required. Integration patterns and partner references should be reviewed by Engineering (Jesse) and BD before publication. Wallet integration details may have changed.

PreviousCBTC AuthenticationNextSecurity Deep Dive

Last updated