Update README

This commit is contained in:
Adw8 2024-09-06 14:24:55 +05:30
parent 60b681bfea
commit f4a3e0c497

View File

@ -4,7 +4,7 @@
To get started, follow the [installation](../README.md#installation) guide to setup ansible on your machine
## Deploy nitro contracts
## Deploy Nitro Contracts
The following commands have to be executed in [`nitro-bridge-setup`](./) directory
@ -20,7 +20,7 @@ The following commands have to be executed in [`nitro-bridge-setup`](./) directo
# L1 RPC endpoint
geth_url: ""
# L1 chain ID (Sepolia: 11155111)
# L1 chain ID
geth_chain_id: ""
# Private key for a funded account on L1 to use for contracts deployment on L1
@ -46,7 +46,7 @@ The following commands have to be executed in [`nitro-bridge-setup`](./) directo
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
## Run Nitro Bridge
- Copy the `bridge-vars-example.yml` vars file
@ -70,8 +70,8 @@ The following commands have to be executed in [`nitro-bridge-setup`](./) directo
# This account should have tokens for funding Nitro channels
nitro_chain_pk: ""
# L1 chain ID (Sepolia: 11155111)
geth_chain_id: "11155111"
# L1 chain ID
geth_chain_id: ""
# L1 RPC endpoint
geth_url: ""
@ -83,7 +83,7 @@ The following commands have to be executed in [`nitro-bridge-setup`](./) directo
# Use the same account for L1 and L2 deployments
optimism_deployer_pk: ""
# Details of deployed custom L1 token
# Custom L2 token to be deployed
token_name: "LaconicNetworkToken"
token_symbol: "LNT"
intial_token_supply: "129600"
@ -92,6 +92,8 @@ The following commands have to be executed in [`nitro-bridge-setup`](./) directo
na_address: ""
vpa_address: ""
ca_address: ""
# Address of deployed custom L1 token
l1_asset_address: ""
```