feat: cch separate service #901

doitian · 2025-09-17T06:26:55Z

Based on #615 and #898

A rework of #522

This PR allows running cch as a separate service, which talks to another fiber node via HTTP and WebSocket JSONRPC.

Add StoreWithPubSub to emit store update events. It uses ractor OutputPort for pub-sub. This is a rework of StoreWithHooks in nervosnetwork#511 - Use decorator pattern to add additional features on Store - Minimize the interface change that original codes relying on Store traits dot not need to change. - Avoid using an Actor to fetch extra data asynchronously. This resolves the issue mentioned in nervosnetwork#615 (comment) . The channel actor cleans preimage on success payment automatically. Thus we may fail to get the preimage when settling the cch payment in the BTC end.

Copilot

Pull Request Overview

This PR enables running the Cross-Chain Hub (CCH) as a separate service that communicates with another fiber node via HTTP and WebSocket JSONRPC. It introduces a significant architectural change to support CCH as a standalone service alongside the existing embedded CCH functionality.

Key changes:

Implements a separate CCH service architecture with RPC communication to fiber nodes
Adds comprehensive test infrastructure for cross-chain payment scenarios
Enhances invoice management with hold invoice support and manual settlement
Refactors store components to support pub/sub patterns for cross-service communication

Reviewed Changes

Copilot reviewed 116 out of 118 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
tests/nodes/start.sh	Adds conditional startup of separate CCH node for specific test scenarios
tests/nodes/deployer/config.yml	Updates CCH configuration with proper wrapped BTC type script
tests/deploy/udt-init/src/main.rs	Extends node configuration generation to support separate CCH node setup
tests/bruno/e2e/cross-chain-hub/*.bru	Creates comprehensive test suite for cross-chain hub functionality
tests/bruno/e2e/cross-chain-hub-separate/*.bru	Adds test cases for separate CCH service architecture
crates/fiber-lib/src/store/*	Implements pub/sub store wrapper and CCH order storage
crates/fiber-lib/src/rpc/*	Updates RPC modules to support separate CCH service and new endpoints
crates/fiber-lib/src/invoice/*	Enhances invoice system with hold invoices and manual settlement
crates/fiber-lib/src/cch/tests/*	Adds comprehensive test infrastructure for CCH functionality

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-09-17T06:28:06Z

fiber-js/src/index.ts

        return await this.invokeCommand("cancel_invoice", [params]);
    }
+    async settleInvoice(params: SettleInvoiceParams): Promise<SettleInvoiceResult> {
+        return await this.invokeCommand("cancel_invoice", [params]);


The settleInvoice method is incorrectly calling 'cancel_invoice' instead of 'settle_invoice'. This will cause the method to cancel invoices instead of settling them.

Suggested change

return await this.invokeCommand("cancel_invoice", [params]);

return await this.invokeCommand("settle_invoice", [params]);

Copilot · 2025-09-17T06:28:06Z

tests/deploy/udt-init/src/main.rs

            auto_accept_amount: Some(1000),
            script: UdtScript {
-                code_hash: code_hash,
+                code_hash,


[nitpick] Using shorthand field initialization syntax is good, but this change is inconsistent with the surrounding code style that explicitly shows field names. Consider keeping the explicit 'code_hash: code_hash' for consistency.

Suggested change

code_hash,

code_hash: code_hash,

Copilot · 2025-09-17T06:28:07Z

crates/fiber-lib/src/rpc/mod.rs

+            println!("cch enabled!");
            if config.is_module_enabled("cch") {
                modules
                    .merge(CchRpcServerImpl::new(cch_actor).into_rpc())
                    .unwrap();
            }
+        } else {
+            println!("cch not enabled!");


Using println! for logging in production code is not recommended. Use the tracing macros (debug!, info!, etc.) instead for consistent logging that can be controlled by log levels.

Suggested change

println!("cch enabled!");

if config.is_module_enabled("cch") {

modules

.merge(CchRpcServerImpl::new(cch_actor).into_rpc())

.unwrap();

}

} else {

println!("cch not enabled!");

tracing::info!("cch enabled!");

if config.is_module_enabled("cch") {

modules

.merge(CchRpcServerImpl::new(cch_actor).into_rpc())

.unwrap();

}

} else {

tracing::info!("cch not enabled!");

Copilot · 2025-09-17T06:28:07Z

crates/fiber-lib/src/rpc/mod.rs

+            println!("cch enabled!");
            if config.is_module_enabled("cch") {
                modules
                    .merge(CchRpcServerImpl::new(cch_actor).into_rpc())
                    .unwrap();
            }
+        } else {
+            println!("cch not enabled!");


Using println! for logging in production code is not recommended. Use the tracing macros (debug!, info!, etc.) instead for consistent logging that can be controlled by log levels.

Suggested change

println!("cch enabled!");

if config.is_module_enabled("cch") {

modules

.merge(CchRpcServerImpl::new(cch_actor).into_rpc())

.unwrap();

}

} else {

println!("cch not enabled!");

tracing::info!("cch enabled!");

if config.is_module_enabled("cch") {

modules

.merge(CchRpcServerImpl::new(cch_actor).into_rpc())

.unwrap();

}

} else {

tracing::info!("cch not enabled!");

@contrun

…saction Rebase nervosnetwork#511 by @contrun

Merge SendBTCOrder and ReceiveBTCOrder into CchOrder to simplify persistence. Add a order status to mark that the outgoing payment succeeds and preimage is obtained. Ensure the preimage is stored in case to retry settling the incoming payment.

Load orders from database and resume the workflow.

codecov-commenter · 2025-09-17T07:33:10Z

Codecov Report

❌ Patch coverage is 0% with 1286 lines in your changes missing coverage. Please review.
✅ Project coverage is 0.00%. Comparing base (f73119e) to head (1949e80).

Files with missing lines	Patch %	Lines
crates/fiber-lib/src/cch/actor.rs	0.00%	302 Missing ⚠️
.../fiber-lib/src/store/pub_sub/store_with_pub_sub.rs	0.00%	136 Missing ⚠️
crates/fiber-lib/src/cch/cch_fiber_agent.rs	0.00%	90 Missing ⚠️
crates/fiber-lib/src/fiber/channel.rs	0.00%	88 Missing ⚠️
crates/fiber-lib/src/fiber/gossip.rs	0.00%	81 Missing ⚠️
crates/fiber-lib/src/cch/order_guard.rs	0.00%	67 Missing ⚠️
crates/fiber-lib/src/store/pub_sub/pub_sub_rpc.rs	0.00%	65 Missing ⚠️
crates/fiber-lib/src/store/store_impl/mod.rs	0.00%	60 Missing ⚠️
crates/fiber-lib/src/watchtower/store.rs	0.00%	51 Missing ⚠️
crates/fiber-lib/src/fiber/network.rs	0.00%	41 Missing ⚠️
... and 16 more

Additional details and impacted files

@@           Coverage Diff            @@
##           develop    #901    +/-   ##
========================================
  Coverage     0.00%   0.00%            
========================================
  Files           61      67     +6     
  Lines        38205   39013   +808     
========================================
- Misses       38205   39013   +808

Flag	Coverage Δ
unittests	`0.00% <0.00%> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

doitian requested a review from Copilot September 17, 2025 06:27

doitian added 2 commits September 17, 2025 14:27

refactor: move pub sub tests under its own mod

2b1acd5

Copilot AI reviewed Sep 17, 2025

View reviewed changes

doitian force-pushed the feature/cch-separate-service branch from 18505a5 to cff1c58 Compare September 17, 2025 06:46

doitian added 5 commits September 17, 2025 14:47

Merge contrun/support-fiber-multiple-hops-payment-in-cross-chain-tran…

88f28df

…saction Rebase nervosnetwork#511 by @contrun

refactor: unify cch order types

d886d6f

Merge SendBTCOrder and ReceiveBTCOrder into CchOrder to simplify persistence. Add a order status to mark that the outgoing payment succeeds and preimage is obtained. Ensure the preimage is stored in case to retry settling the incoming payment.

feat: persist cch orders in rocksdb

f26fb06

feat: resume cch order on restart

ac35142

Load orders from database and resume the workflow.

feat: add rpc to subscribe store changes

3e157e9

doitian force-pushed the feature/cch-separate-service branch from cff1c58 to 1949e80 Compare September 17, 2025 06:49

doitian force-pushed the feature/cch-separate-service branch 5 times, most recently from a75fc9f to 7f94dce Compare September 18, 2025 00:45

feat: allow running cch as a separate service

b263400

doitian force-pushed the feature/cch-separate-service branch from 7f94dce to b263400 Compare September 18, 2025 01:32

doitian marked this pull request as draft November 3, 2025 02:38

doitian mentioned this pull request Nov 5, 2025

Cross-Chain Hub Improvements #944

Open

9 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: cch separate service #901

feat: cch separate service #901

Uh oh!

doitian commented Sep 17, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Sep 17, 2025

Uh oh!

Copilot AI Sep 17, 2025

Uh oh!

Copilot AI Sep 17, 2025

Uh oh!

Copilot AI Sep 17, 2025

Uh oh!

codecov-commenter commented Sep 17, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	return await this.invokeCommand("cancel_invoice", [params]);
	return await this.invokeCommand("settle_invoice", [params]);

feat: cch separate service #901

Are you sure you want to change the base?

feat: cch separate service #901

Uh oh!

Conversation

doitian commented Sep 17, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Sep 17, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 17, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 17, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 17, 2025

Choose a reason for hiding this comment

Uh oh!

codecov-commenter commented Sep 17, 2025

Codecov Report

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants