mirror of
https://gitlab.com/pulsechaincom/staking-deposit-cli.git
synced 2024-12-23 20:07:17 +00:00
08eeed26ed
1. Use v0.12.0 signing format 2. `GENESIS_FORK_VERSION` may be various for mainnet and testnets. Add option for it.
134 lines
3.6 KiB
Markdown
134 lines
3.6 KiB
Markdown
# eth2.0-deposit-cli
|
|
|
|
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
|
|
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
|
|
**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)*
|
|
|
|
- [Tutorial for users](#tutorial-for-users)
|
|
- [Requirements](#requirements)
|
|
- [For Linux or MacOS users](#for-linux-or-macos-users)
|
|
- [Step 1. Install deposit-cli dependencies](#step-1-install-deposit-cli-dependencies)
|
|
- [Step 2. Create your keys and deposit data](#step-2-create-your-keys-and-deposit-data)
|
|
- [Arguments](#arguments)
|
|
- [For Windows users](#for-windows-users)
|
|
- [Step 1. Install deposit-cli dependencies](#step-1-install-deposit-cli-dependencies-1)
|
|
- [Step 2. Create your keys and deposit data](#step-2-create-your-keys-and-deposit-data-1)
|
|
- [Arguments](#arguments-1)
|
|
- [For `venv` users](#for-venv-users)
|
|
- [Development](#development)
|
|
- [Install basic requirements](#install-basic-requirements)
|
|
- [Install testing requirements](#install-testing-requirements)
|
|
- [Run tests](#run-tests)
|
|
|
|
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
|
|
|
|
## Tutorial for users
|
|
|
|
### Requirements
|
|
|
|
- [Python **3.7+**](https://www.python.org/about/gettingstarted/)
|
|
- [pip3](https://pip.pypa.io/en/stable/installing/)
|
|
|
|
### 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:
|
|
|
|
```sh
|
|
./deposit.sh install
|
|
```
|
|
|
|
#### Step 2. Create your keys and deposit data
|
|
|
|
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 --folder=<YOUR_FOLDER_PATH>
|
|
```
|
|
|
|
#### 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 defualt | The chain setting for the signing domain. |
|
|
|
|
### 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
|
|
sh deposit.sh install
|
|
```
|
|
|
|
#### Step 2. Create your keys and deposit data
|
|
|
|
Run the following command to enter the interactive CLI:
|
|
|
|
```sh
|
|
sh deposit.sh
|
|
```
|
|
|
|
You can also run the tool with optional arguments:
|
|
|
|
```sh
|
|
sh deposit.sh --num_validators=<NUM_VALIDATORS> --mnemonic_language=english --folder=<YOUR_FOLDER_PATH>
|
|
```
|
|
|
|
You will see the following messages after successfully generated the keystore(s) and the deposit(s):
|
|
|
|
#### Arguments
|
|
|
|
See [here](#arguments)
|
|
|
|
```
|
|
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`](https://docs.python.org/3.7/library/venv.html), just run:
|
|
|
|
```sh
|
|
make venv_deposit
|
|
```
|
|
|
|
## Development
|
|
|
|
### Install basic requirements
|
|
|
|
```sh
|
|
python3 -m pip install -r requirements.txt
|
|
python3 setup.py install
|
|
```
|
|
|
|
### Install testing requirements
|
|
|
|
```sh
|
|
python3 -m pip install -r requirements_test.txt
|
|
```
|
|
|
|
### Run tests
|
|
|
|
```sh
|
|
python3 -m pytest .
|
|
```
|