Search
⌃K

Cluster Scanner CLI

The Cluster Scanner CLI tool is a command-line interface that retrieves the latest snapshot for a provided cluster.

Installation

Prerequisites - this tool requires NodeJS installed on your machine.
  1. 1.
    Clone the cluster repo
git clone https://github.com/bloxapp/cluster-scanner.git
  1. 2.
    Navigate to repo cluster-scanner
cd cluster-scanner
  1. 3.
    Run yarn
yarn

Arguments

You can use yarn cli --help to see all arguments.
Argument
Type
Description
--node-url (-n)
string
ETH1 (execution client) node endpoint URL
--ssv-contract-address (-ca)
string
SSV contract address (reference)
--owner-address (-oa)
string
The cluster owner address (in the SSV contract)
--operator-ids (-oids)
int
Comma-separated list of operator IDs. The amount must be 3f+1 compatible.
Run
yarn cli -n <ETH1_NODE_ENDPOINT_URL> -ca <SSV_CONTRACT_ADDRESS> -oa <CLUSTER_OWNER_ADDRESS> -oids <OPERATOR1_ID, OPERATOR2_ID, OPERATOR3_ID, OPERATOR4_ID>
Output
The cluster snapshot breakdown and the cluster object in transaction payload format.
Example:
{
"block": 8508854,
"cluster snapshot": {
"validatorCount": "1",
"networkFee": "0",
"networkFeeIndex": "0",
"index": "0",
"balance": "1000000000000",
"active": true
},
"cluster": [
"1",
"0",
"0",
"1000000000000",
true
]
}