Important dependencies:
This repository contains The ssv scanner library and CLI. It is used to retrieve events data from the SSV network contract. The tool is used for retrieving the latest cluster snapshot or owner nonce from the blockchain, which are required as inputs for SSV tooling and smart contract transactions.
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/ssvlabs/ssv-scanner.git
cd ssv-scanner
npm i yarn -g
yarn
yarn cli --help
Help on available actions:
yarn cli --help
Input parameters:
- node-url (n) = The ETH1 node url
- network (nw) = The network (mainnet, holesky)
- owner-address (oa) = Cluster owner address
- operator-ids (oids) = Comma separated operator ids list
Example of running cluster scanner in the CLI:
yarn cli cluster -n .... -nw mainnet -oa ..... -oids 1,2,3,4
Output: Latest cluster data (serialized).
Input parameters:
- node-url (n) = The ETH1 node url
- network (nw) = The network (mainnet, holesky)
- owner-address (oa) = Cluster owner address
Example of running nonce scanner in the CLI:
yarn cli nonce -n .... -nw mainnet -oa .....
Output: Current owner nonce.
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
yarn dev:cli ...
yarn cli ...
yarn lint
Build TypeScript into JavaScript
yarn build
Build for NodeJs using esbuild
yarn esbuild
Build everything
yarn build-all
The ssv-api is licensed under the
GNU General Public License v3.0,
also included in our repository in the LICENSE
file.