nitro-bridge-setup/README.md

@@ -4,10 +4,50 @@
 
 To get started, follow the [installation](../README.md#installation) guide to setup ansible on your machine
 
-## Run nitro bridge
+## Deploy nitro contracts
 
 The following commands have to be executed in [`nitro-bridge-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 (Sepolia: 11155111)
+  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](./setup-vars.yml) file.
+
+  ```bash
+  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:
+
+    ```bash
+    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
 
   ```bash
@@ -39,15 +79,23 @@ The following commands have to be executed in [`nitro-bridge-setup`](./) directo
   # L2 RPC endpoint
   optimism_url: ""
 
-  # Private key for a funded account on L1 to use for contracts deployment on L1
-  geth_deployer_pk: ""
-
   # 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: ""
+
+  # Details of deployed custom L1 token
+  token_name: "LaconicNetworkToken"
+  token_symbol: "LNT"
+  intial_token_supply: "129600"
+
+  # Addresses of the deployed nitro contracts
+  na_address: ""
+  vpa_address: ""
+  ca_address: ""
+  l1_asset_address: ""
   ```
 
-- To run the nitro bridge, execute the `run-nitro-bridge.yml` Ansible playbook by running the following command.
+- 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](./setup-vars.yml) file.
 
@@ -68,10 +116,10 @@ The following commands have to be executed in [`nitro-bridge-setup`](./) directo
   - Check logs for deployments:
 
     ```bash
-    # Check the l2 nitro contract deployments
+    # Check the L2 nitro contract deployment logs
     laconic-so deployment --dir bridge-deployment logs l2-nitro-contracts -f
 
-    # Check the logs, ensure that the node is running
+    # Check the bridge deployment logs, ensure that the node is running
     laconic-so deployment --dir bridge-deployment logs nitro-bridge -f
     ```
 

nitro-bridge-setup/bridge-vars-example.yml

@@ -5,7 +5,6 @@ nitro_sc_pk: ""
 geth_chain_id: ""
 geth_url: ""
 optimism_url: ""
-geth_deployer_pk: ""
 optimism_deployer_pk: ""
 token_name: "LaconicNetworkToken"
 token_symbol: "LNT"

nitro-bridge-setup/contract-vars-example.yml

@@ -0,0 +1,6 @@
+geth_url: ""
+geth_chain_id: ""
+geth_deployer_pk: ""
+token_name: ""
+token_symbol: ""
+intial_token_supply: ""

nitro-bridge-setup/deploy-contracts.yml

@@ -3,7 +3,7 @@
 
   vars_files:
     - setup-vars.yml
-    - bridge-vars.yml
+    - contract-vars.yml
 
   environment:
     PATH: "{{ ansible_env.PATH }}:/home/{{ansible_user}}/bin"

nitro-bridge-setup/templates/specs/bridge-nitro-spec.yml.j2

@@ -9,8 +9,8 @@ config:
   OPTIMISM_URL: {{ optimism_url }}
   OPTIMISM_DEPLOYER_PK: {{ optimism_deployer_pk }}
   TOKEN_NAME: {{ token_name }}
-  TOKEN_SYMBOL: LNT
+  TOKEN_SYMBOL: {{ token_symbol }}
-  INITIAL_TOKEN_SUPPLY: 129600
+  INITIAL_TOKEN_SUPPLY: {{ token_symbol }}
   NA_ADDRESS: {{ na_address }}
   VPA_ADDRESS: {{ vpa_address }}
   CA_ADDRESS: {{ ca_address }}