smartnode

README

Rocket Pool - Smart Node Package

---

Rocket Pool 2.5 is a next generation Ethereum proof of stake (PoS) infrastructure service designed to be highly decentralised, distributed and compatible with Ethereum 2.0, the new consensus protocol that Ethereum will transition to in 2020.

Running a Rocket Pool smart node allows you to stake on Ethereum 2.0 with only 16 ETH, and earn a higher return than you would outside the network.

This repository contains the source code for:

• The Rocket Pool smart node client (CLI), which is used to manage a smart node either locally or remotely (over SSH)
• The Rocket Pool smart node service, which provides an API for client communication and performs background node tasks
• The Rocket Pool smart node PoW proxy, a simple Eth 1.0 client proxy server for communicating with remote Eth 1.0 services such as Infura

The smart node service and PoW proxy are designed to be run as part of a docker stack and generally do not need to be installed manually. See the Rocket Pool dockerhub page for a complete list of docker images.

Installation

See the Smart Node Installer repository for supported platforms and installation instructions.

CLI Commands

The following commands are available via the smart node client:

• rocketpool service install - Install the Rocket Pool service either locally or to a remote server

• rocketpool service config - Configure the Rocket Pool service for use

• rocketpool service status - Display the current status of the Rocket Pool service

• rocketpool service start - Start the Rocket Pool service to begin running a smart node

• rocketpool service pause - Pause the Rocket Pool service temporarily

• rocketpool service stop - Pause the Rocket Pool service temporarily

• rocketpool service terminate - Terminate the Rocket Pool service and remove all associated docker containers & volumes

• rocketpool service logs [services...] - View the logs for one or more services running as part of the docker stack

• rocketpool service stats - Display resource usage statistics for the Rocket Pool service

• rocketpool service version - Display version information for the Rocket Pool client & service

• rocketpool wallet status - Display the current status of the node's wallet

• rocketpool wallet init - Initialize the node's password and wallet

• rocketpool wallet recover - Recover a node wallet from a mnemonic phrase

• rocketpool wallet rebuild - Rebuild validator keystores from derived keys

• rocketpool wallet export - Export the node's wallet information

• rocketpool faucet withdraw [token] - Withdraw ETH or tokens from the RP faucet (beta only)

• rocketpool node status - Display the current status of the node

• rocketpool node register - Register the node with the Rocket Pool network

• rocketpool node set-timezone - Update the node's timezone location

• rocketpool node deposit - Make a deposit to create a minipool and begin staking

• rocketpool node send [amount] [token] [to] - Send an amount of ETH or tokens to an address

• rocketpool minipool status - Display the current status of all minipools run by the node

• rocketpool minipool refund - Refund ETH from minipools which have had user-deposited ETH assigned to them

• rocketpool minipool dissolve - Dissolve initialized minipools and recover deposited ETH from them

• rocketpool minipool exit - Exit active minipool validators from the beacon chain

• rocketpool minipool withdraw - Withdraw rewards from minipools which have finished staking and close them

• rocketpool minipool close - Close minipools which have timed out and been dissolved

• rocketpool network node-fee - Display the current network node commission rate for new minipools

• rocketpool queue status - Display the current status of the deposit pool

• rocketpool queue process - Process the deposit pool by assigning user-deposited ETH to available minipools