Skip to main content

Contributoor: A Lightweight Beacon Node Companion

·572 words·3 mins·
Xatu Consensus Layer
matty
DevOps Engineer
samcm
DevOps Engineer
savid
DevOps Engineer
Table of Contents

We’re excited to announce Contributoor, a new monitoring and data-gathering tool that helps improve Ethereum’s network visibility while running seamlessly alongside your beacon node. Think of it as a streamlined version of Xatu Sentry with a smaller footprint, fewer dependencies, and a much simpler setup process. For more info on Xatu Sentry, check out our post on contributing to the Xatu dataset.

Why Contributoor?
#

We’re building a network of home stakers to provide comprehensive and decentralized timing data for Ethereum. We started with a small group, and contributoor is a step towards including the broader community as our primary data source.

  • Lightweight: This tool is slimmed down and focuses on the essential features you need.
  • Easy Installation: We built an installer—Contributoor Installer—so anyone can get started in minutes.
  • Reduced Complexity: Contributoor is set up to get you running faster, with minimal overhead compared to a typical Xatu Sentry installation.

How It Works
#

Contributoor runs as a sidecar process to your beacon node, collecting important metrics and events without impacting your node’s performance. It:

  • Connects to your beacon node’s API
  • Monitors key events and metrics
  • Securely forwards data to our collection endpoints

What Does It Do?
#

Contributoor captures the same events Xatu Sentry does, including:

  • beacon_api_eth_v1_events_block
  • beacon_api_eth_v1_events_blob_sidecar
  • beacon_api_eth_v1_events_chain_reorg
  • beacon_api_eth_v1_events_finalized_checkpoint
  • beacon_api_eth_v1_events_head_v2

This data helps researchers and developers:

  • Optimize network performance
  • Identify potential issues early
  • Improve client implementations
  • Understand network behavior during upgrades

Getting Started
#

Installation:

# Download the script.
curl -O https://raw.githubusercontent.com/ethpandaops/contributoor-installer/refs/heads/master/install.sh

# Inspect the script contents.
less install.sh

# Make it executable and run if you're satisfied with the contents.
chmod +x install.sh && ./install.sh

Alternatively, if you trust the source, you can run this one-liner:

curl -O https://raw.githubusercontent.com/ethpandaops/contributoor-installer/refs/heads/master/install.sh && chmod +x install.sh && ./install.sh

Using eth-docker? Contributoor can be run as part of your eth-docker setup - check it out here.

Managing Contributoor:

After installation, you can manage Contributoor using a single command-line interface:

contributoor start     # Start the service
contributoor stop      # Stop the service
contributoor status    # Check service status
contributoor restart   # Restart the service
contributoor config    # View/edit configuration
contributoor update    # Update to latest version
contributoor logs      # Show logs

For more details or troubleshooting tips, check out the main Contributoor GitHub repository.

Staying Up to Date
#

It’s a good idea to periodically check contributoor to ensure you’re on the latest version!

Keeping up to date is simple - just run:

contributoor update

Updating Contributoor

Ready to Contribute?
#

By offering Contributoor as a streamlined data collection tool, we hope to empower the Ethereum community to gather valuable insights and drive meaningful improvements to the network.

We’re gradually scaling up our data collection network, starting with home stakers. If you run your own beacon node and want to help improve Ethereum’s network visibility:

  • Who Can Join: For now, individual home stakers running their own beacon nodes
  • Getting Started: We need some basic details to get you started - Apply here
  • What’s Next: We’re expanding access as we scale, with home stakers being our primary focus
ethpandaops/contributoor

Contributoor is a lightweight service that runs alongside an Ethereum consensus client and collects data via the client’s APIs.

Go
5
0

ethpandaops/contributoor-installer

The installer for the contributoor service.

Go
6
1

Get in Touch
#

🤫 Psst… we’ve got something cooking in the lab 🧪 that lets you peek at some of the contributed data. More on that soon!