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
• License

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

NPM

git clone [email protected]: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.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 privateKey is required property for this type of operations. For using elLink in a right way be attentive to match rpc resolver link and its 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 hub r info

Count of all vaults

yarn start hub r v-count

Programs

• Account
• VaultHub
• VaultFactory
• Vault
• Dashboard
• PredepositGuarantee
• OperatorGrid
• VaultViewer
• Report

Documentation

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

License

This project is licensed under the MIT License.