Skip to main content

Prerequisites

Before installing Chainbench, ensure you have the following:
  • Python 3.10 or higher: Check your version with python --version or python3 --version
  • Poetry 1.7+ (optional, only if installing via Poetry): See Poetry installation guide
Chainbench is tested and supported on Python 3.10+. Earlier versions are not supported.

Installation Methods

Core Dependencies

Chainbench automatically installs these key dependencies:
  • locust: Core load testing framework (^2.39.0)
  • click: CLI interface framework (^8.1.6)
  • locust-plugins: Enhanced dashboards and metrics (^4.5.3)
  • tenacity: Retry mechanisms (^9.0.0)
  • base58: Encoding utilities for Solana (^2.1.1)
  • solders: Solana SDK (^0.26.0)
  • websocket-client: WebSocket support (^1.8.0)
  • orjson: Fast JSON parsing (^3.11.2)
Chainbench requires Python 3.10 or higher. Attempting to install on earlier Python versions will fail.

Verify Installation

Confirm Chainbench is installed correctly:
chainbench --version
chainbench --help
You should see output showing the version number and available commands:
chainbench-0.8.8

List Available Profiles

Check that built-in profiles are accessible:
chainbench list profiles
You should see profiles like:
arbitrum.general
avalanche.general
base.general
bsc.general
ethereum.general
evm.heavy
evm.light
polygon.general
solana.general
...

List Available Methods

See which RPC methods are supported:
chainbench list methods
This displays methods grouped by protocol (EVM, Solana, etc.).

Troubleshooting

Command Not Found

If chainbench command is not found after pip installation:
  1. Ensure pip’s binary directory is in your PATH
  2. Try using python -m chainbench or python3 -m chainbench instead
  3. Consider using a virtual environment:
    python3 -m venv venv
    source venv/bin/activate  # On Windows: venv\Scripts\activate
    pip install chainbench
    

Python Version Mismatch

If you get version errors:
  1. Check your Python version: python3 --version
  2. Upgrade Python to 3.10 or higher
  3. Use pyenv or conda to manage multiple Python versions

Poetry Lock Issues

If you encounter lock file errors with Poetry:
poetry lock --no-update
poetry install

Next Steps

Now that Chainbench is installed, proceed to the quickstart guide:

Quickstart Guide

Run your first blockchain benchmark in minutes

Build docs developers (and LLMs) love