Overview

Livepeer is currently deployed on the Arbitrum L2 network (Arbitrum One). In order to interact with the Livepeer smart contracts you will need to connect to an Arbitrum RPC. If you plan to run your Gateway in On-Chain mode, you will need:

An Ethereum account with funds to pay for transaction fees
An Ethereum RPC URL to connect to the Arbitrum network where Livepeer is deployed

ETH Account Setup

Step 1: Create and fund your ETH account

You need an Arbitrum One ETH account for on-chain Livepeer operation.

Create a keystore

Use go-livepeer to initialize a keystore path:

./livepeer -network arbitrum-one-mainnet -ethKeystorePath ~/.lpData/keystore

Store your keystore and passphrase securely.

Never commit keystore files or passphrase files to version control.

Fund your account on Arbitrum One

Add ETH to your account for gas and ticket payments.

Minimum recommended to start: 0.1 ETH
Bridge option: Arbitrum Bridge
Exchange options: Arbitrum exchanges

Required On-Chain Flags

Network Configuration

-network

string

default:"offchain"

Set to the blockchain network arbitrum-one-mainnet

Account Configuration

-ethUrl

string

default:"none"

Ethereum JSON-RPC URL

-ethAcctAddr

string

default:"none"

Your Ethereum PUBLIC Wallet (Account) Address.The 0x prefix is optional for -ethAcctAddr Livepeer accepts addresses both with and without the prefix.

-ethPassword

string

default:"none"

Password for your KEYSTORE file orPath to your password.txt file containing the password for your Keystore Account

-ethKeystorePath

string

default:"none"

Path to your encrypted keystore directory or keyfile containing your private key

Security Notes

Never share your keystore files - they contain your encrypted private keys
Use strong passwords for keystore encryption - Back up your keystore securely - The ethPassword only protects the keystore file - your actual private key is stored encrypted within the keystore - Never share your wallet private key. In case of accidental public exposure - remove any funds & change your wallet immediately

Easy Setup with Livepeer Tooling

Install Your Gateway Software First

-> then come back to this guide.

Livepeer will automatically create a new wallet & keystore for you if you do not provide an existing wallet address after first installing your Gateway software. The software will detect no keystore exists for that address and ask you to:

Enter your private key
Create an account address (wallet) -ethAcctAddr
Set a password for the keystore encryption -ethPassword
Create the keystore file -ethKeystorePath

Use the below command to quickstart an on-chain gateway with a new wallet and auto-generate all required parameters. See RPC URL for instructions on finding or using an alternative Arbitrum RPC URL.

Create New Wallet & Keystore

livepeer -gateway \
-network arbitrum-one-mainnet \
-ethUrl=https://arb1.arbitrum.io/rpc #public RPC: rate-limited
\ -ethAcctAddr="" \
-ethKeystorePath="" \
-ethPassword=""

If you want to bring an existing wallet - put the public address in the -ethAcctAddr flag.

Exisiting Wallet, New Keystore

livepeer -gateway \
    -network arbitrum-one-mainnet \
    -ethUrl=https://arb1.arbitrum.io/rpc #public rate-limited RPC
    \ -ethAcctAddr=<YOUR_WALLET_ADDRESS> \
    -ethKeystorePath=""

Account Data Default Folders

Account data is stored in the ~/.lpData directory by default. Keystore files are by default created in:

Docker
Linux / Mac
Windows

Docker

#inside container
/root/.lpData/

#on host
/var/lib/docker/volumes/gateway-lpData/_data/

Linux/Mac

~/.lpData/arbitrum-one-mainnet/keystore/

Windows

#C:\Users\YOUR_USERNAME\.lpData\{network}\keystore\
%USERPROFILE%\.lpData\arbitrum-one-mainnet\keystore\

Next Step

Fund Your Gateway

Comprehensive On-Chain Setup Guide

Full Guide with alternative options for setting up an on-chain Gateway

Show REMOVE ME: Old Stuff

An Ethereum private key is a 256-bit random integer. For user presentation and interoperability across most software, this number is nearly always represented as a 64-character hexadecimal string

# Private Key Example
afdfd9c3d2095ef696594f6cedcae59e72dcd697e2a7521b1578140422a4f890

