102 lines
3.1 KiB
Markdown
102 lines
3.1 KiB
Markdown
# nitro-bridge-setup
|
|
|
|
## Setup Ansible
|
|
|
|
To get started, follow the [installation](../README.md#installation) guide to setup ansible on your machine
|
|
|
|
## Setup for Remote Host
|
|
|
|
To run the playbook on a remote host:
|
|
|
|
- Follow steps from [setup remote hosts](../README.md#setup-remote-hosts)
|
|
|
|
- Update / append the [`hosts.ini`](../hosts.ini) file for your remote host with `<deployment_host>` set as `nitro_host`
|
|
|
|
## Run Nitro Bridge
|
|
|
|
- Copy the `bridge-vars-example.yml` vars file
|
|
|
|
```bash
|
|
cp bridge-vars-example.yml bridge-vars.yml
|
|
```
|
|
|
|
- Edit [`bridge-vars.yml`](./bridge-vars.yml) and fill in the following values
|
|
|
|
```bash
|
|
# L1 WS endpoint
|
|
nitro_l1_chain_url: ""
|
|
|
|
# L2 WS endpoint
|
|
nitro_l2_chain_url: ""
|
|
|
|
# Private key for the bridge's nitro address
|
|
nitro_sc_pk: ""
|
|
|
|
# Private key for a funded account on L1
|
|
# This account should have tokens for funding Nitro channels
|
|
nitro_chain_pk: ""
|
|
|
|
# L2 RPC endpoint
|
|
optimism_url: ""
|
|
|
|
# Private key for a funded account on L2 to use for contracts deployment on L2
|
|
# Use the same account for L1 and L2 deployments
|
|
optimism_deployer_pk: ""
|
|
|
|
# Custom L2 token to be deployed
|
|
token_name: "LaconicNetworkToken"
|
|
token_symbol: "LNT"
|
|
intial_token_supply: "129600"
|
|
|
|
# Addresses of the deployed nitro contracts
|
|
na_address: ""
|
|
vpa_address: ""
|
|
ca_address: ""
|
|
|
|
# Address of deployed custom L1 token
|
|
l1_asset_address: ""
|
|
```
|
|
|
|
- To run the nitro bridge, execute the `run-nitro-bridge.yml` Ansible playbook by running one of the following commands:
|
|
|
|
- For local deployment, specify the `"target_host": localhost` in the `--extra-vars` parameter:
|
|
|
|
```bash
|
|
LANG=en_US.utf8 ansible-playbook run-nitro-bridge.yml --extra-vars='{ "target_host": "localhost"}' --user $USER -kK
|
|
```
|
|
|
|
- For remote deployment, provide an inventory and specify the `"target_host": nitro_host` in the `--extra-vars` parameter:
|
|
|
|
```bash
|
|
LANG=en_US.utf8 ansible-playbook -i ./hosts.ini run-nitro-bridge.yml --extra-vars='{ "target_host": "nitro_host"}' --user $USER -kK
|
|
```
|
|
|
|
NOTE: By default, deployments are created in the `out` directory. To change this location, update the `nitro_directory` variable in the [setup-vars.yml](./setup-vars.yml) file.
|
|
|
|
- For skipping container build, run with `"skip_container_build" : true` in the `--extra-vars` parameter:
|
|
|
|
```bash
|
|
LANG=en_US.utf8 ansible-playbook -i ./hosts.ini run-nitro-bridge.yml --extra-vars='{ "target_host": "nitro_host", "skip_container_build": true }' --user $USER -kK
|
|
```
|
|
|
|
## Check Deployment Status
|
|
|
|
- Run the following command in the directory where the bridge-deployment is created:
|
|
|
|
- Check logs for deployments:
|
|
|
|
```bash
|
|
# Check the bridge deployment logs, ensure that the node is running
|
|
laconic-so deployment --dir bridge-deployment logs nitro-bridge -f
|
|
```
|
|
|
|
## Get Contract Addresses
|
|
|
|
- Run the following commands in the directory where the deployments are created:
|
|
|
|
- Get addresses of L2 nitro contracts:
|
|
|
|
```bash
|
|
laconic-so deployment --dir bridge-deployment exec nitro-bridge "cat /app/deployment/nitro-addresses.json"
|
|
```
|