Go to file
Hsiao-Wei Wang 10080093b6
Update script and readme
1. deposit.sh two steps: (i) install (ii) run tool
2. Update readme for all known usages
2020-05-23 22:28:41 +08:00
.circleci Update script and readme 2020-05-23 22:28:41 +08:00
eth2deposit Move cli/deposit.py back to eth2deposit for less confusion 2020-05-12 01:37:13 +08:00
tests Update script and readme 2020-05-23 22:28:41 +08:00
.gitignore Rest of the fucking owl. Implements interface + signing of deposits + SSZ 2020-02-28 12:02:29 +00:00
deposit.sh Update script and readme 2020-05-23 22:28:41 +08:00
flake8.ini Fix typing error 2020-05-07 15:13:09 +08:00
LICENSE Adds CC0 Licence 2020-02-26 16:53:57 +00:00
Makefile Update script and readme 2020-05-23 22:28:41 +08:00
mypy.ini Fix typing error 2020-05-07 15:13:09 +08:00
README.md Update script and readme 2020-05-23 22:28:41 +08:00
requirements_test.txt Try Windows 2020-05-23 22:28:38 +08:00
requirements.txt Fix typing error 2020-05-07 15:13:09 +08:00
setup.py Package reorg (#10) 2020-05-08 21:34:09 +08:00
test_deposit_script.py Update script and readme 2020-05-23 22:28:41 +08:00
tox.ini Update script and readme 2020-05-23 22:28:41 +08:00

eth2.0-deposit-cli

Table of Contents generated with DocToc

Tutorial for users

Requirements

For Linux or MacOS users

Step 1. Install deposit-cli dependencies

If it's your first time to use this tool, you need to install the Python library dependencies:

./deposit.sh install

Step 2. Create your keys and deposit data

Run the following command:

./deposit.sh

You can also run the tool with optional arguments:

./deposit.sh --num_validators=<NUM_VALIDATORS> --mnemonic_language=english --password=<YOUR_PASSWORD> --folder=<YOUR_FOLDER_PATH>

For Windows users

Step 1. Install deposit-cli dependencies

If it's your first time to use this tool, you need to install the Python library dependencies:

sh deposit.sh install

Step 2. Create your keys and deposit data

Run the following command:

sh deposit.sh

You can also run the tool with optional arguments:

sh deposit.sh --num_validators=<NUM_VALIDATORS> --mnemonic_language=english --password=<YOUR_PASSWORD> --folder=<YOUR_FOLDER_PATH>

You should 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>

For venv users

If you want to use Python venv, just run:

make venv_deposit

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 .