Fix CBTC docs to match actual cbtc-lib and canton-lib APIs#22
Open
gyorgybalazsi wants to merge 2 commits intoreview-cbtc-docsfrom
Open
Fix CBTC docs to match actual cbtc-lib and canton-lib APIs#22gyorgybalazsi wants to merge 2 commits intoreview-cbtc-docsfrom
gyorgybalazsi wants to merge 2 commits intoreview-cbtc-docsfrom
Conversation
Verified all documentation against the actual source code in cbtc-lib (crate: cbtc v0.1.0, tag v0.3.0) and canton-lib (v0.3.0). Key fixes: - Fix version numbers: v0.0.1 → v0.3.0 for both cbtc-lib and canton-lib - Fix crate name: cbtc_lib/cbtc-lib → cbtc (actual Cargo.toml name) - Fix keycloak auth: keycloak::login() → keycloak::login::password(PasswordParams) with url built from password_url(host, realm) - Fix non-existent modules: cbtc_lib::deposit, cbtc_lib::balance, cbtc_lib::withdraw, cbtc_lib::utxo → actual cbtc::mint_redeem::mint, cbtc::active_contracts, cbtc::mint_redeem::redeem, cbtc::consolidate - Fix function names: get_deposit_address → get_bitcoin_address, get_active_contracts → get, transfer::send → transfer::submit, accept::accept_transfer → accept::submit, redeem::burn_and_withdraw → redeem::create_withdraw_account + submit_withdraw - Fix all function signatures to use actual struct params - Fix env vars: KEYCLOAK_URL → KEYCLOAK_HOST + KEYCLOAK_REALM, remove KEYCLOAK_CLIENT_SECRET from password flow, LEDGER_HOST:LEDGER_PORT → LEDGER_HOST - Fix ATTESTOR_URL values: attestor.bitsafe.dev → devnet.dlc.link/attestor-1 etc. - Add missing modules to module tables: cbtc::accept, cbtc::cancel_offers - Fix Daml template names: CBTC.Issuance:* → CBTC.DepositAccount:CBTCDepositAccount etc. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
scolear
approved these changes
Mar 2, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
cbtcv0.1.0, tag v0.3.0) and canton-lib (v0.3.0)Key fixes across all docs
cbtc-lib/cbtc_libcbtckeycloak::login(url, id, secret, user, pass)keycloak::login::password(PasswordParams { client_id, username, password, url })cbtc_lib::deposit,cbtc_lib::balance,cbtc_lib::withdraw,cbtc_lib::utxocbtc::mint_redeem::mint,cbtc::active_contracts,cbtc::mint_redeem::redeem,cbtc::consolidateget_deposit_address,get_active_contracts,transfer::send,accept::accept_transfer,redeem::burn_and_withdrawget_bitcoin_address,active_contracts::get,transfer::submit,accept::submit,redeem::create_withdraw_account+redeem::submit_withdrawKEYCLOAK_URL,KEYCLOAK_CLIENT_SECRET,LEDGER_PORTKEYCLOAK_HOST+KEYCLOAK_REALM, removed secret from password flow,LEDGER_HOSTonlyattestor.bitsafe.devetc.devnet.dlc.link/attestor-1etc.CBTC.Issuance:DepositAccountCBTC.DepositAccount:CBTCDepositAccountTest plan
src/.env.examplesrc/mint_redeem/constants.rs🤖 Generated with Claude Code