cerc-io/testnet-laconicd-stack

Fork 1

Prathamesh Musale 1bf0066234 Update instructions L2 and bridge setup

2024-09-05 09:10:54 +05:30

20 KiB

Raw Blame History

Create deployments from scratch (for reference only)

Log in as dev user on the deployments VM
All the deployments are placed in the /srv directory:
```
cd /srv
```

Prerequisites

laconic-so: see installation
Ansible: see installation
Check versions to verify installation:
```
laconic-so version

ansible --version
```

L2 Optimism

Stack: https://git.vdb.to/cerc-io/fixturenet-optimism-stack
Source repos:
- github.com/ethereum-optimism/optimism@v1.7.7
- github.com/ethereum-optimism/op-geth@v1.101315.2
Target dir: /srv/l2/optimism-deployment

Cleanup an existing deployment if required:

cd /srv/l2

# Stop the deployment
laconic-so deployment --dir optimism-deployment stop --delete-volumes

# Remove the deployment dir
sudo rm -rf optimism-deployment

Setup

Clone the cerc-io/testnet-ops repository:

cd /srv
git clone git@git.vdb.to:cerc-io/testnet-ops.git

cd testnet-ops/l2-setup

Edit l2-vars.yml with required values:

# L1 chain ID (Sepolia: 11155111)
l1_chain_id: "11155111"

# L1 RPC endpoint
l1_rpc: ""

# L1 RPC endpoint host or IP address
l1_host: ""

# L1 RPC endpoint port number
l1_port: ""

# L1 Beacon endpoint
l1_beacon: ""

# Account credentials for the Admin account
# Used for Optimism contracts deployment and funding other generated accounts
l1_address: ""
l1_priv_key: ""

Update the target dir in setup-vars.yml:

sed -i 's|^l2_directory:.*|l2_directory: /srv/l2|' setup-vars.yml

# Will create deployment at /srv/l2/optimism-deployment

Run

Setup and run L2 by executing the run-optimism.yml Ansible playbook:

LANG=en_US.utf8 ansible-playbook -i localhost, --connection=local run-optimism.yml --extra-vars='{ "target_host": "localhost"}' --user $USER

For skipping container build, run with "skip_container_build" : true:

LANG=en_US.utf8 ansible-playbook -i localhost, --connection=local run-optimism.yml --extra-vars='{"target_host" : "localhost", "skip_container_build": true}' -kK --user $USER

Nitro Bridge

Stack: https://git.vdb.to/cerc-io/nitro-stack
Source repos: https://github.com/cerc-io/go-nitro
Target dir: /srv/bridge/bridge-deployment

Cleanup an existing deployment if required:

cd /srv/bridge

# Stop the deployment
laconic-so deployment --dir bridge-deployment stop --delete-volumes

# Remove the deployment dir
sudo rm -rf bridge-deployment

Setup

Clone the cerc-io/testnet-ops repository:

cd /srv

# Can be skipped if repo already exists
git clone git@git.vdb.to:cerc-io/testnet-ops.git

cd testnet-ops/nitro-bridge-setup

Create the required vars file:

cp bridge-vars-example.yml bridge-vars.yml

Edit bridge-vars.yml with required values:

# L1 WS endpoint
nitro_l1_chain_url: ""

# L2 WS endpoint
nitro_l2_chain_url: ""

# Private key for bridge Nitro address
nitro_sc_pk: ""

# Private key for a funded account on L1
# This account should have Laconic tokens for funding Nitro channels
nitro_chain_pk: ""

# L1 chain ID (Sepolia: 11155111)
geth_chain_id: "11155111"

# L1 RPC endpoint
geth_url: ""

# L2 RPC endpoint
optimism_url: ""

# Private key for a funded account for L1 contracts deployment
geth_deployer_pk: ""

# Private key for a funded account for L2 contracts deployment
# Use the same account for L1 and L2 deployments
optimism_deployer_pk: ""

Update the target dir in setup-vars.yml:

sed -i 's|^nitro_directory:.*|nitro_directory: /srv/bridge|' vars.yml

# Will create deployment at /srv/bridge/bridge-deployment

Run

Setup and run L2 by executing the run-nitro-bridge.yml Ansible playbook:

