docs(digital-assets): restructure digital assets reference and add chain-key token pages#149
Merged
Merged
Conversation
…ain-key token pages - Rename token-ledgers.mdx → ledgers.mdx; rewrite with ledger suite concept, ICRC-3 transaction history section, CLI + language tab separation convention - Rewrite chain-key-tokens.mdx: add ckDOGE and ckSOL deposit/withdrawal flows, slim canister IDs section to pointer, remove duplicate CLI balance checks - Add reference/chain-key-canister-ids.md: canonical canister IDs for all chain-key tokens (ckBTC, ckETH, ckERC20, ckDOGE, ckSOL) with mainnet and testnet - Add reference/icrc-standards.md: index of all adopted ICRC standards with external spec links for both digital asset and wallet signer standards - Rename token-standards.md → digital-asset-standards.md; update description - Rewrite protocol-canisters.md: minter APIs and protocol reference only; add ckDOGE, ckSOL, ckERC20 sections; remove duplicate canister ID tables and deposit/withdrawal flows (now in chain-key-tokens.mdx) - Reorder sidebar: Digital Assets before Chain Fusion; fix reference section order to match index.md grouping (canisters → token standards → costs → errors → specs) - Record CLI/language tab separation convention in decisions.md
marc0olo
added a commit
that referenced
this pull request
Apr 29, 2026
## Summary Follow-up to #149 as noted in that PR's description. **Diagrams added:** - \`bitcoin.mdx\`: ckBTC deposit and withdrawal flow diagrams, now including Bitcoin Checker (KYT), ckBTC Ledger, and the 4-confirmation note - \`ethereum.mdx\`: EVM RPC canister request flow diagram (fan-out to providers, consensus check, cycle refund) - \`dogecoin.md\`: ckDOGE deposit and withdrawal diagrams - \`solana.mdx\`: SOL RPC canister flow diagram; ckSOL deposit and withdrawal diagrams; removed stale "No ckSOL token" limitation **Diagram styling (global, \`plugins/remark-plantuml.mjs\` + \`src/styles/custom.css\`):** - ICP brand skin injected into all PlantUML diagrams (terracotta arrows, parchment fills, muted strokes) - Diagrams wrapped in \`<figure class="plantuml-diagram">\` with elevated background and \`border-radius: 6px\` - Dark mode: \`filter: invert(1) hue-rotate(180deg)\` on the image preserves hue relationships while flipping luminance **Factual corrections:** - \`bitcoin.mdx\`, \`dogecoin.md\`: replaced "management canister" with "Bitcoin canister" for \`bitcoin_*\` API calls; management canister Bitcoin API is deprecated (already noted in \`management-canister.md\`) - \`bitcoin.mdx\`, \`chain-key-tokens.mdx\`: updated ckBTC minimum confirmations from 6 to 4 (current mainnet value) - \`bitcoin.mdx\`: ckBTC deposit and withdrawal diagrams updated with KYT check step, Bitcoin Checker and Ledger participants, and async note on withdrawal - \`dogecoin.md\`: removed status labels from Bitcoin/Dogecoin comparison table; corrected all "management canister's Bitcoin API" references to "Bitcoin canister" ## Sync recommendation \`informed by dfinity/ic rs/bitcoin/ckbtc/minter/README.adoc, rs/dogecoin/ckdoge/minter/README.adoc, rs/ethereum/cketh/docs/cketh.adoc; dfinity/cksol README.md; dfinity/bitcoin-canister INTERFACE_SPECIFICATION.md; wiki.internetcomputer.org/wiki/Chain-key_Bitcoin\`
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
1 participant
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
reference/chain-key-canister-ids.md: canonical reference for all chain-key token canister IDs (ckBTC, ckETH, ckERC20, ckDOGE, ckSOL) — mainnet and testnet; single source of truthreference/icrc-standards.md: index of all adopted ICRC standards with external spec links for digital asset and wallet signer standardschain-key-tokens.mdxrewritten: ckDOGE and ckSOL deposit/withdrawal flows added; duplicate canister ID tables removed (now point to reference page); CLI flag corrections (-n ic)token-ledgers.mdx→ledgers.mdx: rewritten with ledger suite concept, ICRC-3 transaction history section, CLI/language tab separation (CLI first as standalone, language tabs after)token-standards.md→digital-asset-standards.md: renamed to match brand voice preference for "asset" over "token"protocol-canisters.mdrewritten: minter APIs and protocol reference only; ckDOGE, ckSOL, ckERC20 sections added; deposit/withdrawal flows and duplicate ID tables removedreference/index.mdgrouping (canisters → ICRC standards → costs → errors → specs)decisions.md: CLI/language tab separation convention recordedCross-reference map (no page overlaps primary content of another)
guides/chain-fusion/bitcoin.mdxguides/digital-assets/chain-key-tokens.mdxreference/chain-key-canister-ids.mdreference/protocol-canisters.mdreference/icrc-standards.md→ external linksSync recommendation
informed by dfinity/ic rs/bitcoin/ckbtc, rs/dogecoin/ckdoge, rs/ethereum/cketh; dfinity/cksol; dfinity/icskills skills/ckbtc, skills/icrc-ledger; dfinity/portal docs/defi/chain-key-tokens, docs/defi/token-standardsFollow-up (separate PR)
bitcoin.mdx,ethereum.mdx,solana.mdx,dogecoin.mdchain-key-tokens.mdxsolana.mdx; remove "upcoming" label fromdogecoin.md