Quick Setup

This guide will walk you through the steps to download and set up the ethstaker-deposit-cli for your operating system.

Build requirements

• Python 3.9+
• pip3

Step 1: Download the Latest Release

Download binary executable file

1. Navigate to the Releases page of the ethstaker-deposit-cli repository.

2. Download the corresponding file for your operating system:

   • Windows: Look for a file with windows in the name.
   • MacOS: Look for a file with darwin in the name.
   • Linux: Look for a file with linux in the name.

3. Extract the contents of the zipped file

4. Open a terminal or command prompt and navigate to the extracted folder

For other installation options, including building with python or virtualenv and docker image instructions, go here

Step 2: Verify the Installation

1. Make sure you have GPG installed.

2. Make sure you have the edc-security@ethstaker.cc public key by running

gpg --keyserver keys.openpgp.org --search-keys 'edc-security@ethstaker.cc'

3. Verify the signature file against the corresponding file but be sure to replace the contents with the exact file name:

gpg --verify staking_deposit-cli-***.asc staking_deposit-cli-***

4. You should see Good signature from "EDC Security <edc-security@ethstaker.cc>" in the output otherwise do not continue.

Step 3: Usage

Windows users: You should replace ./deposit with deposit.exe to run properly.

MacOS users: In order to run from the terminal, you must first open the file to bypass MacOS code signing issues. Do so by right clicking the deposit file and then selecting Open.

Linux users: On Unix-based systems, keystores and the deposit_data*.json have 440/-r--r----- file permissions (user & group read only). This improves security by limiting which users and processes that have access to these files. If you are getting permission denied errors when handling your keystores, consider changing which user/group owns the file (with chown) or, if need be, change the file permissions with chmod.

Determine which command best suites what you would like to accomplish:

• new-mnemonic: Used to generate a new mnemonic, validator keys, and deposit file. It is not recommended to use this command if you have existing validators.

• existing-mnemonic: Provide a mnemonic to regenerate validator keys or create new ones.

• generate-bls-to-execution-change: Update your withdrawal credentials of existing validators. It is required to have the corresponding mnemonic.

• generate-bls-to-execution-change-keystore: Sign an update withdrawal credentials message using your validator keystore.

• exit-transaction-keystore: Generate an exit message using the keystore of your validators.

• exit-transaction-mnemonic: Generate an exit message using the mnemonic of your validators.

• partial-deposit: Generate a partial deposit using a validator keystore.

If you encounter any issues, please check the issues page for help or to report a problem. You may also contact us on the Ethstaker discord.