testnet-ops/nitro-bridge-setup/README.md

# nitro-bridge-setup

## Setup Ansible

To get started, follow the [installation](../README.md#installation) guide to setup ansible on your machine

## Deploy nitro contracts

The following commands have to be executed in [`nitro-bridge-setup`](./) directory

- 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
  # L1 RPC endpoint
  geth_url: ""

  # L1 chain ID (Sepolia: 11155111)
  geth_chain_id: ""

  # Private key for a funded account on L1 to use for contracts deployment on L1
  geth_deployer_pk: ""

  # Custom L1 token to be deployed
  token_name: "LaconicNetworkToken"
  token_symbol: "LNT"
  intial_token_supply: "129600"
  ```

- To deploy the L1 nitro contracts, execute the `deploy-contracts.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 deploy-contracts.yml --extra-vars='{ "target_host": "localhost"}' --user $USER -kK
  ```

  - 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 deploy-contracts.yml --extra-vars='{ "target_host": "localhost", "skip_container_build": true }' --user $USER -kK
    ```

## 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: ""

  # L1 chain ID (Sepolia: 11155111)
  geth_chain_id: "11155111"

  # L1 RPC endpoint
  geth_url: ""

  # 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: ""

  # Details of deployed custom L1 token
  token_name: "LaconicNetworkToken"
  token_symbol: "LNT"
  intial_token_supply: "129600"

  # Addresses of the deployed nitro contracts
  na_address: ""
  vpa_address: ""
  ca_address: ""
  l1_asset_address: ""
  ```

- To run the nitro bridge, execute the `run-nitro-bridge.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-bridge.yml --extra-vars='{ "target_host": "localhost"}' --user $USER -kK
  ```

  - 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-bridge.yml --extra-vars='{ "target_host": "localhost", "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 L2 nitro contract deployment logs
    laconic-so deployment --dir bridge-deployment logs l2-nitro-contracts -f

    # 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 L1 nitro contracts:

    ```bash
    laconic-so deployment --dir nitro-contracts-deployment exec nitro-contracts "cat /app/deployment/nitro-addresses.json"
    ```

  - Get addresses of L2 nitro contracts:

    ```bash
    laconic-so deployment --dir bridge-deployment exec nitro-bridge "cat /app/deployment/nitro-addresses.json"
    ```