testnet-ops/nitro-nodes-setup/README.md
2024-09-03 18:09:32 +05:30

68 lines
2.1 KiB
Markdown

# nitro-nodes-setup
## Setup Ansible
To get started, follow the [installation](../../README.md#installation) guide to setup ansible on your machine
## Run a nitro node
The following commands have to be executed in [`nitro-nodes-setup`](./) directory
- Copy the `nitro-vars-example.yml` vars file
```bash
cp nitro-vars-example.yml nitro-vars.yml
```
- Edit [`nitro-vars.yml`](./nitro-vars.yml) and fill in the following values
```bash
# L1 WS endpoint
l1_nitro_chain_url: ""
# L2 WS endpoint
l2_nitro_chain_url: ""
# Private key for your nitro address
nitro_sc_pk: ""
# Private key of the account on chain that is used for funding channels in Nitro node
nitro_chain_pk: ""
# Contract address of NitroAdjudicator
na_address: ""
# Contract address of VirtualPaymentApp
vpa_address: ""
# Contract address of ConsensusApp
ca_address: ""
# Address of the bridge node
bridge_contract_address: ""
# Multi address of the bridge node
nitro_bridge_multiaddr ""
# Multiaddr with publically accessible IP address / DNS for your nitro node
# Example: "/ip4/192.168.x.y/tcp/3009"
# Example: "/dns4/example.com/tcp/3009"
nitro_node_multiaddr: ""
```
- To run a nitro node, execute the `run-nitro-node.yml` Ansible playbook by running the following command.
NOTE: By default, deployments are created in the `nitro-nodes-setup/out` directory. To change this location, update the `nitro_directory` variable in the [setup-vars.yml](./setup-vars.yml) file.
```bash
LANG=en_US.utf8 ansible-playbook -i localhost, --connection=local run-nitro-node.yml --extra-vars='{ "target_host": "localhost"}' --user $USER
```
- For skipping container build, run with `"skip_container_build" : true` in the `--extra-vars` parameter:
```bash
LANG=en_US.utf8 ansible-playbook -i localhost, --connection=local run-nitro-node.yml --extra-vars='{ "target_host": "localhost", "skip_container_build": true }' --user $USER
```
- Follow steps from [Demo](https://git.vdb.to/cerc-io/nitro-stack/src/branch/main/nitro-bridge-demo.md#demo) to create mirror channels on L2, create virtual channel and make payments