Charon test commands are designed to help you evaluate the performance and readiness of your candidate cluster. It allows you to test your connection to other Charon peers, the performance of your beacon node(s), the readiness of your validator client, the performance of the MEV relays you will be using and the infrastructure on which you will run the cluster. It prints a performance report to the standard output (which can be omitted with the --quiet flag) and a machine-readable JSON format of the report if the --output-json flag is set.
Test all
Intended for running tests across all categories. Each flag should have a prefix for its category (i.e.: the flag --endpoints from the beacon tests becomes --beacon-endpoints). For details about each category refer to their respective sections.
Regular tests intended for relatively fast run, without putting any major load on any tested system. Based on which stage you are with your cluster creation, some steps are easened.
Pre-requisites
.
Peers' ENRs, supplied to the --peers-enrs flag.
Running beacon node(s) towards which tests will be executed, supplied to --beacon-endpoints flag.
Running validator client towards which tests will be executed.
Running MEV relay(s) towards which tests will be executed, supplied to --mev-endpoints flag.
Example run
charon alpha test all \
--peers-enrs="enr:-HW4QMno_MB_ID6GFVxoIQAHHVHZZZjzFctxtX2tm9D95tvaPbHathi8YUP8jh8v2YUAVu2fYWEOB_BT14pt8QgiGg2AgmlkgnY0iXNlY3AyNTZrMaECdpnK83s0dbBwCaEfDIkQ-3nJkkC93STvv6Vmi0bYlzg,enr:-HW4QO2vefLueTBEUGly5hkcpL7NWdMKWx7Nuy9f7z6XZInCbFAc0IZj6bsnmj-Wi4ElS6jNa0Mge5Rkc2WGTVemas2AgmlkgnY0iXNlY3AyNTZrMaECR9SmYQ_1HRgJmNxvh_ER2Sxx78HgKKgKaOkCROYwaDY" \
--beacon-endpoints="https://ethereum-holesky-beacon-api.publicnode.com,https://ethereum-sepolia-beacon-api.publicnode.com" \
--mev-endpoints="https://0xa15b52576bcbf1072f4a011c0f99f9fb6c66f3e1ff321f11f461d15e31b1cb359caa092c71bbded0bae5b5ea401aab7e@aestus.live,https://0xa7ab7a996c8584251c8f925da3170bdfd6ebc75d50f5ddc4050a6fdc77f2a3b5fce2cc750d0865e05d7228af97d69561@agnostic-relay.net,https://0x8b5d2e73e2a3a55c6c87b8b6eb92e0149a125c852751db1422fa951e42a09b82c142c3ea98d0d9930b056a3bc9896b8f@bloxroute.max-profit.blxrbdn.com,https://0xac6e77dfe25ecd6110b8e780608cce0dab71fdd5ebea22a16c0205200f2f8e2e3ad3b71d3499c54ad14d6c21b41a37ae@boost-relay.flashbots.net,https://0xa1559ace749633b997cb3fdacffb890aeebdb0f5a3b6aaa7eeeaf1a38af0a8fe88b9e4b1f61f236d2e64d95733327a62@relay.ultrasound.money,https://0x8c4ed5e24fe5c6ae21018437bde147693f68cda427cd1122cf20819c30eda7ed74f72dece09bb313f2a1855595ab677d@regional.titanrelay.xyz,https://0x8c4ed5e24fe5c6ae21018437bde147693f68cda427cd1122cf20819c30eda7ed74f72dece09bb313f2a1855595ab677d@global.titanrelay.xyz"
Pre-requisites
Cluster definition file, supplied to the --peers-definition-file flag.
Running beacon node(s) towards which tests will be executed, supplied to --beacon-endpoints flag.
Running validator client towards which tests will be executed.
Running MEV relay(s) towards which tests will be executed, supplied to --mev-endpoints flag.
Example run
charon alpha test all \
--peers-definition-file="./.charon/cluster-definition.json" \
--beacon-endpoints="https://ethereum-holesky-beacon-api.publicnode.com,https://ethereum-sepolia-beacon-api.publicnode.com" \
--mev-endpoints="https://0xa15b52576bcbf1072f4a011c0f99f9fb6c66f3e1ff321f11f461d15e31b1cb359caa092c71bbded0bae5b5ea401aab7e@aestus.live,https://0xa7ab7a996c8584251c8f925da3170bdfd6ebc75d50f5ddc4050a6fdc77f2a3b5fce2cc750d0865e05d7228af97d69561@agnostic-relay.net,https://0x8b5d2e73e2a3a55c6c87b8b6eb92e0149a125c852751db1422fa951e42a09b82c142c3ea98d0d9930b056a3bc9896b8f@bloxroute.max-profit.blxrbdn.com,https://0xac6e77dfe25ecd6110b8e780608cce0dab71fdd5ebea22a16c0205200f2f8e2e3ad3b71d3499c54ad14d6c21b41a37ae@boost-relay.flashbots.net,https://0xa1559ace749633b997cb3fdacffb890aeebdb0f5a3b6aaa7eeeaf1a38af0a8fe88b9e4b1f61f236d2e64d95733327a62@relay.ultrasound.money,https://0x8c4ed5e24fe5c6ae21018437bde147693f68cda427cd1122cf20819c30eda7ed74f72dece09bb313f2a1855595ab677d@regional.titanrelay.xyz,https://0x8c4ed5e24fe5c6ae21018437bde147693f68cda427cd1122cf20819c30eda7ed74f72dece09bb313f2a1855595ab677d@global.titanrelay.xyz"
Pre-requisites
Cluster lock file, supplied to the --peers-lock-file flag.
Running beacon node(s) towards which tests will be executed, supplied to --beacon-endpoints flag.
Running validator client towards which tests will be executed.
Running MEV relay(s) towards which tests will be executed, supplied to --mev-endpoints flag.
Example run
charon alpha test all \
--peers-lock-file="./.charon/cluster-lock.json" \
--beacon-endpoints="https://ethereum-holesky-beacon-api.publicnode.com,https://ethereum-sepolia-beacon-api.publicnode.com" \
--mev-endpoints="https://0xa15b52576bcbf1072f4a011c0f99f9fb6c66f3e1ff321f11f461d15e31b1cb359caa092c71bbded0bae5b5ea401aab7e@aestus.live,https://0xa7ab7a996c8584251c8f925da3170bdfd6ebc75d50f5ddc4050a6fdc77f2a3b5fce2cc750d0865e05d7228af97d69561@agnostic-relay.net,https://0x8b5d2e73e2a3a55c6c87b8b6eb92e0149a125c852751db1422fa951e42a09b82c142c3ea98d0d9930b056a3bc9896b8f@bloxroute.max-profit.blxrbdn.com,https://0xac6e77dfe25ecd6110b8e780608cce0dab71fdd5ebea22a16c0205200f2f8e2e3ad3b71d3499c54ad14d6c21b41a37ae@boost-relay.flashbots.net,https://0xa1559ace749633b997cb3fdacffb890aeebdb0f5a3b6aaa7eeeaf1a38af0a8fe88b9e4b1f61f236d2e64d95733327a62@relay.ultrasound.money,https://0x8c4ed5e24fe5c6ae21018437bde147693f68cda427cd1122cf20819c30eda7ed74f72dece09bb313f2a1855595ab677d@regional.titanrelay.xyz,https://0x8c4ed5e24fe5c6ae21018437bde147693f68cda427cd1122cf20819c30eda7ed74f72dece09bb313f2a1855595ab677d@global.titanrelay.xyz"
Load tests intended for more time consuming run. Beacon nodes are put under heavy load. MEV relays are required to create real blocks. Based on which stage you are with your cluster creation, some steps are easened.
Pre-requisites
.
Peers' ENRs, supplied to the --peers-enrs flag.
Running beacon node(s) towards which tests will be executed, supplied to --beacon-endpoints flag. It is important that the node is expecting to handle huge load and that it is not a publicly accessible one, which can block you.
Running validator client towards which tests will be executed.
Running MEV relay(s) towards which tests will be executed, supplied to --mev-endpoints flag.
Running beacon node which will be used for fetching data required by the MEV relay for block creation, supplied to --mev-beacon-node-endpoint. There is no restrictions on the node and a public one can be used.
Example run
charon alpha test all \
--peers-enrs="enr:-HW4QMno_MB_ID6GFVxoIQAHHVHZZZjzFctxtX2tm9D95tvaPbHathi8YUP8jh8v2YUAVu2fYWEOB_BT14pt8QgiGg2AgmlkgnY0iXNlY3AyNTZrMaECdpnK83s0dbBwCaEfDIkQ-3nJkkC93STvv6Vmi0bYlzg,enr:-HW4QO2vefLueTBEUGly5hkcpL7NWdMKWx7Nuy9f7z6XZInCbFAc0IZj6bsnmj-Wi4ElS6jNa0Mge5Rkc2WGTVemas2AgmlkgnY0iXNlY3AyNTZrMaECR9SmYQ_1HRgJmNxvh_ER2Sxx78HgKKgKaOkCROYwaDY" \
--beacon-endpoints="http://127.0.0.1:5052/" \
--beacon-load-test \
--mev-endpoints="https://0xa15b52576bcbf1072f4a011c0f99f9fb6c66f3e1ff321f11f461d15e31b1cb359caa092c71bbded0bae5b5ea401aab7e@aestus.live,https://0xa7ab7a996c8584251c8f925da3170bdfd6ebc75d50f5ddc4050a6fdc77f2a3b5fce2cc750d0865e05d7228af97d69561@agnostic-relay.net,https://0x8b5d2e73e2a3a55c6c87b8b6eb92e0149a125c852751db1422fa951e42a09b82c142c3ea98d0d9930b056a3bc9896b8f@bloxroute.max-profit.blxrbdn.com,https://0xac6e77dfe25ecd6110b8e780608cce0dab71fdd5ebea22a16c0205200f2f8e2e3ad3b71d3499c54ad14d6c21b41a37ae@boost-relay.flashbots.net,https://0xa1559ace749633b997cb3fdacffb890aeebdb0f5a3b6aaa7eeeaf1a38af0a8fe88b9e4b1f61f236d2e64d95733327a62@relay.ultrasound.money,https://0x8c4ed5e24fe5c6ae21018437bde147693f68cda427cd1122cf20819c30eda7ed74f72dece09bb313f2a1855595ab677d@regional.titanrelay.xyz,https://0x8c4ed5e24fe5c6ae21018437bde147693f68cda427cd1122cf20819c30eda7ed74f72dece09bb313f2a1855595ab677d@global.titanrelay.xyz" \
--mev-beacon-node-endpoint="https://ethereum-beacon-api.publicnode.com" \
--mev-load-test
Pre-requisites
Cluster definition file, supplied to the --peers-definition-file flag.
Running beacon node(s) towards which tests will be executed, supplied to --beacon-endpoints flag. It is important that the node is expecting to handle huge load and that it is not a publicly accessible one, which can block you.
Running validator client towards which tests will be executed.
Running MEV relay(s) towards which tests will be executed, supplied to --mev-endpoints flag.
Running beacon node which will be used for fetching data required by the MEV relay for block creation, supplied to --mev-beacon-node-endpoint. There is no restrictions on the node and a public one can be used.
Example run
charon alpha test all \
--peers-definition-file="./.charon/cluster-definition.json" \
--beacon-endpoints="http://127.0.0.1:5052/" \
--beacon-load-test \
--mev-endpoints="https://0xa15b52576bcbf1072f4a011c0f99f9fb6c66f3e1ff321f11f461d15e31b1cb359caa092c71bbded0bae5b5ea401aab7e@aestus.live,https://0xa7ab7a996c8584251c8f925da3170bdfd6ebc75d50f5ddc4050a6fdc77f2a3b5fce2cc750d0865e05d7228af97d69561@agnostic-relay.net,https://0x8b5d2e73e2a3a55c6c87b8b6eb92e0149a125c852751db1422fa951e42a09b82c142c3ea98d0d9930b056a3bc9896b8f@bloxroute.max-profit.blxrbdn.com,https://0xac6e77dfe25ecd6110b8e780608cce0dab71fdd5ebea22a16c0205200f2f8e2e3ad3b71d3499c54ad14d6c21b41a37ae@boost-relay.flashbots.net,https://0xa1559ace749633b997cb3fdacffb890aeebdb0f5a3b6aaa7eeeaf1a38af0a8fe88b9e4b1f61f236d2e64d95733327a62@relay.ultrasound.money,https://0x8c4ed5e24fe5c6ae21018437bde147693f68cda427cd1122cf20819c30eda7ed74f72dece09bb313f2a1855595ab677d@regional.titanrelay.xyz,https://0x8c4ed5e24fe5c6ae21018437bde147693f68cda427cd1122cf20819c30eda7ed74f72dece09bb313f2a1855595ab677d@global.titanrelay.xyz" \
--mev-beacon-node-endpoint="https://ethereum-beacon-api.publicnode.com" \
--mev-load-test
Pre-requisites
Cluster lock file, supplied to the --peers-lock-file flag.
Running beacon node(s) towards which tests will be executed, supplied to --beacon-endpoints flag. It is important that the node is expecting to handle huge load and that it is not a publicly accessible one, which can block you.
Running validator client towards which tests will be executed.
Running MEV relay(s) towards which tests will be executed, supplied to --mev-endpoints flag.
Running beacon node which will be used for fetching data required by the MEV relay for block creation, supplied to --mev-beacon-node-endpoint. There is no restrictions on the node and a public one can be used.
Example run
charon alpha test all \
--peers-lock-file="./.charon/cluster-lock.json" \
--beacon-endpoints="http://127.0.0.1:5052/" \
--beacon-load-test \
--mev-endpoints="https://0xa15b52576bcbf1072f4a011c0f99f9fb6c66f3e1ff321f11f461d15e31b1cb359caa092c71bbded0bae5b5ea401aab7e@aestus.live,https://0xa7ab7a996c8584251c8f925da3170bdfd6ebc75d50f5ddc4050a6fdc77f2a3b5fce2cc750d0865e05d7228af97d69561@agnostic-relay.net,https://0x8b5d2e73e2a3a55c6c87b8b6eb92e0149a125c852751db1422fa951e42a09b82c142c3ea98d0d9930b056a3bc9896b8f@bloxroute.max-profit.blxrbdn.com,https://0xac6e77dfe25ecd6110b8e780608cce0dab71fdd5ebea22a16c0205200f2f8e2e3ad3b71d3499c54ad14d6c21b41a37ae@boost-relay.flashbots.net,https://0xa1559ace749633b997cb3fdacffb890aeebdb0f5a3b6aaa7eeeaf1a38af0a8fe88b9e4b1f61f236d2e64d95733327a62@relay.ultrasound.money,https://0x8c4ed5e24fe5c6ae21018437bde147693f68cda427cd1122cf20819c30eda7ed74f72dece09bb313f2a1855595ab677d@regional.titanrelay.xyz,https://0x8c4ed5e24fe5c6ae21018437bde147693f68cda427cd1122cf20819c30eda7ed74f72dece09bb313f2a1855595ab677d@global.titanrelay.xyz" \
--mev-beacon-node-endpoint="https://ethereum-beacon-api.publicnode.com" \
--mev-load-test
If you are running Charon using the , services like the beacon node and validator client are hosted locally. To run the beacon node and validator client tests, you need to point them toward the correct Docker container, and also include the Docker container’s network. Check your docker networks with docker network ls. When you run the test command, specify the Docker network with --network <name>. Read more about docker networking .
Test all
Intended for running tests across all categories. Each flag should have a prefix for its category (i.e.: the flag --endpoints from the beacon tests becomes --beacon-endpoints). For details about each category refer to their respective sections.
Regular tests intended for relatively fast run, without putting any major load on any tested system. Based on which stage you are with your cluster creation, some steps are easened.
Pre-requisites
.
Peers' ENRs, supplied to the --peers-enrs flag.
Running beacon node(s) towards which tests will be executed, supplied to --beacon-endpoints flag.
Running validator client towards which tests will be executed.
Running MEV relay(s) towards which tests will be executed, supplied to --mev-endpoints flag.
Example run
docker run -u $(id -u):$(id -g) --rm -v "$(pwd):/opt/charon/test" obolnetwork/charon:v1.4.0 alpha test all \
--peers-enrs="enr:-HW4QMno_MB_ID6GFVxoIQAHHVHZZZjzFctxtX2tm9D95tvaPbHathi8YUP8jh8v2YUAVu2fYWEOB_BT14pt8QgiGg2AgmlkgnY0iXNlY3AyNTZrMaECdpnK83s0dbBwCaEfDIkQ-3nJkkC93STvv6Vmi0bYlzg,enr:-HW4QO2vefLueTBEUGly5hkcpL7NWdMKWx7Nuy9f7z6XZInCbFAc0IZj6bsnmj-Wi4ElS6jNa0Mge5Rkc2WGTVemas2AgmlkgnY0iXNlY3AyNTZrMaECR9SmYQ_1HRgJmNxvh_ER2Sxx78HgKKgKaOkCROYwaDY" \
--peers-private-key-file="/opt/charon/test/.charon/charon-enr-private-key" \
--beacon-endpoints="https://ethereum-holesky-beacon-api.publicnode.com,https://ethereum-sepolia-beacon-api.publicnode.com" \
--mev-endpoints="https://0xa15b52576bcbf1072f4a011c0f99f9fb6c66f3e1ff321f11f461d15e31b1cb359caa092c71bbded0bae5b5ea401aab7e@aestus.live,https://0xa7ab7a996c8584251c8f925da3170bdfd6ebc75d50f5ddc4050a6fdc77f2a3b5fce2cc750d0865e05d7228af97d69561@agnostic-relay.net,https://0x8b5d2e73e2a3a55c6c87b8b6eb92e0149a125c852751db1422fa951e42a09b82c142c3ea98d0d9930b056a3bc9896b8f@bloxroute.max-profit.blxrbdn.com,https://0xac6e77dfe25ecd6110b8e780608cce0dab71fdd5ebea22a16c0205200f2f8e2e3ad3b71d3499c54ad14d6c21b41a37ae@boost-relay.flashbots.net,https://0xa1559ace749633b997cb3fdacffb890aeebdb0f5a3b6aaa7eeeaf1a38af0a8fe88b9e4b1f61f236d2e64d95733327a62@relay.ultrasound.money,https://0x8c4ed5e24fe5c6ae21018437bde147693f68cda427cd1122cf20819c30eda7ed74f72dece09bb313f2a1855595ab677d@regional.titanrelay.xyz,https://0x8c4ed5e24fe5c6ae21018437bde147693f68cda427cd1122cf20819c30eda7ed74f72dece09bb313f2a1855595ab677d@global.titanrelay.xyz" \
--infra-disk-io-test-file-dir="/opt/charon/test"
Pre-requisites
Cluster definition file, supplied to the --peers-definition-file flag.
Running beacon node(s) towards which tests will be executed, supplied to --beacon-endpoints flag.
Running validator client towards which tests will be executed.
Running MEV relay(s) towards which tests will be executed, supplied to --mev-endpoints flag.
Example run
docker run -u $(id -u):$(id -g) --rm -v "$(pwd):/opt/charon/test" obolnetwork/charon:v1.4.0 alpha test all \
--peers-definition-file="/opt/charon/test/.charon/cluster-definition.json" \
--peers-private-key-file="/opt/charon/test/.charon/charon-enr-private-key" \
--beacon-endpoints="https://ethereum-holesky-beacon-api.publicnode.com,https://ethereum-sepolia-beacon-api.publicnode.com" \
--mev-endpoints="https://0xa15b52576bcbf1072f4a011c0f99f9fb6c66f3e1ff321f11f461d15e31b1cb359caa092c71bbded0bae5b5ea401aab7e@aestus.live,https://0xa7ab7a996c8584251c8f925da3170bdfd6ebc75d50f5ddc4050a6fdc77f2a3b5fce2cc750d0865e05d7228af97d69561@agnostic-relay.net,https://0x8b5d2e73e2a3a55c6c87b8b6eb92e0149a125c852751db1422fa951e42a09b82c142c3ea98d0d9930b056a3bc9896b8f@bloxroute.max-profit.blxrbdn.com,https://0xac6e77dfe25ecd6110b8e780608cce0dab71fdd5ebea22a16c0205200f2f8e2e3ad3b71d3499c54ad14d6c21b41a37ae@boost-relay.flashbots.net,https://0xa1559ace749633b997cb3fdacffb890aeebdb0f5a3b6aaa7eeeaf1a38af0a8fe88b9e4b1f61f236d2e64d95733327a62@relay.ultrasound.money,https://0x8c4ed5e24fe5c6ae21018437bde147693f68cda427cd1122cf20819c30eda7ed74f72dece09bb313f2a1855595ab677d@regional.titanrelay.xyz,https://0x8c4ed5e24fe5c6ae21018437bde147693f68cda427cd1122cf20819c30eda7ed74f72dece09bb313f2a1855595ab677d@global.titanrelay.xyz" \
--infra-disk-io-test-file-dir="/opt/charon/test"
Pre-requisites
Cluster lock file, supplied to the --peers-lock-file flag.
Running beacon node(s) towards which tests will be executed, supplied to --beacon-endpoints flag.
Running validator client towards which tests will be executed.
Running MEV relay(s) towards which tests will be executed, supplied to --mev-endpoints flag.
Example run
docker run -u $(id -u):$(id -g) --rm -v "$(pwd):/opt/charon/test" obolnetwork/charon:v1.4.0 alpha test all \
--peers-lock-file="/opt/charon/test/.charon/cluster-lock.json" \
--peers-private-key-file="/opt/charon/test/.charon/charon-enr-private-key"
--beacon-endpoints="https://ethereum-holesky-beacon-api.publicnode.com,https://ethereum-sepolia-beacon-api.publicnode.com" \
--mev-endpoints="https://0xa15b52576bcbf1072f4a011c0f99f9fb6c66f3e1ff321f11f461d15e31b1cb359caa092c71bbded0bae5b5ea401aab7e@aestus.live,https://0xa7ab7a996c8584251c8f925da3170bdfd6ebc75d50f5ddc4050a6fdc77f2a3b5fce2cc750d0865e05d7228af97d69561@agnostic-relay.net,https://0x8b5d2e73e2a3a55c6c87b8b6eb92e0149a125c852751db1422fa951e42a09b82c142c3ea98d0d9930b056a3bc9896b8f@bloxroute.max-profit.blxrbdn.com,https://0xac6e77dfe25ecd6110b8e780608cce0dab71fdd5ebea22a16c0205200f2f8e2e3ad3b71d3499c54ad14d6c21b41a37ae@boost-relay.flashbots.net,https://0xa1559ace749633b997cb3fdacffb890aeebdb0f5a3b6aaa7eeeaf1a38af0a8fe88b9e4b1f61f236d2e64d95733327a62@relay.ultrasound.money,https://0x8c4ed5e24fe5c6ae21018437bde147693f68cda427cd1122cf20819c30eda7ed74f72dece09bb313f2a1855595ab677d@regional.titanrelay.xyz,https://0x8c4ed5e24fe5c6ae21018437bde147693f68cda427cd1122cf20819c30eda7ed74f72dece09bb313f2a1855595ab677d@global.titanrelay.xyz" \
--infra-disk-io-test-file-dir="/opt/charon/test"
Load tests intended for more time consuming run. Beacon nodes are put under heavy load. MEV relays are required to create real blocks. Based on which stage you are with your cluster creation, some steps are easened.
Pre-requisites
.
Peers' ENRs, supplied to the --peers-enrs flag.
Running beacon node(s) towards which tests will be executed, supplied to --beacon-endpoints flag. It is important that the node is expecting to handle huge load and that it is not a publicly accessible one, which can block you.
Running validator client towards which tests will be executed.
Running MEV relay(s) towards which tests will be executed, supplied to --mev-endpoints flag.
Running beacon node which will be used for fetching data required by the MEV relay for block creation, supplied to --mev-beacon-node-endpoint. There is no restrictions on the node and a public one can be used.
Cluster definition file, supplied to the --peers-definition-file flag.
Running beacon node(s) towards which tests will be executed, supplied to --beacon-endpoints flag. It is important that the node is expecting to handle huge load and that it is not a publicly accessible one, which can block you.
Running validator client towards which tests will be executed.
Running MEV relay(s) towards which tests will be executed, supplied to --mev-endpoints flag.
Running beacon node which will be used for fetching data required by the MEV relay for block creation, supplied to --mev-beacon-node-endpoint. There is no restrictions on the node and a public one can be used.
Cluster lock file, supplied to the --peers-lock-file flag.
Running beacon node(s) towards which tests will be executed, supplied to --beacon-endpoints flag. It is important that the node is expecting to handle huge load and that it is not a publicly accessible one, which can block you.
Running validator client towards which tests will be executed.
Running MEV relay(s) towards which tests will be executed, supplied to --mev-endpoints flag.
Running beacon node which will be used for fetching data required by the MEV relay for block creation, supplied to --mev-beacon-node-endpoint. There is no restrictions on the node and a public one can be used.
Run tests towards other Charon peers to evaluate the effectiveness of a potential cluster setup. The command sets up a libp2p node, similarly to what Charon normally does. This test command has to be run simultaneously with the other peers. After the node is up it waits for other peers to get their nodes up and running, retrying the connection every 3 seconds. The libp2p node connects to relays (configurable with p2p-relays flag) and to other libp2p nodes via TCP. Other peer nodes are discoverable by using their ENRs. Note that for a peer to be successfully discovered, it needs to be connected to the same relay. After completion of the test suite the libp2p node stays alive (duration configurable with keep-alive flag) for other peers to continue testing against it. The node can be forcefully stopped as well.
To be able to establish direct connection, you have to ensure:
Your machine is publicly accessible on the internet or at least a specific port is.
You add flag p2p-tcp-address (i.e.: 127.0.0.1:9001) flag and the port specified in it is free and publicly accessible.
You add the flag p2p-external-ip (i.e.: 8.8.8.8) and specify your public IP.
If all points are satisfied by you and the other peers, you should be able to establish a direct TCP connection between each other. Note that a relay is still required, as it is used for peer discovery.
Based on which stage you are with your cluster creation, some steps are easened.
Pre-requisites
Peers' ENRs, supplied to the --enrs flag.
Example run
charon alpha test peers \
--enrs="enr:-HW4QMno_MB_ID6GFVxoIQAHHVHZZZjzFctxtX2tm9D95tvaPbHathi8YUP8jh8v2YUAVu2fYWEOB_BT14pt8QgiGg2AgmlkgnY0iXNlY3AyNTZrMaECdpnK83s0dbBwCaEfDIkQ-3nJkkC93STvv6Vmi0bYlzg,enr:-HW4QO2vefLueTBEUGly5hkcpL7NWdMKWx7Nuy9f7z6XZInCbFAc0IZj6bsnmj-Wi4ElS6jNa0Mge5Rkc2WGTVemas2AgmlkgnY0iXNlY3AyNTZrMaECR9SmYQ_1HRgJmNxvh_ER2Sxx78HgKKgKaOkCROYwaDY"
Pre-requisites
Cluster definition file, supplied to the --definition-file flag.
Example run
charon alpha test peers \
--definition-file="./.charon/cluster-definition.json"
Pre-requisites
Cluster lock file, supplied to the --lock-file flag.
Example run
charon alpha test peers \
--lock-file="./.charon/cluster-lock.json"
Test beacon node
Run tests on beacon node(s), to evaluate their effectiveness for a Distributed Validator cluster. The beacon node is usually the client doing the most work in a validating stack, especially with a high number of validators being serviced by the validator client(s) and Charon(s) that depend on it.
Regular tests intended for relatively fast run, without putting any major load on any tested system.
Pre-requisites
Running beacon node(s) towards which tests will be executed, supplied to --endpoints flag.
Example run
charon alpha test beacon \
--endpoints="https://ethereum-holesky-beacon-api.publicnode.com,https://ethereum-sepolia-beacon-api.publicnode.com"
Load tests intended for more time consuming run. Beacon nodes are put under heavy load.
These tests include simulated workloads for an increasing number of validators, and the process takes some time (approximately ~33 minutes). It is normal to observe some warnings during the simulations.
A file with detailed results about simulations done is saved at the current working directory (configurable by --simulation-file-dir flag).
Pre-requisites
Running beacon node(s) towards which tests will be executed, supplied to --endpoints flag. It is important that the node is expecting to handle huge load and that it is not a publicly accessible one, which can block you.
Example run
charon alpha test beacon \
--endpoints="http://127.0.0.1:5052/" \
--load-test
Test validator client
Run tests towards your validator client, to evaluate its effectiveness for a Distributed Validator cluster.
Default endpoint for validator and port is used at 127.0.0.1:3600. This can be changed by supplying different endpoint to the --validator-api-address flag.
Pre-requisites
Running validator client towards which tests will be executed.
Example run
charon alpha test validator
Test MEV relay
Run tests towards MEV relays, to evaluate their effectiveness for a Distributed Validator cluster. If MEV-Boost clients are configured for the distributed validator nodes, it is of utmost importance that the relays they connect to are fast and reliable. If not, the chance of missing a block proposal increases significantly. Supplying --beacon-node-endpoint and --load-test flags allows the test to ask relays for real MEV headers, increasing the accuracy (and duration) of this test.
At least 1 endpoint is required to be supplied to the --endpoints flag.
Pre-requisites
Running MEV relay(s) towards which tests will be executed.
Example run
charon alpha test mev \
--endpoints="https://0xa15b52576bcbf1072f4a011c0f99f9fb6c66f3e1ff321f11f461d15e31b1cb359caa092c71bbded0bae5b5ea401aab7e@aestus.live,https://0xa7ab7a996c8584251c8f925da3170bdfd6ebc75d50f5ddc4050a6fdc77f2a3b5fce2cc750d0865e05d7228af97d69561@agnostic-relay.net,https://0x8b5d2e73e2a3a55c6c87b8b6eb92e0149a125c852751db1422fa951e42a09b82c142c3ea98d0d9930b056a3bc9896b8f@bloxroute.max-profit.blxrbdn.com,https://0xac6e77dfe25ecd6110b8e780608cce0dab71fdd5ebea22a16c0205200f2f8e2e3ad3b71d3499c54ad14d6c21b41a37ae@boost-relay.flashbots.net,https://0xa1559ace749633b997cb3fdacffb890aeebdb0f5a3b6aaa7eeeaf1a38af0a8fe88b9e4b1f61f236d2e64d95733327a62@relay.ultrasound.money,https://0x8c4ed5e24fe5c6ae21018437bde147693f68cda427cd1122cf20819c30eda7ed74f72dece09bb313f2a1855595ab677d@regional.titanrelay.xyz,https://0x8c4ed5e24fe5c6ae21018437bde147693f68cda427cd1122cf20819c30eda7ed74f72dece09bb313f2a1855595ab677d@global.titanrelay.xyz"
Pre-requisites
Running MEV relay(s) towards which tests will be executed.
Running beacon node which will be used for fetching data required by the MEV relay for block creation, supplied to --beacon-node-endpoint. There is no restrictions on the node and a public one can be used.
Example run
charon alpha test mev \
--endpoints="https://0xa15b52576bcbf1072f4a011c0f99f9fb6c66f3e1ff321f11f461d15e31b1cb359caa092c71bbded0bae5b5ea401aab7e@aestus.live,https://0xa7ab7a996c8584251c8f925da3170bdfd6ebc75d50f5ddc4050a6fdc77f2a3b5fce2cc750d0865e05d7228af97d69561@agnostic-relay.net,https://0x8b5d2e73e2a3a55c6c87b8b6eb92e0149a125c852751db1422fa951e42a09b82c142c3ea98d0d9930b056a3bc9896b8f@bloxroute.max-profit.blxrbdn.com,https://0xac6e77dfe25ecd6110b8e780608cce0dab71fdd5ebea22a16c0205200f2f8e2e3ad3b71d3499c54ad14d6c21b41a37ae@boost-relay.flashbots.net,https://0xa1559ace749633b997cb3fdacffb890aeebdb0f5a3b6aaa7eeeaf1a38af0a8fe88b9e4b1f61f236d2e64d95733327a62@relay.ultrasound.money,https://0x8c4ed5e24fe5c6ae21018437bde147693f68cda427cd1122cf20819c30eda7ed74f72dece09bb313f2a1855595ab677d@regional.titanrelay.xyz,https://0x8c4ed5e24fe5c6ae21018437bde147693f68cda427cd1122cf20819c30eda7ed74f72dece09bb313f2a1855595ab677d@global.titanrelay.xyz" \
--load-test \
--beacon-node-endpoint="https://ethereum-beacon-api.publicnode.com"
Test machine and network performance
Run tests of your machine and network, to evaluate their effectiveness for a Distributed Validator cluster. Distributed Validators need stable, low-latency, internet, a reasonable amount of RAM, and a highly performant disk drive for storage. This test aims to analyse these requirements to give an overview of the systems suitability.
Pre-requisites
Example run
charon alpha test infra
.
The storage tests require fio to be installed on your machine. Read more about fio .
