Get started
This guide provides instructions on how to run an orchestrator using the
Go Livepeer
client. In order to use Go Livepeer
, the software must first be
installed. There are several ways Go Livepeer
can be installed depending on
the operating system and the user’s choice of installation method, for example
using a container or building from source. Instructions for installing
Go Livepeer
can be found on the
“Install” guide. The instructions
on this page assumes Go Livepeer
and its associated binaries have been
installed successfully.
Prerequisites
- How to work with a command-line interface
wget
is recommended (alternatively,cURL
can be used)- grpcurl for interacting with gRPC servers for testing and monitoring
- Basic familiarity with installing binaries directly or with Docker
- Familiarity with networking concepts and configuration (URLs, ports and port forwarding, static IPs, etc)
- Access to a hosted or self-hosted Arbitrum node
- Decent bandwidth. Low bandwidth will result in poor performance on the network
Go Livepeer
and its associated binaries have been installed successfully
Run the Go Livepeer client in orchestrator mode.
Get a list of your accessible GPUs
Before running the Go Livepeer client in orchestrator mode you must first get a list of your accessible GPUs. Once you have checked your Nvidia driver is installed, your Nvidia GPUs on your machine should be accessible.
Note: Instructions for non-Nvidia GPUs will be added in the future.
- Use the
nvidia-smi
(installed with the Nvidia driver) to print a list of GPUs:
For example:
The following output indicates that there are 5 GPUs accessible on the machine with IDs from 0 through 4.
Run the livepeer
command
You’re now ready to run Go Livepeer
in orchestrator mode.
Flags
-
Use the
-ethUrl
flag to connect to the arbitrum network using a hosted or self hosted Arbitrum node. -
Use the
-ethAcctAddr
flag to specify the ETH account address that you want the node to use.
Note: This flag is only required if you already have an account that you want to use.
- Be sure the private key for the account address is stored in the keystore directory.
This defaults to
~/.lpData/arbitrum-one-mainnet/keystore
.
Note: It is paramount that you securely manage the private key, as it controls your wallet and funds.
-
Use both the
-orchestrator
and-transcoder
flags to run the binary in orchestrator mode transcoding video. -
-nvidia
is used to specify a comma delimited string of Nvidia GPU IDs. The flag is only required when transcoding with Nvidia GPUs -
-pricePerUnit
is used to specify the price (wei per pixel) for transcoding. The flag is required on startup, but the value can be changed later. -
-serviceAddr
is used to specify the publicly accessible address that the orchestrator should receive requests at. Changing this requires a blockchain transaction, so it’s preferable to use a hostname for a domain you own, not an IP address that may change.
Automatic ETH account creation
If you did not use the -ethAcctAddr
flag, an ETH account will automatically be
created and you will be prompted for a passphrase:
This account will be used to identify your orchestrator on the network. By default, the private key for the account will be stored under:
Note: It is very important to safeguard both the private key and the passphrase because together they allow someone to sign messages and send transactions using the account.
Check the node is accessible
Once your node completes the start up process, you should see the following logs indicating that the node is publicly accessible:
Fund your account with ETH and LPT
In order to activate on Livepeer, your account should have:
- arbETH to pay for transaction fees
- Recommendation: Start with a small amount and add more when needed.
livepeer
andlivepeer_cli
will inform you if your account’s ETH balance is insufficient to pay for transaction fees when attempting to submit the transactions
- Recommendation: Start with a small amount and add more when needed.
- LPT to stake in order to activate
- Recommendation: Check the explorer and find the 100th orchestrator with the most stake. This is the amount of stake required for you to activate. Note that more stake will help you receive more work.
If your orchestrator drops out of the active set (top 100 in stake), it will not be reactivated by the protocol unless (1) you re-register or (2) your stake amount (delegated or self-stake) changes such that you are in the top 100 again. If you are inactive and your stake amount places you in the top 100 but your stake does not change, your orchestrator will not be automatically added to the active set.
Activate
The active orchestrator set consists of the top 100 orchestrators with the most LPT stake on the network. You can check this on the Livepeer Explorer.
Activate using livepeer_cli
Once the orchestrator has been started and is connected to Arbitrum you can activate the orchestrator:
-
Run
livepeer_cli
-
Enter the number corresponding to the
Invoke multi-step "become an orchestrator"
option. -
Set the percentage of LPT rewards that you will keep (the rest will be shared with your delegators):
-
Set the percentage of ETH fees that you will keep (the rest will be shared with your delegators):
-
Set the number of pixels in a single unit of work you will charge a price for (You can use the default (1) and change this later if needed):
-
Set the price (in
Wei
) that you will charge per unit of work. This can be the same as or different from the value used with the-pricePerUnit
flag when starting your orchestrator: -
Set the publicly accessible service address that your orchestrator will receive requests. This should be the same as the value used with the
-serviceAddr
flag when starting your orchestrator, i.e.: -
Set the amount of LPTU (1 LPT = 1e18 LPTU) that you want to stake. It is important this amount is denominated in LPTU; if you want to bond 5 LPT, you would enter 5000000000000000000.
For example:
Note: If the active orchestrator set is full (i.e. at 100 orchestrators), the minimum stake you need to stake to activate is the lowest total stake of an orchestrator in the active set found on the Livepeer Explorer.
- Wait for transactions to confirm. You should see the logs of your orchestrator indicating transactions are submitted and confirmed on-chain. Once the transactions have confirmed, your orchestrator will join the active set in the following round.
Navigate to the Livepeer Explorer on Arbitrum Mainnet
Once you have activated your orchestrator on the Arbitrum Mainnet, you should be able to see it on the Livepeer Explorer.
Was this page helpful?