testnet-ops/nitro-bridge-setup
2024-09-06 14:25:44 +05:30
..
templates/specs Add README steps to deploy nitro contracts 2024-09-06 11:40:03 +05:30
bridge-vars-example.yml Add README steps to deploy nitro contracts 2024-09-06 11:40:03 +05:30
contract-vars-example.yml Add README steps to deploy nitro contracts 2024-09-06 11:40:03 +05:30
deploy-contracts.yml Add README steps to deploy nitro contracts 2024-09-06 11:40:03 +05:30
README.md Update README 2024-09-06 14:25:44 +05:30
run-nitro-bridge.yml Decouple playbook to deploy nitro contracts 2024-09-05 19:03:33 +05:30
setup-vars.yml Add README for running bridge 2024-09-05 14:39:49 +05:30

nitro-bridge-setup

Setup Ansible

To get started, follow the 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

    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:

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

      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:

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