Skip to content

Latest commit

 

History

History
229 lines (166 loc) · 7.02 KB

README.md

File metadata and controls

229 lines (166 loc) · 7.02 KB
Raw

SSV Keys

GitHub GitHub Workflow Status GitHub package.json version

GitHub commit activity GitHub contributors GitHub last commit

GitHub package.json dynamic GitHub package.json dynamic

Discord

Important dependencies:

  • GitHub package.json dependency version (prod)
  • GitHub package.json dependency version (prod)
  • GitHub package.json dependency version (prod)
  • GitHub package.json dependency version (prod)
  • GitHub package.json dependency version (prod)

Library and CLI to work with the ETH keystore file and extract latest validator cluster snapshot to build the payload:

  1. Parse the private key using the keystore password
  2. Use the private key to get shares for operators
  3. 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)

  1. Go to the releases section: https://github.com/ssvlabs/ssv-keys/releases
  2. 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: v0.0.1-v1 or v0.0.1-v2.
  3. Download the native executable for your operating system:
    • ssv-keys-lin - for Ubuntu Linux
    • ssv-keys-mac - for MacOS
    • ssv-keys.exe - for Windows
  4. Open terminal and change the directory to where you downloaded the executable. For instance, on MacOS you can: 
    cd ~/Downloads
  5. (Mac and Linux) Make sure that the executable has permissions to run by running: 
    chmod 777 ./ssv-keys-mac
  6. Now you can run it: 
    ./ssv-keys-mac
  7. 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 Open menu. Once open click the Open or allow button 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

Installation

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

Once you have installed NodeJS, follow instructions:

git clone https://github.com/ssvlabs/ssv-keys.git
cd ssv-keys
npm install -g yarn
yarn install
yarn cli --help

Help

Help on available actions:

yarn cli --help

Help on a specific action:

yarn cli <action> --help

Example

To run you will use the "shares" command

Input parameters:

  • keystore (ks) = The path to either a validator keystore file or a folder that contains multiple validator keystore files. If a folder is provided, it will split in bulk all the keystore files within it according to the additional arguments provided
  • password (ps) = The keystore file encryption password. For one keystore, enter the absolute path. For multiple keystores, enter only the password file name.
  • 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 (in the SSV contract)
  • owner-nonce (on) = The validator registration nonce of the account (owner address) within the SSV contract (increments after each validator registration), obtained using the ssv-scanner tool
6 directories, 20 files
# single file
yarn cli shares --keystore=./keystore.json --password=./password.txt --operator-ids=1,2,3,4 --operator-keys=LS..,LS..,LS..,LS.. --output-folder=./ --owner-address=... --owner-nonce=..

# folder with multiple keystore files
## folder structure
keystore_folders
├── 0xe020....
│   ├── keystore-m_12381_3600_1_0_0-1717971132.json
│   └── password.txt
├── 0xe025....
│   ├── keystore-m_12381_3600_6_0_0-1717971134.json
│   └── password.txt
├── 0xe02a....
│   ├── keystore-m_12381_3600_11_0_0-1717971135.json
│   └── password.txt
├── 0xe02f....
│   ├── keystore-m_12381_3600_16_0_0-1717971137.json
│   └── password.txt
└── 0xe034....
    ├── keystore-m_12381_3600_21_0_0-1717971139.json
    └── password.txt
yarn cli shares --keystore=./keystore_folders --password=password.txt --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

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/console
yarn install

To run a JavaScript example:

# example 1
yarn start:basic:js
# example 2
yarn start:complex:js

To run a TypeScript example:

yarn start:ts

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:

yarn start

Open the developer console to see how it works in a browser environment.

Development

Run the CLI as a TypeScript executable:

yarn dev:cli ...

Run the CLI as a JavaScript compiled executable:

yarn cli ...

Lint

yarn lint

Testing

yarn test

In watch mode during development

yarn test --watchAll

Building

Build TypeScript into JavaScript

yarn build

Build for NodeJs using esbuild

yarn esbuild

Build everything

yarn build-all

License

The ssv-api is licensed under the GNU General Public License v3.0, also included in our repository in the LICENSE file.