LogoLogo
SDKAPI
Next
Next
  • 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
      • The OBOL Token
      • Delegate Guide
      • RAF1 Guide
    • 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
Edit on GitHub
  1. API

DV Exit

PreviousStateNextCluster Effectiveness

Last updated 2 months ago

Retrieve Distributed Validator threshold aggregated signed exit msg

get

This endpoint is used to retrieve validator exit message

Authorizations
Path parameters
validatorPubkeystringRequired

The distributed_public_key in a cluster lock.

shareIdxanyRequired

Represents the cluster operatorIndex+1.

lockHashanyRequired

The cluster lockHash.

Responses
200
The DV signed exit message
application/json
Responseany of
objectOptional
401
Authorization header is missing or incorrect
404
Data is not found
500
An unknown error occurred
get
GET //exp/exit/{lockHash}/{shareIdx}/{validatorPubkey} HTTP/1.1
Host: api.obol.tech
Authorization: Bearer JWT
Accept: */*
{}

Retrieve Distributed Validator threshold aggregated signed exit msg

get

This endpoint is used to retrieve validator exit message

Authorizations
Path parameters
validatorPubkeystringRequired

The distributed_public_key in a cluster lock.

shareIdxanyRequired

Represents the cluster operatorIndex+1.

lockHashanyRequired

The cluster lockHash.

Responses
200
The DV signed exit message
application/json
Responseany of
objectOptional
401
Authorization header is missing or incorrect
404
Data is not found
500
An unknown error occurred
get
GET //v1/exp/exit/{lockHash}/{shareIdx}/{validatorPubkey} HTTP/1.1
Host: api.obol.tech
Authorization: Bearer JWT
Accept: */*
{}

Retrieve validators exit status

get

It shows data of operators who have signed and who have not

Path parameters
lockHashstringRequired

The cluster lockHash.

Query parameters
pagenumberRequired
limitnumberRequired
operatorAddressstringRequired

The operatorAddress.

validatorPubkeystringRequired

The pubkey in a cluster lock.

Responses
200
The exit status data
application/json
Responseany of
objectOptional
404
Data is not found
500
An unknown error occurred
get
GET //exp/exit/status/{lockHash} HTTP/1.1
Host: api.obol.tech
Accept: */*
{}

Retrieve validators exit status

get

It shows data of operators who have signed and who have not

Path parameters
lockHashstringRequired

The cluster lockHash.

Query parameters
pagenumberRequired
limitnumberRequired
operatorAddressstringRequired

The operatorAddress.

validatorPubkeystringRequired

The pubkey in a cluster lock.

Responses
200
The exit status data
application/json
Responseany of
objectOptional
404
Data is not found
500
An unknown error occurred
get
GET //v1/exp/exit/status/{lockHash} HTTP/1.1
Host: api.obol.tech
Accept: */*
{}

Retrieve validators exit status summary

get

It shows data of operators who have signed and the count of validators ready to exit

Path parameters
lockHashstringRequired

The cluster lock hash.

Responses
200
The exit summary data
application/json
Responseany of
404
Data is not found
500
An unknown error occurred
get
GET //exp/exit/status/summary/{lockHash} HTTP/1.1
Host: api.obol.tech
Accept: */*
{
  "operator_exits": {
    "0x000000000000000000000000000000000000dea1": 5,
    "0x000000000000000000000000000000000000dead": 10
  },
  "ready_exits": 2
}

Retrieve validators exit status summary

get

It shows data of operators who have signed and the count of validators ready to exit

Path parameters
lockHashstringRequired

The cluster lock hash.

Responses
200
The exit summary data
application/json
Responseany of
404
Data is not found
500
An unknown error occurred
get
GET //v1/exp/exit/status/summary/{lockHash} HTTP/1.1
Host: api.obol.tech
Accept: */*
{
  "operator_exits": {
    "0x000000000000000000000000000000000000dea1": 5,
    "0x000000000000000000000000000000000000dead": 10
  },
  "ready_exits": 2
}
  • GETRetrieve Distributed Validator threshold aggregated signed exit msg
  • GETRetrieve Distributed Validator threshold aggregated signed exit msg
  • GETRetrieve validators exit status
  • GETRetrieve validators exit status
  • GETRetrieve validators exit status summary
  • GETRetrieve validators exit status summary
  • POSTPush Distributed Validator partial signed exit message
  • POSTPush Distributed Validator partial signed exit message

Push Distributed Validator partial signed exit message

post

This endpoint saves partial signed exit messages.

Path parameters
lockHashstringRequired

The lockHash of the cluster which the validator belongs to

Body
share_idxnumberRequiredExample: 42
signaturestringRequired
Responses
201
success message
400
Bad request received
404
Data or validator not found
409
Duplicate entry
500
An unknown error occurred
post
POST //exp/partial_exits/{lockHash} HTTP/1.1
Host: api.obol.tech
Content-Type: application/json
Accept: */*
Content-Length: 256

{
  "partial_exits": [
    {
      "public_key": "0x8b69c67720c909423d7edc5d3a7554e1d1e50f6d7d5f8d18548d68daf424e536afba8b31fbd15df1970ba4af4a7d944c",
      "signed_exit_message": {
        "message": {
          "epoch": "162304",
          "validator_index": "42"
        },
        "signature": ""
      }
    }
  ],
  "share_idx": 42,
  "signature": ""
}

No content

Push Distributed Validator partial signed exit message

post

This endpoint saves partial signed exit messages.

Path parameters
lockHashstringRequired

The lockHash of the cluster which the validator belongs to

Body
share_idxnumberRequiredExample: 42
signaturestringRequired
Responses
201
success message
400
Bad request received
404
Data or validator not found
409
Duplicate entry
500
An unknown error occurred
post
POST //v1/exp/partial_exits/{lockHash} HTTP/1.1
Host: api.obol.tech
Content-Type: application/json
Accept: */*
Content-Length: 256

{
  "partial_exits": [
    {
      "public_key": "0x8b69c67720c909423d7edc5d3a7554e1d1e50f6d7d5f8d18548d68daf424e536afba8b31fbd15df1970ba4af4a7d944c",
      "signed_exit_message": {
        "message": {
          "epoch": "162304",
          "validator_index": "42"
        },
        "signature": ""
      }
    }
  ],
  "share_idx": 42,
  "signature": ""
}

No content