History

Thomas E Lackey 6fa3ca2b6d Update from github.com to git.vdb.to where applicable. (#553 ) * Update from github.com to git.vdb.to for many repos. * Use ipld-eth-server@v1.11.6-statediff-v5 for most stacks * Specify go-ethereum branch/tag		2023-10-03 13:55:33 -05:00
..
watcher-p2p-network	Map ports in mobymask-v2 and apps stacks to localhost (#439 )	2023-06-27 12:23:56 +05:30
demo.md	Update instructions in the mobymask-v2 stack (#438 )	2023-06-26 15:37:08 +05:30
mobymask-only.md	Update mobymask-v2 stack with pubsub option (#527 )	2023-09-06 14:48:32 +05:30
README.md	Restart support for fixturenet-lotus (#499 )	2023-08-14 12:46:04 +05:30
stack.yml	Update from github.com to git.vdb.to where applicable. (#553 )	2023-10-03 13:55:33 -05:00
web-apps.md	Update mobymask-v2 stack with pubsub option (#527 )	2023-09-06 14:48:32 +05:30

README.md

MobyMask v2 watcher

Instructions to setup and deploy an end-to-end MobyMask v2 stack (L1 + L2 chains + watcher + web-app(s)) using laconic-stack-orchestrator

We support running just the watcher part of stack, given an external L2 Optimism endpoint. Follow mobymask-only for the same.

We also support running just the web-app(s), given external watcher GQL (for mobymask-app) and relay node endpoints. Follow web-apps.md for the same.

Setup

Clone required repositories:

laconic-so --stack mobymask-v2 setup-repositories

NOTE: If repositories already exist and are checked out to different versions, setup-repositories command will throw an error. For getting around this, the repositories mentioned below can be removed and then run the command.

Build the container images:

laconic-so --stack mobymask-v2 build-containers

This should create the required docker images in the local image registry.

Deploy the stack:

Deploy the containers:
```
laconic-so --stack mobymask-v2 deploy --cluster mobymask_v2 up
```
NOTE: The fixturenet-optimism-contracts service takes a while to run to completion and it may restart a few times after running into errors.

To list down and monitor the running containers:

laconic-so --stack mobymask-v2 deploy --cluster mobymask_v2 ps

# With status
docker ps -a

# Check logs for a container
docker logs -f <CONTAINER_ID>

Tests

Find the watcher container's id and export it for later use:

export CONTAINER_ID=$(docker ps -q --filter "name=peer-tests")

Run the peer tests:

docker exec $CONTAINER_ID yarn test

Web Apps

Check that the web-app containers are healthy:

docker ps | grep -E 'mobymask-app|peer-test-app'

mobymask-app

The mobymask-app should be running at http://localhost:3002
The lxdao-mobymask-app should be running at http://localhost:3004

peer-test-app

The peer-test-app should be running at http://localhost:3003

Details

The relay node for p2p network is running at http://localhost:9090
The peer package (published in gitea) can be used in client code for connecting to the network
The react-peer package (published in gitea) which uses the peer package can be used in react app for connecting to the network

Demo

Follow the demo to try out the MobyMask app with L2 chain

Clean up

Stop all the services running in background:

laconic-so --stack mobymask-v2 deploy --cluster mobymask_v2 down 30

Clear volumes created by this stack:

# List all relevant volumes
docker volume ls -q --filter "name=mobymask_v2"

# Remove all the listed volumes
docker volume rm $(docker volume ls -q --filter "name=mobymask_v2")