From c195f3d39383a868fc7ee73d66cd45d381fafd65 Mon Sep 17 00:00:00 2001 From: IshaVenikar Date: Tue, 27 Aug 2024 14:46:12 +0530 Subject: [PATCH] Add expected output for direct-fund commands --- nitro-bridge-demo.md | 51 +++++++++++++++++++++++++++++++++----------- 1 file changed, 38 insertions(+), 13 deletions(-) diff --git a/nitro-bridge-demo.md b/nitro-bridge-demo.md index 9f31522..1f4a0cc 100644 --- a/nitro-bridge-demo.md +++ b/nitro-bridge-demo.md @@ -305,16 +305,16 @@ ``` - Create a deployment `nitro-contracts` from the spec file - + ```bash laconic-so --stack ~/cerc/nitro-stack/stack-orchestrator/stacks/nitro-contracts deploy create --spec-file nitro-contracts-spec.yml --deployment-dir nitro-contracts-deployment ``` - Start `nitro-contracts` deployment: - ``` + ```bash laconic-so deployment --dir nitro-contracts-deployment start - + # Check the l1 nitro contract deployments laconic-so deployment --dir nitro-contracts-deployment logs nitro-contracts -f ``` @@ -322,15 +322,15 @@ - Run the bridge: - Get the deployed nitro contract addresses (run in the directory where the deployments were created): - + ```bash # Nitro contract addresses export NA_ADDRESS=$(laconic-so deployment --dir nitro-contracts-deployment exec nitro-contracts "jq -r '.\"1212\"[0].contracts.NitroAdjudicator.address' /app/deployment/nitro-addresses.json") export CA_ADDRESS=$(laconic-so deployment --dir nitro-contracts-deployment exec nitro-contracts "jq -r '.\"1212\"[0].contracts.ConsensusApp.address' /app/deployment/nitro-addresses.json") - export VPA_ADDRESS=$(laconic-so deployment --dir nitro-contracts-deployment exec nitro-contracts "jq -r '.\"1212\"[0].contracts.VirtualPaymentApp.address' /app/deployment/nitro-addresses.json") - export L1_ASSET_ADDRESS="$(laconic-so deployment --dir nitro-contracts-deployment exec nitro-contracts "jq -r '.\"1212\"[0].contracts.Token.address' /app/deployment/nitro-addresses.json")" + export VPA_ADDRESS=$(laconic-so deployment --dir nitro-contracts-deployment exec nitro-contracts "jq -r '.\"1212\"[0].contracts.VirtualPaymentApp.address' /app/deployment/nitro-addresses.json") + export L1_ASSET_ADDRESS="$(laconic-so deployment --dir nitro-contracts-deployment exec nitro-contracts "jq -r '.\"1212\"[0].contracts.Token.address' /app/deployment/nitro-addresses.json")" ``` - + - Create a spec-file for the deployment, map container ports to host ports and set env variables: ```bash @@ -543,13 +543,17 @@ ```bash laconic-so deployment --dir l1alice-nitro-deployment exec nitro-rpc-client "nitro-rpc-client direct-fund $BRIDGE_NITRO_ADDRESS --assetAddress $L1_ASSET_ADDRESS --alphaAmount 1000000 --betaAmount 1000000 -p 4005 -h nitro-node" + + # Expected Output: + # Objective started DirectFunding-0x161d289a50222caa781db215bb82a3ede4f557217742245525b8e8cbff04ec21 + # Channel Open 0x161d289a50222caa781db215bb82a3ede4f557217742245525b8e8cbff04ec21 ``` - Once direct-fund objective is complete, bridge will create mirrored channel on L2 - Check node A' logs to see bridged-fund objective completed - Check the [Troubleshooting](#troubleshooting) section if command to create a ledger channel fails or gets stuck - - Check status of L1 ledger channel between A and Bridge + - Check status of L1 ledger channel between A and Bridge using channel ID in output above ```bash laconic-so deployment --dir l1alice-nitro-deployment exec nitro-rpc-client "nitro-rpc-client get-ledger-channel -p 4005 -h nitro-node" @@ -573,13 +577,17 @@ ```bash laconic-so deployment --dir l1charlie-nitro-deployment exec nitro-rpc-client "nitro-rpc-client direct-fund $BRIDGE_NITRO_ADDRESS --assetAddress $L1_ASSET_ADDRESS --alphaAmount 1000000 --betaAmount 1000000 -p 4005 -h nitro-node" + + # Expected Output: + # Objective started DirectFunding-0x69a3f09b6f4f94f033cf084e6e4a9453438c45b43606e9a95f5434f4c6527543 + # Channel Open 0x69a3f09b6f4f94f033cf084e6e4a9453438c45b43606e9a95f5434f4c6527543 ``` - Once direct fund objective is complete, bridge will create mirrored channel on L2 - Check node C' logs to see bridged-fund objective completed - Check the [Troubleshooting](#troubleshooting) section if command to create a ledger channel fails or gets stuck - - Check status of L1 ledger channel between C and Bridge + - Check status of L1 ledger channel between C and Bridge using channel ID in output above ```bash laconic-so deployment --dir l1charlie-nitro-deployment exec nitro-rpc-client "nitro-rpc-client get-ledger-channel -p 4005 -h nitro-node" @@ -674,6 +682,23 @@ - Check payment channel status again to view updated channel state + ```bash + laconic-so deployment --dir l2alice-nitro-deployment exec nitro-rpc-client "nitro-rpc-client get-payment-channel $PAYMENT_CHANNEL_ID -p 4005 -h nitro-node" + + # Expected output: + # { + # ID: '0xb29aeb32c9495a793ebf7bd116232075d1e7bfe89fc82281c7d498e3ffd3e3bf', + # Status: 'Open', + # Balance: { + # AssetAddress: '0x0000000000000000000000000000000000000000', + # Payee: '0xa8d2d06ace9c7ffc24ee785c2695678aecdfd7a0', + # Payer: '0xaaa6628ec44a8a742987ef3a114ddfe2d4f7adce', + # PaidSoFar: 200n, + # RemainingFunds: 800n + # } + # } + ``` + - Close payment channel after payments ```bash @@ -733,9 +758,9 @@ ```bash laconic-so deployment --dir l1alice-nitro-deployment start laconic-so deployment --dir l1charlie-nitro-deployment start - laconic-so deployment --dir l2alice-nitro-deployment start - laconic-so deployment --dir l2charlie-nitro-deployment start - laconic-so deployment --dir bridge-deployment start + laconic-so deployment --dir l2alice-nitro-deployment start + laconic-so deployment --dir l2charlie-nitro-deployment start + laconic-so deployment --dir bridge-deployment start ``` - Follow the steps from [Demo](#demo) to re-run the demo @@ -827,4 +852,4 @@ laconic-so deployment --dir l1charlie-nitro-deployment start ``` - - Retry the ledger channel creation command \ No newline at end of file + - Retry the ledger channel creation command