testnet-ops/nitro-bridge-setup

nitro-bridge-setup

Setup Ansible

To get started, follow the installation guide to setup ansible on your machine

Setup Remote Hosts

To run the playbooks on a remote machine, follow these steps:

• In the nitro-bridge-setup directory, create a new file named hosts.ini:

  cp ../example-hosts.ini hosts.ini
  

• Edit the hosts.ini file to run the playbook on a remote machine

  [nitro_host]
  hostname ansible_host= ansible_user= ansible_ssh_common_args='-o ForwardAgent=yes'
  

  • 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

  ansible all -m ping -i hosts.ini
  

Deploy Nitro Contracts

The following commands have to be executed in nitro-bridge-setup directory

• Copy the contract-vars-example.yml vars file

  cp contract-vars-example.yml contract-vars.yml
  

• Edit contract-vars.yml and fill in the following values

  # L1 RPC endpoint
  geth_url: ""
  
  # L1 chain ID
  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 file.

  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:

    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

  cp bridge-vars-example.yml bridge-vars.yml
  

• Edit bridge-vars.yml and fill in the following values

  # 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
  geth_chain_id: ""
  
  # 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: ""
  
  # 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 the following command:

  • For local deployment, specify the "target_host": localhost in the --extra-vars parameter:

    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:

    LANG=en_US.utf8 ansible-playbook -i ./hosts.ini run-nitro-bridge.yml --extra-vars='{ "target_host": "localhost"}' --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 file.

  • For skipping container build, run with "skip_container_build" : true in the --extra-vars parameter:

    LANG=en_US.utf8 ansible-playbook -i ./hosts.ini 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:

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

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

  • Get addresses of L2 nitro contracts:

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