LANG=en_US.utf8 ansible-playbook -i localhost, --connection=local run-nitro-bridge.yml --extra-vars='{ "target_host": "localhost"}' --user $USER

For skipping container build, run with "skip_container_build" : true:

LANG=en_US.utf8 ansible-playbook -i localhost, --connection=local run-nitro-bridge.yml --extra-vars='{"target_host" : "localhost", "skip_container_build": true}' -kK --user $USER

stage0 laconicd

Stack: https://git.vdb.to/cerc-io/fixturenet-laconicd-stack/src/branch/main/stack-orchestrator/stacks/fixturenet-laconicd
Source repo: https://git.vdb.to/cerc-io/laconicd
Target dir: /srv/laconicd/stage0-deployment

Cleanup an existing deployment if required:

cd /srv/laconicd

# Stop the deployment
laconic-so deployment --dir stage0-deployment stop --delete-volumes

# Remove the deployment dir
sudo rm -rf stage0-deployment

# Remove the existing spec file
rm stage0-spec.yml

Setup

Clone the stack repo:

laconic-so fetch-stack git.vdb.to/cerc-io/fixturenet-laconicd-stack --pull

# This should clone the fixturenet-laconicd-stack repo at `/home/dev/cerc/fixturenet-laconicd-stack`

Clone required repositories:

laconic-so --stack ~/cerc/fixturenet-laconicd-stack/stack-orchestrator/stacks/fixturenet-laconicd setup-repositories --pull

# This should clone the laconicd repo at `/home/dev/cerc/laconicd`

Build the container images:

laconic-so --stack ~/cerc/fixturenet-laconicd-stack/stack-orchestrator/stacks/fixturenet-laconicd build-containers --force-rebuild

# This should create the "cerc/laconicd" Docker image

Deployment

Create a spec file for the deployment:

cd /srv/laconicd

laconic-so --stack ~/cerc/fixturenet-laconicd-stack/stack-orchestrator/stacks/fixturenet-laconicd deploy init --output stage0-spec.yml

Edit network in the spec file to map container ports to host ports:

# stage0-spec.yml
network:
  ports:
    laconicd:
      - '6060'
      - '127.0.0.1:26657:26657'
      - '26656'
      - '127.0.0.1:9473:9473'
      - '127.0.0.1:9090:9090'
      - '127.0.0.1:1317:1317'

Create a deployment from the spec file:

laconic-so --stack ~/cerc/fixturenet-laconicd-stack/stack-orchestrator/stacks/fixturenet-laconicd deploy create --spec-file stage0-spec.yml --deployment-dir stage0-deployment

Update the configuration:

cat <<EOF > stage0-deployment/config.env
# Set to true to enable adding participants functionality of the onboarding module
ONBOARDING_ENABLED=true

# A custom human readable name for this node
MONIKER=LaconicStage0
EOF

Start

Start the deployment:

laconic-so deployment --dir stage0-deployment start

Check status:

# List down the containers and check health status
docker ps -a | grep laconicd

# Follow logs for laconicd container, check that new blocks are getting created
laconic-so deployment --dir stage0-deployment logs laconicd -f

Verify that endpoint is now publicly accessible:
- https://laconicd.laconic.com is pointed to the node's RPC endpoint
- Check status query:
```
curl https://laconicd.laconic.com/status | jq

# Expected output:
# JSON with `node_info`, `sync_info` and `validator_info`
```

faucet

Stack: https://git.vdb.to/cerc-io/testnet-laconicd-stack/src/branch/main/stack-orchestrator/stacks/laconic-faucet
Source repo: https://git.vdb.to/cerc-io/laconic-faucet
Target dir: /srv/faucet/laconic-faucet-deployment

Cleanup an existing deployment if required:

cd /srv/faucet

# Stop the deployment
laconic-so deployment --dir laconic-faucet-deployment stop

# Remove the deployment dir
sudo rm -rf laconic-faucet-deployment

# Remove the existing spec file
rm laconic-faucet-spec.yml

Setup

Clone the stack repo:

laconic-so fetch-stack git.vdb.to/cerc-io/testnet-laconicd-stack --pull

# This should clone the testnet-laconicd-stack repo at `/home/dev/cerc/testnet-laconicd-stack`

Clone required repositories:

