nabarun
034778ebeb
Part of [Create bridge channel in go-nitro](https://www.notion.so/Create-bridge-channel-in-go-nitro-22ce80a0d8ae4edb80020a8f250ea270) - Remove L2 stack setup from demo steps - Remove steps to deploy l2 contract Co-authored-by: Shreerang Kale <shreerangkale@gmail.com> Co-authored-by: Neeraj <neeraj.rtly@gmail.com> Reviewed-on: #11
839 lines
29 KiB
Markdown
839 lines
29 KiB
Markdown
# nitro-bridge demo
|
|
|
|
## Setup
|
|
|
|
### eth-stack
|
|
|
|
- Clone the stack repo:
|
|
|
|
```bash
|
|
laconic-so fetch-stack git.vdb.to/cerc-io/fixturenet-eth-stacks --pull
|
|
```
|
|
|
|
- Clone required repositories:
|
|
|
|
```bash
|
|
# fixturenet-eth
|
|
laconic-so --stack ~/cerc/fixturenet-eth-stacks/stack-orchestrator/stacks/fixturenet-eth setup-repositories --pull
|
|
|
|
# If this throws an error as a result of being already checked out to a branch/tag in a repo, remove all repositories from that stack and re-run the command
|
|
# The repositories are located in $HOME/cerc by default
|
|
```
|
|
|
|
- Build the container images:
|
|
|
|
```bash
|
|
# Remove any older foundry image with `latest` tag
|
|
docker rmi ghcr.io/foundry-rs/foundry:latest
|
|
|
|
# fixturenet-eth
|
|
laconic-so --stack ~/cerc/fixturenet-eth-stacks/stack-orchestrator/stacks/fixturenet-eth build-containers --force-rebuild
|
|
|
|
# If errors are thrown during build, old images used by this stack would have to be deleted
|
|
```
|
|
|
|
- NOTE: this will take >10 mins depending on the specs of your machine, and **requires** 16GB of memory or greater.
|
|
|
|
- Remove any dangling Docker images (to clear up space):
|
|
|
|
```bash
|
|
docker image prune
|
|
```
|
|
|
|
- Create spec files for deployments, which will map the stack's ports and volumes to the host:
|
|
|
|
```bash
|
|
laconic-so --stack ~/cerc/fixturenet-eth-stacks/stack-orchestrator/stacks/fixturenet-eth deploy init --output fixturenet-eth-spec.yml
|
|
```
|
|
|
|
- Configure ports:
|
|
- `fixturenet-eth-spec.yml`
|
|
|
|
```yml
|
|
...
|
|
network:
|
|
ports:
|
|
fixturenet-eth-bootnode-geth:
|
|
- '9898:9898'
|
|
- '30303'
|
|
fixturenet-eth-geth-1:
|
|
- '8545:8545'
|
|
- '8546:8546'
|
|
- '40000'
|
|
- '6060'
|
|
fixturenet-eth-lighthouse-1:
|
|
- '8001'
|
|
...
|
|
```
|
|
|
|
- Create deployments:
|
|
Once you've made any needed changes to the spec files, create deployments from them:
|
|
|
|
```bash
|
|
laconic-so --stack ~/cerc/fixturenet-eth-stacks/stack-orchestrator/stacks/fixturenet-eth deploy create --spec-file fixturenet-eth-spec.yml --deployment-dir fixturenet-eth-deployment
|
|
```
|
|
|
|
- Env configuration:
|
|
|
|
```bash
|
|
cat <<EOF > fixturenet-eth-deployment/config.env
|
|
CERC_ALLOW_UNPROTECTED_TXS=true
|
|
EOF
|
|
```
|
|
|
|
### go-nitro
|
|
|
|
- Clone the stack repo:
|
|
|
|
```bash
|
|
laconic-so fetch-stack git.vdb.to/cerc-io/nitro-stack --git-ssh --pull
|
|
```
|
|
|
|
- Clone required repositories:
|
|
|
|
```bash
|
|
laconic-so --stack ~/cerc/nitro-stack/stack-orchestrator/stacks/nitro-node setup-repositories --git-ssh --pull
|
|
```
|
|
|
|
- Build the container images:
|
|
|
|
```bash
|
|
laconic-so --stack ~/cerc/nitro-stack/stack-orchestrator/stacks/nitro-node build-containers --force-rebuild
|
|
```
|
|
|
|
- Create a deployment spec-file for Alice's L1 nitro-node:
|
|
- Create spec file for the deployment:
|
|
|
|
```bash
|
|
laconic-so --stack ~/cerc/nitro-stack/stack-orchestrator/stacks/nitro-node deploy init --output l1alice-nitro-spec.yml
|
|
```
|
|
|
|
- Edit `network` in the spec file to map container ports to host ports as required:
|
|
|
|
```bash
|
|
# l1alice-nitro-spec.yml
|
|
...
|
|
network:
|
|
ports:
|
|
nitro-node:
|
|
- 3007:3005
|
|
- 4007:4005
|
|
```
|
|
|
|
- Create a deployment spec-file for Charlie's L1 nitro-node:
|
|
- Create spec file for the deployment:
|
|
|
|
```bash
|
|
laconic-so --stack ~/cerc/nitro-stack/stack-orchestrator/stacks/nitro-node deploy init --output l1charlie-nitro-spec.yml
|
|
```
|
|
|
|
- Edit `network` in the spec file to map container ports to host ports as required:
|
|
|
|
```bash
|
|
# l1charlie-nitro-spec.yml
|
|
...
|
|
network:
|
|
ports:
|
|
nitro-node:
|
|
- 3008:3005
|
|
- 4008:4005
|
|
```
|
|
|
|
- Create a deployment spec-file for Alice's L2 nitro-node:
|
|
- Create spec file for the deployment:
|
|
|
|
```bash
|
|
laconic-so --stack ~/cerc/nitro-stack/stack-orchestrator/stacks/nitro-node deploy init --output l2alice-nitro-spec.yml
|
|
```
|
|
|
|
- Edit `network` in the spec file to map container ports to host ports as required:
|
|
|
|
```bash
|
|
# l2alice-nitro-spec.yml
|
|
...
|
|
network:
|
|
ports:
|
|
nitro-node:
|
|
- 3009:3005
|
|
- 4009:4005
|
|
```
|
|
|
|
- Create a deployment spec-file for Charlie's L2 nitro-node:
|
|
- Create spec file for the deployment:
|
|
|
|
```bash
|
|
laconic-so --stack ~/cerc/nitro-stack/stack-orchestrator/stacks/nitro-node deploy init --output l2charlie-nitro-spec.yml
|
|
```
|
|
|
|
- Edit `network` in the spec file to map container ports to host ports as required:
|
|
|
|
```bash
|
|
# l2charlie-nitro-spec.yml
|
|
...
|
|
network:
|
|
ports:
|
|
nitro-node:
|
|
- 3010:3005
|
|
- 4010:4005
|
|
```
|
|
|
|
## Run
|
|
|
|
- Start fixturenet eth stack:
|
|
(run steps in directory where the stack deployments had been created)
|
|
|
|
- Start `fixturenet-eth-deployment` deployment:
|
|
|
|
```bash
|
|
laconic-so deployment --dir fixturenet-eth-deployment start
|
|
```
|
|
|
|
- Check status of L1
|
|
|
|
- Run status check:
|
|
|
|
```bash
|
|
laconic-so deployment --dir fixturenet-eth-deployment exec fixturenet-eth-bootnode-lighthouse "/scripts/status-internal.sh"
|
|
```
|
|
|
|
- Check geth logs to ensure that new blocks are getting created
|
|
|
|
```bash
|
|
laconic-so deployment --dir fixturenet-eth-deployment logs -f fixturenet-eth-geth-1
|
|
```
|
|
|
|
- Deploy L1 nitro contracts
|
|
|
|
- Create a deployment spec-file for L1 nitro contract:
|
|
|
|
```bash
|
|
laconic-so --stack ~/cerc/nitro-stack/stack-orchestrator/stacks/nitro-contracts deploy init --output nitro-contracts-spec.yml --config "GETH_URL=http://host.docker.internal:8545,GETH_DEPLOYER_PK=888814df89c4358d7ddb3fa4b0213e7331239a80e1f013eaa7b2deca2a41a218,GETH_CHAIN_ID=1212,TOKEN_NAME=TestToken,TOKEN_SYMBOL=TST,INITIAL_TOKEN_SUPPLY=129600"
|
|
```
|
|
|
|
- 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
|
|
```
|
|
|
|
- Run the bridge:
|
|
|
|
- Get the deployed nitro contract addresses (run in the directory where the deployments were created):
|
|
|
|
```bash
|
|
# Nitro contract addresses
|
|
export GETH_CHAIN_ID="1212"
|
|
export NA_ADDRESS=$(laconic-so deployment --dir nitro-contracts-deployment exec nitro-contracts "jq -r '.\"$GETH_CHAIN_ID\"[0].contracts.NitroAdjudicator.address' /app/deployment/nitro-addresses.json")
|
|
export CA_ADDRESS=$(laconic-so deployment --dir nitro-contracts-deployment exec nitro-contracts "jq -r '.\"$GETH_CHAIN_ID\"[0].contracts.ConsensusApp.address' /app/deployment/nitro-addresses.json")
|
|
export VPA_ADDRESS=$(laconic-so deployment --dir nitro-contracts-deployment exec nitro-contracts "jq -r '.\"$GETH_CHAIN_ID\"[0].contracts.VirtualPaymentApp.address' /app/deployment/nitro-addresses.json")
|
|
```
|
|
|
|
- Create a spec-file for the deployment, map container ports to host ports and set env variables:
|
|
|
|
```bash
|
|
laconic-so --stack ~/cerc/nitro-stack/stack-orchestrator/stacks/bridge deploy init --map-ports-to-host any-same --output bridge-nitro-spec.yml --config "NITRO_CHAIN_URL=ws://host.docker.internal:8546,NITRO_CHAIN_PK=888814df89c4358d7ddb3fa4b0213e7331239a80e1f013eaa7b2deca2a41a218,NITRO_SC_PK=0279651921cd800ac560c21ceea27aab0107b67daf436cdd25ce84cad30159b4,TOKEN_NAME=TestToken,TOKEN_SYMBOL=TST,INITIAL_TOKEN_SUPPLY=129600,NA_ADDRESS=$NA_ADDRESS,VPA_ADDRESS=$VPA_ADDRESS,CA_ADDRESS=$CA_ADDRESS"
|
|
```
|
|
|
|
- Create a deployment from the spec file:
|
|
|
|
```bash
|
|
laconic-so --stack ~/cerc/nitro-stack/stack-orchestrator/stacks/bridge deploy create --spec-file bridge-nitro-spec.yml --deployment-dir bridge-deployment
|
|
```
|
|
|
|
- Start the nitro bridge
|
|
|
|
```bash
|
|
laconic-so deployment --dir bridge-deployment start
|
|
|
|
# Check the logs, ensure that the node is running
|
|
laconic-so deployment --dir bridge-deployment logs nitro-bridge -f
|
|
```
|
|
|
|
- Send custom tokens to Alice and Charlie
|
|
|
|
- Export variables for L1 token address
|
|
|
|
```bash
|
|
export GETH_CHAIN_ID="1212"
|
|
export ASSET_ADDRESS=$(laconic-so deployment --dir nitro-contracts-deployment exec nitro-contracts "jq -r '.\"$GETH_CHAIN_ID\"[0].contracts.Token.address' /app/deployment/nitro-addresses.json")
|
|
|
|
export A_CHAIN_ADDRESS="0xe22AD83A0dE117bA0d03d5E94Eb4E0d80a69C62a"
|
|
export C_CHAIN_ADDRESS="0xf1ac8Dd1f6D6F5c0dA99097c57ebF50CD99Ce293"
|
|
```
|
|
|
|
- Send tokens to Alice and Charlie
|
|
|
|
```bash
|
|
# Send tokens to Alice
|
|
laconic-so deployment --dir nitro-contracts-deployment exec nitro-contracts "cd packages/nitro-protocol && yarn hardhat transfer --contract $ASSET_ADDRESS --to $A_CHAIN_ADDRESS --amount 1000 --network geth"
|
|
|
|
#Send tokens to Charlie
|
|
laconic-so deployment --dir nitro-contracts-deployment exec nitro-contracts "cd packages/nitro-protocol && yarn hardhat transfer --contract $ASSET_ADDRESS --to $C_CHAIN_ADDRESS --amount 1000 --network geth"
|
|
```
|
|
|
|
- Get the deployed nitro contract addresses (run in the directory where the deployments were created):
|
|
|
|
```bash
|
|
# Nitro contract addresses
|
|
export GETH_CHAIN_ID="1212"
|
|
export NA_ADDRESS=$(laconic-so deployment --dir nitro-contracts-deployment exec nitro-contracts "jq -r '.\"$GETH_CHAIN_ID\"[0].contracts.NitroAdjudicator.address' /app/deployment/nitro-addresses.json")
|
|
export CA_ADDRESS=$(laconic-so deployment --dir nitro-contracts-deployment exec nitro-contracts "jq -r '.\"$GETH_CHAIN_ID\"[0].contracts.ConsensusApp.address' /app/deployment/nitro-addresses.json")
|
|
export VPA_ADDRESS=$(laconic-so deployment --dir nitro-contracts-deployment exec nitro-contracts "jq -r '.\"$GETH_CHAIN_ID\"[0].contracts.VirtualPaymentApp.address' /app/deployment/nitro-addresses.json")
|
|
```
|
|
|
|
```bash
|
|
export A_PRIVATE_KEY=0x9aebbd42f3044295411e3631fcb6aa834ed5373a6d3bf368bfa09e5b74f4f6d1
|
|
export C_PRIVATE_KEY=0x19242258fc60ec7488db0163b20ed1c32f2d27dc49e4d427a461e20a6656de20
|
|
```
|
|
|
|
- Prepare deployments for the nodes
|
|
|
|
- Create a deployment `l1alice-nitro-deployment` from the spec file
|
|
|
|
```bash
|
|
laconic-so --stack ~/cerc/nitro-stack/stack-orchestrator/stacks/nitro-node deploy create --spec-file l1alice-nitro-spec.yml --deployment-dir l1alice-nitro-deployment
|
|
```
|
|
|
|
- Set the env variables for L1 Alice's nitro-node:
|
|
|
|
```bash
|
|
cat <<EOF > l1alice-nitro-deployment/config.env
|
|
NITRO_CHAIN_URL=ws://host.docker.internal:8546
|
|
NITRO_SC_PK=$A_PRIVATE_KEY
|
|
NITRO_CHAIN_PK=570b909da9669b2f35a0b1ac70b8358516d55ae1b5b3710e95e9a94395090597
|
|
NA_ADDRESS=$NA_ADDRESS
|
|
VPA_ADDRESS=$VPA_ADDRESS
|
|
CA_ADDRESS=$CA_ADDRESS
|
|
NITRO_BOOTPEERS=/dns4/host.docker.internal/tcp/3005/p2p/16Uiu2HAmJDxLM8rSybX78FH51iZq9PdrwCoCyyHRBCndNzcAYMes
|
|
NITRO_EXT_MULTIADDR=/dns4/host.docker.internal/tcp/3007
|
|
EOF
|
|
```
|
|
|
|
- Create a deployment `l1charlie-nitro-deployment` from the spec file
|
|
|
|
```bash
|
|
laconic-so --stack ~/cerc/nitro-stack/stack-orchestrator/stacks/nitro-node deploy create --spec-file l1charlie-nitro-spec.yml --deployment-dir l1charlie-nitro-deployment
|
|
```
|
|
|
|
- Set the env variables for L1 Charlie's nitro-node:
|
|
|
|
```bash
|
|
cat <<EOF > l1charlie-nitro-deployment/config.env
|
|
NITRO_CHAIN_URL=ws://host.docker.internal:8546
|
|
NITRO_SC_PK=$C_PRIVATE_KEY
|
|
NITRO_CHAIN_PK=111b7500bdce494d6f4bcfe8c2a0dde2ef92f751d9070fac6475dbd6d8021b3f
|
|
NA_ADDRESS=$NA_ADDRESS
|
|
VPA_ADDRESS=$VPA_ADDRESS
|
|
CA_ADDRESS=$CA_ADDRESS
|
|
NITRO_BOOTPEERS=/dns4/host.docker.internal/tcp/3005/p2p/16Uiu2HAmJDxLM8rSybX78FH51iZq9PdrwCoCyyHRBCndNzcAYMes
|
|
NITRO_EXT_MULTIADDR=/dns4/host.docker.internal/tcp/3008
|
|
EOF
|
|
```
|
|
|
|
- Create a deployment `l2alice-nitro-deployment` from the spec file:
|
|
|
|
```bash
|
|
laconic-so --stack ~/cerc/nitro-stack/stack-orchestrator/stacks/nitro-node deploy create --spec-file l2alice-nitro-spec.yml --deployment-dir l2alice-nitro-deployment
|
|
```
|
|
|
|
- Set the env variables for L2 Alice's nitro-node:
|
|
|
|
```bash
|
|
cat <<EOF > l2alice-nitro-deployment/config.env
|
|
NITRO_CHAIN_URL=ws://host.docker.internal:9546
|
|
NITRO_SC_PK=$A_PRIVATE_KEY
|
|
NITRO_CHAIN_PK=570b909da9669b2f35a0b1ac70b8358516d55ae1b5b3710e95e9a94395090597
|
|
NA_ADDRESS=$NA_ADDRESS
|
|
VPA_ADDRESS=$VPA_ADDRESS
|
|
CA_ADDRESS=$CA_ADDRESS
|
|
NITRO_BOOTPEERS=/dns4/host.docker.internal/tcp/3006/p2p/16Uiu2HAmJDxLM8rSybX78FH51iZq9PdrwCoCyyHRBCndNzcAYMes
|
|
NITRO_EXT_MULTIADDR=/dns4/host.docker.internal/tcp/3009
|
|
NITRO_L2=true
|
|
EOF
|
|
```
|
|
|
|
- Create deployment `l2charlie-nitro-deployment` from the spec files:
|
|
|
|
```bash
|
|
laconic-so --stack ~/cerc/nitro-stack/stack-orchestrator/stacks/nitro-node deploy create --spec-file l2charlie-nitro-spec.yml --deployment-dir l2charlie-nitro-deployment
|
|
```
|
|
|
|
- Set the env variables for L2 Charlie's nitro-node:
|
|
|
|
```bash
|
|
cat <<EOF > l2charlie-nitro-deployment/config.env
|
|
NITRO_CHAIN_URL=ws://host.docker.internal:9546
|
|
NITRO_SC_PK=$C_PRIVATE_KEY
|
|
NITRO_CHAIN_PK=111b7500bdce494d6f4bcfe8c2a0dde2ef92f751d9070fac6475dbd6d8021b3f
|
|
NA_ADDRESS=$NA_ADDRESS
|
|
VPA_ADDRESS=$VPA_ADDRESS
|
|
CA_ADDRESS=$CA_ADDRESS
|
|
NITRO_BOOTPEERS=/dns4/host.docker.internal/tcp/3006/p2p/16Uiu2HAmJDxLM8rSybX78FH51iZq9PdrwCoCyyHRBCndNzcAYMes
|
|
NITRO_EXT_MULTIADDR=/dns4/host.docker.internal/tcp/3010
|
|
NITRO_L2=true
|
|
EOF
|
|
```
|
|
|
|
- Start nitro nodes for Alice and Charlie on L1 and L2:
|
|
|
|
- Start the deployment for Alice's L1 node
|
|
|
|
```bash
|
|
laconic-so deployment --dir l1alice-nitro-deployment start
|
|
|
|
# Check the logs, ensure that the node is running
|
|
laconic-so deployment --dir l1alice-nitro-deployment logs nitro-node -f
|
|
```
|
|
|
|
- Start the deployment for Charlie's L1 node
|
|
|
|
```bash
|
|
laconic-so deployment --dir l1charlie-nitro-deployment start
|
|
|
|
# Check the logs, ensure that the node is running
|
|
laconic-so deployment --dir l1charlie-nitro-deployment logs nitro-node -f
|
|
```
|
|
|
|
- Start the deployment for Alice's L2 node
|
|
|
|
```bash
|
|
laconic-so deployment --dir l2alice-nitro-deployment start
|
|
|
|
# Check the logs, ensure that the node is running
|
|
laconic-so deployment --dir l2alice-nitro-deployment logs nitro-node -f
|
|
```
|
|
|
|
- Start the deployment for Charlie's L2 node
|
|
|
|
```bash
|
|
laconic-so deployment --dir l2charlie-nitro-deployment start
|
|
|
|
# Check the logs, ensure that the node is running
|
|
laconic-so deployment --dir l2charlie-nitro-deployment logs nitro-node -f
|
|
```
|
|
|
|
## Demo
|
|
|
|
- Create ledger channels on L1 and mirrored channels on L2
|
|
- Open new terminal, check that no channels exist on L2
|
|
|
|
```bash
|
|
laconic-so deployment --dir bridge-deployment exec nitro-rpc-client "nitro-rpc-client get-all-l2-channels -p 4005 -h nitro-bridge"
|
|
|
|
# Expected output:
|
|
# []
|
|
```
|
|
|
|
- Set address of bridge and address of custom token on L1 in the current terminal
|
|
|
|
```bash
|
|
export BRIDGE_NITRO_ADDRESS=0xBBB676f9cFF8D242e9eaC39D063848807d3D1D94
|
|
export GETH_CHAIN_ID="1212"
|
|
export ASSET_ADDRESS=$(laconic-so deployment --dir nitro-contracts-deployment exec nitro-contracts "jq -r '.\"$GETH_CHAIN_ID\"[0].contracts.Token.address' /app/deployment/nitro-addresses.json")
|
|
```
|
|
|
|
- Create ledger channel between A and Bridge with custom token
|
|
|
|
```bash
|
|
laconic-so deployment --dir l1alice-nitro-deployment exec nitro-rpc-client "nitro-rpc-client direct-fund $BRIDGE_NITRO_ADDRESS --assetAddress $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
|
|
|
|
```bash
|
|
laconic-so deployment --dir l2alice-nitro-deployment logs nitro-node -f --tail 30
|
|
|
|
# Expected Output:
|
|
# nitro-node-1 | 5:01AM INF INFO Objective cranked address=0xaaa6628ec44a8a742987ef3a114ddfe2d4f7adce objective-id=bridgedfunding-0x6a9f5ccf1fa802525d794f4a899897f947615f6acc7141e61e056a8bfca29179 waiting-for=WaitingForNothing
|
|
# nitro-node-1 | 5:01AM INF INFO Objective is complete & returned to API address=0xaaa6628ec44a8a742987ef3a114ddfe2d4f7adce objective-id=bridgedfunding-0x6a9f5ccf1fa802525d794f4a899897f947615f6acc7141e61e056a8bfca29179
|
|
```
|
|
|
|
- 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 using channel ID in output above
|
|
|
|
```bash
|
|
laconic-so deployment --dir l1alice-nitro-deployment exec nitro-rpc-client "nitro-rpc-client get-ledger-channel <ledger channel ID> -p 4005 -h nitro-node"
|
|
|
|
# Expected output:
|
|
# {
|
|
# ID: '0x161d289a50222caa781db215bb82a3ede4f557217742245525b8e8cbff04ec21',
|
|
# Status: 'Open',
|
|
# Balance: {
|
|
# AssetAddress: '<Token address on L1>',
|
|
# Me: '0xaaa6628ec44a8a742987ef3a114ddfe2d4f7adce',
|
|
# Them: '0xbbb676f9cff8d242e9eac39d063848807d3d1d94',
|
|
# MyBalance: 1000000n,
|
|
# TheirBalance: 1000000n
|
|
# },
|
|
# ChannelMode: 'Open'
|
|
# }
|
|
```
|
|
|
|
- Create ledger channel between C and Bridge with custom token
|
|
|
|
```bash
|
|
laconic-so deployment --dir l1charlie-nitro-deployment exec nitro-rpc-client "nitro-rpc-client direct-fund $BRIDGE_NITRO_ADDRESS --assetAddress $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
|
|
|
|
```bash
|
|
laconic-so deployment --dir l2charlie-nitro-deployment logs nitro-node -f --tail 30
|
|
|
|
# Expected Output:
|
|
# nitro-node-1 | 5:06AM INF INFO Objective cranked address=0xa8d2d06ace9c7ffc24ee785c2695678aecdfd7a0 objective-id=bridgedfunding-0x15dbe6b996e4e46fdd6ea3e2074cbca58014dbb07368e3e7ba286df5c7b9da0d waiting-for=WaitingForNothing
|
|
# nitro-node-1 | 5:06AM INF INFO Objective is complete & returned to API address=0xa8d2d06ace9c7ffc24ee785c2695678aecdfd7a0 objective-id=bridgedfunding-0x15dbe6b996e4e46fdd6ea3e2074cbca58014dbb07368e3e7ba286df5c7b9da0d
|
|
```
|
|
|
|
- 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 using channel ID in output above
|
|
|
|
```bash
|
|
laconic-so deployment --dir l1charlie-nitro-deployment exec nitro-rpc-client "nitro-rpc-client get-ledger-channel <ledger channel ID> -p 4005 -h nitro-node"
|
|
|
|
# Expected output:
|
|
# {
|
|
# ID: '0x69a3f09b6f4f94f033cf084e6e4a9453438c45b43606e9a95f5434f4c6527543',
|
|
# Status: 'Open',
|
|
# Balance: {
|
|
# AssetAddress: '<Token address on L1>',
|
|
# Me: '0xa8d2d06ace9c7ffc24ee785c2695678aecdfd7a0',
|
|
# Them: '0xbbb676f9cff8d242e9eac39d063848807d3d1d94',
|
|
# MyBalance: 1000000n,
|
|
# TheirBalance: 1000000n
|
|
# },
|
|
# ChannelMode: 'Open'
|
|
# }
|
|
```
|
|
|
|
- Check status of all L2 mirrored ledger channels
|
|
|
|
```bash
|
|
laconic-so deployment --dir bridge-deployment exec nitro-rpc-client "nitro-rpc-client get-all-l2-channels -p 4005 -h nitro-bridge"
|
|
|
|
# Expected output:
|
|
# [
|
|
# {
|
|
# "ID": "0x15dbe6b996e4e46fdd6ea3e2074cbca58014dbb07368e3e7ba286df5c7b9da0d",
|
|
# "Status": "Open",
|
|
# "Balance": {
|
|
# "AssetAddress": "<Token address on L2>",
|
|
# "Me": "0xbbb676f9cff8d242e9eac39d063848807d3d1d94",
|
|
# "Them": "0xa8d2d06ace9c7ffc24ee785c2695678aecdfd7a0",
|
|
# "MyBalance": 1000000,
|
|
# "TheirBalance": 1000000
|
|
# },
|
|
# "ChannelMode": "Open"
|
|
# },
|
|
# {
|
|
# "ID": "0x6a9f5ccf1fa802525d794f4a899897f947615f6acc7141e61e056a8bfca29179",
|
|
# "Status": "Open",
|
|
# "Balance": {
|
|
# "AssetAddress": "<Token address on L2>",
|
|
# "Me": "0xbbb676f9cff8d242e9eac39d063848807d3d1d94",
|
|
# "Them": "0xaaa6628ec44a8a742987ef3a114ddfe2d4f7adce",
|
|
# "MyBalance": 1000000,
|
|
# "TheirBalance": 1000000
|
|
# },
|
|
# "ChannelMode": "Open"
|
|
# }
|
|
# ]
|
|
```
|
|
|
|
In above expected output the following are observed
|
|
- In ledger channel with ID `0x6a9f5ccf1fa802525d794f4a899897f947615f6acc7141e61e056a8bfca29179`
|
|
- Alice is a participant since `Them` address is `0xaaa6628ec44a8a742987ef3a114ddfe2d4f7adce`
|
|
- Alice amount is `1000000` since `TheirBalance` corresponds to her amount
|
|
- In ledger channel with ID `0x15dbe6b996e4e46fdd6ea3e2074cbca58014dbb07368e3e7ba286df5c7b9da0d`
|
|
- Charlie is participant since `Them` address is `0xa8d2d06ace9c7ffc24ee785c2695678aecdfd7a0`
|
|
- Charlie amount is `1000000` since `TheirBalance` corresponds to his amount
|
|
|
|
### Payments Demo in L2
|
|
|
|
- Create virtual channel on L2 from A' to C' via Bridge' as intermediary
|
|
|
|
- Get Nitro (Ethereum) addresses for Alice and Charlie from the wallet:
|
|
|
|
```bash
|
|
export A_ADDRESS=0x4B64e26da8279AB12bcd4cA9974eC2b4741e175e
|
|
export C_ADDRESS=0x03Eb7a84E286c671836b9897AaE24b31D36f9cA8
|
|
|
|
# Bridge's Nitro address
|
|
export BRIDGE_NITRO_ADDRESS=0xBBB676f9cFF8D242e9eaC39D063848807d3D1D94
|
|
```
|
|
|
|
- Create a virtual channel:
|
|
|
|
```bash
|
|
# Starts virtual fund objective on L2 to create virtual channel from A' to C'
|
|
laconic-so deployment --dir l2alice-nitro-deployment exec nitro-rpc-client "nitro-rpc-client virtual-fund $C_ADDRESS $BRIDGE_NITRO_ADDRESS --amount 1000 -p 4005 -h nitro-node"
|
|
|
|
# Set the payment channel id in a variable
|
|
PAYMENT_CHANNEL_ID=<payment channel id>
|
|
```
|
|
|
|
- Check payment channel between A' and C'
|
|
|
|
```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: 0n,
|
|
# RemainingFunds: 1000n
|
|
# }
|
|
# }
|
|
```
|
|
|
|
- After virtual fund objective is complete, make payments
|
|
|
|
```bash
|
|
laconic-so deployment --dir l2alice-nitro-deployment exec nitro-rpc-client "nitro-rpc-client pay $PAYMENT_CHANNEL_ID 200 -p 4005 -h nitro-node"
|
|
|
|
# Expected output:
|
|
# {
|
|
# Amount: 200,
|
|
# Channel: '0xb29aeb32c9495a793ebf7bd116232075d1e7bfe89fc82281c7d498e3ffd3e3bf'
|
|
# }
|
|
```
|
|
|
|
- Check largest voucher received on the payment channel
|
|
|
|
```bash
|
|
laconic-so deployment --dir l2charlie-nitro-deployment exec nitro-rpc-client "nitro-rpc-client get-voucher $PAYMENT_CHANNEL_ID -p 4005 -h nitro-node"
|
|
|
|
# Expected output:
|
|
# {
|
|
# Amount: 200,
|
|
# ChannelId: '0xb29aeb32c9495a793ebf7bd116232075d1e7bfe89fc82281c7d498e3ffd3e3bf',
|
|
# Signature: '0x8fbdb9bb91932b422c30cc07bf422e4f1c3ae1be1b60e01bbfcb193ae5c8f5b0571de84667d87b5ef9b737287faa0ddf41f1f9fc159673205679622c69fd69d81b'
|
|
# }
|
|
```
|
|
|
|
- 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
|
|
laconic-so deployment --dir l2alice-nitro-deployment exec nitro-rpc-client "nitro-rpc-client virtual-defund $PAYMENT_CHANNEL_ID -p 4005 -h nitro-node"
|
|
```
|
|
|
|
- Check L2 mirrored channels status after virtual-defund is complete:
|
|
|
|
- Note balance change in A' node:
|
|
|
|
```bash
|
|
laconic-so deployment --dir l2alice-nitro-deployment exec nitro-rpc-client "nitro-rpc-client get-all-ledger-channels -p 4005 -h nitro-node"
|
|
|
|
# Expected output:
|
|
# [
|
|
# {
|
|
# "ID": "0x6a9f5ccf1fa802525d794f4a899897f947615f6acc7141e61e056a8bfca29179",
|
|
# "Status": "Open",
|
|
# "Balance": {
|
|
# "AssetAddress": "<Token_address_on_L2>",
|
|
# "Me": "0xaaa6628ec44a8a742987ef3a114ddfe2d4f7adce",
|
|
# "Them": "0xbbb676f9cff8d242e9eac39d063848807d3d1d94",
|
|
# "MyBalance": 999800,
|
|
# "TheirBalance": 1000200
|
|
# },
|
|
# "ChannelMode": "Open"
|
|
# }
|
|
# ]
|
|
```
|
|
|
|
- Note balance change in C' node:
|
|
|
|
```bash
|
|
laconic-so deployment --dir l2charlie-nitro-deployment exec nitro-rpc-client "nitro-rpc-client get-all-ledger-channels -p 4005 -h nitro-node"
|
|
|
|
# Expected output:
|
|
# [
|
|
# {
|
|
# "ID": "0x15dbe6b996e4e46fdd6ea3e2074cbca58014dbb07368e3e7ba286df5c7b9da0d",
|
|
# "Status": "Open",
|
|
# "Balance": {
|
|
# "AssetAddress": "<Token_address_on_L2>",
|
|
# "Me": "0xa8d2d06ace9c7ffc24ee785c2695678aecdfd7a0",
|
|
# "Them": "0xbbb676f9cff8d242e9eac39d063848807d3d1d94",
|
|
# "MyBalance": 1000200,
|
|
# "TheirBalance": 999800
|
|
# },
|
|
# "ChannelMode": "Open"
|
|
# }
|
|
# ]
|
|
```
|
|
|
|
## Demo cleanup
|
|
|
|
- Reset nitro-node deployments:
|
|
|
|
- Stop nitro-node deployments and remove volumes:
|
|
|
|
```bash
|
|
# Run where deployments are created
|
|
laconic-so deployment --dir l1alice-nitro-deployment stop --delete-volumes
|
|
laconic-so deployment --dir l1charlie-nitro-deployment stop --delete-volumes
|
|
laconic-so deployment --dir l2alice-nitro-deployment stop --delete-volumes
|
|
laconic-so deployment --dir l2charlie-nitro-deployment stop --delete-volumes
|
|
laconic-so deployment --dir bridge-deployment stop --delete-volumes
|
|
```
|
|
|
|
- Clear nitro-nodes durable store:
|
|
|
|
```bash
|
|
# Run where deployments are created
|
|
sudo rm -rf l1alice-nitro-deployment/data/nitro_node_data/nitro-store
|
|
sudo rm -rf l1charlie-nitro-deployment/data/nitro_node_data/nitro-store
|
|
sudo rm -rf l2alice-nitro-deployment/data/nitro_node_data/nitro-store
|
|
sudo rm -rf l2charlie-nitro-deployment/data/nitro_node_data/nitro-store
|
|
sudo rm -rf bridge-deployment/data/nitro_bridge_data/bridge-store
|
|
```
|
|
|
|
## Re-run
|
|
|
|
- After running demo cleanup, start the deployments
|
|
|
|
```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
|
|
```
|
|
|
|
- Follow the steps from [Demo](#demo) to re-run the demo
|
|
|
|
## Cleanup
|
|
|
|
- Reset nitro-node deployments:
|
|
|
|
- Stop nitro-node, bridge, nitro-contracts deployments and remove volumes:
|
|
|
|
```bash
|
|
# Run where deployments are created
|
|
laconic-so deployment --dir l1alice-nitro-deployment stop --delete-volumes
|
|
laconic-so deployment --dir l1charlie-nitro-deployment stop --delete-volumes
|
|
laconic-so deployment --dir l2alice-nitro-deployment stop --delete-volumes
|
|
laconic-so deployment --dir l2charlie-nitro-deployment stop --delete-volumes
|
|
laconic-so deployment --dir bridge-deployment stop --delete-volumes
|
|
laconic-so deployment --dir nitro-contracts-deployment stop --delete-volumes
|
|
```
|
|
|
|
- Clear nitro-node, nitro-contracts and bridge deployments:
|
|
|
|
```bash
|
|
# Run where deployments are created
|
|
sudo rm -rf l1alice-nitro-deployment
|
|
sudo rm -rf l1charlie-nitro-deployment
|
|
sudo rm -rf l2alice-nitro-deployment
|
|
sudo rm -rf l2charlie-nitro-deployment
|
|
sudo rm -rf bridge-deployment
|
|
sudo rm -rf nitro-contracts-deployment
|
|
```
|
|
|
|
- Clean up eth-stack deployment:
|
|
- Stop deployment and remove volume:
|
|
|
|
```bash
|
|
# Run where deployments are created
|
|
laconic-so deployment --dir fixturenet-eth-deployment stop --delete-volumes
|
|
```
|
|
|
|
- Clear deployment:
|
|
|
|
```bash
|
|
# Run where deployments are created
|
|
sudo rm -rf fixturenet-eth-deployment
|
|
```
|
|
|
|
## Troubleshooting
|
|
|
|
- If the ledger channel creation fails, follow these steps:
|
|
|
|
- Check whether the status of `cerc/fixturenet-eth-geth` is `unhealthy`.
|
|
|
|
```bash
|
|
docker ps
|
|
```
|
|
|
|
- If the chain is not producing new blocks, restart the chain.
|
|
|
|
```bash
|
|
laconic-so deployment --dir fixturenet-eth-deployment stop
|
|
|
|
laconic-so deployment --dir fixturenet-eth-deployment start
|
|
```
|
|
|
|
- Stop the nitro-rpc-client direct-fund command if it is stuck
|
|
|
|
- Restart the failed node (for example: to restart Charlie's node)
|
|
|
|
- Stop the failed nitro node
|
|
|
|
```bash
|
|
laconic-so deployment --dir l1charlie-nitro-deployment stop
|
|
```
|
|
|
|
- Remove the node's durable store and create it again
|
|
|
|
```bash
|
|
sudo rm -rf l1charlie-nitro-deployment/data/nitro_node_data
|
|
|
|
mkdir l1charlie-nitro-deployment/data/nitro_node_data
|
|
```
|
|
|
|
- Restart the node and create ledger channel again
|
|
|
|
```bash
|
|
laconic-so deployment --dir l1charlie-nitro-deployment start
|
|
```
|
|
|
|
- Retry the ledger channel creation command
|