1. System Considerations

The Keep Network expects certain capabilites for each node running on the network. To help attain these capabilities consider the following criteria:

  • It is paramount that Keep nodes remain available to the Keep Network. We strongly encourage a stable and redundant internet connection.

  • A connection to a production grade self-hosted or third party Ethereum node deployment.

  • Persistent and redundant storage that will survive a VM or container rotation, and disk failure.

  • Each random beacon client running on the network requires a unique Ethereum operator account.

  • Each random beacon client running on the network requires a unique IP address or a unique application port running under the same IP.

  • Recommended machine types by provider:

Your operating environment will ultimately dictate what machine type to go with. This is particulary relevant if you’re running a containerized solution where multiple applications are sharing VM resources. The below types are sufficient for running at least one instance of the Keep Random Beacon client.

Cloud Provider Machine Type

Google Cloud





A2 v2


2 vCPU / 4 GiB RAM / 1 GiB Persistent Storage

2. Configuration

2.1. Network

Default port mappings.

Egress Port

Ethereum Network

8545 / 8546

Keep Network


Ingress Port

Keep Network


If you set a different port in your keep-client configuration, or configure peers with non-default ports configured, firewall rules will need to be adjusted accordingly.

2.2. Application

Application configurations are stored in a .toml file and passed to the application run command with the --config flag.

2.2.1. Sample

# Ethereum host connection info.
  URL = "ws://"
  URLRPC = ""

# Keep operator Ethereum account.
  KeyFile = "/Users/someuser/ethereum/data/keystore/UTC--2018-03-11T01-37-33.202765887Z--AAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8AAAAAAAAA"

# Keep contract addresses configuration.
  # Hex-encoded address of KeepRandomBeaconOperator contract
  # Hex-encoded address of TokenStaking contract
  # Hex-encoded address of KeepRandomBeaconService contract. Only needed
  # in cases where the client's utility functions will be used (e.g., the
  # relay subcommand).

# Keep network configuration.
  Peers = ["/ip4/", "/dns4/some-keep-host.com/tcp/3919/ipfs/njOXcNpVTweO3fmX72OTgDX9lfb1AYiiq4BN6Da1tFy9nT3sRT2h1"]
  Port  = 3920
  # Override the node's default addresses announced in the network
  AnnouncedAddresses = ["/dns4/example.com/tcp/3919", "/ip4/"]

# Storage is encrypted
  DataDir = "/my/secure/location"

2.2.2. Parameters

ethereum Description Default Required


The Ethereum host your keep-client will connect to. Websocket protocol/port.




The Ethereum host your keep-client will connect to. RPC protocol/port.



ethereum.account Description Default Required


The Keep operator Ethereum account address.




The local filesystem path to your Keep operator Ethereum account keyfile.



ethereum.ContractAddresses Description Default Required


Hex-encoded address of the KeepRandomBeaconOperator Contract.




Hex-encoded address of the KeepRandomBeaconService Contract.




Hex-encoded address of the TokenStaking Contract.



LibP2P Description Default Required


Comma separated list of network peers to boostrap against.




The port to run your instance of Keep on.




Multiaddr formatted hostnames or addresses annouced to the Keep Network. More on multiaddr format in the libp2p reference.



Storage Description Default Required


Location to store the Keep nodes group membership details.



3. Build from Source

See the building section in our developer docs.

4. Docker

4.1. Get Image

Latest: docker pull keepnetwork/keep-client

Tag: docker pull keepnetwork/keep-client:<tag-version>

4.2. Run Image

This is a sample run command for illustration purposes only.

export KEEP_CLIENT_ETHEREUM_PASSWORD=$(cat .secrets/eth-account-password.txt)
export KEEP_CLIENT_CONFIG_DIR=$(pwd)/config
export KEEP_CLIENT_PERSISTENCE_DIR=$(pwd)/persistence

docker run -d \
--entrypoint /usr/local/bin/keep-client
--volume $KEEP_CLIENT_PERSISTENCE_DIR:/mnt/keep-client/persistence \
--volume $KEEP_CLIENT_CONFIG_DIR:/mnt/keep-client/config \
--env LOG_LEVEL=debug \
-p 3919:3919 \
keepnetwork/keep-client:<version> --config /mnt/keep-client/config/keep-client-config.toml start

5. Deployment Considerations

5.1. Kubernetes

At Keep we run on GCP + Kube. To accommodate the aforementioned system considerations we use the following pattern for each of our environments:

  • Regional Kube cluster.

  • 5 beacon clients, each running minimum stake required by the network.

  • A LoadBalancer Service for each client.

  • A StatefulSet for each client.

You can see our Ropsten Kube configurations here

6. Logging

Below are some of the key things to look out for to make sure you’re booted and connected to the network:

6.1. Configurable Values


6.2. Startup

