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

# nitro-contracts-setup

## Prerequisites

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

- Setup user with passwordless sudo: Follow steps from [Setup a user](../user-setup/README.md#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

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

   ```bash
   cp ../hosts.example.ini hosts.ini
   ```

- Edit the [`hosts.ini`](./hosts.ini) file:

  ```ini
  [<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

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

  ```bash
  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](./setup-vars.yml) file

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

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

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

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