laconic-so --stack ~/cerc/testnet-laconicd-stack/stack-orchestrator/stacks/laconic-faucet setup-repositories --pull

# This should clone the laconicd repo at `/home/dev/cerc/laconic-faucet

Build the container images:

laconic-so --stack ~/cerc/testnet-laconicd-stack/stack-orchestrator/stacks/laconic-faucet build-containers --force-rebuild

# This should create the "cerc/laconic-faucet" Docker image

Deployment

Create a spec file for the deployment:

cd /srv/faucet

laconic-so --stack ~/cerc/testnet-laconicd-stack/stack-orchestrator/stacks/laconic-faucet deploy init --output laconic-faucet-spec.yml

Edit network in the spec file to map container ports to host ports:

# laconic-faucet-spec.yml
network:
  ports:
    faucet:
      - '127.0.0.1:4000:3000'

Create a deployment from the spec file:

laconic-so --stack ~/cerc/testnet-laconicd-stack/stack-orchestrator/stacks/laconic-faucet deploy create --spec-file laconic-faucet-spec.yml --deployment-dir laconic-faucet-deployment

# Place in the same namespace as stage0
cp /srv/laconicd/stage0-deployment/deployment.yml laconic-faucet-deployment/deployment.yml

Update the configuration:

# Get the faucet account key from stage0 deployment
export FAUCET_ACCOUNT_PK=$(laconic-so deployment --dir /srv/laconicd/stage0-deployment exec laconicd "echo y | laconicd keys export alice --keyring-backend test --unarmored-hex --unsafe")

cat <<EOF > laconic-faucet-deployment/config.env
CERC_FAUCET_KEY=$FAUCET_ACCOUNT_PK
EOF

Start

Start the deployment:

laconic-so deployment --dir laconic-faucet-deployment start

Check status:

# List down the containers and check health status
docker ps -a | grep faucet

# Check logs for faucet container
laconic-so deployment --dir laconic-faucet-deployment logs faucet -f

Verify that endpoint is now publicly accessible:
- https://faucet.laconic.com is pointed to the faucet endpoint
- Check faucet:
```
curl -X POST https://faucet.laconic.com/faucet

# Expected output:
# {"error":"address is required"}
```

testnet-onboarding-app

Stack: https://git.vdb.to/cerc-io/testnet-onboarding-app-stack/src/branch/main/stack-orchestrator/stacks/onboarding-app
Source repo: https://git.vdb.to/cerc-io/testnet-onboarding-app
Target dir: /srv/app/onboarding-app-deployment

Cleanup an existing deployment if required:

cd /srv/app

# Stop the deployment
laconic-so deployment --dir onboarding-app-deployment

# Remove the deployment dir
sudo rm -rf onboarding-app-deployment

# Remove the existing spec file
rm onboarding-app-spec.yml

Setup

Clone the stack repo:

laconic-so fetch-stack git.vdb.to/cerc-io/testnet-onboarding-app-stack --pull

# This should clone the testnet-onboarding-app-stack repo at `/home/dev/cerc/testnet-onboarding-app-stack`

Clone required repositories:

laconic-so --stack ~/cerc/testnet-onboarding-app-stack/stack-orchestrator/stacks/onboarding-app setup-repositories --pull

# This should clone the testnet-onboarding-app repo at `/home/dev/cerc/testnet-onboarding-app`

Build the container images:

laconic-so --stack ~/cerc/testnet-onboarding-app-stack/stack-orchestrator/stacks/onboarding-app build-containers --force-rebuild

# This should create the Docker image "cerc/testnet-onboarding-app" locally

Deployment

Create a spec file for the deployment:

cd /srv/app

laconic-so --stack ~/cerc/testnet-onboarding-app-stack/stack-orchestrator/stacks/onboarding-app deploy init --output onboarding-app-spec.yml

Edit network in the spec file to map container ports to host ports:

network:
  ports:
    testnet-onboarding-app:
      - '127.0.0.1:3000:80'

Create a deployment from the spec file:

laconic-so --stack ~/cerc/testnet-onboarding-app-stack/stack-orchestrator/stacks/onboarding-app deploy create --spec-file onboarding-app-spec.yml --deployment-dir onboarding-app-deployment

Update the configuration:

cat <<EOF > onboarding-app-deployment/config.env
WALLET_CONNECT_ID=63...

