Library and CLI to work with the ETH keystore file and extract latest validator cluster snapshot to build the payload:
- Parse the private key using the keystore password
- Use the private key to get shares for operators
- Build the payload for the transaction
Option 1: Running an Executable (Recommended route)
If you want to run a compiled version (easier option then CLI)
- Go to the releases section: https://github.com/bloxapp/ssv-keys/releases
- Select the latest release for the specific version of the CLI:
vX.Y.Z-v1- for the first version of the contract,
vX.Y.Z-v2- for second etc. Example:
- Download the native executable for your operating system:
ssv-keys-lin- for Ubuntu Linux
ssv-keys-mac- for MacOS
ssv-keys.exe- for Windows
- Open terminal and change the directory to where you downloaded the executable. For instance, on MacOS you can:
- (Mac and Linux) Make sure that the executable has permissions to run by running:
chmod 777 ./ssv-keys-mac
- Now you can run it:
- If your operating system prevents you from running the executable you can open it from the file manager (Finder in case of MacOS), right click on it, and click the
Openmenu. Once open click the
allowbutton when you are asked to do so. After this go back to the console and try to run it again.
Option 2: Running from the CLI
This installation requires NodeJS on your machine. You can download it here.
Once you have installed NodeJS, follow instructions:
git clone https://github.com/bloxapp/ssv-keys.git cd ssv-keys npm install -g yarn yarn install yarn cli --help
Help on available actions:
yarn cli --help
Help on a specific action:
yarn cli <action> --help
To run you will use the "shares" command
- keystore (ks) = The validator keystore file path
- password (ps) = The keystore file encryption password
- operator-ids (oids) = Comma-separated list of operator IDs. The amount must be 3f+1 compatible.
- operator-keys (oks) = Comma-separated list of operator keys (same sequence as operator ids). The amount must be 3f+1 compatible.
- output-folder (of) = Target folder path to output the key shares file
- owner-address (oa) = The cluster owner address
- owner-nonce (on) = The nonce of the owner within the SSV contract (increments after each validator registration), obtained using the ssv-scanner tool
yarn cli shares --keystore=keystore.json --password=test --operator-ids=1,2,3,4 --operator-keys=LS..,LS..,LS..,LS.. --output-folder=./ --owner-address=... --owner-nonce=..
Output: Name will start with keyshares-timestamp.json
Option 3: Integration in your projects
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/example-02 yarn install
To run a TypeScript example:
Browser project (web application)
Go to the example folder and then install all the dependencies:
cd examples/react-app yarn install
Start the web app:
Open the developer console to see how it works in a browser environment.
Run the CLI as a TypeScript executable:
yarn dev:cli ...
yarn cli ...
In watch mode during development
yarn test --watchAll
Build for NodeJs using