The OpenBlockperf client
Project description
OpenBlockperf - A cli tool to monitor and share network metrics from a cardano-node.
The OpenBlockperf Client is a cli tool that collects various data points from a local cardano node. If you dont know what a cardano-node is or dont run one yourself, this tool is probably not very usefull for you.
Installation / Get started
Install openblockperf client using our installer script:
curl -fsSL https://raw.githubusercontent.com/cardano-foundation/openblockperf/main/install.sh | sudo bash
# Once installed you should have a 'blockperf' executable installed.
$ blockperf version
Usage
To run the client you need to specify which network it is in.
Usage Examples:
# Use mainnet (default)
blockperf run
# Use preprod network
blockperf run --network preprod
# Use preview network
blockperf run -n preview
# Override API URL for local development
blockperf run --api-url http://localhost:8000
# Combine network with custom API URL
blockperf run --network mainnet --api-url https://custom-api.example.com
# Or use environment variable
export OPENBLOCKPERF_NETWORK=preprod
blockperf run
Registration
To register for an api key, you need to have a calidus key registered on chain.
Then use the blockperf register command to start the registration. That
You will receive a challenge that you will need to sign with your calidus
key. Then submit that signature back to the api to receive the apikey.
blockperf register --
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file openblockperf-0.0.24.tar.gz.
File metadata
- Download URL: openblockperf-0.0.24.tar.gz
- Upload date:
- Size: 45.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.9.29 {"installer":{"name":"uv","version":"0.9.29","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"13","id":"trixie","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d0062eb6173c63dfdcfe755360184070bb22f0dc4fce85ffc793b518c32a0197
|
|
| MD5 |
92aeb808536933771addfdb937098aa7
|
|
| BLAKE2b-256 |
1880694fc76619e7c9fc9c2015febadb0aee35aa5c87a94087c7d9ba1aead780
|
File details
Details for the file openblockperf-0.0.24-py3-none-any.whl.
File metadata
- Download URL: openblockperf-0.0.24-py3-none-any.whl
- Upload date:
- Size: 47.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.9.29 {"installer":{"name":"uv","version":"0.9.29","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"13","id":"trixie","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a6ed113217f5270d32b93245ee064d2feb94976d8c86e7cae71eaedd3db95990
|
|
| MD5 |
06db2116e291ee90ee95cd8a5cf22669
|
|
| BLAKE2b-256 |
6bcaab118f0b5424aa695ca296773c7d7d6980feecc5559d1878bec65691e92c
|
