Prerequisites

• Linux (Ubuntu 22.04 LTS)

• Nvidia GPU

• Nvidia drivers

• Docker (Ubuntu install)

• Nvidia Docker drivers

Network information and Testnet tokens

The testnet has a base currency of ETH, as well as a utility token called LP. Both are used for running nodes. To add a node to the testnet, follow these steps:

Metamask Configuration

We recommend using MetaMask with custom settings to make things easier. Once you have it installed and setup, here are the settings you need to use:

For a step by step guide on adding the network, please refer to our Setting up MetaMask documentation.

Fund your wallet with ETH and LP

To obtain testnet LP, use the Lilypad faucet and enter your ETH address.

To obtain testnet ETH, use a third party Arbitrum Sepolia testnet faucet and enter your ETH address.

The faucet will give you both ETH (to pay for gas) and LP (to stake and pay for jobs).

Setup Arbitrum RPC (Optional)

The Lilypad Network uses the Arbitrum Sepolia Testnet to settle compute transactions. When a transaction is ready to be saved on-chain, Lilypad cycles through a list of public Arbitrum Sepolia RPC endpoints using the endpoint that settles first to save the compute transaction.

Resource Providers have the option to setup their own Arbitrum RPC endpoint using Alchemy instead of using the default public RPC endpoints.

A personal RPC endpoint helps RPs to avoid reliability issues with the public RPC endpoints used by Lilypad ensuring rewards can be earned and jobs can be run consistently. RPs running a personal RPC endpoint contribute to the fault tolerance and decentralization of the Lilypad Network! Read more in the Alchemy Arbitrum docs.

Usage

Before we start the Docker setup, you'll need to retrieve the private key from the wallet you set up earlier in this guide. For guidance on exporting your private key, refer to this official MetaMask guide. Once you’ve securely copied your private key, proceed to initialize the Docker containers using the commands provided below.

You have two options to start the Lilypad setup: using Docker Compose or directly pulling the image. Both methods will run the containers in the background, allowing you to continue using your terminal while the setup operates.

Docker Compose Setup

1. Export Your Private Key

Before starting, export your private key from MetaMask. Follow the official MetaMask guide for instructions on safely exporting your private key.

2. Download the Docker Compose Configuration

Use curl to download the docker-compose.yml file from the Lilypad GitHub repository.

LATEST_VERSION=$(curl -s https://api.github.com/repos/Lilypad-Tech/lilypad/releases/latest | sed -n 's/.*"tag_name": "\(.*\)".*/\1/p')

curl -o docker-compose.yml "https://raw.githubusercontent.com/Lilypad-Tech/lilypad/$LATEST_VERSION/docker/docker-compose.yml"

3. Check for Existing Containers

You can check if these containers are running with:

docker ps -a | grep -E "resource-provider|ipfs|watchtower"

If they are running, stop them with:

docker stop <container_name>

If there are still conflicts when trying to running with the docker-compose file, remove the containers:

docker rm <container_name>

4. Start the Resource Provider

Start the Lilypad containers using Docker Compose:

WEB3_PRIVATE_KEY=<your_private_key> docker compose up -d

To include a custom RPC URL:

WEB3_PRIVATE_KEY=<your_private_key> WEB3_RPC_URL=wss://arb-sepolia.g.alchemy.com/v2/your-alchemy-id docker compose up -d

5. Monitor Your Node

Use the following command to check the status of the resource provider and bacalhau.

docker logs resource-provider

docker logs bacalhau

Use the following command to view the containers running after starting Docker Compose.

docker ps

Update Lilypad version for Docker RP

When a new version of Lilypad is released, it is critical for Resource Providers to update their installations to ensure compatibility and ability to run Lilypad jobs.

1. If a Docker RP is running stop the system (if the node is not running, disregard this first step)

docker compose down

2. View all Docker images

docker images

3. Delete old Docker images that are duplicates for Lilypad (Bacalhau, Lilypad)

docker rmi <image_name_or_id> 

4. Follow Docker RP install instructions

Using the Lilypad Docker RP install instructions setup a new RP and run.

View Lilybit_ rewards

To view your Lilybit_ rewards, visit one of the following dashboards and paste your node's public address into the input:

• Grafana dashboard

Troubleshooting

Here are some common troubleshooting techniques when it comes to your resource provider using Docker:

Checking Docker Runtime To verify your Docker runtime configuration: sudo docker info | grep Runtimes

You should see the NVIDIA runtime listed. If you only see: Runtimes: io.containerd.runc.v2 runc you will need to configure the NVIDIA runtime.

Configuring NVIDIA Runtime If the NVIDIA runtime is not showing up or you're experiencing issues, try the following:

1. Configure the NVIDIA Container Toolkit runtime: sudo nvidia-ctk runtime configure --runtime=docker --set-as-default 2. Restart the Docker service: sudo systemctl restart docker

Overview of Docker setup For a comprehensive overview of your Docker setup, use: docker info. This command provides detailed information about your Docker daemon configuration.

Remove Previous Versions

If the Linux Install was your previous version, follow part A, and if you had previously installed a Docker version, follow part B if you have already installed the Docker version and are updating.

A) Ensure all processes from Linux install are stopped and removed

