docs(res): comprehensive cross-chain HTLC documentation#71
Open
humble-little-bear wants to merge 2 commits into
Open
docs(res): comprehensive cross-chain HTLC documentation#71humble-little-bear wants to merge 2 commits into
humble-little-bear wants to merge 2 commits into
Conversation
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>
|
@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. |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
yfeng2824
reviewed
Jun 16, 2026
| 4. Alice pays the Fiber invoice | ||
| 5. Ingrid pays the Lightning invoice to Bob | ||
| 6. Both payments settle atomically | ||
| - **Payment interoperability**: A Fiber user can pay any Lightning invoice, and a Lightning user can pay any Fiber invoice. |
Collaborator
There was a problem hiding this comment.
The word "any" might be too absolute? According to https://github.com/nervosnetwork/fiber/blob/v0.8.1/crates/fiber-lib/src/cch/actor.rs#L545-L575 & https://github.com/nervosnetwork/fiber/blob/v0.8.1/crates/fiber-lib/src/cch/actor.rs#L638-L718, use compatible might be better?
yfeng2824
reviewed
Jun 16, 2026
|
|
||
| ### Configuration | ||
|
|
||
| CCH is enabled by adding a `[cch]` section to your Fiber config file (or via CLI flags / env vars): |
Collaborator
There was a problem hiding this comment.
Suggested change
| CCH is enabled by adding a `[cch]` section to your Fiber config file (or via CLI flags / env vars): | |
| To run CCH, add `cch` to the `services` list and configure the `cch` section in your Fiber `config.yml` (or provide the equivalent CLI flags / environment variables). |
yfeng2824
reviewed
Jun 16, 2026
| 2. **On `IncomingAccepted`** (`on_entering`): `SendOutgoingPayment` + `TrackOutgoingPayment` are scheduled. | ||
| 3. **On `OutgoingInFlight`** (`on_entering`): `TrackOutgoingPayment` is scheduled (ensures we keep watching). | ||
| 4. **On `OutgoingSuccess`** (`on_entering`): `SettleIncomingInvoice` is scheduled. | ||
| 5. **On final states** (`Success` / `Failed`): No further actions. Scheduler queues a prune job (21 days later). |
Collaborator
There was a problem hiding this comment.
Suggested change
| 5. **On final states** (`Success` / `Failed`): No further actions. Scheduler queues a prune job (21 days later). | |
| 5. **On final states** (`Success` / `Failed`): No further actions. Final orders are pruned after their scheduled order expiry time plus an additional 21-day retention period |
yfeng2824
requested changes
Jun 16, 2026
yfeng2824
left a comment
yfeng2824
left a comment
Collaborator
There was a problem hiding this comment.
@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>
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
2 participants
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.
This PR replaces the WIP placeholder for Cross-Chain HTLC with a full developer guide covering architecture, mechanics, and usage.
What's added
send_btcandreceive_btcRelated issue
Closes RET-43
🤖 Generated with Claude Code