Add Nitro node config for users and payments instructions (#28)
Part of [Create a public laconicd testnet](https://www.notion.so/Create-a-public-laconicd-testnet-896a11bdd8094eff8f1b49c0be0ca3b8) Co-authored-by: Neeraj <neeraj.rtly@gmail.com> Reviewed-on: cerc-io/testnet-laconicd-stack#28 Co-authored-by: Prathamesh Musale <prathamesh.musale0@gmail.com> Co-committed-by: Prathamesh Musale <prathamesh.musale0@gmail.com>
This commit is contained in:
Neeraj
+195
-27
@@ -2,30 +2,26 @@
|
||||
|
||||
## Prerequisites
|
||||
|
||||
* Ansible: see [installation](https://git.vdb.to/cerc-io/testnet-ops#installation)
|
||||
* Local:
|
||||
|
||||
* yq: see [installation](https://github.com/mikefarah/yq#install)
|
||||
* Clone the `cerc-io/testnet-ops` repository:
|
||||
|
||||
* laconic-so: see [installation](https://git.vdb.to/cerc-io/testnet-ops/src/branch/main/stack-orchestrator-setup/README.md)
|
||||
```bash
|
||||
git clone git@git.vdb.to:cerc-io/testnet-ops.git
|
||||
```
|
||||
|
||||
* Check versions to verify installation:
|
||||
* Ansible: see [installation](https://git.vdb.to/cerc-io/testnet-ops#installation)
|
||||
|
||||
```bash
|
||||
laconic-so version
|
||||
* On deployment machine:
|
||||
|
||||
ansible --version
|
||||
|
||||
yq --version
|
||||
```
|
||||
* laconic-so: see [installation](https://git.vdb.to/cerc-io/testnet-ops/src/branch/main/stack-orchestrator-setup/README.md#setup-stack-orchestrator)
|
||||
|
||||
## Setup
|
||||
|
||||
* Clone the `cerc-io/testnet-ops` repository:
|
||||
* Move to `nitro-nodes-setup` :
|
||||
|
||||
```bash
|
||||
git clone git@git.vdb.to:cerc-io/testnet-ops.git
|
||||
|
||||
cd testnet-ops/nitro-node-setup
|
||||
cd testnet-ops/nitro-nodes-setup
|
||||
```
|
||||
|
||||
* Fetch the required Nitro node config:
|
||||
@@ -76,7 +72,7 @@
|
||||
* Update the target dir in `setup-vars.yml`:
|
||||
|
||||
```bash
|
||||
# Set path to desired deployments dir
|
||||
# Set path to desired deployments dir (under your user)
|
||||
DEPLOYMENTS_DIR=<path-to-deployments-dir>
|
||||
|
||||
sed -i "s|^nitro_directory:.*|nitro_directory: $DEPLOYMENTS_DIR/nitro-node|" setup-vars.yml
|
||||
@@ -86,6 +82,8 @@
|
||||
|
||||
## Run Nitro Nodes
|
||||
|
||||
Nitro nodes can be run using Ansible either locally or on a remote machine; follow corresponding steps for your setup
|
||||
|
||||
### On Local Host
|
||||
|
||||
* Setup and run a Nitro node (L1+L2) by executing the `run-nitro-nodes.yml` Ansible playbook:
|
||||
@@ -94,9 +92,9 @@
|
||||
LANG=en_US.utf8 ansible-playbook -i localhost, --connection=local run-nitro-nodes.yml --extra-vars='{ "target_host": "localhost"}' --user $USER
|
||||
```
|
||||
|
||||
### On Remote Host (optional)
|
||||
### On Remote Host
|
||||
|
||||
* Create a new `hosts.ini` file:
|
||||
* In `testnet-ops/nitro-nodes-setup`, create a new `hosts.ini` file:
|
||||
|
||||
```bash
|
||||
cp ../hosts.example.ini hosts.ini
|
||||
@@ -105,20 +103,22 @@
|
||||
* Edit the [`hosts.ini`](./hosts.ini) file to run the playbook on a remote machine:
|
||||
|
||||
```ini
|
||||
[deployment_host]
|
||||
[<deployment_host>]
|
||||
<host_name> ansible_host=<target_ip> ansible_user=<ssh_user> ansible_ssh_common_args='-o ForwardAgent=yes'
|
||||
```
|
||||
|
||||
- Replace `<deployment_host>` with `nitro_host`
|
||||
- Replace `<host_name>` with the alias of your choice
|
||||
- Replace `<target_ip>` with the IP address or hostname of the target machine
|
||||
- Replace `<ssh_user>` with the SSH username (e.g., dev, ubuntu)
|
||||
* Replace `<deployment_host>` with `nitro_host`
|
||||
* Replace `<host_name>` with the alias of your choice
|
||||
* Replace `<target_ip>` with the IP address or hostname of the target machine
|
||||
* Replace `<ssh_user>` with the SSH username (e.g., dev, ubuntu)
|
||||
|
||||
* Verify that you are able to connect to the host using the following command
|
||||
|
||||
```bash
|
||||
ansible all -m ping -i hosts.ini -k
|
||||
|
||||
# If using password based authentication, enter the ssh password on prompt; otherwise, leave it blank
|
||||
|
||||
# Expected output:
|
||||
|
||||
# <host_name> | SUCCESS => {
|
||||
@@ -134,32 +134,56 @@
|
||||
|
||||
```bash
|
||||
LANG=en_US.utf8 ansible-playbook -i hosts.ini run-nitro-nodes.yml --extra-vars='{ "target_host": "nitro_host"}' --user $USER -kK
|
||||
|
||||
# If using password based authentication, enter the ssh password on prompt; otherwise, leave it blank
|
||||
# Enter the sudo password as "BECOME password" on prompt
|
||||
```
|
||||
|
||||
### Check Deployment Status
|
||||
|
||||
* Run the following command in the directory where the deployments are created:
|
||||
* Run the following commands on deployment machine:
|
||||
|
||||
```bash
|
||||
DEPLOYMENTS_DIR=<path-to-deployments-dir>
|
||||
|
||||
cd $DEPLOYMENTS_DIR/nitro-node
|
||||
|
||||
# Check the logs, ensure that the nodes are running
|
||||
laconic-so deployment --dir l1-nitro-deployment logs nitro-node -f
|
||||
laconic-so deployment --dir l2-nitro-deployment logs nitro-node -f
|
||||
|
||||
# Let L1 node sync up with the chain
|
||||
# Expected logs after sync:
|
||||
# nitro-node-1 | 2:04PM INF Initializing Http RPC transport...
|
||||
# nitro-node-1 | 2:04PM INF Completed RPC server initialization url=127.0.0.1:4005/api/v1
|
||||
```
|
||||
|
||||
* Get your Nitro node's info:
|
||||
|
||||
```bash
|
||||
laconic-so deployment --dir l1-nitro-deployment exec nitro-rpc-client "nitro-rpc-client get-node-info -p 4005 -h nitro-node"
|
||||
|
||||
# Expected output:
|
||||
# {
|
||||
# "SCAddress": "0xd0eA8b27591b1D070cCcD4D30b8D408fe794FDfc",
|
||||
# "MessageServicePeerId": "16Uiu2HAmSHRjoxveaPmJipzmdq69U8zme8BMnFjSBPferj1E5XAd"
|
||||
# }
|
||||
|
||||
# SCAddress -> nitro address, MessageServicePeerId -> libp2p peer id
|
||||
```
|
||||
|
||||
## Create Channels
|
||||
|
||||
Create a ledger channel with the bridge on L1 which is mirrored on L2
|
||||
|
||||
* Run the following commands from the directory where the deployments are created
|
||||
* Run the following commands on deployment machine
|
||||
|
||||
* Set required variables:
|
||||
|
||||
```bash
|
||||
cd $DEPLOYMENTS_DIR/nitro-node
|
||||
DEPLOYMENTS_DIR=<path-to-deployments-dir>
|
||||
|
||||
# Fetch the required Nitro node config
|
||||
wget https://git.vdb.to/cerc-io/testnet-laconicd-stack/raw/branch/main/ops/stage2/nitro-node-config.yml
|
||||
cd $DEPLOYMENTS_DIR/nitro-node
|
||||
|
||||
export BRIDGE_NITRO_ADDRESS=$(yq eval '.bridge_nitro_address' nitro-node-config.yml)
|
||||
export L1_ASSET_ADDRESS=$(yq eval '.l1_asset_address' nitro-node-config.yml)
|
||||
@@ -249,6 +273,150 @@ Create a ledger channel with the bridge on L1 which is mirrored on L2
|
||||
# ]
|
||||
```
|
||||
|
||||
## Payments On L2 Channel
|
||||
|
||||
Perform payments using a virtual payment channel created with another Nitro node over the mirrored L2 channel with bridge as an intermediary
|
||||
|
||||
* Run the following commands on deployment machine
|
||||
|
||||
* Switch to the `nitro-node` directory:
|
||||
|
||||
```bash
|
||||
DEPLOYMENTS_DIR=<path-to-deployments-dir>
|
||||
|
||||
cd $DEPLOYMENTS_DIR/nitro-node
|
||||
```
|
||||
|
||||
* Check status of the mirrored channel on L2:
|
||||
|
||||
```bash
|
||||
laconic-so deployment --dir l2-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": "<l2-asset-address>",
|
||||
# "Me": "<your-nitro-address>",
|
||||
# "Them": "<bridge-nitro-address>",
|
||||
# "MyBalance": Xn,
|
||||
# "TheirBalance": Yn
|
||||
# },
|
||||
# "ChannelMode": "Open"
|
||||
# }
|
||||
# ]
|
||||
```
|
||||
|
||||
* Set required variables:
|
||||
|
||||
```bash
|
||||
export BRIDGE_NITRO_ADDRESS=$(yq eval '.bridge_nitro_address' nitro-node-config.yml)
|
||||
|
||||
# Counterparty to create the payment channel with
|
||||
export COUNTER_PARTY_ADDRESS=<counterparty-nitro-address>
|
||||
|
||||
# Mirrored channel on L2
|
||||
export L2_CHANNEL_ID=<l2-channel-id>
|
||||
|
||||
# Amount to create the payment channel with
|
||||
export PAYMENT_CHANNEL_AMOUNT=10000
|
||||
```
|
||||
|
||||
* Check for existing payment channels for the L2 channel:
|
||||
|
||||
```bash
|
||||
laconic-so deployment --dir l2-nitro-deployment exec nitro-rpc-client "nitro-rpc-client get-payment-channels-by-ledger $L2_CHANNEL_ID -p 4005 -h nitro-node"
|
||||
```
|
||||
|
||||
* Create a virtual payment channel:
|
||||
|
||||
```bash
|
||||
laconic-so deployment --dir l2-nitro-deployment exec nitro-rpc-client "nitro-rpc-client virtual-fund $COUNTER_PARTY_ADDRESS $BRIDGE_NITRO_ADDRESS --amount $PAYMENT_CHANNEL_AMOUNT -p 4005 -h nitro-node"
|
||||
|
||||
# Follow your L2 Nitro node logs for progress
|
||||
|
||||
# Expected Output:
|
||||
# Objective started VirtualFund-0x43db45a101658387263b36d613322cc952d8ce5b70de51e3a495513c256bef4d
|
||||
# Channel Open 0x43db45a101658387263b36d613322cc952d8ce5b70de51e3a495513c256bef4d
|
||||
|
||||
# Set the resulting payment channel id in a variable
|
||||
PAYMENT_CHANNEL_ID=<payment-channel-id>
|
||||
```
|
||||
|
||||
Multiple virtual payment channels can be created at once
|
||||
|
||||
* Check the payment channel's status:
|
||||
|
||||
```bash
|
||||
laconic-so deployment --dir l2-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: '<your-nitro-address>',
|
||||
# Payer: '<counterparty-nitro-address>',
|
||||
# PaidSoFar: 0n,
|
||||
# RemainingFunds: <payment-channel-amount>n
|
||||
# }
|
||||
# }
|
||||
```
|
||||
|
||||
* Send payments using the virtual payment channel:
|
||||
|
||||
```bash
|
||||
export PAY_AMOUNT=200
|
||||
laconic-so deployment --dir l2-nitro-deployment exec nitro-rpc-client "nitro-rpc-client pay $PAYMENT_CHANNEL_ID $PAY_AMOUNT -p 4005 -h nitro-node"
|
||||
|
||||
# Expected output
|
||||
# {
|
||||
# Amount: <pay-amount>,
|
||||
# Channel: '<payment-channel-id>'
|
||||
# }
|
||||
|
||||
# This can be done multiple times until the payment channel balance is exhausted
|
||||
```
|
||||
|
||||
* Check payment channel's status again to view updated channel state
|
||||
|
||||
* Close the payment channel to settle on the L2 mirrored channel:
|
||||
|
||||
```bash
|
||||
laconic-so deployment --dir l2-nitro-deployment exec nitro-rpc-client "nitro-rpc-client virtual-defund $PAYMENT_CHANNEL_ID -p 4005 -h nitro-node"
|
||||
|
||||
# Expected output:
|
||||
# Objective started VirtualDefund-0x43db45a101658387263b36d613322cc952d8ce5b70de51e3a495513c256bef4d
|
||||
# Channel complete 0x43db45a101658387263b36d613322cc952d8ce5b70de51e3a495513c256bef4d
|
||||
```
|
||||
|
||||
* Check L2 mirrored channel's status after the virtual payment channel is closed:
|
||||
|
||||
```bash
|
||||
laconic-so deployment --dir l2-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": "<l2-asset-address>",
|
||||
# "Me": "<your-nitro-address>",
|
||||
# "Them": "<bridge-nitro-address>",
|
||||
# "MyBalance": <your-updated-balance>n,
|
||||
# "TheirBalance": <bridge-updated-balance>n
|
||||
# },
|
||||
# "ChannelMode": "Open"
|
||||
# }
|
||||
# ]
|
||||
```
|
||||
|
||||
Your balance on the L2 channel should be reduced by total payments done on the virtual payment channel
|
||||
|
||||
## Clean up
|
||||
|
||||
* Switch to deployments dir:
|
||||
|
||||
Reference in New Issue
Block a user