Cluster Scanner

Important dependencies:

Repo contains cluster scanner library and CLI. It is used to retrieve the latest cluster snapshot from the blockchain.

Running from the CLI

Installation

This installation requires NodeJS on your machine. You can download it here.

Once you have installed NodeJS, follow these instructions to prepare the project:

git clone https://github.com/bloxapp/cluster-scanner.git
cd cluster-scanner
npm i yarn -g
yarn
yarn cli --help

Running as a CLI from the repository

Help

Help on available actions:

yarn cli --help

Example

Input parameters:

• node-url (n) = The ETH1 node url
• ssv-contract-address (ca) = SSV Network contract address
• owner-address (oa) = Cluster owner address
• operator-ids (oids) = Comma separated operator ids list

Example of running in the CLI:

yarn cli -n .... -ca .... -oa ..... -oids 1,2,3,4

Output: Latest cluster data (serialized).

Integration in your projects

Node Project

To run an example of a NodeJS project containing all the code snippets to build the share and transaction payload, simply follow these instructions!

cd examples
yarn install

To run a JavaScript example:

yarn start:js

To run a Typescript example:

yarn start

Development

Run the CLI as a TypeScript executable:

yarn dev:cli ...

Run the CLI as a JavaScript compiled executable:

yarn cli ...

Lint

yarn lint

Building

Build TypeScript into JavaScript

yarn build

Build for NodeJs using esbuild

yarn esbuild

Build everything

yarn build-all

TODO

Authors

• Wadym Ciumac

License

MIT License