Supplier & RelayMiner (~20 min)
Supplier & RelayMiner Cheat Sheet
This guide provides quick reference commands for setting up a Supplier and running a RelayMiner on Pocket Network.
For detailed instructions, troubleshooting, and observability setup, see the Supplier Walkthrough.
These instructions are intended to run on a Linux machine.
TODO_TECHDEBT(@olshansky): Adapt instructions to be macOS friendly in order to streamline development and reduce friction for any new potential contributor.
- System Requirements
- Pre-Requisites
- Video Walkthrough
- Account Setup
- Supplier Configuration
- RelayMiner Configuration
- Supplier FAQ
System Requirements
Please see the Hardware Requirements page.
20 Minute Video Walkthrough
The following is a ~20 minute video walkthrough using this cheatsheet.
Pre-Requisites
- Make sure to install the
pocketd
CLI. - Make sure you know how to create and fund a new account.
- You have either staked a new
service
or found an existing one. [Optional]
You can run things locally or have dedicated long-running hardware. See the Docker Compose Cheat Sheet if you're interested in the latter.
You can append --keyring-backend test
to all the pocketd
commands throughout
this guide to avoid entering the password each time.
This is not recommended but provided for convenience for NON PRODUCTION USE ONLY.
⚠️ Use at your own risk. ⚠️
Context
This document is a cheat sheet to get you quickly started with two things:
- Staking an onchain
Supplier
- Deploying an offchain
RelayMiner
By the end of it, you should be able to serve Relays offchain, and claim onchain rewards.
Account Setup
Create the Supplier
account
Create a new key pair for the Supplier
pocketd keys add supplier
Prepare your environment
For convenience, we're setting several environment variables to streamline the process of interacting with the Shannon network:
We recommend you put these in your ~/.bashrc
file:
export NODE="https://shannon-testnet-grove-rpc.beta.poktroll.com"
export NODE_FLAGS="--node=https://shannon-testnet-grove-rpc.beta.poktroll.com"
export TX_PARAM_FLAGS="--gas=auto --gas-prices=1upokt --gas-adjustment=1.5 --chain-id=pocket-beta --yes"
export SUPPLIER_ADDR=$(pocketd keys show supplier -a)
As an alternative to appending directly to ~/.bashrc
, you can put the above
in a special ~/.pocketrc
and add source ~/.pocketrc
to
your ~/.profile
(or ~/.bashrc
) file for a cleaner organization.
Fund the Supplier account
Run the following command to get the Supplier
:
echo "Supplier address: $SUPPLIER_ADDR"
Then use the Shannon Beta TestNet faucet to fund the (supplier owner address) account. See Non-Custodial Staking for more information about supplier owner vs operator and non-custodial staking.
Afterwards, you can query the balance using the following command:
pocketd query bank balances $SUPPLIER_ADDR $NODE_FLAGS
You can find all the explorers, faucets and tools at the tools page.