Agora-cl is an Agora consensus layer client based on Ethereum proof-of-stake Prysm client written in Go. You can use Agora-cl to participate in Agora's decentralized economy by running a node and, if you have 40,000 BOA to stake, a validator. If you're new to Agora and are not familiar with Ethereum, you may enjoy the beginner-friendly Nodes and networks explainer.

The following table of contents provides a descriptive overview of Agora-cl's documentation:

Quickstart: Run an Agora node (and a validator)

New Agora-cl users can follow this guidance to get started with Agora-cl.

Security best practices

Learn how to minimize risk as a validator. The guidelines provided in this document are client-agnostic (they apply to Agora-cl and other clients, too).

Command-line options

Learn how to configure Agora-cl's Agora node client, validator client, and more through its command-line interface.

Troubleshooting

Review common troubleshooting scenarios and solutions.

Frequently asked questions

Review frequently asked questions and answers.

How-tos

This section contains procedural documentation that walks you through specific tasks related to Agora-cl.

Configure Fee Recipient

Learn how to specify a Fee Recipient wallet address that allows validators to earn transaction fee tips post-Merge.

Sync from a checkpoint

Syncing from a checkpoint significantly reduces the time it takes for Agora-cl's Agora node to sync by piggypacking off of another fully-synced node.

Check node and validator status

Learn how to check the status of your execution node, Agora node, and validator.

Run a slasher

Learn how to run a slasher, an optional Agora node process that detects and reports slashable offenses on the Agora proof-of-stake network.

Backups and migrations

This subsection contains how-tos that help you back up and migrate Agora-cl's data.

Back up & restore database

Learn how to back up and restore your Agora node and validator databases so you can minimize downtime in the event of a system failure.

Import & export slashing protection history

Learn how to import and export your slashing protection history database, a special-purpose database that protects your validator from slashable events.

Move to a new machine

Learn how to migrate from one host system to another while minimizing risk of slashing and downtime.

Validator and wallet management

This subsection contains how-tos that help you manage your validator and associated keys/wallets.

Create a Agora-cl wallet

Learn how to create a wallet using Agora-cl.

Import keys into a Agora-cl wallet

Learn how to import EIP-2335 keystore files into Agora-cl, such as those generated by the Agora deposit CLI.

Maintain validator uptime with systemd or Docker

Learn how to minimize validator downtime by running your validator as a background service through either Docker or systemd.

Exit your validator

Learn how to voluntarily exit your validator from Agora's consensus layer network.

Monitoring, metrics, and alerts

This subsection contains how-tos that help you configure monitoring and alerts for Agora-cl.

Monitor Agora-cl for expected behavior

Learn how to assess the health of your Agora-cl Agora node and/or validator by analyzing output logs.

Monitor validators by index

Learn how to use Agora-cl to monitor block proposals, attestations, slashings, and more for any number of validators.

Collect metrics with client-stats

Learn how to collect Agora node and validator metrics using Agora-cl's client-stats utility. This can be used to relay metrics data to the beaconcha.in stats service.

Use Agora-cl's Web UI

Agora-cl's Web UI can be used to monitor and configure your Agora node and validator on localhost using an app-like interface.