LogoLogo
SDKAPI
Version-v1.4.0 (current)
Version-v1.4.0 (current)
  • Learn
    • Introduction
      • Obol Collective
      • OBOL Incentives
      • Key Staking Concepts
      • Obol vs Other DV Implementations
      • Obol Splits
      • DV Launchpad
      • Frequently Asked Questions
    • Charon
      • Introduction to Charon
      • Distributed Key Generation
      • Cluster Configuration
      • Charon Networking
      • CLI Reference
    • Futher Reading
      • Ethereum and Its Relationship With DVT
      • Community Testing
      • Peer Score
      • Useful Links
  • Run a DV
    • Quickstart
      • Quickstart Overview
      • Create a DV Alone
      • Create a DV With a Group
      • Push Metrics to Obol Monitoring
    • Prepare to Run a DV
      • How and Where To Run DVs
      • Deployment Best Practices
      • Test a Cluster
    • Running a DV
      • Activate a DV
      • Update a DV
      • Monitoring Your Node
      • Claim Rewards
      • Exit a DV
    • Partner Integrations
      • Create an EigenLayer DV
      • Create a Lido CSM DV
      • DappNode
  • Advanced & Troubleshooting
    • Advanced Guides
      • Create a DV Using the SDK
      • Migrate an Existing Validator
      • Enable MEV
      • Combine DV Private Key Shares
      • Self-Host a Relay
      • Advanced Docker Configs
      • Beacon node authentication
    • Troubleshooting
      • Errors & Resolutions
      • Handling DKG Failure
      • Client Configuration
      • Test Commands
    • Security
      • Overview
      • Centralization Risks and Mitigation
      • Obol Bug Bounty Program
      • Smart Contract Audit
      • Software Development at Obol
      • Charon Threat Model
      • Contacts
  • Community & Governance
    • Governance
      • Collective Overview
      • The Token House
      • The RAF
      • Delegate Guide
      • RAF1 Guide
    • The OBOL Token
      • Token Utility
      • Token Distribution & Liquidity
      • TGE FAQ
    • Community
      • Staking Mastery Program
      • Techne
    • Contribution & Feedback
      • Filing a Bug Report
      • Documentation Standards
      • Feedback
  • Walkthrough Guides
    • Walkthroughs
      • Walkthrough Guides
  • SDK
    • Intro
    • Enumerations
      • FORK_MAPPING
    • Classes
      • Client
    • Interfaces
      • ClusterDefinition
      • RewardsSplitPayload
    • Type-Aliases
      • BuilderRegistration
      • BuilderRegistrationMessage
      • ClusterCreator
      • ClusterLock
      • ClusterOperator
      • ClusterPayload
      • ClusterValidator
      • DepositData
      • DistributedValidator
      • ETH_ADDRESS
      • OperatorPayload
      • SplitRecipient
      • TotalSplitPayload
    • Functions
      • validateClusterLock
  • API
    • What is this API?
    • System
    • Metrics
    • Cluster Definition
    • Cluster Lock
    • State
    • DV Exit
    • Cluster Effectiveness
    • Terms And Conditions
    • Techne Credentials
    • Address
    • OWR Information
  • Specification
Powered by GitBook
On this page
  • Obol SDK
  • Getting Started
  • Terms and Conditions
  • ⚠️ Important Security Notice:
  • Contributing
  • Enumerations
  • Classes
  • Interfaces
  • Type Aliases
  • Functions
Edit on GitHub
  1. SDK

Intro

PreviousWalkthrough GuidesNextEnumerations

Last updated 6 days ago

SDK Version: v2.1.0

Obol Logo

Obol SDK

Getting Started

Terms and Conditions

⚠️ Important Security Notice:

If you're integrating this SDK with a backend (e.g., in Node.js), and you store a private key for executing splitter transactions, handle it with extreme caution. Ensure that:

  • The private key is securely stored (e.g., in an .env file).

  • Never commit or push your .env file containing the private key to version control.

Contributing

Please review the following guidelines:

How to Report Bugs

If you encounter a bug or unexpected behavior, please follow these steps to report it:

  1. Go to the "Issues" tab of this repository.

  2. Click on the "Get started" button in the Bug report section.

  3. Provide a clear title and description of the issue following the format provided.

How to Propose Changes

If you'd like to propose improvements or new features, please follow these steps:

  1. Fork this repository.

  2. Create a new branch for your changes.

  3. Make your changes and commit them with clear messages.

  4. Open a pull request with a detailed description of the changes.

Code Review Process

All contributions are reviewed before they are merged into the main branch. Please address any feedback provided during the review process.

Thank you for contributing to Obol-SDK!

Enumerations

Classes

Interfaces

Type Aliases

Functions

This repo contains the Obol Software Development Kit, for creating Distributed Validators with the help of the .

Checkout our , , and SDK . Further guides and walkthroughs coming soon.

To use obol-sdk and in order to be able to create a cluster definition or accept an invite to join a cluster, you must accept the by calling acceptObolLatestTermsAndConditions.

Obol API
docs
examples
reference
latest Obol terms and conditions
FORK_MAPPING
Client
ClusterDefinition
RewardsSplitPayload
ClusterOperator
OperatorPayload
ClusterCreator
ClusterValidator
ClusterPayload
SplitRecipient
TotalSplitPayload
BuilderRegistrationMessage
BuilderRegistration
DepositData
DistributedValidator
ClusterLock
ETH_ADDRESS
validateClusterLock
How to Report Bugs
How to Propose Changes
Code Review Process