CERC_REGISTRY_GQL_ENDPOINT="https://laconicd.laconic.com/api"
CERC_LACONICD_RPC_ENDPOINT="https://laconicd.laconic.com"

CERC_FAUCET_ENDPOINT="https://faucet.laconic.com"

CERC_WALLET_META_URL="https://loro-signup.laconic.com"
EOF

Start

Start the deployment:

laconic-so deployment --dir onboarding-app-deployment start

Check status:

# List down the container
docker ps -a | grep testnet-onboarding-app

# Follow logs for testnet-onboarding-app container, wait for the build to finish
laconic-so deployment --dir onboarding-app-deployment logs testnet-onboarding-app -f

The onboarding app can now be viewed at https://loro-signup.laconic.com

laconic-wallet-web

Stack: https://git.vdb.to/cerc-io/laconic-wallet-web/src/branch/main/stack/stack-orchestrator/stack/laconic-wallet-web
Source repo: https://git.vdb.to/cerc-io/laconic-wallet-web
Target dir: /srv/wallet/laconic-wallet-web-deployment

Cleanup an existing deployment if required:

cd /srv/wallet

# Stop the deployment
laconic-so deployment --dir laconic-wallet-web-deployment

# Remove the deployment dir
sudo rm -rf laconic-wallet-web-deployment

# Remove the existing spec file
rm laconic-wallet-web-spec.yml

Setup

Clone the stack repo:

laconic-so fetch-stack git.vdb.to/cerc-io/laconic-wallet-web --pull

# This should clone the laconic-wallet-web repo at `/home/dev/cerc/laconic-wallet-web`

Build the container images:

laconic-so --stack ~/cerc/laconic-wallet-web/stack/stack-orchestrator/stack/laconic-wallet-web build-containers --force-rebuild

# This should create the Docker image "cerc/laconic-wallet-web" locally

Deployment

Create a spec file for the deployment:

cd /srv/wallet

laconic-so --stack ~/cerc/laconic-wallet-web/stack/stack-orchestrator/stack/laconic-wallet-web deploy init --output laconic-wallet-web-spec.yml

Edit network in the spec file to map container ports to host ports:

network:
  ports:
    laconic-wallet-web:
      - '127.0.0.1:5000:80'

Create a deployment from the spec file:

laconic-so --stack ~/cerc/laconic-wallet-web/stack/stack-orchestrator/stack/laconic-wallet-web deploy create --spec-file laconic-wallet-web-spec.yml --deployment-dir laconic-wallet-web-deployment

Update the configuration:

cat <<EOF > laconic-wallet-web-deployment/config.env
WALLET_CONNECT_ID=63...
EOF

Start

Start the deployment:

laconic-so deployment --dir laconic-wallet-web-deployment start

Check status:

# List down the container
docker ps -a | grep laconic-wallet-web

# Follow logs for laconic-wallet-web container, wait for the build to finish
laconic-so deployment --dir laconic-wallet-web-deployment logs laconic-wallet-web -f

The web wallet can now be viewed at https://wallet.laconic.com

stage1 laconicd

Stack: https://git.vdb.to/cerc-io/fixturenet-laconicd-stack/src/branch/main/stack-orchestrator/stacks/fixturenet-laconicd
Source repo: https://git.vdb.to/cerc-io/laconicd
Target dir: /srv/laconicd/stage1-deployment

Cleanup an existing deployment if required:

cd /srv/laconicd

# Stop the deployment
laconic-so deployment --dir stage1-deployment stop --delete-volumes

# Remove the deployment dir
sudo rm -rf stage1-deployment

# Remove the existing spec file
rm stage1-spec.yml

Setup

Same as that for stage0 laconicd, not required if already done for stage0

Deployment

Create a spec file for the deployment:

cd /srv/laconicd

laconic-so --stack ~/cerc/fixturenet-laconicd-stack/stack-orchestrator/stacks/fixturenet-laconicd deploy init --output stage1-spec.yml

Edit network in the spec file to map container ports to host ports:

# stage1-spec.yml
network:
  ports:
    laconicd:
      - '6060'
      - '127.0.0.1:26657:26657'
      - '26656:26656'
      - '127.0.0.1:9473:9473'
      - '127.0.0.1:9090:9090'
      - '127.0.0.1:1317:1317'

Create a deployment from the spec file:

laconic-so --stack ~/cerc/fixturenet-laconicd-stack/stack-orchestrator/stacks/fixturenet-laconicd deploy create --spec-file stage1-spec.yml --deployment-dir stage1-deployment

Update the configuration:

cat <<EOF > stage1-deployment/config.env
AUTHORITY_AUCTION_ENABLED=true
AUTHORITY_AUCTION_COMMITS_DURATION=3600
AUTHORITY_AUCTION_REVEALS_DURATION=3600
AUTHORITY_GRACE_PERIOD=7200

MONIKER=LaconicStage1
EOF

Start

Follow stage0-to-stage1.md to halt stage0 deployment, generate the genesis file for stage1 and start the stage1 deployment

laconic-console

Stack: https://git.vdb.to/cerc-io/testnet-laconicd-stack/src/branch/main/stack-orchestrator/stacks/laconic-console
Source repos:
- https://git.vdb.to/cerc-io/laconic-registry-cli
- https://git.vdb.to/cerc-io/laconic-console
Target dir: /srv/console/laconic-console-deployment

Cleanup an existing deployment if required:

cd /srv/console

# Stop the deployment
laconic-so deployment --dir laconic-console-deployment stop --delete-volumes

# Remove the deployment dir
sudo rm -rf laconic-console-deployment

# Remove the existing spec file
rm laconic-console-spec.yml

Setup

Clone the stack repo:

laconic-so fetch-stack git.vdb.to/cerc-io/testnet-laconicd-stack --pull

# This should clone the testnet-laconicd-stack repo at `/home/dev/cerc/testnet-laconicd-stack`

Clone required repositories:

laconic-so --stack ~/cerc/testnet-laconicd-stack/stack-orchestrator/stacks/laconic-console setup-repositories --pull

# This should clone the laconic-registry-cli repo at `/home/dev/cerc/laconic-registry-cli`, laconic-console repo at `/home/dev/cerc/laconic-console`

Build the container images:

laconic-so --stack ~/cerc/testnet-laconicd-stack/stack-orchestrator/stacks/laconic-console build-containers --force-rebuild

# This should create the Docker images: "cerc/laconic-registry-cli", "cerc/webapp-base", "cerc/laconic-console-host"

Deployment

Create a spec file for the deployment:

cd /srv/console

laconic-so --stack ~/cerc/testnet-laconicd-stack/stack-orchestrator/stacks/laconic-console deploy init --output laconic-console-spec.yml

Edit network in the spec file to map container ports to host ports:
```
network:
  ports:
    console:
      - '127.0.0.1:4001:80'
```

Create a deployment from the spec file:

laconic-so --stack ~/cerc/testnet-laconicd-stack/stack-orchestrator/stacks/laconic-console deploy create --spec-file laconic-console-spec.yml --deployment-dir laconic-console-deployment

Update the configuration:

cat <<EOF > laconic-console-deployment/config.env
# Laconicd (hosted) GQL endpoint
LACONIC_HOSTED_ENDPOINT=https://laconicd.laconic.com
EOF

Start

Start the deployment:

laconic-so deployment --dir laconic-console-deployment start

Check status:

# List down the container
docker ps -a | grep console

# Follow logs for console container
laconic-so deployment --dir laconic-console-deployment logs console -f

The laconic console can now be viewed at https://loro-console.laconic.com

Domains / Port Mappings

laconicd.laconic.com        -> 26657
laconicd.laconic.com/api    -> 9473/api
faucet.laconic.com          -> 4000
loro-signup.laconic.com     -> 3000
wallet.laconic.com          -> 5000
loro-console.laconic.com    -> 4001

20 KiB Raw Blame History

Create deployments from scratch (for reference only)

Login

Prerequisites

L2 Optimism

Setup

Run

Nitro Bridge

Setup

Run

stage0 laconicd

Setup

Deployment

Start

faucet

Setup

Deployment

Start

testnet-onboarding-app

Setup

Deployment

Start

laconic-wallet-web

Setup

Deployment

Start

stage1 laconicd

Setup

Deployment

Start

laconic-console

Setup

Deployment

Start

Domains / Port Mappings

20 KiB

Raw Blame History