testnet-ops/nitro-contracts-setup/README.md
nabarun 65be098ce9 Add steps to clean up service provider setup (#14)
Part of [Service Provider Setup](https://www.notion.so/Service-provider-setup-a09e2207e1f34f3a847f7ce9713b7ac5)
- Move user setup playbook to separate directory
- Remove unneeded variables

Co-authored-by: Adw8 <adwaitgharpure@gmail.com>
Reviewed-on: cerc-io/testnet-ops#14
2024-10-23 06:53:07 +00:00

3.1 KiB

nitro-contracts-setup

Prerequisites

  • Setup Ansible: To get started, follow the installation guide to setup ansible on your machine.

  • Setup user with passwordless sudo: Follow steps from Setup a user to setup a new user with passwordless sudo

Setup

The following commands have to be executed in the 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: "TestToken"
    token_symbol: "TST"
    initial_token_supply: "129600"
    

Deploy Contracts

  • Create a new hosts.ini file:

    cp ../hosts.example.ini hosts.ini
    
  • Edit the hosts.ini file:

    [<deployment_host>]
    <host_name> ansible_host=<target_ip> ansible_user=<ssh_user> ansible_ssh_common_args='-o ForwardAgent=yes'
    
    • Replace <deployment_host> with nitro_host
    • 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 username of the user that you set up on target machine (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
    
    # Expected output:
    
    # <host_name> | SUCCESS => {
    #  "ansible_facts": {
    #      "discovered_interpreter_python": "/usr/bin/python3.10"
    #  },
    #  "changed": false,
    #  "ping": "pong"
    # }
    
  • Execute the deploy-contracts.yml Ansible playbook to deploy nitro contracts:

    LANG=en_US.utf8 ansible-playbook -i hosts.ini deploy-contracts.yml --extra-vars='{ "target_host": "nitro_host"}'  --user $USER
    

    NOTE: By default, deployments are created in an 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": "nitro_host", "skip_container_build": true }' --user $USER
    

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"