Account Address: Created and stored in

# Account Address
~/.lpData/arbitrum-one-mainnet/keystore/

Keystore File: Located at

# Keystore file
~/.lpData/arbitrum-one-mainnet/keystore/UTC--{timestamp}--{address}

Password: Livepeer prompts you to enter and confirm a password

ETH Account

Docker

Show Create ETH Wallet & Keystore

Create Livepeer Gateway ETH accountIn this step we need to start the Gateway in order to create an Ethereum account.

docker compose run -it gateway

When prompted for the ETH password, enter a strong password to secure your Ethereum account. This password is used to decrypt and access the ETH private key.

Make sure to never share or lose access to either the password or the keystore file.

Keep this password handy, we will use it in the following steps.

After you see the message that the Ethereum account has been unlocked, CTRL+C to exit the Livepeer docker instance.Using the previously created ETH password, create the eth-secret file

nano -p /var/lib/docker/volumes/gateway-lpData/_data/eth-secret.txt

Modify Docker compose file to include eth-secret.txt

nano docker-compose.yml

Add the following line below the -ethKeystorePath and save

-ethPassword=/root/.lpData/eth-secret.txt

Here is the full modified version of the docker-compose.yml file

version: '3.9'

services:
gateway:
    image: livepeer/go-livepeer:<RELEASE_VERSION>
    container_name: "gateway"
    hostname: "gateway"
    ports:
    - 1935:1935
    - 8935:8935
    volumes:
    - gateway-lpData:/root/.lpData
    command: '-ethUrl=<YOUR ARB APC>
            -ethKeystorePath=/root/.lpData
            -ethPassword=/root/.lpData/eth-secret.txt
            -network=arbitrum-one-mainnet
            -cliAddr=gateway:5935
            -broadcaster=true
            -monitor=true
            -v=99
            -blockPollingInterval=20
            -maxPricePerUnit=300
            -pixelsPerUnit=1
            -rtmpAddr=0.0.0.0:1935
            -httpAddr=0.0.0.0:8935
            '
volumes:
gateway-lpData:
    external: true

Start Livepeer in the background

docker compose up -d

Launch the livepeer_cli

docker exec -it gateway /bin/bash
livepeer_cli -host gateway -http 5935

Linux

Show Create ETH Wallet & Keystore

Windows

Show Create ETH Wallet & Keystore

Funding Your ETH Account

See

-ethUrl: Ethereum JSON-RPC URL (required for on-chain)
-ethAcctAddr: Your Ethereum account address
-ethPassword: Password for your ETH account or path to password file
-ethKeystorePath: Path to your keystore directory or keyfile

Development Setup For testing, use the devtool to create keys :

func CreateKey(keystoreDir string) string {
    keyStore := keystore.NewKeyStore(keystoreDir, keystore.StandardScryptN, keystore.StandardScryptP)
    account, err := keyStore.NewAccount(passphrase)
    return account.Address.Hex()
}

Gateway Knowledge Hub

Public Gateways

Operate Quickstart ⚡

Run A Gateway

Guides and Tools

Technical References

On-Chain Setup Requirements

Overview

ETH Account Setup

Step 1: Create and fund your ETH account

Required On-Chain Flags

Security Notes

Easy Setup with Livepeer Tooling

Install Your Gateway Software First

Account Data Default Folders

Next Step

Comprehensive On-Chain Setup Guide

ETH Account

Funding Your ETH Account

Gateway Knowledge Hub

Public Gateways

Operate Quickstart ⚡

Run A Gateway

Guides and Tools

Technical References

​Overview

​ETH Account Setup

​Step 1: Create and fund your ETH account

​Required On-Chain Flags

​Security Notes

​ Easy Setup with Livepeer Tooling

Install Your Gateway Software First

​Account Data Default Folders

Next Step

​Comprehensive On-Chain Setup Guide

​ETH Account

​Funding Your ETH Account

Overview

ETH Account Setup

Step 1: Create and fund your ETH account

Required On-Chain Flags

Security Notes

Easy Setup with Livepeer Tooling

Account Data Default Folders

Comprehensive On-Chain Setup Guide

ETH Account

Funding Your ETH Account