staking-deposit-cli/README.md

eth2.0-deposit-cli

• Introduction
• Tutorial for users
  • Build requirements
  • For Linux or MacOS users
    • Option 1. Download binary executable file
      • Step 1. Installation
      • Step 2. Create keys and deposit_data-*.json
        • Arguments
        • Successful message
    • Option 2. Build deposit-cli with native Python
      • Step 0. Python version checking
      • Step 1. Installation
      • Step 2. Create keys and deposit_data-*.json
        • Arguments
        • Successful message
    • Option 3. Build deposit-cli with virtualenv
      • Step 0. Python version checking
      • Step 1. Installation
      • Step 2. Create keys and deposit_data-*.json
        • Arguments
        • Successful message
    • Option 4. Use Docker image
      • Step 1. Build the docker image
      • Step 2. Create keys and deposit_data-*.json
        • Arguments
        • Successful message
  • For Windows users
    • Option 1. Download binary executable file
      • Step 1. Installation
      • Step 2. Create keys and deposit_data-*.json
        • Arguments
        • Successful message
    • Option 2. Build deposit-cli with native Python
      • Step 0. Python version checking
      • Step 1. Installation
      • Step 2. Create keys and deposit_data-*.json
        • Arguments
        • Successful message
    • Option 3. Build deposit-cli with virtualenv
      • Step 0. Python version checking
      • Step 1. Installation
      • Step 2. Create keys and deposit_data-*.json
        • Arguments
        • Successful message
• Development
  • Install basic requirements
  • Install testing requirements
  • Run tests

Introduction

deposit-cli is a tool for creating EIP-2335 format BLS12-381 keystores and a corresponding deposit_data*.json file for Ethereum 2.0 Launchpad.

• Warning: Please generate your keystores on your own safe, completely offline device.
• Warning: Please backup your mnemonic, keystores, and password securely.

Please read Launchpad Validator FAQs before generating the keys.

You can find the audit report by Trail of Bits here.

Tutorial for users

Build requirements

• Python 3.7+
• pip3

For Linux or MacOS users

Option 1. Download binary executable file

Step 1. Installation

See releases page to download and decompress the corresponding binary files.

Step 2. Create keys and deposit_data-*.json

Run the following command to enter the interactive CLI:

./deposit

You can also run the tool with optional arguments:

./deposit --num_validators=<NUM_VALIDATORS> --mnemonic_language=english --chain=<CHAIN_NAME> --folder=<YOUR_FOLDER_PATH>

Arguments

You can use --help flag to see all arguments.

Argument	Type	Description
--num_validators	Non-negative integer	The number of signing keys you want to generate. Note that the child key(s) are generated via the same master key.
--mnemonic_language	String. Options: czech, chinese_traditional, chinese_simplified, english, spanish, italian, korean. Default to english	The mnemonic language
--folder	String. Pointing to ./validator_keys by default	The folder path for the keystore(s) and deposit(s)
--chain	String. mainnet by default	The chain setting for the signing domain.

Successful message

You will see the following messages after successfully generated the keystore(s) and the deposit(s):

Creating your keys.
Saving your keystore(s).
Creating your deposit(s).
Verifying your keystore(s).
Verifying your deposit(s).

Success!
Your keys can be found at: <YOUR_FOLDER_PATH>

Option 2. Build deposit-cli with native Python

Step 0. Python version checking

Ensure you are using Python version >= Python3.7:

python3 -V

Step 1. Installation

Install the dependencies:

pip3 install -r requirements.txt
python3 setup.py install

Or use the helper script:

./deposit.sh install

Step 2. Create keys and deposit_data-*.json

Run the following command to enter the interactive CLI:

./deposit.sh

You can also run the tool with optional arguments:

./deposit.sh --num_validators=<NUM_VALIDATORS> --mnemonic_language=english --chain=<CHAIN_NAME> --folder=<YOUR_FOLDER_PATH>

Arguments

See here

