Compare commits
9
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
 Neeraj
|
c892c8811e | ||
|
Neeraj
|
b1d8dfa041 | ||
|
Neeraj
|
41437647b0 | ||
  nabarunandShreerang Kale
|
d92a1febed | ||
|
nabarunandShreerang Kale
|
81923f5323 | ||
|
nabarunandNeeraj
|
92e91ec50c | ||
 prathameshandNeeraj
|
7041a4ebe8 | ||
|
prathameshandShreerang Kale
|
16a164f373 | ||
|
|
9d92a20ab9 |
@@ -11,7 +11,12 @@ Stacks to run a node for laconic testnet
|
||||
- [Update deployments after code changes](./ops/update-deployments.md)
|
||||
- [Halt stage0 and start stage1](./ops/stage0-to-stage1.md)
|
||||
- [Create deployments from scratch (for reference only)](./ops/deployments-from-scratch.md)
|
||||
- [Deploy and transfer new tokens for nitro operations](./ops/nitro-token-ops.md)
|
||||
|
||||
## Join LORO testnet
|
||||
|
||||
Follow steps in [testnet-onboarding-validator.md](./testnet-onboarding-validator.md) to onboard your participant and join as a validator on the LORO testnet
|
||||
|
||||
## Run testnet Nitro Node
|
||||
|
||||
Follow steps in [testnet-nitro-node.md](./testnet-nitro-node.md) to run you Nitro node for the testnet
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
## Login
|
||||
|
||||
* Log in as `dev` user on the deployments VM
|
||||
* Log in as `dev` user on the deployments machine
|
||||
|
||||
* All the deployments are placed in the `/srv` directory:
|
||||
|
||||
@@ -10,6 +10,457 @@
|
||||
cd /srv
|
||||
```
|
||||
|
||||
## Prerequisites
|
||||
|
||||
* Local:
|
||||
|
||||
* Clone the `cerc-io/testnet-ops` repository:
|
||||
|
||||
```bash
|
||||
git clone git@git.vdb.to:cerc-io/testnet-ops.git
|
||||
```
|
||||
|
||||
* Ansible: see [installation](https://git.vdb.to/cerc-io/testnet-ops#installation)
|
||||
|
||||
* On deployments machine(s):
|
||||
|
||||
* laconic-so: see [installation](https://git.vdb.to/cerc-io/testnet-ops/src/branch/main/stack-orchestrator-setup/README.md#setup-stack-orchestrator)
|
||||
|
||||
<details open>
|
||||
<summary>Fixturenet Eth</summary>
|
||||
|
||||
## Fixturenet Eth
|
||||
|
||||
* Stack: <https://git.vdb.to/cerc-io/fixturenet-eth-stacks>
|
||||
|
||||
* Target dir: `/srv/fixturenet-eth/fixturenet-eth-deployment`
|
||||
|
||||
* Cleanup an existing deployment if required:
|
||||
|
||||
```bash
|
||||
cd /srv/fixturenet-eth
|
||||
|
||||
# Stop the deployment
|
||||
laconic-so deployment --dir fixturenet-eth-deployment stop --delete-volumes
|
||||
|
||||
# Remove the deployment dir
|
||||
sudo rm -rf fixturenet-eth-deployment
|
||||
```
|
||||
|
||||
### Setup
|
||||
|
||||
* Create a `fixturenet-eth` dir if not present already and cd into it
|
||||
|
||||
```bash
|
||||
mkdir /srv/fixturenet-eth
|
||||
|
||||
cd /srv/fixturenet-eth
|
||||
```
|
||||
|
||||
* Clone the stack repo:
|
||||
|
||||
```bash
|
||||
laconic-so fetch-stack git.vdb.to/cerc-io/fixturenet-eth-stacks --pull
|
||||
```
|
||||
|
||||
* Clone required repositories:
|
||||
|
||||
```bash
|
||||
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
|
||||
|
||||
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:
|
||||
- '7545:8545'
|
||||
- '7546: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
|
||||
```
|
||||
|
||||
### Run
|
||||
|
||||
* Start `fixturenet-eth-deployment` deployment:
|
||||
|
||||
```bash
|
||||
laconic-so deployment --dir fixturenet-eth-deployment start
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
<details open>
|
||||
<summary>Nitro Contracts Deployment</summary>
|
||||
|
||||
## Nitro Contracts Deployment
|
||||
|
||||
* Stack: <https://git.vdb.to/cerc-io/nitro-stack/src/branch/main/stack-orchestrator/stacks/nitro-contracts>
|
||||
|
||||
* Source repo: <https://github.com/cerc-io/go-nitro>
|
||||
|
||||
* Target dir: `/srv/bridge/nitro-contracts-deployment`
|
||||
|
||||
* Cleanup an existing deployment if required:
|
||||
|
||||
```bash
|
||||
cd /srv/bridge
|
||||
|
||||
# Stop the deployment
|
||||
laconic-so deployment --dir nitro-contracts-deployment stop --delete-volumes
|
||||
|
||||
# Remove the deployment dir
|
||||
sudo rm -rf nitro-contracts-deployment
|
||||
```
|
||||
|
||||
### Setup
|
||||
|
||||
* Switch to `testnet-ops/nitro-contracts-setup` directory on your local machine:
|
||||
|
||||
```bash
|
||||
cd testnet-ops/nitro-contracts-setup
|
||||
```
|
||||
|
||||
* Copy the `contract-vars-example.yml` vars file:
|
||||
|
||||
```bash
|
||||
cp contract-vars.example.yml contract-vars.yml
|
||||
```
|
||||
|
||||
* Edit [`contract-vars.yml`](./contract-vars.yml) and fill in the following values:
|
||||
|
||||
```bash
|
||||
# RPC endpoint
|
||||
geth_url: "https://fixturenet-eth.laconic.com"
|
||||
|
||||
# Chain ID (Fixturenet-eth: 1212)
|
||||
geth_chain_id: "1212"
|
||||
|
||||
# Private key for a funded L1 account, to be used for contract deployment on L1
|
||||
# Required since this private key will be utilized by both L1 and L2 nodes of the bridge
|
||||
|
||||
geth_deployer_pk: "888814df89c4358d7ddb3fa4b0213e7331239a80e1f013eaa7b2deca2a41a218"
|
||||
|
||||
# Custom token to be deployed
|
||||
token_name: "TestToken"
|
||||
token_symbol: "TST"
|
||||
initial_token_supply: "129600"
|
||||
```
|
||||
|
||||
* Update the target dir in `setup-vars.yml`:
|
||||
|
||||
```bash
|
||||
sed -i 's|^nitro_directory:.*|nitro_directory: /srv/bridge|' setup-vars.yml
|
||||
|
||||
# Will create deployment at /srv/bridge/nitro-contracts-deployment
|
||||
```
|
||||
|
||||
### Run
|
||||
|
||||
* Deploy nitro contracts on remote host by executing `deploy-contracts.yml` Ansible playbook on your local machine:
|
||||
|
||||
* Create a new `hosts.ini` file:
|
||||
|
||||
```bash
|
||||
cp ../hosts.example.ini hosts.ini
|
||||
```
|
||||
|
||||
* Edit the [`hosts.ini`](./hosts.ini) file to run the playbook on a remote machine:
|
||||
|
||||
```ini
|
||||
[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)
|
||||
|
||||
* Verify that you are able to connect to the host using the following command:
|
||||
|
||||
```bash
|
||||
ansible all -m ping -i hosts.ini -k
|
||||
|
||||
# Expected output:
|
||||
# <host_name> | SUCCESS => {
|
||||
# "ansible_facts": {
|
||||
# "discovered_interpreter_python": "/usr/bin/python3.10"
|
||||
# },
|
||||
# "changed": false,
|
||||
# "ping": "pong"
|
||||
# }
|
||||
```
|
||||
|
||||
* Execute the `deploy-contracts.yml` Ansible playbook for remote deployment:
|
||||
|
||||
```bash
|
||||
LANG=en_US.utf8 ansible-playbook -i hosts.ini deploy-contracts.yml --extra-vars='{ "target_host": "nitro_host"}' --user $USER -kK
|
||||
```
|
||||
|
||||
* Check logs for deployment on the remote machine:
|
||||
|
||||
```bash
|
||||
cd /srv/bridge
|
||||
|
||||
# Check the nitro contract deployments
|
||||
laconic-so deployment --dir nitro-contracts-deployment logs nitro-contracts -f
|
||||
```
|
||||
|
||||
* To deploy a new token and transfer it to another account, refer to this [doc](./nitro-token-ops.md)
|
||||
|
||||
</details>
|
||||
|
||||
<details open>
|
||||
<summary>Nitro Bridge</summary>
|
||||
|
||||
## Nitro Bridge
|
||||
|
||||
* Stack: <https://git.vdb.to/cerc-io/nitro-stack/src/branch/main/stack-orchestrator/stacks/bridge>
|
||||
|
||||
* Source repo: <https://github.com/cerc-io/go-nitro>
|
||||
|
||||
* Target dir: `/srv/bridge/bridge-deployment`
|
||||
|
||||
* Cleanup an existing deployment if required:
|
||||
|
||||
```bash
|
||||
cd /srv/bridge
|
||||
|
||||
# Stop the deployment
|
||||
laconic-so deployment --dir bridge-deployment stop --delete-volumes
|
||||
|
||||
# Remove the deployment dir
|
||||
sudo rm -rf bridge-deployment
|
||||
```
|
||||
|
||||
### Setup
|
||||
|
||||
* Execute the following command on deployment machine to get the deployed Nitro contract addresses along with the asset address:
|
||||
|
||||
```bash
|
||||
cd /srv/bridge
|
||||
|
||||
laconic-so deployment --dir nitro-contracts-deployment exec nitro-contracts "cat /app/deployment/nitro-addresses.json"
|
||||
|
||||
# Expected output:
|
||||
# {
|
||||
# "1212": [
|
||||
# {
|
||||
# "name": "geth",
|
||||
# "chainId": "1212",
|
||||
# "contracts": {
|
||||
# "ConsensusApp": {
|
||||
# "address": "0xC98aD0B41B9224dad0605be32A9241dB9c67E2e8"
|
||||
# },
|
||||
# "NitroAdjudicator": {
|
||||
# "address": "0x7C22fdA703Cdf09eB8D3B5Adc81F723526713D0e"
|
||||
# },
|
||||
# "VirtualPaymentApp": {
|
||||
# "address": "0x778e4e6297E8BF04C67a20Ec989618d72eB4a19E"
|
||||
# },
|
||||
# "TestToken": {
|
||||
# "address": "0x02ebfB2706527C7310F2a7d9098b2BC61014C5F2"
|
||||
# }
|
||||
# }
|
||||
# }
|
||||
# ]
|
||||
# }
|
||||
```
|
||||
|
||||
* Switch to `testnet-ops/nitro-bridge-setup` directory on your local machine:
|
||||
|
||||
```bash
|
||||
cd testnet-ops/nitro-bridge-setup
|
||||
```
|
||||
|
||||
* Create the required vars file:
|
||||
|
||||
```bash
|
||||
cp bridge-vars.example.yml bridge-vars.yml
|
||||
```
|
||||
|
||||
* Edit `bridge-vars.yml` with required values:
|
||||
|
||||
```bash
|
||||
# WS endpoint
|
||||
nitro_chain_url: "wss://fixturenet-eth.laconic.com"
|
||||
|
||||
# Private key for bridge Nitro address
|
||||
nitro_sc_pk: ""
|
||||
|
||||
# Private key should correspond to a funded account on L1 and this account must own the Nitro contracts
|
||||
# It also needs to hold L1 tokens to fund Nitro channels
|
||||
nitro_chain_pk: "888814df89c4358d7ddb3fa4b0213e7331239a80e1f013eaa7b2deca2a41a218"
|
||||
|
||||
# Deployed Nitro contract addresses
|
||||
na_address: ""
|
||||
vpa_address: ""
|
||||
ca_address: ""
|
||||
```
|
||||
|
||||
* Update the target dir in `setup-vars.yml`:
|
||||
|
||||
```bash
|
||||
sed -i 's|^nitro_directory:.*|nitro_directory: /srv/bridge|' setup-vars.yml
|
||||
|
||||
# Will create deployment at /srv/bridge/nitro-contracts-deployment and /srv/bridge/bridge-deployment
|
||||
```
|
||||
|
||||
### Run
|
||||
|
||||
* Start the bridge on remote host by executing `run-nitro-bridge.yml` Ansible playbook on your local machine:
|
||||
|
||||
* Create a new `hosts.ini` file:
|
||||
|
||||
```bash
|
||||
cp ../hosts.example.ini hosts.ini
|
||||
```
|
||||
|
||||
* Edit the [`hosts.ini`](./hosts.ini) file to run the playbook on a remote machine:
|
||||
|
||||
```ini
|
||||
[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)
|
||||
|
||||
* Verify that you are able to connect to the host using the following command:
|
||||
|
||||
```bash
|
||||
ansible all -m ping -i hosts.ini -k
|
||||
|
||||
# Expected output:
|
||||
# <host_name> | SUCCESS => {
|
||||
# "ansible_facts": {
|
||||
# "discovered_interpreter_python": "/usr/bin/python3.10"
|
||||
# },
|
||||
# "changed": false,
|
||||
# "ping": "pong"
|
||||
# }
|
||||
```
|
||||
|
||||
* Execute the `run-nitro-bridge.yml` Ansible playbook for remote deployment:
|
||||
|
||||
```bash
|
||||
LANG=en_US.utf8 ansible-playbook -i hosts.ini run-nitro-bridge.yml --extra-vars='{ "target_host": "nitro_host"}' --user $USER -kK
|
||||
```
|
||||
|
||||
* Check logs for deployments on the remote machine:
|
||||
|
||||
```bash
|
||||
cd /srv/bridge
|
||||
|
||||
# Check bridge logs, ensure that the node is running
|
||||
laconic-so deployment --dir bridge-deployment logs nitro-bridge -f
|
||||
```
|
||||
|
||||
* Create Nitro node config for users:
|
||||
|
||||
```bash
|
||||
cd /srv/bridge
|
||||
|
||||
# Create required variables
|
||||
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")
|
||||
|
||||
export BRIDGE_NITRO_ADDRESS=$(laconic-so deployment --dir bridge-deployment exec nitro-rpc-client "nitro-rpc-client get-node-info -p 4005 -h nitro-bridge" | jq -r '.SCAddress')
|
||||
|
||||
export BRIDGE_PEER_ID=$(laconic-so deployment --dir bridge-deployment exec nitro-rpc-client "nitro-rpc-client get-node-info -p 4005 -h nitro-bridge" | jq -r '.MessageServicePeerId')
|
||||
|
||||
export L1_BRIDGE_MULTIADDR="/dns4/bridge.laconic.com/tcp/3005/p2p/$BRIDGE_PEER_ID"
|
||||
export L2_BRIDGE_MULTIADDR="/dns4/bridge.laconic.com/tcp/3006/p2p/$BRIDGE_PEER_ID"
|
||||
|
||||
# Create the required config files
|
||||
cat <<EOF > nitro-node-config.yml
|
||||
nitro_chain_url: "wss://fixturenet-eth.laconic.com"
|
||||
na_address: "$NA_ADDRESS"
|
||||
ca_address: "$CA_ADDRESS"
|
||||
vpa_address: "$VPA_ADDRESS"
|
||||
bridge_nitro_address: "$BRIDGE_NITRO_ADDRESS"
|
||||
nitro_l1_bridge_multiaddr: "$L1_BRIDGE_MULTIADDR"
|
||||
nitro_l2_bridge_multiaddr: "$L2_BRIDGE_MULTIADDR"
|
||||
EOF
|
||||
|
||||
laconic-so deployment --dir nitro-contracts-deployment exec nitro-contracts "jq --arg chainId \"$GETH_CHAIN_ID\" '{
|
||||
(\$chainId): [
|
||||
{
|
||||
\"name\": .[\$chainId][0].name,
|
||||
\"chainId\": .[\$chainId][0].chainId,
|
||||
\"contracts\": (
|
||||
.[\$chainId][0].contracts
|
||||
| to_entries
|
||||
| map(select(.key | in({\"ConsensusApp\":1, \"NitroAdjudicator\":1, \"VirtualPaymentApp\":1}) | not))
|
||||
| from_entries
|
||||
)
|
||||
}
|
||||
]
|
||||
}' /app/deployment/nitro-addresses.json" > assets.json
|
||||
```
|
||||
|
||||
* The required config files should be generated at `/srv/bridge/nitro-node-config.yml` and `/srv/bridge/assets.json`
|
||||
|
||||
* Check in the generated files at locations `ops/stage2/nitro-node-config.yml` and `ops/stage2/assets.json` within this repository respectively
|
||||
|
||||
* List down L2 channels created by the bridge:
|
||||
|
||||
```bash
|
||||
laconic-so deployment --dir bridge-deployment exec nitro-rpc-client "nitro-rpc-client get-all-l2-channels -p 4005 -h nitro-bridge"
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
<details open>
|
||||
<summary>stage0 laconicd</summary>
|
||||
|
||||
@@ -669,10 +1120,22 @@
|
||||
## Domains / Port Mappings
|
||||
|
||||
```bash
|
||||
laconicd.laconic.com -> 26657
|
||||
laconicd.laconic.com/api -> 9473/api
|
||||
faucet.laconic.com -> 4000
|
||||
loro-signup.laconic.com -> 3000
|
||||
wallet.laconic.com -> 5000
|
||||
loro-console.laconic.com -> 4001
|
||||
# Machine 1
|
||||
https://laconicd.laconic.com -> 26657
|
||||
https://laconicd.laconic.com/api -> 9473/api
|
||||
https://faucet.laconic.com -> 4000
|
||||
https://loro-signup.laconic.com -> 3000
|
||||
https://wallet.laconic.com -> 5000
|
||||
https://loro-console.laconic.com -> 4001
|
||||
|
||||
# Machine 2
|
||||
https://sepolia.laconic.com -> 8545
|
||||
wss://sepolia.laconic.com -> 8546
|
||||
https://fixturenet-eth.laconic.com -> 7545
|
||||
wss://fixturenet-eth.laconic.com -> 7546
|
||||
|
||||
bridge.laconic.com
|
||||
Open ports:
|
||||
3005 (L1 side)
|
||||
3006 (L2 side)
|
||||
```
|
||||
|
||||
@@ -0,0 +1,63 @@
|
||||
# Nitro Token Ops
|
||||
|
||||
## Setup
|
||||
|
||||
* Go to the directory where `nitro-contracts-deployment` is present:
|
||||
|
||||
```bash
|
||||
cd /srv/bridge
|
||||
```
|
||||
|
||||
## Deploy new token
|
||||
|
||||
* To deploy another token:
|
||||
|
||||
```bash
|
||||
# These values can be changed to deploy another token with different name and symbol
|
||||
export TOKEN_NAME="TestToken2"
|
||||
export TOKEN_SYMBOL="TST2"
|
||||
|
||||
# Note: Token supply denotes actual number of tokens and not the supply in Wei
|
||||
export INITIAL_TOKEN_SUPPLY="129600"
|
||||
|
||||
laconic-so deployment --dir nitro-contracts-deployment exec nitro-contracts "TOKEN_NAME=$TOKEN_NAME TOKEN_SYMBOL=$TOKEN_SYMBOL INITIAL_TOKEN_SUPPLY=$INITIAL_TOKEN_SUPPLY /app/deploy-l1-tokens.sh"
|
||||
```
|
||||
|
||||
* Recreate `assets.json` to include newly deployed token address:
|
||||
|
||||
```bash
|
||||
export GETH_CHAIN_ID="1212"
|
||||
|
||||
laconic-so deployment --dir nitro-contracts-deployment exec nitro-contracts "jq --arg chainId \"$GETH_CHAIN_ID\" '{
|
||||
(\$chainId): [
|
||||
{
|
||||
\"name\": .[\$chainId][0].name,
|
||||
\"chainId\": .[\$chainId][0].chainId,
|
||||
\"contracts\": (
|
||||
.[\$chainId][0].contracts
|
||||
| to_entries
|
||||
| map(select(.key | in({\"ConsensusApp\":1, \"NitroAdjudicator\":1, \"VirtualPaymentApp\":1}) | not))
|
||||
| from_entries
|
||||
)
|
||||
}
|
||||
]
|
||||
}' /app/deployment/nitro-addresses.json" > assets.json
|
||||
```
|
||||
|
||||
* The required config file should be generated at `/srv/bridge/assets.json`
|
||||
|
||||
* Check in the generated file at location `ops/stage2/assets.json` within this repository
|
||||
|
||||
## Transfer deployed tokens to given address
|
||||
|
||||
* To transfer a token to an account:
|
||||
|
||||
```bash
|
||||
export GETH_CHAIN_ID=1212
|
||||
export TOKEN_NAME="<name-of-token-to-be-transferred>"
|
||||
export ASSET_ADDRESS=$(laconic-so deployment --dir nitro-contracts-deployment exec nitro-contracts "jq -r '.\"$GETH_CHAIN_ID\"[0].contracts.$TOKEN_NAME.address' /app/deployment/nitro-addresses.json")
|
||||
export ACCOUNT="<target-account-address>"
|
||||
export AMOUNT="<transfer-amount>"
|
||||
|
||||
laconic-so deployment --dir nitro-contracts-deployment exec nitro-contracts "cd packages/nitro-protocol && yarn hardhat transfer --contract $ASSET_ADDRESS --to $ACCOUNT --amount 1000 --network geth"
|
||||
```
|
||||
@@ -0,0 +1,16 @@
|
||||
{
|
||||
"1212": [
|
||||
{
|
||||
"name": "geth",
|
||||
"chainId": "1212",
|
||||
"contracts": {
|
||||
"TestToken": {
|
||||
"address": "0x2b79F4a92c177B4E61F5c4AC37b1B8A623c665A4"
|
||||
},
|
||||
"TestToken2": {
|
||||
"address": "0xa6B4B8b84576047A53255649b4994743d9C83A71"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -0,0 +1,7 @@
|
||||
nitro_chain_url: "wss://fixturenet-eth.laconic.com"
|
||||
na_address: "0x2B6AFbd4F479cE4101Df722cF4E05F941523EaD9"
|
||||
ca_address: "0xBca48057Da826cB2eb1258E2C679678b269dC262"
|
||||
vpa_address: "0xCf5207018766587b8cBad4B8B1a1a38c225ebA7A"
|
||||
bridge_nitro_address: "0xf0E6a85C6D23AcA9ff1b83477D426ed26F218185"
|
||||
nitro_l1_bridge_multiaddr: "/dns4/bridge.laconic.com/tcp/3005/p2p/16Uiu2HAky2PYTfBNHpytybz4ADY9n7boiLgK5btJpTrGVbWC3diZ"
|
||||
nitro_l2_bridge_multiaddr: "/dns4/bridge.laconic.com/tcp/3006/p2p/16Uiu2HAky2PYTfBNHpytybz4ADY9n7boiLgK5btJpTrGVbWC3diZ"
|
||||
@@ -22,7 +22,8 @@
|
||||
},
|
||||
"scripts": {
|
||||
"build": "tsc",
|
||||
"map-subscribers-to-participants": "node dist/map-subscribers-to-participants.js"
|
||||
"map-subscribers-to-participants": "node dist/map-subscribers-to-participants.js",
|
||||
"participants-with-filtered-validators": "node dist/participants-with-filtered-validators.js"
|
||||
},
|
||||
"packageManager": "yarn@1.22.19+sha1.4ba7fc5c6e704fce2066ecbfb0b0d8976fe62447"
|
||||
}
|
||||
|
||||
@@ -0,0 +1,29 @@
|
||||
services:
|
||||
faucet:
|
||||
restart: unless-stopped
|
||||
image: cerc/laconic-shopify-faucet:local
|
||||
command: ["bash", "-c", "./start-faucet.sh"]
|
||||
environment:
|
||||
CERC_SCRIPT_DEBUG: ${CERC_SCRIPT_DEBUG}
|
||||
CERC_LACONICD_RPC_ENDPOINT: ${CERC_LACONICD_RPC_ENDPOINT:-http://laconicd:26657}
|
||||
CERC_FAUCET_KEY: ${CERC_FAUCET_KEY}
|
||||
CERC_LACONICD_CHAIN_ID: ${CERC_LACONICD_CHAIN_ID:-laconic_9000-1}
|
||||
CERC_LACONICD_PREFIX: ${CERC_LACONICD_PREFIX:-laconic}
|
||||
CERC_LACONICD_GAS_PRICE: ${CERC_LACONICD_GAS_PRICE:-1}
|
||||
volumes:
|
||||
- faucet-data:/app/db
|
||||
- ../config/laconic-shopify-faucet/start-faucet.sh:/app/start-faucet.sh
|
||||
- ../config/laconic-shopify-faucet/config-template.toml:/app/environments/config-template.toml
|
||||
ports:
|
||||
- 3000
|
||||
healthcheck:
|
||||
test: ["CMD", "nc", "-vz", "127.0.0.1", "3000"]
|
||||
interval: 10s
|
||||
timeout: 5s
|
||||
retries: 10
|
||||
start_period: 5s
|
||||
extra_hosts:
|
||||
- "host.docker.internal:host-gateway"
|
||||
|
||||
volumes:
|
||||
faucet-data:
|
||||
@@ -0,0 +1,21 @@
|
||||
services:
|
||||
shopify:
|
||||
restart: unless-stopped
|
||||
image: cerc/laconic-shopify:local
|
||||
command: ["bash", "-c", "./start-faucet.sh"]
|
||||
environment:
|
||||
CERC_SCRIPT_DEBUG: ${CERC_SCRIPT_DEBUG}
|
||||
CERC_SHOPIFY_GRAPHQL_URL: ${CERC_SHOPIFY_GRAPHQL_URL}
|
||||
CERC_SHOPIFY_ACCESS_TOKEN: ${CERC_SHOPIFY_ACCESS_TOKEN}
|
||||
CERC_FETCH_ORDER_DELAY: ${CERC_FETCH_ORDER_DELAY:-10000}
|
||||
CERC_FAUCET_URL: ${CERC_FAUCET_URL}
|
||||
CERC_ITEMS_PER_ORDER: ${CERC_ITEMS_PER_ORDER:-10}
|
||||
volumes:
|
||||
- shopify-data:/app/data
|
||||
- ../config/laconic-shopify/start-shopify.sh:/app/start-faucet.sh
|
||||
- ../config/laconic-shopify/product_pricings.json:/app/config/product_pricings.json
|
||||
extra_hosts:
|
||||
- "host.docker.internal:host-gateway"
|
||||
|
||||
volumes:
|
||||
shopify-data:
|
||||
@@ -0,0 +1,12 @@
|
||||
[upstream]
|
||||
rpcEndpoint = "REPLACE_WITH_CERC_LACONICD_RPC_ENDPOINT"
|
||||
chainId = "REPLACE_WITH_CERC_LACONICD_CHAIN_ID"
|
||||
prefix = "REPLACE_WITH_CERC_LACONICD_PREFIX"
|
||||
gasPrice = "REPLACE_WITH_CERC_LACONICD_GAS_PRICE"
|
||||
faucetKey = "REPLACE_WITH_CERC_FAUCET_KEY"
|
||||
denom = "alnt"
|
||||
|
||||
[server]
|
||||
port=3000
|
||||
enableRateLimit=false
|
||||
dbDir = "db"
|
||||
@@ -0,0 +1,29 @@
|
||||
#!/bin/bash
|
||||
|
||||
set -e
|
||||
set -u
|
||||
if [ -n "$CERC_SCRIPT_DEBUG" ]; then
|
||||
set -x
|
||||
fi
|
||||
|
||||
config_template=$(cat environments/config-template.toml)
|
||||
target_config="./environments/local.toml"
|
||||
|
||||
# Check if faucet key is set
|
||||
if [ -z "${CERC_FAUCET_KEY:-}" ]; then
|
||||
echo "Error: CERC_FAUCET_KEY is not set. Exiting..."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo "Using laconicd RPC endpoint: $CERC_LACONICD_RPC_ENDPOINT"
|
||||
|
||||
FAUCET_CONFIG=$(echo "$config_template" | \
|
||||
sed -E "s|REPLACE_WITH_CERC_FAUCET_KEY|${CERC_FAUCET_KEY}|g; \
|
||||
s|REPLACE_WITH_CERC_LACONICD_CHAIN_ID|${CERC_LACONICD_CHAIN_ID}|g; \
|
||||
s|REPLACE_WITH_CERC_LACONICD_PREFIX|${CERC_LACONICD_PREFIX}|g; \
|
||||
s|REPLACE_WITH_CERC_LACONICD_GAS_PRICE|${CERC_LACONICD_GAS_PRICE}|g; \
|
||||
s|REPLACE_WITH_CERC_LACONICD_RPC_ENDPOINT|${CERC_LACONICD_RPC_ENDPOINT}|g; ")
|
||||
|
||||
echo "$FAUCET_CONFIG" > $target_config
|
||||
echo "Starting faucet..."
|
||||
node dist/index.js
|
||||
@@ -0,0 +1,6 @@
|
||||
{
|
||||
"10 pre-paid webapp deployments": "100000",
|
||||
"100 webapp deployments": "1000000",
|
||||
"500 webapp deployments": "5000000",
|
||||
"1000 webapp deployments": "10000000"
|
||||
}
|
||||
@@ -0,0 +1,21 @@
|
||||
#!/bin/bash
|
||||
|
||||
set -e
|
||||
set -u
|
||||
if [ -n "$CERC_SCRIPT_DEBUG" ]; then
|
||||
set -x
|
||||
fi
|
||||
|
||||
echo "Shopify GraphQL URL: $CERC_SHOPIFY_GRAPHQL_URL"
|
||||
echo "Shopify access token: $CERC_SHOPIFY_ACCESS_TOKEN"
|
||||
echo "Fetch order delay: $CERC_FETCH_ORDER_DELAY"
|
||||
echo "Faucet URL: $CERC_FAUCET_URL"
|
||||
echo "Number of line items per order: $CERC_ITEMS_PER_ORDER"
|
||||
|
||||
export SHOPIFY_GRAPHQL_URL=$CERC_SHOPIFY_GRAPHQL_URL
|
||||
export SHOPIFY_ACCESS_TOKEN=$CERC_SHOPIFY_ACCESS_TOKEN
|
||||
export FETCH_ORDER_DELAY=$CERC_FETCH_ORDER_DELAY
|
||||
export FAUCET_URL=$CERC_FAUCET_URL
|
||||
export ITEMS_PER_ORDER=$CERC_ITEMS_PER_ORDER
|
||||
|
||||
yarn start
|
||||
@@ -0,0 +1,5 @@
|
||||
#!/usr/bin/env bash
|
||||
|
||||
# Build cerc/laconic-shopify-faucet
|
||||
source ${CERC_CONTAINER_BASE_DIR}/build-base.sh
|
||||
docker build -t cerc/laconic-shopify-faucet:local ${build_command_args} ${CERC_REPO_BASE_DIR}/laconic-faucet
|
||||
@@ -0,0 +1,9 @@
|
||||
FROM node:20-bullseye
|
||||
|
||||
WORKDIR /app
|
||||
|
||||
COPY . .
|
||||
|
||||
RUN yarn install
|
||||
|
||||
CMD ["yarn", "start"]
|
||||
@@ -0,0 +1,8 @@
|
||||
#!/usr/bin/env bash
|
||||
|
||||
# Build cerc/laconic-faucet
|
||||
source ${CERC_CONTAINER_BASE_DIR}/build-base.sh
|
||||
|
||||
SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
|
||||
|
||||
docker build -t cerc/laconic-shopify:local ${build_command_args} -f ${SCRIPT_DIR}/Dockerfile ${CERC_REPO_BASE_DIR}/laconic-shopify
|
||||
@@ -0,0 +1,121 @@
|
||||
# laconic-shopify-faucet
|
||||
|
||||
Instructions for running the laconic faucet
|
||||
|
||||
## Setup
|
||||
|
||||
* Clone the stack repo:
|
||||
|
||||
```bash
|
||||
laconic-so fetch-stack git.vdb.to/cerc-io/testnet-laconicd-stack
|
||||
```
|
||||
|
||||
* Clone the laconic-faucet respository:
|
||||
|
||||
```bash
|
||||
laconic-so --stack ~/cerc/testnet-laconicd-stack/stack-orchestrator/stacks/laconic-shopify-faucet setup-repositories
|
||||
```
|
||||
|
||||
* Build the container image:
|
||||
|
||||
```bash
|
||||
laconic-so --stack ~/cerc/testnet-laconicd-stack/stack-orchestrator/stacks/laconic-shopify-faucet build-containers
|
||||
```
|
||||
|
||||
This should create the `cerc/laconic-shopify-faucet` image locally
|
||||
|
||||
## Create a deployment
|
||||
|
||||
* Create a spec file for the deployment:
|
||||
|
||||
```bash
|
||||
laconic-so --stack ~/cerc/testnet-laconicd-stack/stack-orchestrator/stacks/laconic-shopify-faucet deploy init --output laconic-shopify-faucet-spec.yml
|
||||
```
|
||||
|
||||
* Edit `network` in the spec file to map container ports to host ports as required:
|
||||
|
||||
```bash
|
||||
network:
|
||||
ports:
|
||||
faucet:
|
||||
- '3000:3000'
|
||||
```
|
||||
|
||||
* Create a deployment from the spec file:
|
||||
|
||||
```bash
|
||||
laconic-so --stack ~/cerc/testnet-laconicd-stack/stack-orchestrator/stacks/laconic-shopify-faucet deploy create --spec-file laconic-shopify-faucet-spec.yml --deployment-dir laconic-shopify-faucet-deployment
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
* Inside the `laconic-shopify-faucet-deployment` deployment directory, open `config.env` file and set following env variables:
|
||||
|
||||
```bash
|
||||
# Private key of a funded faucet account
|
||||
CERC_FAUCET_KEY=
|
||||
|
||||
# Optional
|
||||
|
||||
# laconicd RPC endpoint (default: http://laconicd:26657)
|
||||
CERC_LACONICD_RPC_ENDPOINT=
|
||||
|
||||
# laconicd chain id (default: laconic_9000-1)
|
||||
CERC_LACONICD_CHAIN_ID=
|
||||
|
||||
# laconicd address prefix (default: laconic)
|
||||
CERC_LACONICD_PREFIX=
|
||||
|
||||
# laconicd gas price (default: 1)
|
||||
CERC_LACONICD_GAS_PRICE=
|
||||
```
|
||||
|
||||
## Start the deployment
|
||||
|
||||
```bash
|
||||
laconic-so deployment --dir laconic-shopify-faucet-deployment start
|
||||
```
|
||||
|
||||
## Check status
|
||||
|
||||
* To list down and monitor the running container:
|
||||
|
||||
```bash
|
||||
# With status
|
||||
docker ps
|
||||
|
||||
# Check logs for a container
|
||||
docker logs -f <CONTAINER_ID>
|
||||
```
|
||||
|
||||
## Run
|
||||
|
||||
* Request tokens from the faucet for an account:
|
||||
|
||||
```bash
|
||||
curl -X POST http://localhost:3000/faucet \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"address": "<laconicd_address>"}'
|
||||
|
||||
# Expected output:
|
||||
# {"success":true,"txHash":"<tx_hash>"}
|
||||
```
|
||||
|
||||
## Clean up
|
||||
|
||||
* Stop the `laconic-shopify-faucet` service running in the background:
|
||||
|
||||
```bash
|
||||
# Stop the docker container
|
||||
laconic-so deployment --dir laconic-shopify-faucet-deployment stop
|
||||
```
|
||||
|
||||
* To stop the service and also delete data:
|
||||
|
||||
```bash
|
||||
# Stop the docker containers
|
||||
laconic-so deployment --dir laconic-shopify-faucet-deployment stop --delete-volumes
|
||||
|
||||
# Remove deployment directory (deployment will have to be recreated for a re-run)
|
||||
rm -r laconic-shopify-faucet-deployment
|
||||
```
|
||||
@@ -0,0 +1,9 @@
|
||||
version: "1.0"
|
||||
name: laconic-shopify-faucet
|
||||
description: "Faucet for shopify app"
|
||||
repos:
|
||||
- git.vdb.to/cerc-io/laconic-faucet@shopify
|
||||
containers:
|
||||
- cerc/laconic-shopify-faucet
|
||||
pods:
|
||||
- laconic-shopify-faucet
|
||||
@@ -0,0 +1,97 @@
|
||||
# laconic-shopify
|
||||
|
||||
Instructions for running the laconic shopify
|
||||
|
||||
## Setup
|
||||
|
||||
* Clone the stack repo:
|
||||
|
||||
```bash
|
||||
laconic-so fetch-stack git.vdb.to/cerc-io/testnet-laconicd-stack
|
||||
```
|
||||
|
||||
* Clone the laconic-shopify respository:
|
||||
|
||||
```bash
|
||||
laconic-so --stack ~/cerc/testnet-laconicd-stack/stack-orchestrator/stacks/laconic-shopify setup-repositories
|
||||
```
|
||||
|
||||
* Build the container image:
|
||||
|
||||
```bash
|
||||
laconic-so --stack ~/cerc/testnet-laconicd-stack/stack-orchestrator/stacks/laconic-shopify build-containers
|
||||
```
|
||||
|
||||
This should create the `cerc/laconic-shopify-faucet` image locally
|
||||
|
||||
## Create a deployment
|
||||
|
||||
* Create a spec file for the deployment:
|
||||
|
||||
```bash
|
||||
laconic-so --stack ~/cerc/testnet-laconicd-stack/stack-orchestrator/stacks/laconic-shopify deploy init --output laconic-shopify-spec.yml
|
||||
```
|
||||
|
||||
* Create a deployment from the spec file:
|
||||
|
||||
```bash
|
||||
laconic-so --stack ~/cerc/testnet-laconicd-stack/stack-orchestrator/stacks/laconic-shopify deploy create --spec-file laconic-shopify-spec.yml --deployment-dir laconic-shopify-deployment
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
* Inside the `laconic-shopify-deployment` deployment directory, open `config.env` file and set following env variables:
|
||||
|
||||
```bash
|
||||
# Shopify GraphQL URL
|
||||
CERC_SHOPIFY_GRAPHQL_URL='https://6h071x-zw.myshopify.com/admin/api/2024-10/graphql.json'
|
||||
|
||||
# Access token for Shopify API
|
||||
CERC_SHOPIFY_ACCESS_TOKEN=
|
||||
|
||||
# Delay for fetching orders in milliseconds
|
||||
CERC_FETCH_ORDER_DELAY=10000
|
||||
|
||||
# URL for the laconic faucet
|
||||
CERC_FAUCET_URL='http://host.docker.internal:3000/'
|
||||
|
||||
# Number of line items per order in Get Orders GraphQL query
|
||||
CERC_ITEMS_PER_ORDER=10
|
||||
```
|
||||
|
||||
## Start the deployment
|
||||
|
||||
```bash
|
||||
laconic-so deployment --dir laconic-shopify-deployment start
|
||||
```
|
||||
|
||||
## Check status
|
||||
|
||||
* To list down and monitor the running container:
|
||||
|
||||
```bash
|
||||
# With status
|
||||
docker ps
|
||||
|
||||
# Check logs for a container
|
||||
docker logs -f <CONTAINER_ID>
|
||||
```
|
||||
|
||||
## Clean up
|
||||
|
||||
* Stop the `laconic-shopify-faucet` service running in the background:
|
||||
|
||||
```bash
|
||||
# Stop the docker container
|
||||
laconic-so deployment --dir laconic-shopify-deployment stop
|
||||
```
|
||||
|
||||
* To stop the service and also delete data:
|
||||
|
||||
```bash
|
||||
# Stop the docker containers
|
||||
laconic-so deployment --dir laconic-shopify-deployment stop --delete-volumes
|
||||
|
||||
# Remove deployment directory (deployment will have to be recreated for a re-run)
|
||||
rm -r laconic-shopify-deployment
|
||||
```
|
||||
@@ -0,0 +1,9 @@
|
||||
version: "1.0"
|
||||
name: laconic-shopify
|
||||
description: "Service that integrates a Shopify app with the Laconic wallet."
|
||||
repos:
|
||||
- git.vdb.to/cerc-io/laconic-shopify
|
||||
containers:
|
||||
- cerc/laconic-shopify
|
||||
pods:
|
||||
- laconic-shopify
|
||||
@@ -0,0 +1,797 @@
|
||||
# testnet-nitro-node
|
||||
|
||||
## Prerequisites
|
||||
|
||||
* Local:
|
||||
|
||||
* Clone the `cerc-io/testnet-ops` repository:
|
||||
|
||||
```bash
|
||||
git clone git@git.vdb.to:cerc-io/testnet-ops.git
|
||||
```
|
||||
|
||||
* Ansible: see [installation](https://git.vdb.to/cerc-io/testnet-ops#installation)
|
||||
|
||||
* On deployment machine:
|
||||
|
||||
* laconic-so: see [installation](https://git.vdb.to/cerc-io/testnet-ops/src/branch/main/stack-orchestrator-setup/README.md#setup-stack-orchestrator)
|
||||
|
||||
## Setup
|
||||
|
||||
* Move to `nitro-nodes-setup` :
|
||||
|
||||
```bash
|
||||
cd testnet-ops/nitro-nodes-setup
|
||||
```
|
||||
|
||||
* Fetch the required Nitro node config:
|
||||
|
||||
```bash
|
||||
wget -O nitro-vars.yml https://git.vdb.to/cerc-io/testnet-laconicd-stack/raw/branch/main/ops/stage2/nitro-node-config.yml
|
||||
|
||||
# Expected variables in the fetched config file:
|
||||
|
||||
# nitro_chain_url: ""
|
||||
# na_address: ""
|
||||
# ca_address: ""
|
||||
# vpa_address: ""
|
||||
# bridge_nitro_address: ""
|
||||
# nitro_l1_bridge_multiaddr: ""
|
||||
# nitro_l2_bridge_multiaddr: ""
|
||||
```
|
||||
|
||||
* Fetch required asset addresses:
|
||||
|
||||
```bash
|
||||
wget -O assets.json https://git.vdb.to/cerc-io/testnet-laconicd-stack/raw/branch/main/ops/stage2/assets.json
|
||||
|
||||
# Example output:
|
||||
# {
|
||||
# "1212": [
|
||||
# {
|
||||
# "name": "geth",
|
||||
# "chainId": "1212",
|
||||
# "contracts": {
|
||||
# "TestToken": {
|
||||
# "address": "0xCf7Ed3AccA5a467e9e704C703E8D87F634fB0Fc9"
|
||||
# },
|
||||
# "TestToken2": {
|
||||
# "address": "0xDc64a140Aa3E981100a9becA4E685f962f0cF6C9"
|
||||
# }
|
||||
# }
|
||||
# }
|
||||
# ]
|
||||
# }
|
||||
```
|
||||
|
||||
* TODO: Get L1 tokens on your address
|
||||
|
||||
* Edit `nitro-vars.yml` and add the following variables:
|
||||
|
||||
```bash
|
||||
# Private key for your Nitro account (same as the one used in stage0 onboarding)
|
||||
# Export the key from Laconic wallet (https://wallet.laconic.com)
|
||||
nitro_sc_pk: ""
|
||||
|
||||
# Private key for a funded account on L1
|
||||
# This account should have L1 tokens for funding your Nitro channels
|
||||
nitro_chain_pk: ""
|
||||
|
||||
# Multiaddr with publically accessible IP address / DNS for your L1 nitro node
|
||||
# Use port 3007
|
||||
# Example: "/ip4/192.168.x.y/tcp/3007"
|
||||
# Example: "/dns4/example.com/tcp/3007"
|
||||
nitro_l1_ext_multiaddr: ""
|
||||
|
||||
# Multiaddr with publically accessible IP address / DNS for your L2 nitro node
|
||||
# Use port 3009
|
||||
# Example: "/ip4/192.168.x.y/tcp/3009"
|
||||
# Example: "/dns4/example.com/tcp/3009"
|
||||
nitro_l2_ext_multiaddr: ""
|
||||
```
|
||||
|
||||
* Update the target dir in `setup-vars.yml`:
|
||||
|
||||
```bash
|
||||
# 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
|
||||
|
||||
# Will create deployments at $DEPLOYMENTS_DIR/nitro-node/l1-nitro-deployment and $DEPLOYMENTS_DIR/nitro-node/l2-nitro-deployment
|
||||
```
|
||||
|
||||
## 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:
|
||||
|
||||
```bash
|
||||
LANG=en_US.utf8 ansible-playbook -i localhost, --connection=local run-nitro-nodes.yml --extra-vars='{ "target_host": "localhost"}' --user $USER
|
||||
```
|
||||
|
||||
### On Remote Host
|
||||
|
||||
* In `testnet-ops/nitro-nodes-setup`, create a new `hosts.ini` file:
|
||||
|
||||
```bash
|
||||
cp ../hosts.example.ini hosts.ini
|
||||
```
|
||||
|
||||
* Edit the [`hosts.ini`](./hosts.ini) file to run the playbook on a remote machine:
|
||||
|
||||
```ini
|
||||
[<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)
|
||||
|
||||
* 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 => {
|
||||
# "ansible_facts": {
|
||||
# "discovered_interpreter_python": "/usr/bin/python3.10"
|
||||
# },
|
||||
# "changed": false,
|
||||
# "ping": "pong"
|
||||
# }
|
||||
```
|
||||
|
||||
* Execute the `run-nitro-nodes.yml` Ansible playbook for remote deployment:
|
||||
|
||||
```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 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 on deployment machine
|
||||
|
||||
* Set required variables:
|
||||
|
||||
```bash
|
||||
DEPLOYMENTS_DIR=<path-to-deployments-dir>
|
||||
|
||||
cd $DEPLOYMENTS_DIR/nitro-node
|
||||
|
||||
export BRIDGE_NITRO_ADDRESS=$(yq eval '.bridge_nitro_address' nitro-node-config.yml)
|
||||
|
||||
# Get asset addresses from assets.json file
|
||||
export ASSET_ADDRESS_1=$(jq -r --arg chainId "$CHAIN_ID" '.[$chainId][0].contracts.TestToken.address' assets.json)
|
||||
export ASSET_ADDRESS_2=$(jq -r --arg chainId "$CHAIN_ID" '.[$chainId][0].contracts.TestToken2.address' assets.json)
|
||||
```
|
||||
|
||||
* Check that check that you have no existing channels on L1 or L2:
|
||||
|
||||
```bash
|
||||
laconic-so deployment --dir l1-nitro-deployment exec nitro-rpc-client "nitro-rpc-client get-all-ledger-channels -p 4005 -h nitro-node"
|
||||
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:
|
||||
# []
|
||||
```
|
||||
|
||||
* Create a ledger channel between your L1 Nitro node and Bridge with custom asset:
|
||||
|
||||
```bash
|
||||
laconic-so deployment --dir l1-nitro-deployment exec nitro-rpc-client "nitro-rpc-client direct-fund $BRIDGE_NITRO_ADDRESS --asset "$ASSET_ADDRESS_1:1000,1000" --asset "$ASSET_ADDRESS_2:1000,1000" -p 4005 -h nitro-node"
|
||||
|
||||
# Follow your L1 Nitro node logs for progress
|
||||
|
||||
# Expected Output:
|
||||
# Objective started DirectFunding-0x161d289a50222caa781db215bb82a3ede4f557217742245525b8e8cbff04ec21
|
||||
# Channel Open 0x161d289a50222caa781db215bb82a3ede4f557217742245525b8e8cbff04ec21
|
||||
|
||||
# Set the resulting ledger channel id in a variable
|
||||
export LEDGER_CHANNEL_ID=
|
||||
```
|
||||
|
||||
* Check the [Troubleshooting](#troubleshooting) section if command to create a ledger channel fails or gets stuck
|
||||
|
||||
* Once direct-fund objective is complete, the bridge will create a mirrored channel on L2
|
||||
|
||||
* Check L2 Nitro node's logs to see that a bridged-fund objective completed:
|
||||
|
||||
```bash
|
||||
laconic-so deployment --dir l2-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 status of L1 ledger channel with the bridge using channel id:
|
||||
|
||||
```bash
|
||||
laconic-so deployment --dir l1-nitro-deployment exec nitro-rpc-client "nitro-rpc-client get-ledger-channel $LEDGER_CHANNEL_ID -p 4005 -h nitro-node"
|
||||
|
||||
# Example output:
|
||||
# {
|
||||
# ID: '0xbb28acc2e1543f4b41eb1ab9eb2e354b18554aefe4e7f0fa5f20046869d8553f',
|
||||
# Status: 'Open',
|
||||
# Balances: [
|
||||
# {
|
||||
# AssetAddress: '0xa6b4b8b84576047a53255649b4994743d9c83a71',
|
||||
# Me: '0xdaaa6ef3bc03f9c7dabc9a02847387d2c19107f5',
|
||||
# Them: '0xf0e6a85c6d23aca9ff1b83477d426ed26f218185',
|
||||
# MyBalance: 1000n,
|
||||
# TheirBalance: 1000n
|
||||
# },
|
||||
# {
|
||||
# AssetAddress: '0x0000000000000000000000000000000000000000',
|
||||
# Me: '0xdaaa6ef3bc03f9c7dabc9a02847387d2c19107f5',
|
||||
# Them: '0xf0e6a85c6d23aca9ff1b83477d426ed26f218185',
|
||||
# MyBalance: 1000n,
|
||||
# TheirBalance: 1000n
|
||||
# }
|
||||
# ],
|
||||
# ChannelMode: 'Open'
|
||||
# }
|
||||
```
|
||||
|
||||
* 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"
|
||||
|
||||
# Example output:
|
||||
# [
|
||||
# {
|
||||
# "ID": "0xb34210b763d4fdd534190ba11886ad1daa1e411c87be6fd20cff74cd25077c46",
|
||||
# "Status": "Open",
|
||||
# "Balances": [
|
||||
# {
|
||||
# "AssetAddress": "0xa4351114dae1abeb2d552d441c9733c72682a45d",
|
||||
# "Me": "0x075400039e303b3fb46c0cff0404c5fa61947c05",
|
||||
# "Them": "0xf0e6a85c6d23aca9ff1b83477d426ed26f218185",
|
||||
# "MyBalance": 1000,
|
||||
# "TheirBalance": 1000
|
||||
# },
|
||||
# {
|
||||
# "AssetAddress": "0x314e43f9825b10961859c2a62c2de6a765c1c1f1",
|
||||
# "Me": "0x075400039e303b3fb46c0cff0404c5fa61947c05",
|
||||
# "Them": "0xf0e6a85c6d23aca9ff1b83477d426ed26f218185",
|
||||
# "MyBalance": 1000,
|
||||
# "TheirBalance": 1000
|
||||
# }
|
||||
# ],
|
||||
# "ChannelMode": "Open"
|
||||
# }
|
||||
# ]
|
||||
```
|
||||
|
||||
## 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
|
||||
|
||||
* Prerequisite: Ledger channel is required to create a payment channel
|
||||
|
||||
* Note: Currently payment channel is created from first asset present in ledger channel
|
||||
|
||||
* 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"
|
||||
|
||||
# Example output:
|
||||
# [
|
||||
# {
|
||||
# "ID": "0xb34210b763d4fdd534190ba11886ad1daa1e411c87be6fd20cff74cd25077c46",
|
||||
# "Status": "Open",
|
||||
# "Balances": [
|
||||
# {
|
||||
# "AssetAddress": "0xa4351114dae1abeb2d552d441c9733c72682a45d",
|
||||
# "Me": "0x075400039e303b3fb46c0cff0404c5fa61947c05",
|
||||
# "Them": "0xf0e6a85c6d23aca9ff1b83477d426ed26f218185",
|
||||
# "MyBalance": 1000,
|
||||
# "TheirBalance": 1000
|
||||
# },
|
||||
# {
|
||||
# "AssetAddress": "0x314e43f9825b10961859c2a62c2de6a765c1c1f1",
|
||||
# "Me": "0x075400039e303b3fb46c0cff0404c5fa61947c05",
|
||||
# "Them": "0xf0e6a85c6d23aca9ff1b83477d426ed26f218185",
|
||||
# "MyBalance": 1000,
|
||||
# "TheirBalance": 1000
|
||||
# }
|
||||
# ],
|
||||
# "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=500
|
||||
```
|
||||
|
||||
* 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"
|
||||
|
||||
# Example output:
|
||||
# [
|
||||
# {
|
||||
# "ID": "0xb34210b763d4fdd534190ba11886ad1daa1e411c87be6fd20cff74cd25077c46",
|
||||
# "Status": "Open",
|
||||
# "Balances": [
|
||||
# {
|
||||
# "AssetAddress": "0xa4351114dae1abeb2d552d441c9733c72682a45d",
|
||||
# "Me": "0x075400039e303b3fb46c0cff0404c5fa61947c05",
|
||||
# "Them": "0xf0e6a85c6d23aca9ff1b83477d426ed26f218185",
|
||||
# "MyBalance": <updated balance>,
|
||||
# "TheirBalance": <updated balance>
|
||||
# },
|
||||
# {
|
||||
# "AssetAddress": "0x314e43f9825b10961859c2a62c2de6a765c1c1f1",
|
||||
# "Me": "0x075400039e303b3fb46c0cff0404c5fa61947c05",
|
||||
# "Them": "0xf0e6a85c6d23aca9ff1b83477d426ed26f218185",
|
||||
# "MyBalance": <updated balance>,
|
||||
# "TheirBalance": <updated balance>
|
||||
# }
|
||||
# ],
|
||||
# "ChannelMode": "Open"
|
||||
# }
|
||||
# ]
|
||||
```
|
||||
|
||||
Your balance on the L2 channel should be reduced by total payments done on the virtual payment channel
|
||||
|
||||
## Swaps on L2
|
||||
|
||||
Perform swaps using a swap channel created with another Nitro node over the mirrored L2 channel with bridge as an intermediary
|
||||
|
||||
* Prerequisite: Ledger channel is required to create a swap channel
|
||||
|
||||
* 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"
|
||||
|
||||
# Example output:
|
||||
# [
|
||||
# {
|
||||
# "ID": "0xb34210b763d4fdd534190ba11886ad1daa1e411c87be6fd20cff74cd25077c46",
|
||||
# "Status": "Open",
|
||||
# "Balances": [
|
||||
# {
|
||||
# "AssetAddress": "0xa4351114dae1abeb2d552d441c9733c72682a45d",
|
||||
# "Me": "0x075400039e303b3fb46c0cff0404c5fa61947c05",
|
||||
# "Them": "0xf0e6a85c6d23aca9ff1b83477d426ed26f218185",
|
||||
# "MyBalance": 1000,
|
||||
# "TheirBalance": 1000
|
||||
# },
|
||||
# {
|
||||
# "AssetAddress": "0x314e43f9825b10961859c2a62c2de6a765c1c1f1",
|
||||
# "Me": "0x075400039e303b3fb46c0cff0404c5fa61947c05",
|
||||
# "Them": "0xf0e6a85c6d23aca9ff1b83477d426ed26f218185",
|
||||
# "MyBalance": 1000,
|
||||
# "TheirBalance": 1000
|
||||
# }
|
||||
# ],
|
||||
# "ChannelMode": "Open"
|
||||
# }
|
||||
# ]
|
||||
```
|
||||
|
||||
* Set required variables:
|
||||
|
||||
```bash
|
||||
export BRIDGE_NITRO_ADDRESS=$(yq eval '.bridge_nitro_address' nitro-node-config.yml)
|
||||
|
||||
# Counterparty to create the swap channel with
|
||||
export COUNTER_PARTY_ADDRESS=<counterparty-nitro-address>
|
||||
|
||||
# Get asset addresses from assets.json file
|
||||
export ASSET_ADDRESS_1=$(jq -r --arg chainId "$CHAIN_ID" '.[$chainId][0].contracts.TestToken.address' assets.json)
|
||||
export ASSET_ADDRESS_2=$(jq -r --arg chainId "$CHAIN_ID" '.[$chainId][0].contracts.TestToken2.address' assets.json)
|
||||
```
|
||||
|
||||
* Create swap channel:
|
||||
|
||||
```bash
|
||||
laconic-so deployment --dir l2-nitro-deployment exec nitro-rpc-client "nitro-rpc-client swap-fund $COUNTER_PARTY_ADDRESS $BRIDGE_NITRO_ADDRESS --asset "$ASSET_ADDRESS_1:100,100" --asset "$ASSET_ADDRESS_2:100,100" -p 4005 -h nitro-node"
|
||||
|
||||
# Expected output
|
||||
# Objective started SwapFund-0x1dbd58d314f123f4b0f4147eee7fd92fa523ba7082d8a75b846f6d1189e2f0e9
|
||||
# Channel open 0x1dbd58d314f123f4b0f4147eee7fd92fa523ba7082d8a75b846f6d1189e2f0e9
|
||||
```
|
||||
|
||||
* Export swap channel ID:
|
||||
|
||||
```bash
|
||||
export SWAP_CHANNEL_ID=
|
||||
```
|
||||
|
||||
* Check swap channel:
|
||||
|
||||
```bash
|
||||
laconic-so deployment --dir l2-nitro-deployment exec nitro-rpc-client "nitro-rpc-client get-swap-channel $SWAP_CHANNEL_ID -p 4005 -h nitro-node"
|
||||
|
||||
# Expected output:
|
||||
# {
|
||||
# ID: '0x1dbd58d314f123f4b0f4147eee7fd92fa523ba7082d8a75b846f6d1189e2f0e9',
|
||||
# Status: 'Open',
|
||||
# Balances: [
|
||||
# {
|
||||
# AssetAddress: '0xa4351114dae1abeb2d552d441c9733c72682a45d',
|
||||
# Me: '0x075400039e303b3fb46c0cff0404c5fa61947c05',
|
||||
# Them: '0xd0ea8b27591b1d070cccd4d30b8d408fe794fdfc',
|
||||
# MyBalance: 100n,
|
||||
# TheirBalance: 100n
|
||||
# },
|
||||
# {
|
||||
# AssetAddress: '0x314e43f9825b10961859c2a62c2de6a765c1c1f1',
|
||||
# Me: '0x075400039e303b3fb46c0cff0404c5fa61947c05',
|
||||
# Them: '0xd0ea8b27591b1d070cccd4d30b8d408fe794fdfc',
|
||||
# MyBalance: 100n,
|
||||
# TheirBalance: 100n
|
||||
# }
|
||||
# ]
|
||||
# }
|
||||
```
|
||||
|
||||
### Performing swaps
|
||||
|
||||
* One of the participants can initiate the swap and other one will either accept it or reject it
|
||||
|
||||
* For initiating the swap:
|
||||
|
||||
```bash
|
||||
laconic-so deployment --dir l2-nitro-deployment exec nitro-rpc-client "nitro-rpc-client swap-initiate $SWAP_CHANNEL_ID --AssetIn "$ASSET_ADDRESS_1:20" --AssetOut "$ASSET_ADDRESS_2:10" -p 4005 -h nitro-node"
|
||||
|
||||
# Expected output:
|
||||
# {
|
||||
# SwapAssetsData: {
|
||||
# TokenIn: '0xa4351114dae1abeb2d552d441c9733c72682a45d',
|
||||
# TokenOut: '0x314e43f9825b10961859c2a62c2de6a765c1c1f1',
|
||||
# AmountIn: 20,
|
||||
# AmountOut: 10
|
||||
# },
|
||||
# Channel: '0x1dbd58d314f123f4b0f4147eee7fd92fa523ba7082d8a75b846f6d1189e2f0e9'
|
||||
# }
|
||||
```
|
||||
|
||||
OR
|
||||
|
||||
* For receiving the swap
|
||||
|
||||
* Get the pending swap:
|
||||
|
||||
```bash
|
||||
laconic-so deployment --dir l2-nitro-deployment exec nitro-rpc-client "nitro-rpc-client get-pending-swap $SWAP_CHANNEL_ID -p 4005 -h nitro-node"
|
||||
|
||||
# Expected output:
|
||||
# {
|
||||
# Id: '0x7d582020753335cfd2f2af14127c9b51c7ed7a5d547a674d9cb04fe62de6ddf3',
|
||||
# ChannelId: '0x1dbd58d314f123f4b0f4147eee7fd92fa523ba7082d8a75b846f6d1189e2f0e9',
|
||||
# Exchange: {
|
||||
# TokenIn: '0xa4351114dae1abeb2d552d441c9733c72682a45d',
|
||||
# TokenOut: '0x314e43f9825b10961859c2a62c2de6a765c1c1f1',
|
||||
# AmountIn: 20,
|
||||
# AmountOut: 10
|
||||
# },
|
||||
# Sigs: {
|
||||
# '0': '0x0a018de18a091f7bfb400d9bc64fe958d298882e569c1668c5b1c853b5493221576b2d72074ef6e1899b79e60eaa9934afac5c1e07b7000746bac5b3b1da93311b'
|
||||
# },
|
||||
# Nonce: 2840594896360394000
|
||||
# }
|
||||
```
|
||||
|
||||
* Export swap ID:
|
||||
|
||||
```bash
|
||||
export SWAP_ID=
|
||||
```
|
||||
|
||||
* Either accept or reject the swap
|
||||
|
||||
* To accept:
|
||||
|
||||
```bash
|
||||
laconic-so deployment --dir l2-nitro-deployment exec nitro-rpc-client "nitro-rpc-client swap-accept $SWAP_ID -p 4005 -h nitro-node"
|
||||
|
||||
# Expected output:
|
||||
# Confirming Swap with accepted
|
||||
# Objective complete Swap-0x7d582020753335cfd2f2af14127c9b51c7ed7a5d547a674d9cb04fe62de6ddf3
|
||||
```
|
||||
|
||||
OR
|
||||
|
||||
* To reject:
|
||||
|
||||
```bash
|
||||
laconic-so deployment --dir l2-nitro-deployment exec nitro-rpc-client "nitro-rpc-client swap-reject $SWAP_ID -p 4005 -h nitro-node"
|
||||
|
||||
# Expected output:
|
||||
# Confirming Swap with accepted
|
||||
# Objective complete Swap-0x7d582020753335cfd2f2af14127c9b51c7ed7a5d547a674d9cb04fe62de6ddf3
|
||||
```
|
||||
|
||||
* Check swap channel:
|
||||
|
||||
```bash
|
||||
laconic-so deployment --dir l2-nitro-deployment exec nitro-rpc-client "nitro-rpc-client get-swap-channel $SWAP_CHANNEL_ID -p 4005 -h nitro-node"
|
||||
|
||||
# Example output:
|
||||
# {
|
||||
# ID: '0x1dbd58d314f123f4b0f4147eee7fd92fa523ba7082d8a75b846f6d1189e2f0e9',
|
||||
# Status: 'Open',
|
||||
# Balances: [
|
||||
# {
|
||||
# AssetAddress: '0xa4351114dae1abeb2d552d441c9733c72682a45d',
|
||||
# Me: '0xd0ea8b27591b1d070cccd4d30b8d408fe794fdfc',
|
||||
# Them: '0x075400039e303b3fb46c0cff0404c5fa61947c05',
|
||||
# MyBalance: 120n,
|
||||
# TheirBalance: 80n
|
||||
# },
|
||||
# {
|
||||
# AssetAddress: '0x314e43f9825b10961859c2a62c2de6a765c1c1f1',
|
||||
# Me: '0xd0ea8b27591b1d070cccd4d30b8d408fe794fdfc',
|
||||
# Them: '0x075400039e303b3fb46c0cff0404c5fa61947c05',
|
||||
# MyBalance: 90n,
|
||||
# TheirBalance: 110n
|
||||
# }
|
||||
# ]
|
||||
# }
|
||||
```
|
||||
|
||||
* Close swap channel:
|
||||
|
||||
```bash
|
||||
laconic-so deployment --dir l2-nitro-deployment exec nitro-rpc-client "nitro-rpc-client swap-defund $SWAP_CHANNEL_ID -p 4005 -h nitro-node"
|
||||
|
||||
# Expected output:
|
||||
# Objective started SwapDefund-0x1dbd58d314f123f4b0f4147eee7fd92fa523ba7082d8a75b846f6d1189e2f0e9
|
||||
# Objective complete SwapDefund-0x1dbd58d314f123f4b0f4147eee7fd92fa523ba7082d8a75b846f6d1189e2f0e9
|
||||
```
|
||||
|
||||
* Check L2 mirrored channel status:
|
||||
|
||||
```bash
|
||||
laconic-so deployment --dir l2-nitro-deployment exec nitro-rpc-client "nitro-rpc-client get-all-ledger-channels -p 4005 -h nitro-node"
|
||||
|
||||
# Example output:
|
||||
# [
|
||||
# {
|
||||
# "ID": "0xb34210b763d4fdd534190ba11886ad1daa1e411c87be6fd20cff74cd25077c46",
|
||||
# "Status": "Open",
|
||||
# "Balances": [
|
||||
# {
|
||||
# "AssetAddress": "0xa4351114dae1abeb2d552d441c9733c72682a45d",
|
||||
# "Me": "0x075400039e303b3fb46c0cff0404c5fa61947c05",
|
||||
# "Them": "0xf0e6a85c6d23aca9ff1b83477d426ed26f218185",
|
||||
# "MyBalance": <updated balance>,
|
||||
# "TheirBalance": <updated balance>
|
||||
# },
|
||||
# {
|
||||
# "AssetAddress": "0x314e43f9825b10961859c2a62c2de6a765c1c1f1",
|
||||
# "Me": "0x075400039e303b3fb46c0cff0404c5fa61947c05",
|
||||
# "Them": "0xf0e6a85c6d23aca9ff1b83477d426ed26f218185",
|
||||
# "MyBalance": <updated balance>,
|
||||
# "TheirBalance": <updated balance>
|
||||
# }
|
||||
# ],
|
||||
# "ChannelMode": "Open"
|
||||
# }
|
||||
# ]
|
||||
```
|
||||
|
||||
## Clean up
|
||||
|
||||
* Switch to deployments dir:
|
||||
|
||||
```bash
|
||||
cd $DEPLOYMENTS_DIR/nitro-node
|
||||
```
|
||||
|
||||
* Stop all Nitro services running in the background:
|
||||
|
||||
```bash
|
||||
laconic-so deployment --dir l1-nitro-deployment stop
|
||||
laconic-so deployment --dir l2-nitro-deployment stop
|
||||
```
|
||||
|
||||
* To stop all services and also delete data:
|
||||
|
||||
```bash
|
||||
laconic-so deployment --dir l1-nitro-deployment stop --delete-volumes
|
||||
laconic-so deployment --dir l2-nitro-deployment stop --delete-volumes
|
||||
|
||||
# Remove deployment directories (deployments will have to be recreated for a re-run)
|
||||
sudo rm -r l1-nitro-deployment
|
||||
sudo rm -r l2-nitro-deployment
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
* Check the logs of nitro node to see if the objective is completed
|
||||
|
||||
```bash
|
||||
# To check logs of L1 nitro-node
|
||||
laconic-so deployment --dir l1-nitro-deployment logs nitro-node -f --tail 30
|
||||
|
||||
# To check logs of L2 nitro-node
|
||||
laconic-so deployment --dir l2-nitro-deployment logs nitro-node -f --tail 30
|
||||
```
|
||||
|
||||
* If the objective is completed, you can safely stop (`Ctrl+C`) the running CLI command and continue with the further instructions
|
||||
|
||||
* Stop (`Ctrl+C`) the direct-fund command if it is stuck
|
||||
|
||||
* Restart the L1 Nitro node:
|
||||
|
||||
* Stop the deployment:
|
||||
|
||||
```bash
|
||||
cd $DEPLOYMENTS_DIR/nitro-node
|
||||
|
||||
laconic-so deployment --dir l1-nitro-deployment stop
|
||||
```
|
||||
|
||||
* Reset the node's durable store:
|
||||
|
||||
```bash
|
||||
sudo rm -rf l1-nitro-deployment/data/nitro_node_data
|
||||
|
||||
mkdir l1-nitro-deployment/data/nitro_node_data
|
||||
```
|
||||
|
||||
* Restart the deployment:
|
||||
|
||||
```bash
|
||||
laconic-so deployment --dir l1-nitro-deployment start
|
||||
```
|
||||
|
||||
* Retry the ledger channel creation command
|
||||
@@ -879,7 +879,7 @@
|
||||
- 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 4006 -h nitro-bridge"
|
||||
laconic-so deployment --dir bridge-deployment exec nitro-rpc-client "nitro-rpc-client get-all-l2-channels -p 4005 -h nitro-bridge"
|
||||
```
|
||||
|
||||
- Set address of bridge and address of custom token on L1 in the current terminal
|
||||
@@ -952,7 +952,7 @@
|
||||
- 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 4006 -h nitro-bridge"
|
||||
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"}
|
||||
|
||||
Reference in New Issue
Block a user