SSV SDK

The SSV SDK is an open-source TypeScript toolkit for interacting with SSV Network programmatically.

It brings the main developer workflows into a single package.

The SDK is structured into four core modules:

• Cluster: Manage and interact with distributed validator clusters.
• Operator: Work with operator-related data and actions.
• API: Access SSV data through SDK-supported APIs.
• Utils: Use helper functions for common development workflows.

Explore the source code on GitHub: SSV SDK Repository.

Installation

To install the SDK, run:

npm i @ssv-labs/ssv-sdk

Initialization

The SDK requires a publicClient configured with a supported chain (mainnet or hoodi). A walletClient is optional and is only needed for write operations. You can use viem to create both clients, whether you want a read-only setup or a read/write setup.

If needed, you can attach a wallet later with sdk.connectWallet(walletClient).

import { SSVSDK, chains } from '@ssv-labs/ssv-sdk'
import { createPublicClient, createWalletClient, http } from 'viem'
import { privateKeyToAccount } from 'viem/accounts'

// Set up viem clients
const chain = chains.mainnet // or chains.hoodi
const transport = http()

const publicClient = createPublicClient({
  chain,
  transport,
})

const account = privateKeyToAccount('0x...')
const walletClient = createWalletClient({
  account,
  chain,
  transport,
})

// Initialize SDK with viem clients
const sdk = new SSVSDK({
    publicClient,
    walletClient,
    extendedConfig: {
      subgraph: {
        apiKey: process.env.SUBGRAPH_API_KEY,
        endpoint: process.env.SUBGRAPH_ENDPOINT,
      }
    }
  });

The extendedConfig parameter is optional. If you do not provide it, the SDK uses the development endpoint. That endpoint is rate-limited, so using your own API key is strongly recommended. For more information, see the SSV Subgraph page.

Initialization Parameters

Input name	Input type	Optional
publicClient	Viem public client	No
walletClient	Viem wallet client	Yes
SUBGRAPH_API_KEY	API key retrieved from The Graph account	Yes, strongly recommended
SUBGRAPH_ENDPOINT	Subgraph Endpoint retrieved from Mainnet or Testnet subgraph page	Yes, strongly recommended

Usage

Use the SDK by choosing one of the five modules and calling the function you need. For working examples, see the Tutorials section.

async function main() {
  const ownerNonce = await sdk.api.getOwnerNonce({ 
      owner: "0x...✎" 
  })
  
  console.log(ownerNonce)
}