Add comments for values in bridge-vars file

This commit is contained in:
Neeraj 2024-09-11 14:51:47 +05:30
parent 98c502a882
commit 32b0b9ee52
2 changed files with 23 additions and 17 deletions

View File

@ -12,10 +12,6 @@
## Prerequisites ## Prerequisites
* On deployments VM(s):
* laconic-so: see [installation](https://git.vdb.to/cerc-io/stack-orchestrator#install)
* Local: * Local:
* Clone the `cerc-io/testnet-ops` repository: * Clone the `cerc-io/testnet-ops` repository:
@ -26,6 +22,10 @@
* Ansible: see [installation](https://git.vdb.to/cerc-io/testnet-ops#installation) * Ansible: see [installation](https://git.vdb.to/cerc-io/testnet-ops#installation)
* On deployments VM(s):
* laconic-so: see [installation](https://git.vdb.to/cerc-io/testnet-ops/src/branch/main/stack-orchestrator-setup/README.md)
<details open> <details open>
<summary>L2 Optimism</summary> <summary>L2 Optimism</summary>
@ -354,7 +354,7 @@
* Create the required vars file: * Create the required vars file:
```bash ```bash
cp bridge-vars-example.yml bridge-vars.yml cp bridge-vars.example.yml bridge-vars.yml
``` ```
* Edit `bridge-vars.yml` with required values: * Edit `bridge-vars.yml` with required values:
@ -373,21 +373,28 @@
# This account should have L1 tokens for funding Nitro channels # This account should have L1 tokens for funding Nitro channels
nitro_chain_pk: "" nitro_chain_pk: ""
# L1 chain ID (Sepolia: 11155111) # L2 chain ID (Optimism: 42069)
geth_chain_id: "11155111" optimism_chain_id: "42069"
# L1 RPC endpoint
geth_url: "https://sepolia.laconic.com"
# L2 RPC endpoint # L2 RPC endpoint
optimism_url: "https://optimism.laconic.com" optimism_url: "https://optimism.laconic.com"
# Private key for a funded account for L1 contracts deployment
geth_deployer_pk: ""
# Private key for a funded account for L2 contracts deployment # Private key for a funded account for L2 contracts deployment
# Use the same account for L1 and L2 deployments # Use the same account for L1 and L2 deployments
optimism_deployer_pk: "" optimism_deployer_pk: ""
# Custom L2 token to be deployed
token_name: ""
token_symbol: ""
intial_token_supply: ""
# Deployed L1 Nitro contract addresses
na_address: ""
vpa_address: ""
ca_address: ""
# Deployed L1 token address
l1_asset_address: ""
``` ```
* Update the target dir in `setup-vars.yml`: * Update the target dir in `setup-vars.yml`:
@ -1171,7 +1178,6 @@ https://loro-signup.laconic.com -> 3000
https://wallet.laconic.com -> 5000 https://wallet.laconic.com -> 5000
https://loro-console.laconic.com -> 4001 https://loro-console.laconic.com -> 4001
# Machine 2 # Machine 2
https://sepolia.laconic.com -> 8545 https://sepolia.laconic.com -> 8545
wss://sepolia.laconic.com -> 8546 wss://sepolia.laconic.com -> 8546

View File

@ -86,16 +86,16 @@
## Run ## Run
* Setup and run a Nitro node (L1+L2) by executing the `run-nitro-node.yml` Ansible playbook: * Setup and run a Nitro node (L1+L2) by executing the `run-nitro-nodes.yml` Ansible playbook:
```bash ```bash
LANG=en_US.utf8 ansible-playbook -i localhost, --connection=local run-nitro-node.yml --extra-vars='{ "target_host": "localhost"}' --user $USER LANG=en_US.utf8 ansible-playbook -i localhost, --connection=local run-nitro-nodes.yml --extra-vars='{ "target_host": "localhost"}' --user $USER
``` ```
* For skipping container build, run with `"skip_container_build" : true`: * For skipping container build, run with `"skip_container_build" : true`:
```bash ```bash
LANG=en_US.utf8 ansible-playbook -i localhost, --connection=local run-nitro-node.yml --extra-vars='{ "target_host": "localhost", "skip_container_build": true }' --user $USER LANG=en_US.utf8 ansible-playbook -i localhost, --connection=local run-nitro-nodes.yml --extra-vars='{ "target_host": "localhost", "skip_container_build": true }' --user $USER
``` ```
* Check status: * Check status: