Lido Staking Vault CLI

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

Table of Contents

• Features
• Prerequisites
• Installation
• Configuration
• Usage
  • Examples
• Programs
• Documentation
• License

Features

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

Prerequisites

• Node.js: Ensure you have Node.js (v20 or later) installed.
• Yarn: Yarn package manager is required to install dependencies.

Installation

From Source

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

Branch Selection

The repository has two primary branches:

• main (Recommended): Stable releases with tested and verified features. Ideal for production use and reliable operations.
• develop: Active development branch with the latest features. Use this if you want immediate access to new functionality and can handle potentially unstable features.

# Switch to stable branch (recommended)
git checkout main

# Or switch to development branch for latest features
git checkout develop

Configuration

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

# Network Configuration (Required)
CHAIN_ID=560048
CL_URL=https://your-consensus-layer-endpoint
EL_URL=https://your-execution-layer-endpoint

# Contract addresses (Required)
DEPLOYED=deployed-hoodi-vaults.json

# Wallet
PRIVATE_KEY=0x

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

# WalletConnect (optional)
# Note: WALLET_CONNECT_PROJECT_ID is NOT a secret. It is a public identifier
# of the application using WalletConnect.
WALLET_CONNECT_PROJECT_ID=ee928c025792b10a6daa97d85328c433

If you plan to manage contracts, PRIVATE_KEY (or an encrypted account file) is required for write operations. Ensure your EL_URL matches the configured CHAIN_ID.

Usage

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

yarn start [command] [options]

yarn start -h

Examples

VaultHub constants

yarn start vo r info

Count of all vaults

yarn start contracts hub r v-count

Programs

• Get Started
• Global Flags
• Account
• Vault Operations
• Deposits
• Metrics
• Report
• Consolidation
• PredepositGuarantee Helpers
• Contracts:
  • Dashboard
  • LazyOracle
  • OperatorGrid
  • PredepositGuarantee
  • VaultFactory
  • VaultHub
  • VaultViewer
  • Vault
• DeFi Wrapper

Testing

Unit Tests

Run unit tests for utilities and helpers:

yarn test

Integration Tests

Integration tests run on a forked chain to test real contract interactions.

Setup

1. Install dependencies (includes Anvil via @viem/anvil):

   yarn install

2. Create test configuration:

   cp env.test.example .env.test
   # Edit .env.test and set your RPC_URL

Running Tests

Anvil starts automatically when you run tests:

# All integration tests (Anvil starts automatically)
yarn test:integration

# Watch mode
yarn test:integration:watch

For detailed information, see tests/integration/README.md.

Documentation

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

License

This project is licensed under the MIT License.