From 3bacfb402570f21bc27d25acbd28edce380163ad Mon Sep 17 00:00:00 2001 From: IshaVenikar Date: Fri, 19 Jul 2024 09:49:32 +0530 Subject: [PATCH] Fix indentation --- .../stacks/testnet-laconicd/README.md | 11 ++ testnet-onboarding-demo.md | 166 +++++++++--------- 2 files changed, 94 insertions(+), 83 deletions(-) diff --git a/stack-orchestrator/stacks/testnet-laconicd/README.md b/stack-orchestrator/stacks/testnet-laconicd/README.md index 7ab058f..28664b6 100644 --- a/stack-orchestrator/stacks/testnet-laconicd/README.md +++ b/stack-orchestrator/stacks/testnet-laconicd/README.md @@ -30,6 +30,8 @@ Instructions for running a laconicd testnet full node and joining as a validator # laconic cli and console laconic-so --stack ~/cerc/testnet-laconicd-stack/stack-orchestrator/stacks/laconic-console setup-repositories --pull + + # If this throws an error as a result of being already checked out to a branch/tag in a repo, remove the repositories and re-run the command ``` * Build the container images: @@ -216,7 +218,10 @@ laconic-so deployment --dir laconic-console-deployment start * Create required validator configuration: ```bash + # Note: # Edit the staking amount and other fields as required + # Replace with your node's moniker for "moniker" field and the file name in command below + laconic-so deployment --dir testnet-laconicd-deployment exec laconicd 'cat < -validator.json { "pubkey": $(laconicd cometbft show-validator), @@ -256,6 +261,12 @@ laconic-so deployment --dir laconic-console-deployment start # Set your PK as 'userKey' in the config file laconic-so deployment --dir laconic-console-deployment exec cli "nano config.yml" + # services: + # registry: + # ... + # userKey: + # ... + # Note: any changes made to the config will be lost when the cli Docker container is brought down # So set / update the values in 'laconic-console-deployment/config.env' accordingly before restarting ``` diff --git a/testnet-onboarding-demo.md b/testnet-onboarding-demo.md index 01336e8..410a8d8 100644 --- a/testnet-onboarding-demo.md +++ b/testnet-onboarding-demo.md @@ -403,33 +403,33 @@ - In `l1alice-nitro-deployment/config.env` file, set the following env variable: ```bash - # URL endpoint of the chain - CERC_NITRO_CHAIN_URL=ws://host.docker.internal:8546 + # URL endpoint of the chain + CERC_NITRO_CHAIN_URL=ws://host.docker.internal:8546 - # Private key of account to be used by Nitro node (derived address is used as Nitro address) - # Note: Enter PKs without the leading `0x` - CERC_NITRO_PK="" + # Private key of account to be used by Nitro node (derived address is used as Nitro address) + # Note: Enter PKs without the leading `0x` + CERC_NITRO_PK="" - # Private key of the account on chain that is used for funding channels in Nitro node - CERC_NITRO_CHAIN_PK=570b909da9669b2f35a0b1ac70b8358516d55ae1b5b3710e95e9a94395090597 + # Private key of the account on chain that is used for funding channels in Nitro node + CERC_NITRO_CHAIN_PK=570b909da9669b2f35a0b1ac70b8358516d55ae1b5b3710e95e9a94395090597 - # Port to be used by P2P message service - CERC_NITRO_MSG_PORT=3007 + # Port to be used by P2P message service + CERC_NITRO_MSG_PORT=3007 - # Port to be used by RPC server - CERC_NITRO_RPC_PORT=4007 + # Port to be used by RPC server + CERC_NITRO_RPC_PORT=4007 - # Optional - # Contract addresses of NitroAdjudicator, VirtualPaymentApp and ConsensusApp - # TODO: Contracts are deployed if addresses are not set - CERC_NA_ADDRESS=0xb2592723B09F42937543f199A305ea6576dCb506 - CERC_VPA_ADDRESS=0x198c6643f7750c2569C3468E16750a8E8504E2c7 - CERC_CA_ADDRESS=0x198A8F1F14ACe1662fB2E5BE63A1de2308DE4CC7 + # Optional + # Contract addresses of NitroAdjudicator, VirtualPaymentApp and ConsensusApp + # TODO: Contracts are deployed if addresses are not set + CERC_NA_ADDRESS=0xb2592723B09F42937543f199A305ea6576dCb506 + CERC_VPA_ADDRESS=0x198c6643f7750c2569C3468E16750a8E8504E2c7 + CERC_CA_ADDRESS=0x198A8F1F14ACe1662fB2E5BE63A1de2308DE4CC7 - # Public IP of the nitro-node - CERC_PUBLIC_IP=/ip4/127.0.0.1/tcp/3005/p2p/16Uiu2HAmJDxLM8rSybX78FH51iZq9PdrwCoCyyHRBCndNzcAYMes + # Public IP of the nitro-node + CERC_PUBLIC_IP=/ip4/127.0.0.1/tcp/3005/p2p/16Uiu2HAmJDxLM8rSybX78FH51iZq9PdrwCoCyyHRBCndNzcAYMes - USE_DURABLE_STORE=true + USE_DURABLE_STORE=true ``` 5. Create a deployment for Charlie's L1 nitro-node: @@ -461,34 +461,34 @@ - In `l1charlie-nitro-deployment/config.env` file, set the following env variable: ```bash - # URL endpoint of the chain - CERC_NITRO_CHAIN_URL=ws://host.docker.internal:8546 + # URL endpoint of the chain + CERC_NITRO_CHAIN_URL=ws://host.docker.internal:8546 - # Private key of account to be used by Nitro node (derived address is used as Nitro address) - # Note: Enter PKs without the leading `0x` - CERC_NITRO_PK="" + # Private key of account to be used by Nitro node (derived address is used as Nitro address) + # Note: Enter PKs without the leading `0x` + CERC_NITRO_PK="" - # Private key of the account on chain that is used for funding channels in Nitro node - CERC_NITRO_CHAIN_PK=111b7500bdce494d6f4bcfe8c2a0dde2ef92f751d9070fac6475dbd6d8021b3f + # Private key of the account on chain that is used for funding channels in Nitro node + CERC_NITRO_CHAIN_PK=111b7500bdce494d6f4bcfe8c2a0dde2ef92f751d9070fac6475dbd6d8021b3f - # Port to be used by P2P message service - CERC_NITRO_MSG_PORT=3009 - # Port to be used by RPC server - CERC_NITRO_RPC_PORT=4009 + # Port to be used by P2P message service + CERC_NITRO_MSG_PORT=3009 + # Port to be used by RPC server + CERC_NITRO_RPC_PORT=4009 - # Optional - # Contract addresses of NitroAdjudicator, VirtualPaymentApp and ConsensusApp - # TODO: Contracts are deployed if addresses are not set - CERC_NA_ADDRESS=0xb2592723B09F42937543f199A305ea6576dCb506 - CERC_VPA_ADDRESS=0x198c6643f7750c2569C3468E16750a8E8504E2c7 - CERC_CA_ADDRESS=0x198A8F1F14ACe1662fB2E5BE63A1de2308DE4CC7 + # Optional + # Contract addresses of NitroAdjudicator, VirtualPaymentApp and ConsensusApp + # TODO: Contracts are deployed if addresses are not set + CERC_NA_ADDRESS=0xb2592723B09F42937543f199A305ea6576dCb506 + CERC_VPA_ADDRESS=0x198c6643f7750c2569C3468E16750a8E8504E2c7 + CERC_CA_ADDRESS=0x198A8F1F14ACe1662fB2E5BE63A1de2308DE4CC7 - # Public IP of the nitro-node - CERC_PUBLIC_IP=/ip4/127.0.0.1/tcp/3005/p2p/16Uiu2HAmJDxLM8rSybX78FH51iZq9PdrwCoCyyHRBCndNzcAYMes + # Public IP of the nitro-node + CERC_PUBLIC_IP=/ip4/127.0.0.1/tcp/3005/p2p/16Uiu2HAmJDxLM8rSybX78FH51iZq9PdrwCoCyyHRBCndNzcAYMes - USE_DURABLE_STORE=true + USE_DURABLE_STORE=true - DURABLE_STORE_FOLDER=./data/l2-nitro-store + DURABLE_STORE_FOLDER=./data/l2-nitro-store ``` 6. Create a deployment for Alice's L2 nitro-node: @@ -520,33 +520,33 @@ - In `l2alice-nitro-deployment/config.env` file, set the following env variable: ```bash - # URL endpoint of the chain - CERC_NITRO_CHAIN_URL=ws://host.docker.internal:9546 + # URL endpoint of the chain + CERC_NITRO_CHAIN_URL=ws://host.docker.internal:9546 - # Private key of account to be used by Nitro node (derived address is used as Nitro address) - # Note: Enter PKs without the leading `0x` - CERC_NITRO_PK="" + # Private key of account to be used by Nitro node (derived address is used as Nitro address) + # Note: Enter PKs without the leading `0x` + CERC_NITRO_PK="" - # Private key of the account on chain that is used for funding channels in Nitro node - CERC_NITRO_CHAIN_PK=570b909da9669b2f35a0b1ac70b8358516d55ae1b5b3710e95e9a94395090597 + # Private key of the account on chain that is used for funding channels in Nitro node + CERC_NITRO_CHAIN_PK=570b909da9669b2f35a0b1ac70b8358516d55ae1b5b3710e95e9a94395090597 - # Port to be used by P2P message service - CERC_NITRO_MSG_PORT=3008 + # Port to be used by P2P message service + CERC_NITRO_MSG_PORT=3008 - # Port to be used by RPC server - CERC_NITRO_RPC_PORT=4008 + # Port to be used by RPC server + CERC_NITRO_RPC_PORT=4008 - # Optional - # Contract addresses of NitroAdjudicator, VirtualPaymentApp and ConsensusApp - # TODO: Contracts are deployed if addresses are not set - CERC_NA_ADDRESS=0xb2592723B09F42937543f199A305ea6576dCb506 - CERC_VPA_ADDRESS=0x198c6643f7750c2569C3468E16750a8E8504E2c7 - CERC_CA_ADDRESS=0x198A8F1F14ACe1662fB2E5BE63A1de2308DE4CC7 + # Optional + # Contract addresses of NitroAdjudicator, VirtualPaymentApp and ConsensusApp + # TODO: Contracts are deployed if addresses are not set + CERC_NA_ADDRESS=0xb2592723B09F42937543f199A305ea6576dCb506 + CERC_VPA_ADDRESS=0x198c6643f7750c2569C3468E16750a8E8504E2c7 + CERC_CA_ADDRESS=0x198A8F1F14ACe1662fB2E5BE63A1de2308DE4CC7 - # Public IP of the nitro-node - CERC_PUBLIC_IP=/ip4/127.0.0.1/tcp/3006/p2p/16Uiu2HAmJDxLM8rSybX78FH51iZq9PdrwCoCyyHRBCndNzcAYMes + # Public IP of the nitro-node + CERC_PUBLIC_IP=/ip4/127.0.0.1/tcp/3006/p2p/16Uiu2HAmJDxLM8rSybX78FH51iZq9PdrwCoCyyHRBCndNzcAYMes - USE_DURABLE_STORE=true + USE_DURABLE_STORE=true ``` 7. Create a deployment for Charlie's L2 nitro-node: @@ -578,36 +578,36 @@ - In `l2charlie-nitro-deployment/config.env` file, set the following env variable: ```bash - # URL endpoint of the chain - CERC_NITRO_CHAIN_URL=ws://host.docker.internal:9546 + # URL endpoint of the chain + CERC_NITRO_CHAIN_URL=ws://host.docker.internal:9546 - # Private key of account to be used by Nitro node (derived address is used as Nitro address) - # Note: Enter PKs without the leading `0x` - CERC_NITRO_PK="" + # Private key of account to be used by Nitro node (derived address is used as Nitro address) + # Note: Enter PKs without the leading `0x` + CERC_NITRO_PK="" - # Private key of the account on chain that is used for funding channels in Nitro node - CERC_NITRO_CHAIN_PK=111b7500bdce494d6f4bcfe8c2a0dde2ef92f751d9070fac6475dbd6d8021b3f + # Private key of the account on chain that is used for funding channels in Nitro node + CERC_NITRO_CHAIN_PK=111b7500bdce494d6f4bcfe8c2a0dde2ef92f751d9070fac6475dbd6d8021b3f - # Port to be used by P2P message service - CERC_NITRO_MSG_PORT=3010 - # Port to be used by RPC server - CERC_NITRO_RPC_PORT=4010 + # Port to be used by P2P message service + CERC_NITRO_MSG_PORT=3010 + # Port to be used by RPC server + CERC_NITRO_RPC_PORT=4010 - # Optional - # Contract addresses of NitroAdjudicator, VirtualPaymentApp and ConsensusApp - # TODO: Contracts are deployed if addresses are not set - CERC_NA_ADDRESS=0xb2592723B09F42937543f199A305ea6576dCb506 - CERC_VPA_ADDRESS=0x198c6643f7750c2569C3468E16750a8E8504E2c7 - CERC_CA_ADDRESS=0x198A8F1F14ACe1662fB2E5BE63A1de2308DE4CC7 + # Optional + # Contract addresses of NitroAdjudicator, VirtualPaymentApp and ConsensusApp + # TODO: Contracts are deployed if addresses are not set + CERC_NA_ADDRESS=0xb2592723B09F42937543f199A305ea6576dCb506 + CERC_VPA_ADDRESS=0x198c6643f7750c2569C3468E16750a8E8504E2c7 + CERC_CA_ADDRESS=0x198A8F1F14ACe1662fB2E5BE63A1de2308DE4CC7 - # Public IP of the nitro-node - CERC_PUBLIC_IP=/ip4/127.0.0.1/tcp/3006/p2p/16Uiu2HAmJDxLM8rSybX78FH51iZq9PdrwCoCyyHRBCndNzcAYMes + # Public IP of the nitro-node + CERC_PUBLIC_IP=/ip4/127.0.0.1/tcp/3006/p2p/16Uiu2HAmJDxLM8rSybX78FH51iZq9PdrwCoCyyHRBCndNzcAYMes - USE_DURABLE_STORE=true + USE_DURABLE_STORE=true - L2=true + L2=true - DURABLE_STORE_FOLDER=./data/l2-nitro-store + DURABLE_STORE_FOLDER=./data/l2-nitro-store ``` ## Run