Skip to content

Commit a0053fd

Browse files
committed
docs(bruno): fix external funding README step numbers
1 parent c2328b8 commit a0053fd

File tree

1 file changed

+22
-22
lines changed
  • tests/bruno/e2e/external-funding-open

1 file changed

+22
-22
lines changed

tests/bruno/e2e/external-funding-open/README.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@ The flow verifies that node1 acts as the channel initiator without spending its
1212

1313
For a quicker read through the main external-funding flow, these are good files to start with:
1414

15-
- [`07-open-channel-with-external-funding.bru`](tests/bruno/e2e/external-funding-open/07-open-channel-with-external-funding.bru): the main entry point; defines `funding_amount`, injects node2's funding/shutdown script, and captures the unsigned funding tx plus channel id.
16-
- [`08-sign-external-funding-tx.bru`](tests/bruno/e2e/external-funding-open/08-sign-external-funding-tx.bru): signs the unsigned funding tx with `EXTERNAL_FUNDING_PRIVKEY`.
17-
- [`09-submit-signed-funding-tx.bru`](tests/bruno/e2e/external-funding-open/09-submit-signed-funding-tx.bru): submits the signed funding tx and records the on-chain funding tx hash.
18-
- [`11-wait-channel-ready.bru`](tests/bruno/e2e/external-funding-open/11-wait-channel-ready.bru): the ready-state polling logic after funding submission.
19-
- [`15-shutdown-channel-from-node1.bru`](tests/bruno/e2e/external-funding-open/15-shutdown-channel-from-node1.bru): starts cooperative shutdown using node2's close script.
20-
- [`17-wait-channel-closed-and-capture-shutdown-tx.bru`](tests/bruno/e2e/external-funding-open/17-wait-channel-closed-and-capture-shutdown-tx.bru): the closed-state polling logic and shutdown tx capture.
21-
- [`18-inspect-shutdown-tx.bru`](tests/bruno/e2e/external-funding-open/18-inspect-shutdown-tx.bru): checks the shutdown refund output returned to node2 and derives the shutdown fee.
15+
- [`08-open-channel-with-external-funding.bru`](tests/bruno/e2e/external-funding-open/08-open-channel-with-external-funding.bru): the main entry point; defines `funding_amount`, injects node2's funding/shutdown script, and captures the unsigned funding tx plus channel id.
16+
- [`09-sign-external-funding-tx.bru`](tests/bruno/e2e/external-funding-open/09-sign-external-funding-tx.bru): signs the unsigned funding tx with `EXTERNAL_FUNDING_PRIVKEY`.
17+
- [`10-submit-signed-funding-tx.bru`](tests/bruno/e2e/external-funding-open/10-submit-signed-funding-tx.bru): submits the signed funding tx and records the on-chain funding tx hash.
18+
- [`12-wait-channel-ready.bru`](tests/bruno/e2e/external-funding-open/12-wait-channel-ready.bru): the ready-state polling logic after funding submission.
19+
- [`16-shutdown-channel-from-node1.bru`](tests/bruno/e2e/external-funding-open/16-shutdown-channel-from-node1.bru): starts cooperative shutdown using node2's close script.
20+
- [`18-wait-channel-closed-and-capture-shutdown-tx.bru`](tests/bruno/e2e/external-funding-open/18-wait-channel-closed-and-capture-shutdown-tx.bru): the closed-state polling logic and shutdown tx capture.
21+
- [`19-inspect-shutdown-tx.bru`](tests/bruno/e2e/external-funding-open/19-inspect-shutdown-tx.bru): checks the shutdown refund output returned to node2 and derives the shutdown fee.
2222

2323
The other `.bru` files are mostly support steps for setup, balance snapshots, and per-node assertions.
2424

@@ -47,17 +47,17 @@ This test validates the following sequence:
4747

4848
The Bruno collection now follows a more request-oriented layout:
4949

50-
- `00` connects node1 to node3.
51-
- `01` to `06` fetch the three nodes' funding scripts and pre-open CKB balances.
52-
- `07` opens the external-funded channel.
53-
- `08` signs the unsigned funding tx via `sign_external_funding_tx`.
54-
- `09` submits the signed funding tx.
55-
- `10` and `11` poll until the channel reaches `ChannelReady`.
56-
- `12` to `14` check node1/node2/node3 balances after open.
57-
- `15` initiates cooperative shutdown from node1.
58-
- `16` and `17` poll until the channel reaches `Closed` and capture the shutdown tx hash.
59-
- `18` inspects the shutdown transaction and records the refund/fee split.
60-
- `19` to `21` check node1/node2/node3 balances after close.
50+
- `01` connects node1 to node3.
51+
- `02` to `07` fetch the three nodes' funding scripts and pre-open CKB balances.
52+
- `08` opens the external-funded channel.
53+
- `09` signs the unsigned funding tx via `sign_external_funding_tx`.
54+
- `10` submits the signed funding tx.
55+
- `11` and `12` poll until the channel reaches `ChannelReady`.
56+
- `13` to `15` check node1/node2/node3 balances after open.
57+
- `16` initiates cooperative shutdown from node1.
58+
- `17` and `18` poll until the channel reaches `Closed` and capture the shutdown tx hash.
59+
- `19` inspects the shutdown transaction and records the refund/fee split.
60+
- `20` to `22` check node1/node2/node3 balances after close.
6161

6262
## Running
6363

@@ -85,13 +85,13 @@ npm exec -- @usebruno/cli@1.20.0 run e2e/external-funding-open -r --env test
8585

8686
### Funding amount selection
8787

88-
[`07-open-channel-with-external-funding.bru`](tests/bruno/e2e/external-funding-open/07-open-channel-with-external-funding.bru) makes a single open attempt with the `funding_amount` defined in the JSON-RPC request body. In the current checked-in version, that value is `0xba43b7400` (500 CKB).
88+
[`08-open-channel-with-external-funding.bru`](tests/bruno/e2e/external-funding-open/08-open-channel-with-external-funding.bru) makes a single open attempt with the `funding_amount` defined in the JSON-RPC request body. In the current checked-in version, that value is `0xba43b7400` (500 CKB).
8989

90-
`EXTERNAL_FUNDING_AMOUNT` is not an input parameter for this collection. Step `07` reads the `funding_amount` from the request body and stores it in the Bruno variable `EXTERNAL_FUNDING_AMOUNT` only so later steps can reuse the same value for assertions.
90+
`EXTERNAL_FUNDING_AMOUNT` is not an input parameter for this collection. Step `08` reads the `funding_amount` from the request body and stores it in the Bruno variable `EXTERNAL_FUNDING_AMOUNT` only so later steps can reuse the same value for assertions.
9191

92-
If you want to test a different amount, update the `funding_amount` field in [`07-open-channel-with-external-funding.bru`](tests/bruno/e2e/external-funding-open/07-open-channel-with-external-funding.bru).
92+
If you want to test a different amount, update the `funding_amount` field in [`08-open-channel-with-external-funding.bru`](tests/bruno/e2e/external-funding-open/08-open-channel-with-external-funding.bru).
9393

9494
## Troubleshooting
9595

9696
- `Missing EXTERNAL_FUNDING_PRIVKEY environment variable`: add it to `tests/bruno/environments/test.bru`, or pass it with `--env-var EXTERNAL_FUNDING_PRIVKEY=...`.
97-
- Failed to open with the selected amount: lower `funding_amount` in [`07-open-channel-with-external-funding.bru`](tests/bruno/e2e/external-funding-open/07-open-channel-with-external-funding.bru).
97+
- Failed to open with the selected amount: lower `funding_amount` in [`08-open-channel-with-external-funding.bru`](tests/bruno/e2e/external-funding-open/08-open-channel-with-external-funding.bru).

0 commit comments

Comments
 (0)