Successful message

See here

Option 3. Build deposit-cli with virtualenv

Step 0. Python version checking

Ensure you are using Python version >= Python3.7:

python3 -V

Step 1. Installation

For the virtualenv users, you can create a new venv:

pip3 install virtualenv
virtualenv venv
source venv/bin/activate

and install the dependencies:

python3 setup.py install
pip3 install -r requirements.txt

Step 2. Create keys and deposit_data-*.json

Run the following command to enter the interactive CLI:

python3 ./eth2deposit/deposit.py

You can also run the tool with optional arguments:

python3 ./eth2deposit/deposit.py --num_validators=<NUM_VALIDATORS> --mnemonic_language=english --chain=<CHAIN_NAME> --folder=<YOUR_FOLDER_PATH>

Arguments

See here

Successful message

See here

Option 4. Use Docker image

Step 1. Build the docker image

Run the following command to locally build the docker image:

make build_docker

Step 2. Create keys and deposit_data-*.json

Run the following command to enter the interactive CLI:

docker run -it --rm -v $(pwd)/validator_keys:/app/validator_keys ethereum/eth2.0-deposit-cli

You can also run the tool with optional arguments:

docker run -it --rm -v $(pwd)/validator_keys:/app/validator_keys ethereum/eth2.0-deposit-cli --num_validators=<NUM_VALIDATORS> --mnemonic_language=english --folder=<YOUR_FOLDER_PATH>

Example for 1 validator on the Medalla testnet using english:

docker run -it --rm -v $(pwd)/validator_keys:/app/validator_keys ethereum/eth2.0-deposit-cli --num_validators=1 --mnemonic_language=english --chain=medalla

Arguments

See here

Successful message

See here

---

For Windows users

Option 1. Download binary executable file

Step 1. Installation

See releases page to download and decompress the corresponding binary files.

Step 2. Create keys and deposit_data-*.json

Run the following command to enter the interactive CLI:

deposit.exe

You can also run the tool with optional arguments:

deposit.exe --num_validators=<NUM_VALIDATORS> --mnemonic_language=english --chain=<CHAIN_NAME> --folder=<YOUR_FOLDER_PATH>

Arguments

See here

Successful message

See here

Option 2. Build deposit-cli with native Python

Step 0. Python version checking

Ensure you are using Python version >= Python3.7 (Assume that you've installed Python 3 as the main Python):

python -V

Step 1. Installation

Install the dependencies:

pip3 install -r requirements.txt
python setup.py install

Or use the helper script:

sh deposit.sh install

Step 2. Create keys and deposit_data-*.json

Run the following command to enter the interactive CLI:

sh deposit.sh

You can also run the tool with optional arguments:

sh deposit.sh --num_validators=<NUM_VALIDATORS> --mnemonic_language=english --chain=<CHAIN_NAME> --folder=<YOUR_FOLDER_PATH>

Arguments

See here

Successful message

See here

Option 3. Build deposit-cli with virtualenv

Step 0. Python version checking

Ensure you are using Python version >= Python3.7 (Assume that you've installed Python 3 as the main Python):

python -V

Step 1. Installation

For the virtualenv users, you can create a new venv:

pip3 install virtualenv
virtualenv venv
.\venv\Scripts\activate

and install the dependencies:

python setup.py install
pip3 install -r requirements.txt

Step 2. Create keys and deposit_data-*.json

Run the following command to enter the interactive CLI:

python .\eth2deposit\deposit.py

You can also run the tool with optional arguments:

python .\eth2deposit\deposit.py --num_validators=<NUM_VALIDATORS> --mnemonic_language=english --chain=<CHAIN_NAME> --folder=<YOUR_FOLDER_PATH>

Arguments

See here

Successful message

See here

Development

Install basic requirements

python3 -m pip install -r requirements.txt
python3 setup.py install

Install testing requirements

python3 -m pip install -r requirements_test.txt

Run tests

python3 -m pytest .