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
        • RAF #1
      • Delegate Guide
      • Grants Program
        • How to create a proposal in Questbook?
        • Grant Track for Boosting Obol DV Adoption
        • Grant Track for Strengthening the Collective: Operators & Community Growth
        • Grant Track for Establishing OBOL Token’s Role in DeFi & Governance
    • The OBOL Token
      • Token Utility
      • Staking & stOBOL
      • Token Distribution & Liquidity
      • Token Holders FAQ
      • 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
  • Extends
  • Properties

Was this helpful?

Edit on GitHub
  1. SDK
  2. Interfaces

ClusterDefinition

PreviousInterfacesNextRewardsSplitPayload

Last updated 25 days ago

Was this helpful?

Cluster definition data needed for dkg

Extends

Properties

Property
Type
Description
Inherited from
Defined in

name

string

The cluster name.

ClusterPayload.name

types.ts:73

operators

The cluster nodes operators addresses.

ClusterPayload.operators

types.ts:76

validators

The cluster validators information.

ClusterPayload.validators

types.ts:79

deposit_amounts?

null | string[]

The cluster partial deposits in gwei or 32000000000.

ClusterPayload.deposit_amounts

types.ts:82

creator

The creator of the cluster.

-

types.ts:90

version

string

The cluster configuration version.

-

types.ts:93

dkg_algorithm

string

The cluster dkg algorithm.

-

types.ts:96

fork_version

string

The cluster fork version.

-

types.ts:99

uuid

string

The cluster uuid.

-

types.ts:102

timestamp

string

The cluster creation timestamp.

-

types.ts:105

config_hash

string

The cluster configuration hash.

-

types.ts:108

threshold

number

The distributed validator threshold.

-

types.ts:111

num_validators

number

The number of distributed validators in the cluster.

-

types.ts:114

definition_hash?

string

The hash of the cluster definition.

-

types.ts:117

[]

[]

ClusterPayload
ClusterOperator
ClusterValidator
ClusterCreator