Skip to content

ZugChainLabs/zugchain-deposit-cli

Repository files navigation

⚡ ZugChain Deposit CLI

License: CC0-1.0 Platform ZugChain

The official tool for generating validator keys and deposit data for the ZugChain Network.

This application is a secure, audited fork of the Ethereum Staking Deposit CLI, adapted specifically for ZugChain's consensus parameters. It allows you to reliably generate keystores and deposit_data.json files required to run a ZugChain Validator Node.


🔒 Security & Trust

To ensure maximum security for your assets, this tool is directly derived from the industry-standard Ethereum Launchpad tooling.

  • Audited Foundation: Built upon the ethereum/staking-deposit-cli codebase, which has been rigorously audited by Trail of Bits.
  • Offline Generation: Designed to run in a completely offline environment (air-gapped) to protect your mnemonic seed phrase from online threats.
  • Open Source: Full transparency of the codebase allows for community verification and open scrutiny.

Caution

Key Security is Paramount. Always generate your keys on a secure, offline machine. Never share your mnemonic phrase with anyone, including ZugChain support.

Important

Official Deposit Contract: The ONLY official ZugChain Beacon Deposit Contract address is 0x00000000219ab540356cBB839Cbe05303d7705Fa. Always verify this exact address before making your validator deposit!


🚀 Installation & Usage

You can run the Deposit CLI using pre-compiled binaries or directly from the source code.

Option A: Binary Executables (Recommended)

Download the latest pre-compiled binary for your operating system from the Releases Page.

Platform Executable
Windows zugchain-deposit-cli-windows-amd64.zip
Linux zugchain-deposit-cli-linux-amd64.tar.gz

Usage Instructions:

For Windows Users
  1. Extract the downloaded .zip file.
  2. Open Command Prompt or PowerShell inside the extracted folder.
  3. Run the generation wizard:
    .\deposit.exe new-mnemonic --num_validators=1 --chain=zugchain
For Linux Users
  1. Extract the downloaded .tar.gz file.
  2. Open your terminal inside the extracted folder.
  3. Run the generation wizard:
    ./deposit new-mnemonic --num_validators=1 --chain=zugchain

Option B: Run from Source (Advanced)

If you prefer to run the Python source code directly:

Prerequisites:

  • Python 3.8+
  • pip package manager
# 1. Clone the repository
git clone https://github.com/ZugChainLabs/zugchain-deposit-cli.git
cd zugchain-deposit-cli

# 2. Install dependencies
pip install -r requirements.txt
python setup.py install

# 3. Run the tool
python ./staking_deposit/deposit.py new-mnemonic --num_validators=1 --chain=zugchain

⚙️ Configuration Reference

Command: new-mnemonic

This command drives the interactive process to generate a new BIP-39 mnemonic phrase and the associated validator keys.

Argument Description Default
--num_validators The number of validators you wish to run. (Required)
--chain The network to target. Always use zugchain. zugchain
--folder The directory where output files will be saved. ./validator_keys
--execution_address Your ZugChain wallet address (0x...) for receiving rewards. (Optional)
--mnemonic_language Language for the seed phrase words. english

📂 Output Files

After successfully running the wizard, the tool will create a validator_keys directory in your current folder containing two distinct file types:

  1. deposit_data-[timestamp].json
    Upload this file to the ZugChain Launchpad to register and fund your validator.

  2. keystore-m_...json
    Import these files into your Consensus Client (Beacon Node). Keep these files extremely safe, as they authorize your node to participate in consensus.


🔗 Official Links


📄 License

This project's code is licensed under the CC0 1.0 Universal License. ZugChain specific adaptations are maintained by the ZugChain Core Team.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages