testnet-ops/nitro-contracts-setup

nitro-contracts-setup

Setup Ansible

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

• Update / append the hosts.ini file for your remote host with <deployment_host> set as nitro_host

Deploy Nitro Contracts

The following commands have to be executed in nitro-contracts-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 one of the following commands:

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

    LANG=en_US.utf8 ansible-playbook deploy-contracts.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 deploy-contracts.yml --extra-vars='{ "target_host": "nitro_host"}' --user $USER -kK
    

  NOTE: By default, deployments are created in the nitro-contracts-setup/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 deploy-contracts.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 nitro-contracts-deployment is created:

  • Check logs for deployments:

    # Check the L2 nitro contract deployment logs
    laconic-so deployment --dir nitro-contracts-deployment logs l2-nitro-contracts -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"