testnet-ops/l2-setup/README.md

# l2-setup

## Setup Ansible

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

## Setup Remote Hosts

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

- In the [`l2-setup`](./) directory, create a new file named hosts.ini:

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

- Edit the [`hosts.ini`](./hosts.ini) file to run the playbook on a remote machine

   ```bash
  [nitro_host]
  <host_name> ansible_host=<TARGET_IP> ansible_user=<SSH_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

  ```bash
  ansible all -m ping -i hosts.ini -k

  # Expected output:

  # <host_name> | SUCCESS => {
  #  "ansible_facts": {
  #      "discovered_interpreter_python": "/usr/bin/python3.10"
  #  },
  #  "changed": false,
  #  "ping": "pong"
  # }
  ```

## Setup and Run Optimism

The following commands have to be executed in [`l2-setup`](./) directory

- Copy the `l2-vars-example.yml` vars file

  ```bash
  cp l2-vars-example.yml l2-vars.yml
  ```

- Edit [`l2-vars.yml`](./l2-vars.yml) with the required values

  ```bash
  # L1 chain ID
  l1_chain_id: ""

  # L1 RPC endpoint
  l1_rpc: ""

  # L1 RPC endpoint host or IP address
  l1_host: ""

  # L1 RPC endpoint port number
  l1_port: ""

  # L1 Beacon endpoint
  l1_beacon: ""

  # Address of the funded account on L1
  # Used for optimism contracts deployment
  l1_address: ""

  # Private key of the funded account on L1
  l1_priv_key: ""
  ```

- To setup and run L2, execute the `run-optimism.yml` Ansible playbook by running one of the following commands:

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

    ```bash
    LANG=en_US.utf8 ansible-playbook run-optimism.yml --extra-vars='{ "target_host": "localhost"}' -kK --user $USER
    ```

  - For remote deployment, provide an inventory and specify the `"target_host": nitro_host` in the `--extra-vars` parameter:

    ```bash
    LANG=en_US.utf8 ansible-playbook -i ./hosts.ini run-optimism.yml --extra-vars='{ "target_host": "nitro_host"}' -kK
    ```

    NOTE: By default, deployments are created in a `out` directory. To change this location, update the `l2_directory` variable in the [setup-vars.yml](./setup-vars.yml) file.

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

    ```bash
    LANG=en_US.utf8 ansible-playbook -i ./hosts.ini run-optimism.yml --extra-vars='{"target_host" : "nitro_host", "skip_container_build": true}' -kK
    ```

- To run using existing contracts deployment

  - Update `artifact_path` in [`setup-vars.yml`](./setup-vars.yml) file with path to data directory of the existing deployment

  - Run the ansible playbook with `"existing_contracts_deployment": true` in the `--extra-vars` parameter:

    ```bash
    LANG=en_US.utf8 ansible-playbook -i ./hosts.ini run-optimism.yml --extra-vars='{"target_host" : "nitro_host", "existing_contracts_deployment":  true}' -kK
    ```

## Check Deployment Status

- Run the following command in the directory where the optimism-deployment is created

  - Follow optimism contracts deployment logs:

    ```bash
    laconic-so deployment --dir optimism-deployment logs -f fixturenet-optimism-contracts
    ```

  - Check L2 logs:

    ```bash
    laconic-so deployment --dir optimism-deployment logs -f op-geth

    # Ensure new blocks are getting created
    ```