Skip to main content

Introduction

Lido Staking Vault CLI is a command-line interface (CLI) tool for managing lido staking vaults. Simplify your staking operations with intuitive commands and streamlined workflows.

Changelog​

For changes between versions see Changelog

Features​

  • Easy Setup: Quick installation and configuration to get you started.
  • Vault Management: Create, manage staking vaults with simple commands.
  • Monitoring: Track vault metrics.

Prerequisites​

  • Node.js: Ensure you have Node.js (v20 or later) installed.
  • npm: Node Package Manager is required to install dependencies.

Installation​

Clone from repository​

git clone git@github.com:lidofinance/lido-staking-vault-cli.git

Configuration​

Before using the CLI, configure your environment variables. You can set them in a .env file in your project root.

CHAIN_ID=560048 // required
CL_URL=url
EL_URL=url

# Contract addresses
DEPLOYED=deployed-hoodi-vaults-testnet-2.json // required

# Wallet
PRIVATE_KEY=0x

# or encrypted file
# ACCOUNT_FILE=wallets/account.json
# ACCOUNT_FILE_PASSWORD=1234

If you plan to manage contracts, the PRIVATE_KEY is a required property for these operations. To use EL_URL correctly, ensure the RPC endpoint matches the configured chain ID.

Usage​

After installation and configuration, you can start using the CLI to manage your staking vaults.

Repository​

yarn start [command] [options]
yarn start -h

Examples​

VaultHub constants

yarn start hub r info

Count of all vaults

yarn start hub r v-count

Documentation​

For additional information about available methods and functionality, refer to the documentation for the Lido Staking Vault CLI.