Skip to content

Fix README and .env.example accuracy#21

Open
gyorgybalazsi wants to merge 2 commits intomainfrom
fix/readme-and-env-example-accuracy
Open

Fix README and .env.example accuracy#21
gyorgybalazsi wants to merge 2 commits intomainfrom
fix/readme-and-env-example-accuracy

Conversation

@gyorgybalazsi
Copy link

Summary

  • API Reference fixes: Corrected module name (cbtc::withdrawcbtc::cancel_offers), function names (submit_multisubmit_sequential_chained, request_withdrawsubmit_withdraw), removed unused client_credentials and added note about canton-lib availability
  • Configuration fixes: Fixed ATTESTOR_URL values to dlc.link URLs, CANTON_NETWORK to canton-devnet format, added missing Keycloak auth variables to both README and .env.example
  • Removed broken links: context/cip-0056.md, context/cip-0078-canton-coin-fee-removal.md, example_transfer.sh
  • Dependency version: Fixed cbtc to branch = "main", keycloak to tag = "v0.3.0"
  • Added missing examples: check_withdraw_requests, list_deposit_addresses, list_contracts, delete_executed_transfers
  • Updated .env.example: Added ENVIRONMENT, Keycloak auth, AMOUNT_PER_RECEIVER, CONTRACT DELETION, and CONSOLIDATION sections

Test plan

  • Verify README renders correctly on GitHub
  • Verify .env.example contains all vars needed to run examples
  • Spot-check API Reference function names against source code

🤖 Generated with Claude Code

- Fix API Reference: rename cbtc::withdraw to cbtc::cancel_offers,
  submit_multi to submit_sequential_chained, request_withdraw to
  submit_withdraw
- Fix ATTESTOR_URL and CANTON_NETWORK values to match actual usage
  (dlc.link URLs, canton-devnet format)
- Add missing Keycloak auth vars to Configuration section and .env.example
- Remove broken links (context/ files, example_transfer.sh)
- Fix cbtc dependency to branch=main, keycloak to tag=v0.3.0
- Add 4 missing examples to Core Operations table
- Remove unused client_credentials from API Reference, add note about
  canton-lib availability
- Add ENVIRONMENT, CONSOLIDATION, CONTRACT DELETION sections to .env.example

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
#### `mint_redeem::mint`

- `list_deposit_accounts(Params)` - Get all deposit accounts for your party
- `create_deposit_account(Params)` - Create new deposit account for receiving BTC
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be "Create new deposit account for minting CBTC"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants