Skip to content

docs(res): comprehensive cross-chain HTLC documentation#71

Merged
HappySonnyDev merged 2 commits into
nervosnetwork:doc_2.0from
humble-little-bear:doc/cch-cross-chain-htlc
Jun 18, 2026
Merged

docs(res): comprehensive cross-chain HTLC documentation#71
HappySonnyDev merged 2 commits into
nervosnetwork:doc_2.0from
humble-little-bear:doc/cch-cross-chain-htlc

Conversation

@humble-little-bear

Copy link
Copy Markdown
Contributor

This PR replaces the WIP placeholder for Cross-Chain HTLC with a full developer guide covering architecture, mechanics, and usage.

What's added

  • CCH architecture overview (actors, state machine, trackers, actions)
  • Detailed atomic swap flows for send_btc and receive_btc
  • Configuration reference for in-process and standalone modes
  • Security mechanisms: expiry safety, preimage verification, permanent vs. transient errors
  • Developer integration patterns (polling, fee estimation, wrapped BTC discovery)
  • Error reference table
  • Source code pointers for contributors

Related issue

Closes RET-43

🤖 Generated with Claude Code

Adds a developer-friendly guide covering:
- CCH architecture and actor model
- HTLC atomic swap mechanics (SendBTC / ReceiveBTC)
- Order state machine and action lifecycle
- Configuration for in-process and standalone modes
- Security mechanisms (expiry safety, preimage verification)
- Error reference and developer integration patterns

Closes RET-43

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@vercel

vercel Bot commented Jun 10, 2026

Copy link
Copy Markdown

@humble-little-bear is attempting to deploy a commit to the CKBA-2026 Team on Vercel.

A member of the Team first needs to authorize it.

@vercel

vercel Bot commented Jun 10, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
fiber-docs Ready Ready Preview, Comment Jun 10, 2026 8:35am

Request Review

Comment thread content/docs/res/cross-chain-htlc.mdx Outdated
Comment thread content/docs/res/cross-chain-htlc.mdx Outdated
Comment thread content/docs/res/cross-chain-htlc.mdx Outdated

@yfeng2824 yfeng2824 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

@HappySonnyDev Broken links: invoice, HTLC, TLC, multi-hop routing, PTLC

- Link key terms (invoice, HTLC, TLC, PTLC, multi-hop routing) to existing docs
- Soften 'any invoice' wording to 'compatible invoice'
- Clarify final-order pruning retention period
- Update config example to YAML with services list
- Expand Related Topics with routing, payment channel, and glossary links

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@HappySonnyDev HappySonnyDev merged commit 14e439c into nervosnetwork:doc_2.0 Jun 18, 2026
1 check failed
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.

3 participants