This only applies if you had a Linux version installed

1. Stop all systemd processess

sudo systemctl stop bacalhau

sudo systemctl stop lilypad-resource-provider

1. Disable the systemd services:

sudo systemctl disable bacalhau

sudo systemctl disable lilypad-resource-provider

1. Delete the service files from the systemd directory.

**Note: Be extremely careful when using sudo to remove files.

sudo rm /etc/systemd/system/bacalhau.service

sudo rm /etc/systemd/system/lilypad-resource-provider.service

1. Reload the systemd daemon to apply the changes.

sudo systemctl daemon-reload

B) Remove old Docker containers

1. If a Docker RP is running stop the system (if the node is not running, disregard this first step)

docker compose down

1. You can check the status of the containers with:

docker ps -a | grep -E "resource-provider|ipfs|watchtower"

If they are running, stop them with:

docker stop <container_name>

Remove the containers:

docker rm <container_name>

1. View all Docker images

docker images

1. Take note of all the IMAGE ID for each lilypad image (resource-provider, bacalhau, and watchtower)

Delete old Docker images that are duplicates for Lilypad (Bacalhau, Lilypad)

docker rmi <IMAGE ID>  

*Note - You can also use docker volume prune to remove specific images that aren't being used

Install and Run a new Version of Lilypad

1. Create a new Resource Provider wallet (We recommend you don't use the same one you were using before, and you cannot use the same wallet you use to run jobs). See the Docs for Setting up a Metamask Wallet

2. Export your new WEB3_PRIVATE_KEY as an environment variable

export WEB3_PRIVATE_KEY=<your-private-key>

1. Use curl to download the docker-compose.yml file from the Lilypad GitHub repository.

LATEST_VERSION=$(curl -s https://api.github.com/repos/Lilypad-Tech/lilypad/releases/latest | sed -n 's/.*"tag_name": "\(.*\)".*/\1/p')

curl -o docker-compose.yml "https://raw.githubusercontent.com/Lilypad-Tech/lilypad/$LATEST_VERSION/docker/docker-compose.yml"

1. Start your Lilypad Node

WEB3_PRIVATE_KEY=<your_private_key> docker compose up -d

OR start with your own RPC URL

WEB3_PRIVATE_KEY=<your_private_key> WEB3_RPC_URL=wss://arb-sepolia.g.alchemy.com/v2/your-alchemy-id docker compose up -d

Monitor Your Node

Use the following command to check the status of the resource provider and bacalhau.

docker logs resource-provider

docker logs bacalhau

Use the following command to view the containers running after starting Docker Compose.

docker ps

A healthy, updated node should have all containers started, a preflight check, and be adding a resource offer.