yellowbench

README

[!IMPORTANT] This tool is still experimental. The results generated by it may not be fully accurate or reliable. Users should exercise caution and verify the data obtained through this tool.

yellowbench

Solana RPC benchmarking tool for Yellowstone Dragon's Mouth Geyser

This is a simple CLI tool that allows you to receive updates from a geyser server and measure their latency. The goal of this tool is to measure the latency and throughput of the geyser server.

[!TIP] Looking to measure transaction landing times instead ? Check out memobench

Usage

• Download the latest release for your OS and architecture from the releases page.
• Execute the binary in a command prompt or terminal.
  • Upon first execution it will create a sample config.json file and exit
  • Edit the config.json file as needed
• Execute the binary again to start the benchmark

Configuration

• geyser_url: The Geyser endpoint to benchmark
• geyser_token: The x-token authentication string (optional, keep empty if not required)
• send_rpc_url: The RPC endpoint to send transactions (optional, if omitted, the RPC URL will be used)
• bench_type: The type of the test to perform, latency to test the latency of the blocks received against the local clock, throughput to test the throughput of the data received
• duration_sec: The duration of the test in seconds

Acknowledgements

• Protocol buffer definitions taken from rpcpool/yellowstone-grpc's repo
• Go code definitions generated by Buf

You like this tool ?

Buy me a coffee ☕ (or a pizza 🍕 or maybe some cake 🍰) CoffeeFpEteoCSPgHeoj98Sb6LCzoG36PGdRbYwqSvLd

or hire me ;)