docs(chain-fusion): add flow diagrams and ckSOL/ckDOGE sections#174
Merged
Conversation
- bitcoin.mdx: add PlantUML sequence diagrams for ckBTC deposit and withdrawal flows - ethereum.mdx: add PlantUML sequence diagram for EVM RPC canister request flow - dogecoin.md: add ckDOGE section with deposit/withdrawal diagrams; mark ckDOGE as live - solana.mdx: add SOL RPC canister flow diagram; add ckSOL section with deposit/withdrawal diagrams; remove stale "No ckSOL token" limitation Source: dfinity/ic rs/bitcoin/ckbtc, rs/dogecoin/ckdoge, rs/ethereum/cketh; dfinity/cksol
…grams Transparent background, terracotta arrows, parchment boxes, ink text. Applied centrally in the plugin so no per-page skinparam needed.
marc0olo
added a commit
that referenced
this pull request
Apr 29, 2026
…corrections (#176) ## Summary Follow-up to #174. Changes that were not pushed before that PR was merged. **PlantUML diagram styling (`plugins/remark-plantuml.mjs`, `src/styles/custom.css`):** - Wrap each diagram in `<figure class="plantuml-diagram">` for CSS targeting - Elevated background (`--icp-bg-elev`) and `border-radius: 6px` as visual container (no explicit border needed) - Dark mode: `filter: invert(1) hue-rotate(180deg)` on the image preserves hue relationships while flipping luminance - Darken actor border, lifeline, participant border, and note border from hairline (`#e5ddcf`) to muted (`#6b6660`) so all structural lines remain legible after dark mode inversion **Bitcoin canister corrections (`bitcoin.mdx`, `dogecoin.md`):** - Replace "management canister" with "Bitcoin canister" for `bitcoin_*` API calls - The management canister Bitcoin API is deprecated; documented in `management-canister.md` - All remaining "management canister" references correctly describe `sign_with_ecdsa` / `sign_with_schnorr`, which do stay on the management canister **ckBTC flow diagrams (`bitcoin.mdx`):** - Deposit diagram: add Bitcoin Checker (KYT), ckBTC Ledger participant, and 4-confirmation note - Withdrawal diagram: add Bitcoin Checker for destination address KYT check and async note for batched Bitcoin submission - Prose updated: names the 4-confirmation threshold, 100-satoshi KYT fee per UTXO, quarantine behaviour for failed UTXOs, and `retrieve_btc_status_v2` for withdrawal tracking **Confirmation count (`bitcoin.mdx`, `chain-key-tokens.mdx`):** - Update ckBTC minimum confirmations from 6 to 4 in the diagram note, deposit flow prose, and the `chain-key-tokens.mdx` callout (distinct from the table/description already updated in #173) ## Sync recommendation `informed by dfinity/ic rs/bitcoin/ckbtc/minter/README.adoc; 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
Follow-up to #149 as noted in that PR's description.
Diagrams added:
Diagram styling (global, `plugins/remark-plantuml.mjs` + `src/styles/custom.css`):
Factual corrections:
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`