cerc-io/testnet-laconicd-stack
18
0
Fork 1
Code Issues 3 Pull Requests Packages Projects Releases Wiki Activity

Update testnet onboarding demo with new stacks #15

Merged
nabarun merged 12 commits from pm-update-demo-kyc into main 2024-08-05 15:45:57 +00:00
Conversation 0 Commits 12 Files Changed 1 +217 -79
1 changed files with 217 additions and 79 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

238
testnet-onboarding-demo.md
View File

@ -2,8 +2,17 @@
## Setup ## Setup
### Stack Orchestrator
- Follow these steps to install laconic-so: <https://git.vdb.to/cerc-io/stack-orchestrator#install>
### Laconic Wallet ### Laconic Wallet
- The `laconic-wallet` can be installed using an APK on an Android device or run as a website using `laconic-wallet-web`
- Follow one of the following (`Setup On Android` or `Setup As Website`) sections as desired
#### Setup On Android
- Install laconic wallet using [latest APK release](https://git.vdb.to/cerc-io/laconic-wallet/releases) - Install laconic wallet using [latest APK release](https://git.vdb.to/cerc-io/laconic-wallet/releases)
- Download the APK file in latest release `laconic-wallet-debug.apk` - Download the APK file in latest release `laconic-wallet-debug.apk`
@ -12,7 +21,7 @@
- It will need third party installation permission to install the APK - It will need third party installation permission to install the APK
- (Optional) Build laconic wallet from source by following the steps below - Alternatively, build laconic wallet from source by following the steps below
- Follow the [Install](https://git.vdb.to/cerc-io/laconic-wallet#install) steps from the laconic-wallet README to setup Android Studio - Follow the [Install](https://git.vdb.to/cerc-io/laconic-wallet#install) steps from the laconic-wallet README to setup Android Studio
@ -53,48 +62,124 @@
cd ../ cd ../
``` ```
### Testnet Onboarding App #### Setup As Website
- Clone the repository - Use the hosted `laconic-wallet-web` at <https://wallet.laconic.com>
- Alternatively, setup the `laconic-wallet-web` stack
- Clone the stack repo:
```bash ```bash
git clone git@git.vdb.to:cerc-io/testnet-onboarding-app.git laconic-so fetch-stack git.vdb.to/cerc-io/laconic-wallet-web
``` ```
- Enter the project directory - Build the container image:
```bash ```bash
cd testnet-onboarding-app laconic-so --stack ~/cerc/laconic-wallet-web/stack/stack-orchestrator/stack/laconic-wallet-web build-containers
``` ```
- Setup .env - Create a spec file for the deployment:
- Copy and update `.env`
```bash ```bash
cp .env.example .env laconic-so --stack ~/cerc/laconic-wallet-web/stack/stack-orchestrator/stack/laconic-wallet-web deploy init --output laconic-wallet-web-spec.yml
``` ```
- In the `.env` file, add the WalletConnect project ID used in your [laconic-wallet](https://git.vdb.to/cerc-io/laconic-wallet) setup. - Edit `network` in the spec file to map container ports to host ports as required:
```bash ```bash
WALLET_CONNECT_PROJECT_ID=39bc93c... network:
ports:
laconic-wallet-web:
- '5000:80'
``` ```
- Install dependencies - Create a deployment from the spec file:
```bash ```bash
yarn 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
``` ```
- Exit project repo - In the `laconic-wallet-web-deployment/config.env` file, set your wallet connect ProjectId:
```bash ```bash
cd ../ WALLET_CONNECT_ID=39bc93c...
``` ```
### Stack Orchestrator ### Testnet Onboarding App and Onboarding API Stacks
- Follow these steps to install laconic-so: <https://git.vdb.to/cerc-io/stack-orchestrator#install> - For running the onboarding API, create sumsub application token from <https://cockpit.sumsub.com>
- Reference: <https://docs.sumsub.com/docs/app-tokens>
- Clone the stack repo:
```bash
laconic-so fetch-stack git.vdb.to/cerc-io/testnet-onboarding-app-stack
```
- Setup required repositories:
```bash
laconic-so --stack ~/cerc/testnet-onboarding-app-stack/stack-orchestrator/stacks/onboarding-app setup-repositories --pull
laconic-so --stack ~/cerc/testnet-onboarding-app-stack/stack-orchestrator/stacks/onboarding-api setup-repositories --pull
```
- Build the container image:
```bash
laconic-so --stack ~/cerc/testnet-onboarding-app-stack/stack-orchestrator/stacks/onboarding-app build-containers --force-rebuild
laconic-so --stack ~/cerc/testnet-onboarding-app-stack/stack-orchestrator/stacks/onboarding-api build-containers --force-rebuild
```
- Create spec files for deployments, which will map the stack's ports to the host:
```bash
laconic-so --stack ~/cerc/testnet-onboarding-app-stack/stack-orchestrator/stacks/onboarding-app deploy init --output onboarding-app-spec.yml
laconic-so --stack ~/cerc/testnet-onboarding-app-stack/stack-orchestrator/stacks/onboarding-api deploy init --output onboarding-api-spec.yml
```
- Configure ports:
- `onboarding-app-spec.yml`:
```bash
network:
ports:
testnet-onboarding-app:
- '3000:80'
```
- `onboarding-api-spec.yml`:
```bash
network:
ports:
testnet-onboarding-api:
- '3001:3000'
```
- Create deployments:
```bash
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
laconic-so --stack ~/cerc/testnet-onboarding-app-stack/stack-orchestrator/stacks/onboarding-api deploy create --spec-file onboarding-api-spec.yml --deployment-dir onboarding-api-deployment
```
- Env configuration:
- In the `onboarding-app-deployment/config.env` file, set your wallet connect ProjectId:
```bash
WALLET_CONNECT_ID=39bc93c...
```
- In the `onboarding-api-deployment/config.env` file, set your sumsub application token and secret key:
```bash
SUMSUB_APP_TOKEN=sbx:Xig...
SUMSUB_SECRET_KEY=pIue...
```
### fixturenet-laconicd and laconic-faucet Stacks ### fixturenet-laconicd and laconic-faucet Stacks
@ -325,7 +410,7 @@
``` ```
- Create a deployment spec-file for Alice's L1 nitro-node: - Create a deployment spec-file for Alice's L1 nitro-node:
- Create spec files for the deployment: - Create spec file for the deployment:
```bash ```bash
laconic-so --stack ~/cerc/nitro-stack/stack-orchestrator/stacks/nitro-node deploy init --output l1alice-nitro-spec.yml laconic-so --stack ~/cerc/nitro-stack/stack-orchestrator/stacks/nitro-node deploy init --output l1alice-nitro-spec.yml
@ -363,7 +448,7 @@
``` ```
- Create a deployment spec-file for Alice's L2 nitro-node: - Create a deployment spec-file for Alice's L2 nitro-node:
- Create spec files for the deployment: - Create spec file for the deployment:
```bash ```bash
laconic-so --stack ~/cerc/nitro-stack/stack-orchestrator/stacks/nitro-node deploy init --output l2alice-nitro-spec.yml laconic-so --stack ~/cerc/nitro-stack/stack-orchestrator/stacks/nitro-node deploy init --output l2alice-nitro-spec.yml
@ -413,10 +498,10 @@
- Check status of L1 - Check status of L1
- Run command in intervals of 3 seconds to check if new blocks are created - Run status check:
```bash ```bash
laconic-so deployment --dir fixturenet-eth-deployment exec foundry "cast block-number" laconic-so deployment --dir fixturenet-eth-deployment exec fixturenet-eth-bootnode-lighthouse "/scripts/status-internal.sh"
``` ```
- Check geth logs to ensure that new blocks are getting created - Check geth logs to ensure that new blocks are getting created
@ -433,7 +518,13 @@
NOTE: The `fixturenet-optimism-contracts` service will configure and deploy the Optimism contracts to L1, exiting when complete. This may take several minutes; you can follow the progress by following the container's logs NOTE: The `fixturenet-optimism-contracts` service will configure and deploy the Optimism contracts to L1, exiting when complete. This may take several minutes; you can follow the progress by following the container's logs
- Check L2 logs - Follow optimism contracts deployment logs:
```bash
laconic-so deployment --dir fixturenet-optimism-deployment logs -f fixturenet-optimism-contracts
```
- Check L2 logs:
```bash ```bash
laconic-so deployment --dir fixturenet-optimism-deployment logs -f op-geth laconic-so deployment --dir fixturenet-optimism-deployment logs -f op-geth
@ -530,17 +621,29 @@
laconic-so deployment --dir bridge-deployment exec nitro-contracts "cd packages/nitro-protocol && yarn hardhat transfer --contract $L1_ASSET_ADDRESS --to $C_CHAIN_ADDRESS --amount 1000 --network geth" laconic-so deployment --dir bridge-deployment exec nitro-contracts "cd packages/nitro-protocol && yarn hardhat transfer --contract $L1_ASSET_ADDRESS --to $C_CHAIN_ADDRESS --amount 1000 --network geth"
``` ```
- Start testnet-onboarding-app (run command in testnet-onboarding-app repo) - Start `onboarding-app` and `onboarding-api` deployments (run where deployments are created):
```bash ```bash
# In testnet-onboarding-app # Builds and serves the app
yarn start laconic-so deployment --dir onboarding-app-deployment start
# Serves the API to generate access tokens
laconic-so deployment --dir onboarding-api-deployment start
``` ```
NOTE: Ignore source map warnings in the terminal Check the health status for onboarding-app container:
```bash
docker ps | grep testnet-onboarding-app
```
Once the container is healthy, the `testnet-onboarding-app` will be accessible at <http://localhost:3000>
- Run Laconic Wallet - Run Laconic Wallet
- Follow the steps to `Run on Android` or `Run as a website` as per the chosen setup
- Run on Android:
- Connect your phone with the PC (Make sure that USB debugging is enabled on your phone) - Connect your phone with the PC (Make sure that USB debugging is enabled on your phone)
- Setup port forwarding for your device using the following command: - Setup port forwarding for your device using the following command:
@ -555,8 +658,7 @@
- Open Laconic Wallet app that was installed from the APK - Open Laconic Wallet app that was installed from the APK
- (Optional) Start `laconic-wallet` android app (run steps in laconic-wallet repo) - Alternatively, you can:
- Set up the Android device - Set up the Android device
- For a physical device, refer to the [React Native documentation for running on a physical device](https://reactnative.dev/docs/running-on-device) - For a physical device, refer to the [React Native documentation for running on a physical device](https://reactnative.dev/docs/running-on-device)
- For a virtual device, continue with the steps - For a virtual device, continue with the steps
@ -570,21 +672,19 @@
- Press `a` to run the application on android and wait till the wallet app opens up on your phone - Press `a` to run the application on android and wait till the wallet app opens up on your phone
## Demo - Alternatively, run as a website:
- Open `laconic-wallet-web` at <https://wallet.laconic.com>
- In laconic-wallet app, click on `Create wallet` and add laconicd chain using `Add network` button: - Alternatively, run the `laconic-wallet-web` stack:
```bash ```bash
Network type - `COSMOS` laconic-so deployment --dir laconic-wallet-web-deployment start
Chain ID - `laconic_9000-1`
Network name - `laconicd`
New RPC URL - `http://127.0.0.1:26657`
Coin Type - `118`
Native Denom - `alnt`
Address Prefix - `laconic`
Gas Price - `1`
``` ```
Open `laconic-wallet-web` at <http://localhost:5000>
## Demo
- Start the stack for stage 0 laconicd (run command in directory where stage0-deployment had been created) - Start the stack for stage 0 laconicd (run command in directory where stage0-deployment had been created)
```bash ```bash
@ -594,6 +694,14 @@
laconic-so deployment --dir stage0-deployment logs laconicd -f laconic-so deployment --dir stage0-deployment logs laconicd -f
``` ```
- In laconic-wallet, click on `Create wallet` and update the `laconicd` network using `Edit Network` button:
```bash
Network name - laconicd
New RPC URL - http://127.0.0.1:26657
Gas Price - 1
```
- Run laconic-faucet: - Run laconic-faucet:
- Get private key of funded faucet account from stage 0 laconicd chain: - Get private key of funded faucet account from stage 0 laconicd chain:
@ -628,7 +736,7 @@
export BRIDGE_ADDRESS=$(laconic-so deployment --dir bridge-deployment exec nitro-bridge "jq -r '.\"42069\"[0].contracts.Bridge.address' /app/deployment/nitro-addresses.json") export BRIDGE_ADDRESS=$(laconic-so deployment --dir bridge-deployment exec nitro-bridge "jq -r '.\"42069\"[0].contracts.Bridge.address' /app/deployment/nitro-addresses.json")
``` ```
- In the wallet, add 2 accounts (Alice and Charlie) for both the networks (ethereum and laconicd) by selecting the network and clicking on `Add account` - In the wallet, add 2 accounts (Alice and Charlie) for both the networks (`Ethereum` and `laconicd`) by selecting the network and clicking on `Add account`
- Get Ethereum private keys for accounts Alice and Charlie from wallet using the `Show private key` link (to be used as statechannel PKs) - Get Ethereum private keys for accounts Alice and Charlie from wallet using the `Show private key` link (to be used as statechannel PKs)
@ -784,7 +892,7 @@
- Create ledger channel between A and Bridge with custom token - Create ledger channel between A and Bridge with custom token
```bash ```bash
laconic-so deployment --dir l1alice-nitro-deployment exec nitro-rpc-client "nitro-rpc-client direct-fund $BRIDGE_NITRO_ADDRESS --assetAddress $L1_ASSET_ADDRESS -p 4005 -h nitro-node" laconic-so deployment --dir l1alice-nitro-deployment exec nitro-rpc-client "nitro-rpc-client direct-fund $BRIDGE_NITRO_ADDRESS --assetAddress $L1_ASSET_ADDRESS --alphaAmount 1000000 --betaAmount 1000000 -p 4005 -h nitro-node"
``` ```
- Once direct-fund objective is complete, bridge will create mirrored channel on L2 - Once direct-fund objective is complete, bridge will create mirrored channel on L2
@ -814,7 +922,7 @@
- Create ledger channel between C and Bridge with custom token - Create ledger channel between C and Bridge with custom token
```bash ```bash
laconic-so deployment --dir l1charlie-nitro-deployment exec nitro-rpc-client "nitro-rpc-client direct-fund $BRIDGE_NITRO_ADDRESS --assetAddress $L1_ASSET_ADDRESS -p 4005 -h nitro-node" laconic-so deployment --dir l1charlie-nitro-deployment exec nitro-rpc-client "nitro-rpc-client direct-fund $BRIDGE_NITRO_ADDRESS --assetAddress $L1_ASSET_ADDRESS --alphaAmount 1000000 --betaAmount 1000000 -p 4005 -h nitro-node"
``` ```
- Once direct fund objective is complete, bridge will create mirrored channel on L2 - Once direct fund objective is complete, bridge will create mirrored channel on L2
@ -861,14 +969,21 @@
- Onboard participants - Onboard participants
- Open the `testnet-onboarding-app` at <http://localhost:3000> - Open the `testnet-onboarding-app` at <http://localhost:3000>
- Connect to the testnet-onboarding app by clicking on the WalletConnect icon on the top right corner in the wallet and scanning QR code of the app - Read and accept the `Terms and Conditions`
- Choose Alice's nitro and laconicd account to onboard - Connect testnet-onboarding app to the wallet:
- Click on `CONNECT WALLET` button on the testnet-onboarding app
- Click on the WalletConnect icon on the top right corner in the wallet
- If using the wallet Android app, scan the QR code from the onboarding app
- If using the wallet website, enter WalletConnect URI for pairing
- In the onboarding app, choose Alice's nitro and laconicd account to onboard
- Use nitro accounts for which ledger channels have been created on L2 - Use nitro accounts for which ledger channels have been created on L2
- Sign using the nitro key - Sign using the nitro key
- Approve sign request on Wallet - Approve sign request on Wallet
- Fund the laconic account by clicking on the `REQUEST TOKENS FROM FAUCET` button - Perform the user verification steps
- Send transaction request to the Wallet - Select the desired participant role (`Validator` or `Participant`) and accept the onboarding terms and conditions
- Approve and send transaction to laconicd chain - In the next step, fund your laconic account by clicking on the `REQUEST TOKENS FROM FAUCET` button; ensure that the displayed balance is updated
- Send transaction request to the wallet
- From wallet, approve and send transaction to laconicd chain
- Repeat onboarding for other (Charlies's) account by clicking on the web app header "Testnet Onboarding" - Repeat onboarding for other (Charlies's) account by clicking on the web app header "Testnet Onboarding"
- List the participants on stage 1 (run in the directory where laconicd deployment was created): - List the participants on stage 1 (run in the directory where laconicd deployment was created):
@ -892,13 +1007,16 @@
- Use the scripts in fixturenet-laconicd stack to generate genesis file for stage 1 with token allocations: - Use the scripts in fixturenet-laconicd stack to generate genesis file for stage 1 with token allocations:
```bash ```bash
# Set current working dir path in a variable
DEPLOYMENTS_DIR=$(pwd)
cd ~/cerc/fixturenet-laconicd-stack/stack-orchestrator/stacks/fixturenet-laconicd cd ~/cerc/fixturenet-laconicd-stack/stack-orchestrator/stacks/fixturenet-laconicd
# Fetch account holdings from bridge # Fetch account holdings from bridge
./scripts/fetch-account-holdings.sh <bridge-deployment-absolute-path> eth-account-holdings.json ./scripts/fetch-account-holdings.sh $DEPLOYMENTS_DIR/bridge-deployment eth-account-holdings.json
# Generate the genesis file # Generate the genesis file
./scripts/generate-stage1-genesis.sh <stage0-deployment-absolute-path> eth-account-holdings.json ./scripts/generate-stage1-genesis.sh $DEPLOYMENTS_DIR/stage0-deployment eth-account-holdings.json
# Expected output: # Expected output:
# Genesis file for stage1 written to output/genesis.json # Genesis file for stage1 written to output/genesis.json
@ -986,7 +1104,7 @@
# ID: '0xb29aeb32c9495a793ebf7bd116232075d1e7bfe89fc82281c7d498e3ffd3e3bf', # ID: '0xb29aeb32c9495a793ebf7bd116232075d1e7bfe89fc82281c7d498e3ffd3e3bf',
# Status: 'Open', # Status: 'Open',
# Balance: { # Balance: {
# AssetAddress: '<Token address on L2>', # AssetAddress: '0x0000000000000000000000000000000000000000',
# Payee: '0xa8d2d06ace9c7ffc24ee785c2695678aecdfd7a0', # Payee: '0xa8d2d06ace9c7ffc24ee785c2695678aecdfd7a0',
# Payer: '0xaaa6628ec44a8a742987ef3a114ddfe2d4f7adce', # Payer: '0xaaa6628ec44a8a742987ef3a114ddfe2d4f7adce',
# PaidSoFar: 0n, # PaidSoFar: 0n,
@ -1128,7 +1246,27 @@
- Reset wallet and stop the app: - Reset wallet and stop the app:
- In laconic-wallet, click on the `Reset Wallet` button to disconnect all apps and clear the accounts - In laconic-wallet, click on the `Reset Wallet` button to disconnect all apps and clear the accounts
- Stop (`Ctrl+C`) both `laconic-wallet` and `testnet-onboarding-app` - Stop (`Ctrl+C`) the `laconic-wallet` if running locally in dev mode
- Stop and cleanup the `laconic-wallet-web` deployment:
```bash
# Run where deployments are created
laconic-so deployment --dir laconic-wallet-web-deployment stop
sudo rm -rf laconic-wallet-web-deployment
```
- Stop and cleanup the `onboarding-app` and `onboarding-api` deployments:
```bash
# Run where deployments are created
laconic-so deployment --dir onboarding-app-deployment stop
laconic-so deployment --dir onboarding-api-deployment stop
sudo rm -rf onboarding-app-deployment
sudo rm -rf onboarding-api-deployment
```
- Clean up stage 0 and stage 1 laconicd deployments: - Clean up stage 0 and stage 1 laconicd deployments:
- Stop deployment and remove volumes: - Stop deployment and remove volumes: