Skip to content

docs(chain-fusion): diagram styling, KYT flows, and Bitcoin canister corrections#176

Merged
marc0olo merged 6 commits into
mainfrom
docs/chain-fusion-diagrams-followup
Apr 29, 2026
Merged

docs(chain-fusion): diagram styling, KYT flows, and Bitcoin canister corrections#176
marc0olo merged 6 commits into
mainfrom
docs/chain-fusion-diagrams-followup

Conversation

@marc0olo
Copy link
Copy Markdown
Member

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):

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

- Darken ActorBorderColor from hairline (#e5ddcf) to muted (#6b6660)
  so the stick figure is visible against the parchment fill
- Wrap diagram <img> in <figure class="plantuml-diagram"> for CSS targeting
- Add .plantuml-diagram styles: elevated background, 6px radius, centered
- Fix dark mode with filter: invert(1) hue-rotate(180deg) on the image;
  this flips luminance while preserving approximate hue relationships
  so arrows remain in the warm-red family
The bitcoin_* methods were moved from the management canister to the
dedicated Bitcoin canisters (ghsi2-tqaaa-aaaan-aaaca-cai for mainnet,
g4xu7-jiaaa-aaaan-aaaaq-cai for testnet). The management canister
bitcoin_* API is deprecated (documented in management-canister.md).

- bitcoin.mdx: replace "management canister" with "Bitcoin canister"
  in the two prose references to the direct Bitcoin API
- bitcoin.mdx: update management canister Next steps link to clarify
  bitcoin_* methods are deprecated there; signing (sign_with_ecdsa,
  sign_with_schnorr) still uses the management canister
- dogecoin.md: fix comparison table (Management canister -> Bitcoin canister)
  and three prose references that incorrectly named the management canister
…sibility

ParticipantBorderColor and NoteBorderColor were #e5ddcf (hairline).
After invert(1) hue-rotate(180deg) in dark mode, both the box fill
(#fdfaf3 -> near-black) and the border (#e5ddcf -> also near-black)
inverted to nearly the same tone, making participant boxes invisible.

Changed both to #6b6660 (muted), consistent with lifeline and actor
border colors. After inversion this becomes ~#94999f (light gray),
clearly visible against the dark-inverted participant fill.
…rams

Deposit diagram: add Bitcoin Checker (KYT), ckBTC Ledger, and a note
about the 6-confirmation requirement. The simplified diagram omitted
the KYT compliance check which can quarantine UTXOs, and the Ledger
as the minting endpoint.

Withdrawal diagram: add Bitcoin Checker (KYT) for destination address
validation and an async note for the batched Bitcoin submission.

Prose: updated to name the 6-confirmation threshold, the 100-satoshi
KYT fee per UTXO, quarantine behaviour, and the retrieve_btc_status_v2
call for tracking withdrawal status.
@marc0olo marc0olo merged commit 957c976 into main Apr 29, 2026
2 checks passed
@marc0olo marc0olo deleted the docs/chain-fusion-diagrams-followup branch April 29, 2026 22:36
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.

1 participant