diff --git a/README.md b/README.md index 59ba4eb..4031661 100644 --- a/README.md +++ b/README.md @@ -41,4 +41,4 @@ - [l2-setup](./l2-setup/README.md) - [nitro-node-setup](./nitro-nodes-setup/README.md) - [nitro-bridge-setup](./nitro-bridge-setup/README.md) -- [nitro-contracts-setup](./nitro-contracts-setup/) +- [nitro-contracts-setup](./nitro-contracts-setup/README.md) diff --git a/l2-setup/README.md b/l2-setup/README.md index 4525d89..60c7282 100644 --- a/l2-setup/README.md +++ b/l2-setup/README.md @@ -43,15 +43,15 @@ The following commands have to be executed in the [`l2-setup`](./) directory: - To setup and run L2 locally, execute the `run-optimism.yml` Ansible playbook: ```bash - LANG=en_US.utf8 ansible-playbook run-optimism.yml --extra-vars='{ "target_host": "localhost"}' -kK --user $USER + LANG=en_US.utf8 ansible-playbook run-optimism.yml --extra-vars='{ "target_host": "localhost"}' --user $USER -kK ``` - NOTE: By default, deployments are created in an `out` directory. To change this location, update the `l2_directory` variable in the [setup-vars.yml](./setup-vars.yml) file. + NOTE: By default, deployments are created in an `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 run-optimism.yml --extra-vars='{"target_host" : "localhost", "skip_container_build": true}' -kK + LANG=en_US.utf8 ansible-playbook run-optimism.yml --extra-vars='{"target_host" : "localhost", "skip_container_build": true}' --user $USER -kK ``` - To run using existing contracts deployment: @@ -61,7 +61,7 @@ The following commands have to be executed in the [`l2-setup`](./) directory: - Run the ansible playbook with `"existing_contracts_deployment": true` in the `--extra-vars` parameter: ```bash - LANG=en_US.utf8 ansible-playbook run-optimism.yml --extra-vars='{"target_host" : "localhost", "existing_contracts_deployment": true}' -kK + LANG=en_US.utf8 ansible-playbook run-optimism.yml --extra-vars='{"target_host" : "localhost", "existing_contracts_deployment": true}' --user $USER -kK ``` ## Setup and Run on Remote Host @@ -102,18 +102,18 @@ To run the playbook on a remote host: # } ``` -- Copy and edit the `l2-vars.yml` file as described in the Local Setup section. +- Copy and edit the `l2-vars.yml` file as described in the [local setup](./README.md#setup-and-run-l2-on-local-host) section - Execute the `run-optimism.yml` Ansible playbook for remote deployment: ```bash - LANG=en_US.utf8 ansible-playbook -i hosts.ini run-optimism.yml --extra-vars='{ "target_host": "l2_host"}' -kK + LANG=en_US.utf8 ansible-playbook -i hosts.ini run-optimism.yml --extra-vars='{ "target_host": "l2_host"}' --user $USER -kK ``` - 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" : "l2_host", "skip_container_build": true}' -kK + LANG=en_US.utf8 ansible-playbook -i hosts.ini run-optimism.yml --extra-vars='{"target_host" : "l2_host", "skip_container_build": true}' --user $USER -kK ``` - To run using existing contracts deployment: @@ -123,7 +123,7 @@ To run the playbook on a remote host: - 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" : "l2_host", "existing_contracts_deployment": true}' -kK + LANG=en_US.utf8 ansible-playbook -i hosts.ini run-optimism.yml --extra-vars='{"target_host" : "l2_host", "existing_contracts_deployment": true}' --user $USER -kK ``` ## Check Deployment Status diff --git a/nitro-bridge-setup/README.md b/nitro-bridge-setup/README.md index b4a540e..deec0f0 100644 --- a/nitro-bridge-setup/README.md +++ b/nitro-bridge-setup/README.md @@ -40,7 +40,7 @@ The following commands have to be executed in the [`nitro-bridge-setup`](./) dir # Custom L2 token to be deployed token_name: "LaconicNetworkToken" token_symbol: "LNT" - intial_token_supply: "129600" + initial_token_supply: "129600" # Addresses of the deployed nitro contracts na_address: "" @@ -54,15 +54,15 @@ The following commands have to be executed in the [`nitro-bridge-setup`](./) dir - To setup and run nitro bridge locally, execute the `run-nitro-bridge.yml` Ansible playbook: ```bash - LANG=en_US.utf8 ansible-playbook run-nitro-bridge.yml --extra-vars='{ "target_host": "localhost"}' -kK --user $USER + LANG=en_US.utf8 ansible-playbook run-nitro-bridge.yml --extra-vars='{ "target_host": "localhost"}' --user $USER -kK ``` - 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. + 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, set `"skip_container_build" : true` in the `--extra-vars` parameter: ```bash - LANG=en_US.utf8 ansible-playbook run-nitro-bridge.yml --extra-vars='{"target_host" : "localhost", "skip_container_build": true}' -kK --user $USER + LANG=en_US.utf8 ansible-playbook run-nitro-bridge.yml --extra-vars='{"target_host" : "localhost", "skip_container_build": true}' --user $USER -kK ``` ## Setup and Run Nitro Bridge on Remote Host @@ -103,12 +103,12 @@ To run the playbook on a remote host: # } ``` -- Copy and edit the `bridge-vars.yml` file as described in the Local Setup section. +- Copy and edit the `bridge-vars.yml` file as described in the [local setup](./README.md#setup-and-run-nitro-bridge-on-local-host) section - Execute the `run-nitro-bridge.yml` Ansible playbook for remote deployment: ```bash - LANG=en_US.utf8 ansible-playbook -i hosts.ini run-nitro-bridge.yml --extra-vars='{ "target_host": "nitro_host"}' -kK + LANG=en_US.utf8 ansible-playbook -i hosts.ini run-nitro-bridge.yml --extra-vars='{ "target_host": "nitro_host"}' --user $USER -kK ``` - For skipping container build, run with `"skip_container_build" : true` in the `--extra-vars` parameter: diff --git a/nitro-bridge-setup/bridge-vars.example.yml b/nitro-bridge-setup/bridge-vars.example.yml index e23f237..be1b0ad 100644 --- a/nitro-bridge-setup/bridge-vars.example.yml +++ b/nitro-bridge-setup/bridge-vars.example.yml @@ -7,7 +7,7 @@ optimism_url: "" optimism_deployer_pk: "" token_name: "LaconicNetworkToken" token_symbol: "LNT" -intial_token_supply: "129600" +initial_token_supply: "129600" na_address: "" vpa_address: "" ca_address: "" diff --git a/nitro-bridge-setup/templates/specs/bridge-nitro-spec.yml.j2 b/nitro-bridge-setup/templates/specs/bridge-nitro-spec.yml.j2 index a75fa0e..9d2fd05 100644 --- a/nitro-bridge-setup/templates/specs/bridge-nitro-spec.yml.j2 +++ b/nitro-bridge-setup/templates/specs/bridge-nitro-spec.yml.j2 @@ -10,7 +10,7 @@ config: OPTIMISM_DEPLOYER_PK: {{ optimism_deployer_pk }} TOKEN_NAME: {{ token_name }} TOKEN_SYMBOL: {{ token_symbol }} - INITIAL_TOKEN_SUPPLY: {{ intial_token_supply }} + INITIAL_TOKEN_SUPPLY: {{ initial_token_supply }} NA_ADDRESS: "{{ na_address }}" VPA_ADDRESS: "{{ vpa_address }}" CA_ADDRESS: "{{ ca_address }}" diff --git a/nitro-contracts-setup/README.md b/nitro-contracts-setup/README.md index 56ae2c8..9d1b40f 100644 --- a/nitro-contracts-setup/README.md +++ b/nitro-contracts-setup/README.md @@ -29,21 +29,21 @@ The following commands have to be executed in the [`nitro-contracts-setup`](./) # Custom L1 token to be deployed token_name: "LaconicNetworkToken" token_symbol: "LNT" - intial_token_supply: "129600" + initial_token_supply: "129600" ``` - To deploy nitro contracts locally, execute the `deploy-contracts.yml` Ansible playbook: ```bash - LANG=en_US.utf8 ansible-playbook deploy-contracts.yml --extra-vars='{ "target_host": "localhost"}' -kK --user $USER + LANG=en_US.utf8 ansible-playbook deploy-contracts.yml --extra-vars='{ "target_host": "localhost"}' --user $USER -kK ``` - 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. + 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, set `"skip_container_build" : true` in the `--extra-vars` parameter: ```bash - LANG=en_US.utf8 ansible-playbook deploy-contracts.yml --extra-vars='{"target_host" : "localhost", "skip_container_build": true}' -kK --user $USER + LANG=en_US.utf8 ansible-playbook deploy-contracts.yml --extra-vars='{"target_host" : "localhost", "skip_container_build": true}' --user $USER -kK ``` ## Deploy Nitro Contracts on Remote Host @@ -84,12 +84,12 @@ To run the playbook on a remote host: # } ``` -- Copy and edit the [`contract-vars.yml`](./contract-vars.yml) file as described in the Local Setup section +- Copy and edit the [`contract-vars.yml`](./contract-vars.yml) file as described in the [local setup](./README.md#deploy-nitro-contracts-on-local-host) section - Execute the `deploy-contracts.yml` Ansible playbook for remote deployment: ```bash - LANG=en_US.utf8 ansible-playbook -i hosts.ini deploy-contracts.yml --extra-vars='{ "target_host": "nitro_host"}' -kK + LANG=en_US.utf8 ansible-playbook -i hosts.ini deploy-contracts.yml --extra-vars='{ "target_host": "nitro_host"}' --user $USER -kK ``` - For skipping container build, run with `"skip_container_build" : true` in the `--extra-vars` parameter: diff --git a/nitro-contracts-setup/contract-vars.example.yml b/nitro-contracts-setup/contract-vars.example.yml index 3fe4834..2999432 100644 --- a/nitro-contracts-setup/contract-vars.example.yml +++ b/nitro-contracts-setup/contract-vars.example.yml @@ -3,4 +3,4 @@ geth_chain_id: "" geth_deployer_pk: "" token_name: "" token_symbol: "" -intial_token_supply: "" +initial_token_supply: "" diff --git a/nitro-contracts-setup/templates/specs/nitro-contracts-spec.yml.j2 b/nitro-contracts-setup/templates/specs/nitro-contracts-spec.yml.j2 index 9c2f4ad..c5fb23b 100644 --- a/nitro-contracts-setup/templates/specs/nitro-contracts-spec.yml.j2 +++ b/nitro-contracts-setup/templates/specs/nitro-contracts-spec.yml.j2 @@ -6,7 +6,7 @@ config: GETH_DEPLOYER_PK: {{ geth_deployer_pk }} TOKEN_NAME: {{ token_name }} TOKEN_SYMBOL: {{ token_symbol }} - INITIAL_TOKEN_SUPPLY: {{ intial_token_supply }} + INITIAL_TOKEN_SUPPLY: {{ initial_token_supply }} network: ports: {} volumes: diff --git a/nitro-nodes-setup/README.md b/nitro-nodes-setup/README.md index 2bf819a..1df90ef 100644 --- a/nitro-nodes-setup/README.md +++ b/nitro-nodes-setup/README.md @@ -67,15 +67,15 @@ The following commands have to be executed in [`nitro-nodes-setup`](./) director - To run a nitro node, execute the `run-nitro-nodes.yml` Ansible playbook by running the following command: ```bash - LANG=en_US.utf8 ansible-playbook run-nitro-nodes.yml --extra-vars='{ "target_host": "localhost"}' -kK --user $USER + LANG=en_US.utf8 ansible-playbook run-nitro-nodes.yml --extra-vars='{ "target_host": "localhost"}' --user $USER -kK ``` - NOTE: By default, deployments are created in a `out` directory. To change this location, update the `nitro_directory` variable in the [setup-vars.yml](./setup-vars.yml) file. + NOTE: By default, deployments are created in a `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 run-nitro-nodes.yml --extra-vars='{ "target_host": "nitro_host", "skip_container_build": true }' -kK --user $USER + LANG=en_US.utf8 ansible-playbook -i hosts.ini run-nitro-nodes.yml --extra-vars='{ "target_host": "nitro_host", "skip_container_build": true }' --user $USER -kK ``` ## Run Nitro Node on Remote Host @@ -116,12 +116,12 @@ To run the playbook on a remote host: # } ``` -- Copy and edit the [`nitro-vars.yml`](./nitro-vars.yml) file as described in the Local Setup section +- Copy and edit the [`nitro-vars.yml`](./nitro-vars.yml) file as described in the [local setup](./README.md#run-nitro-node-on-local-host) section - Execute the `run-nitro-nodes.yml` Ansible playbook for remote deployment: ```bash - LANG=en_US.utf8 ansible-playbook -i hosts.ini run-nitro-nodes.yml --extra-vars='{ "target_host": "nitro_host"}' -kK --user $USER + LANG=en_US.utf8 ansible-playbook -i hosts.ini run-nitro-nodes.yml --extra-vars='{ "target_host": "nitro_host"}' --user $USER -kK ``` - For skipping container build, run with `"skip_container_build" : true` in the `--extra-vars` parameter: