StakeWise SDK and Protocol Documentation

website·Indexed 35 days ago

https://docs.stakewise.io

Developer documentation for the StakeWise V3 protocol and SDK. Includes API references for interacting with vaults, managing osTokens, and handling transactions such as creating vaults, burning and withdrawing funds, and claiming exit queues. Provides tools for fetching user stats, APY, reward splitters, and validator data across supported networks.

Tokens
133.4K
Snippets
787
Records
1.1K
Agent score
68%

What's inside StakeWise

  1. Overview of the StakeWise Operator Service

    The Operator Service is open-source software that runs alongside node infrastructure to automate the day-to-day operations of a StakeWise Vault. It connects to Execution and Consensus nodes to read on-chain state and submit transactions to the Vault contract.

    Core automated functions include:

    • Validator Registration: Monitors Vault balance, prepares deposit data, obtains oracle approval, and submits registration transactions (requires minimum 32 ETH in the Vault).
    • Validator Funding: Tops up 0x02 compound validators before registering new ones, up to the limit defined by --max-validator-balance-gwei (defaults: 300 ETH on Ethereum, 1800 GNO on Gnosis).
    • Withdrawals: Processes exit queue requests via partial withdrawals from 0x02 validators first, then full exits if necessary.
  2. Overview of Obol Distributed Validators (DV) and Operator Service Role

    A Distributed Validator (DV) is an Ethereum proof-of-stake validator running across multiple nodes. Each node consists of execution and consensus layer clients, a validator client, and Charon (middleware). Charon manages the consensus algorithm and aggregates partial signatures from nodes into a final validator signature.

    The Operator Service's role in registration depends on key generation:

    • Centrally generated keys: The Operator Service can access keys and register validators directly.
    • DKG ceremony generated keys: No single party holds the full key; registration is handled via StakeWise DVT components (Sidecars and DVT Relayer).
  3. Overview of EthRewardSplitter contract

    The EthRewardSplitter contract is used on Ethereum networks to split rewards received by a vault's fee recipient among shareholders based on their configured shares. It inherits from RewardSplitter and ReentrancyGuardUpgradeable.
  4. Overview of SSV Network Operator roles

    The SSV Network is a permissionless Distributed Validator Technology (DVT) network. An operator runs an SSV node that implements the SSV protocol, communicates with smart contracts, and performs validator duties (attestations and proposals) using only a share of the validator key. There are two primary ways to run validators: Split Keys (full key generated then split) and DKG Ceremony (shares generated together, full key never exists).
  5. Overview of the StakeWise Liquid Staking Protocol

    StakeWise is a liquid staking protocol for Ethereum and Gnosis Chain that allows users to stake assets without minimum deposits, running validator nodes, or technical setup. The protocol is centered around 'Vaults'—permissionless, customizable, and non-custodial staking pools deployed by operators. Stakers can mint osTokens (liquid staking tokens) to maintain liquidity and utilize their stake within the DeFi ecosystem while earning staking rewards.
  6. Overview of Vault Incentives

    Vault operators can provide extra incentives to stakers to increase the Vault's base and boost APY. These incentives are currently supported only on Ethereum. Supported tokens for distribution include SWISE, osETH, SSV, Obol, WETH, and USDC. To distribute incentives directly, an operator's address must be approved as a distributor by the StakeWise development team.