Skip to content

DEVNET.md

Latest commit

 

History

History
95 lines (57 loc) · 4.1 KB

DEVNET.md

File metadata and controls

95 lines (57 loc) · 4.1 KB
Raw

Devnet

A publicly accessible Lilypad network.

Components

  • A blockchain node
  • A solver service
  • A job creator service

Resource providers

As is, the network cannot execute jobs, it needs resource providers to connect to the network and these in turn will be the ones running the jobs. Follow these instructions to run a node in the Lilypad network.

Deployments

The three components have been isolated into docker containers and these components expose their services to the public via Cloudflare tunnels from inside the containers. This means there is no need to configure networking at the cloud service provider, just deploy the components using the appropriate build and run arguments to expose the services to the configured subdomains.

The deployment processes for each component have the same three steps:

  • Build the docker image
  • Push the image to the container registry
  • Pull the image from the registry and execute the image in a container

Blockchain node

There is a GitHub workflow to deploy the blockchain node, but it does not execute on code changes as there is no need to constantly deploy the blockchain node. There is ongoing work to implement a GitHub workflow that will compile and deploy the smart contracts.

Reset the blockchain

If, for whatever reason, the blockchain node needs to be reset, this can be done in the following manner:

  1. ssh into the instance/pod running the blockchain node
  2. Connect into the chain container's shell (docker exec -it chain /bin/bash)
  3. In the container shell execute the reset script (./reset). This will stop the node, clear the blockchain data, restart the node and fund the admin account.
  4. Execute ./stack chain-boot to compile, deploy and fund the smart contracts, token and accounts respectively. Change the configuration in the Hardhat scripts (/hardhat.config.ts and /scripts/print-contract-env.ts) to make sure the URLs point to the node's exposed subdomains (at the time of this write-up 8545 -> https://devnet-chain-http.lilypad.tech and 8546 -> wss://devnet-chain-ws.lilypad.tech).

Faucet

Checkout the Lilypad faucet repository.

Solver and Job creator

When code changes reach the main branch, a GitHub workflow will trigger the flow that will first deploy and run the solver and then deploy and run the job creator. (reminder) The solver has to be up and running (and have registered its public URL to the blockchain) before the job-creator starts (the job creator will fail if it can't find the solver's websocket server).

Deploying to a new cloud provider

These steps have been used for AWS so maybe some changes have to be put in place for other providers but the overall flow should be similar.

VM instance

The VM should have a running Docker daemon and should be able to pull an image from the chosen container registry. These instructions assume an Ubuntu image.

Create a virtual machine to execute the component. When creating the VM, attach an instance profile that gives it access to pull from an ECR registry. In our ops setup, we have a role named LilypadService that has the necessary permissions.

Install AWS CLI

Update the VM and install the AWS CLI:

sudo apt update && sudo apt upgrade
sudo snap install aws-cli --classic

Install Docker

Install Docker:

curl -fsSL https://get.docker.com -o get-docker.sh
sudo sh get-docker.sh

Add your user to the docker group if you want to run without sudo:

sudo usermod -aG docker ubuntu
newgrp docker

The ubuntu user assumes the default user on Ubuntu images. The newgrrp command adds your user to the group without logging out and back in.

Check that Docker is running:

docker run hello-world

ECR repo

Make sure the repo has been created.

Cloudflare tunnel

Make sure the Cloudflare tunnel has been created and linked to the desired subdomain, and pass the token to the container in the build step.