forked from cerc-io/stack-orchestrator
d6f829ee65
* Refactor L2 enpoint check to contract deployment script
* Add instructions to join to an existing watcher network
* Include mobymask-v2-watcher-ts in repositories setup
* Add a clean up section and expected outputs
* Add a troubleshooting section
* Use lxdao frontend
* Update instructions for updated UI
Former-commit-id: f78176a27f
136 lines
3.4 KiB
Markdown
136 lines
3.4 KiB
Markdown
# MobyMask v2 watcher
|
|
|
|
Instructions to setup and deploy MobyMask v2 watcher independently
|
|
|
|
## Setup
|
|
|
|
Prerequisite: L2 Optimism Geth and Node RPC endpoints
|
|
|
|
Clone required repositories:
|
|
|
|
```bash
|
|
laconic-so --stack mobymask-v2 setup-repositories --include cerc-io/MobyMask,cerc-io/watcher-ts,cerc-io/mobymask-v2-watcher-ts
|
|
|
|
# If this throws an error as a result of being already checked out to a branch/tag in a repo, remove the repositories mentioned below and re-run the command
|
|
```
|
|
|
|
Checkout to the required versions and branches in repos:
|
|
|
|
```bash
|
|
# watcher-ts
|
|
cd ~/cerc/watcher-ts
|
|
git checkout v0.2.39
|
|
|
|
# mobymask-v2-watcher-ts
|
|
cd ~/cerc/mobymask-v2-watcher-ts
|
|
git checkout v0.1.0
|
|
|
|
# MobyMask
|
|
cd ~/cerc/MobyMask
|
|
git checkout v0.1.2
|
|
```
|
|
|
|
Build the container images:
|
|
|
|
```bash
|
|
laconic-so --stack mobymask-v2 build-containers --include cerc/watcher-ts,cerc/watcher-mobymask-v2,cerc/mobymask
|
|
```
|
|
|
|
This should create the required docker images in the local image registry
|
|
|
|
## Deploy
|
|
|
|
### Configuration
|
|
|
|
Create and update an env file to be used in the next step ([defaults](../../config/watcher-mobymask-v2/)):
|
|
|
|
```bash
|
|
# External L2 endpoints
|
|
CERC_L2_GETH_RPC=
|
|
|
|
# Endpoints waited on before contract deployment
|
|
CERC_L2_GETH_HOST=
|
|
CERC_L2_GETH_PORT=
|
|
|
|
CERC_L2_NODE_HOST=
|
|
CERC_L2_NODE_PORT=
|
|
|
|
# URL to get CSV with credentials for accounts on L1 to perform txs on L2
|
|
CERC_L1_ACCOUNTS_CSV_URL=
|
|
|
|
# OR
|
|
# Specify the required account credentials
|
|
CERC_PRIVATE_KEY_DEPLOYER=
|
|
CERC_PRIVATE_KEY_PEER=
|
|
|
|
# Base URI for mobymask-app
|
|
# (used for generating a root invite link after deploying the contract)
|
|
CERC_MOBYMASK_APP_BASE_URI="http://127.0.0.1:3002/#"
|
|
|
|
# (Optional) Set of relay peers to connect to from the relay node
|
|
CERC_RELAY_PEERS=[]
|
|
|
|
# (Optional) Domain to be used in the relay node's announce address
|
|
CERC_RELAY_ANNOUNCE_DOMAIN=
|
|
|
|
# Set to false for disabling watcher peer to send txs to L2
|
|
CERC_ENABLE_PEER_L2_TXS=true
|
|
|
|
# (Optional) Set already deployed MobyMask contract address to avoid deploying contract in the stack
|
|
CERC_DEPLOYED_CONTRACT=
|
|
```
|
|
|
|
* NOTE: If Optimism is running on the host machine, use `host.docker.internal` as the hostname to access the host port
|
|
|
|
### Deploy the stack
|
|
|
|
```bash
|
|
laconic-so --stack mobymask-v2 deploy --include watcher-mobymask-v2 --env-file <PATH_TO_ENV_FILE> up
|
|
```
|
|
|
|
To list down and monitor the running containers:
|
|
|
|
```bash
|
|
laconic-so --stack mobymask-v2 deploy --include watcher-mobymask-v2 ps
|
|
|
|
# With status
|
|
docker ps
|
|
|
|
# Check logs for a container
|
|
docker logs -f <CONTAINER_ID>
|
|
```
|
|
|
|
The watcher endpoint is exposed on host port `3001` and the relay node endpoint is exposed on host port `9090`
|
|
|
|
Check the logs of the deployment container to get the deployed contract's address and generated root invite link:
|
|
|
|
```bash
|
|
docker logs -f $(docker ps -aq --filter name="mobymask-1")
|
|
```
|
|
|
|
## Tests
|
|
|
|
See [Tests](./README.md#tests)
|
|
|
|
## Web Apps
|
|
|
|
For deploying the web-app(s) separately after deploying the watcher, follow [web-apps.md](./web-apps.md)
|
|
|
|
## Clean up
|
|
|
|
Stop all services running in the background:
|
|
|
|
```bash
|
|
laconic-so --stack mobymask-v2 deploy --include watcher-mobymask-v2 down
|
|
```
|
|
|
|
Clear volumes created by this stack:
|
|
|
|
```bash
|
|
# List all relevant volumes
|
|
docker volume ls -q --filter "name=.*mobymask_watcher_db_data|.*peers_ids|.*mobymask_deployment"
|
|
|
|
# Remove all the listed volumes
|
|
docker volume rm $(docker volume ls -q --filter "name=.*mobymask_watcher_db_data|.*peers_ids|.*mobymask_deployment")
|
|
```
|