▓▓▌ ▓▓ ▐▓▓ ▓▓▓▓▓▓▓▓▓▓▌▐▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓ ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓ ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▄
▓▓▓▓▓▓▓▓▓▓ ▓▓▓▓▓▓▓▓▓▓▌▐▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓ ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓ ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓
  ▓▓▓▓▓▓    ▓▓▓▓▓▓▓▀    ▐▓▓▓▓▓▓    ▐▓▓▓▓▓   ▓▓▓▓▓▓     ▓▓▓▓▓   ▐▓▓▓▓▓▌   ▐▓▓▓▓▓▓
  ▓▓▓▓▓▓▄▄▓▓▓▓▓▓▓▀      ▐▓▓▓▓▓▓▄▄▄▄         ▓▓▓▓▓▓▄▄▄▄         ▐▓▓▓▓▓▌   ▐▓▓▓▓▓▓
  ▓▓▓▓▓▓▓▓▓▓▓▓▓▀        ▐▓▓▓▓▓▓▓▓▓▓         ▓▓▓▓▓▓▓▓▓▓▌        ▐▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓
  ▓▓▓▓▓▓▀▀▓▓▓▓▓▓▄       ▐▓▓▓▓▓▓▀▀▀▀         ▓▓▓▓▓▓▀▀▀▀         ▐▓▓▓▓▓▓▓▓▓▓▓▓▓▓▀
  ▓▓▓▓▓▓   ▀▓▓▓▓▓▓▄     ▐▓▓▓▓▓▓     ▓▓▓▓▓   ▓▓▓▓▓▓     ▓▓▓▓▓   ▐▓▓▓▓▓▌
▓▓▓▓▓▓▓▓▓▓ █▓▓▓▓▓▓▓▓▓ ▐▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓ ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓  ▓▓▓▓▓▓▓▓▓▓
▓▓▓▓▓▓▓▓▓▓ ▓▓▓▓▓▓▓▓▓▓ ▐▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓ ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓  ▓▓▓▓▓▓▓▓▓▓

Trust math, not hardware.

| Keep Random Beacon Node                                                                     |
|                                                                                             |
| Port: 3919                                                                                  |
| IPs : /ip4/    |
|       /ip4/ |

Bonus: If you want to share your LibP2P address with others you can get it from the startup log. When sharing remember to substitute the /ipv4/ address with the public facing IP of your client if you’re running on a private machine, or replace the entire /ipv4/ segment with a DNS entry if you’re using a hostname.

6.3. Peer Connections

21:19:47.129 DEBUG keep-net-w: connected to [1] peers:[16Uiu2HAm3eJtyFKAttzJ85NLMromHuRg4yyum3CREMf6CHBBV6KY]

7. ETH Networks

7.1. Mainnet

7.1.1. Boostrap Peers


7.1.2. Contracts

Contract addresses needed to boot the Random Beacon client:









7.2. Testnet

Keep uses the Ethereum Ropsten Testnet.

7.2.1. Faucet

The KEEP faucet will will issue a 300k KEEP token grant for the provided Ethereum account. You can use the faucet from your web browser or via a terminal using curl.

To use the faucet you need to pass your Ethereum account to the faucet endpoint with the parameter ?account=<eth-account-address>.

Curl Example:

curl 'https://us-central1-keep-test-f3e0.cloudfunctions.net/keep-faucet-ropsten?account=0x0eC14BC7cCA82c942Cf276F6BbD0413216dDB2bE'

Browser Example:


Once you’ve got your KEEP token grant you can manage it with our token dashboard.

7.2.2. Bootstrap Peers

Bootstrap peers will come and go on testnet. As long as at least one of your configured peers is up, there is no need to worry.


7.2.3. Contracts

Contract addresses needed to boot the Random Beacon client:









8. Staking

8.1. Terminology


Hexadecimal string consisting of 40 characters prefixed with "0x" uniquely identifying Ethereum account; derived from ECDSA public key of the party. Example address: 0xb2560a01e4b8b5cb0ac549fa39c7ae255d80e943.


The address owning KEEP tokens or KEEP token grant. The owner’s participation is not required in the day-to-day operations on the stake, so cold storage can be accommodated to the maximum extent.


The address of a party authorized to operate in the network on behalf of a given owner. The operator handles the everyday operations on the delegated stake without actually owning the staked tokens. An operator can not simply transfer away delegated tokens, however, it should be noted that operator’s misbehaviour may result in slashing tokens and thus the entire staked amount is indeed at stake.


the address where the rewards for participation and all reimbursements are sent, earned by an operator, on behalf of an owner

delegated stake

an owner’s staked tokens, delegated to the operator by the owner. Delegation enables KEEP owners to have their wallets offline and their stake operated by operators on their behalf.

operator contract

Ethereum smart contract handling operations that may have an impact on staked tokens.


the address appointed by owner to authorize operator contract on behalf of the owner. Operator contract must be pre-approved by authorizer before the operator is eligible to use it and join the specific part of the network.

8.2. Delegating tokens

KEEP tokens are delegated by the owner. During the delegation, the owner needs to appoint an operator, beneficiary, and authorizer. Owner may delegate owned tokens or tokens from a grant. Owner may decide to delegate just a portion of owned tokens or just a part of tokens from a grant. Owner may delegate multiple times to different operators. Tokens can be delegated using Tokens page in KEEP token dashboard and a certain minimum stake defined by the system is required to be provided in the delegation. The more stake is delegated, the higher chance to be selected to relay group.

Delegation takes immediate effect but can be cancelled within one week without additional delay. After one week operator appointed during the delegation becomes eligible for work selection.

8.3. Authorizations

Before operator is considered as eligible for work selection, authorizer appointed during the delegation needs to review and authorize Keep Random Beacon smart contract. Smart contracts can be authorized using KEEP token dashboard. Authorized operator contracts may slash or seize tokens in case of operator’s misbehavior.