Cluster Lock

Retrieve a Distributed Validator Cluster Lock Object

This endpoint is used to retrieve a cluster lock object.

get

/lock/{lockHash}

Path parameters

lockHashstringrequired

The lock_hash calculated for a cluster lock.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.obol.tech//lock/{lockHash}'

200

404

500

200

{
  "cluster_definition": {
    "name": "My Obol Cluster",
    "uuid": "0194FDC2-FA2F-FCC0-41D3-FF12045B73C8",
    "creator": {},
    "version": "v1.8.0",
    "num_validators": 5,
    "threshold": 3,
    "dkg_algorithm": "default",
    "fork_version": "0x00001020",
    "config_hash": "0x2204ba6c238ed2d6a8ff951d4513db993c8d6f8860468391342649bf735a87d7",
    "timestamp": "2022-07-19T18:19:58+02:00",
    "validators": [
      {}
    ],
    "deposit_amounts": [
      "8000000000",
      "16000000000",
      "8000000000"
    ],
    "definition_hash": "0xb656f5a4a5537b5817d6bcf735d043f17f5aff568b1a7ec9102a9f687bd4510c",
    "fee_recipient_address": "0x000000000000000000000000000000000000dead",
    "withdrawal_address": "0x000000000000000000000000000000000000dead",
    "operators": [
      {}
    ],
    "consensus_protocol": "qbft",
    "target_gas_limit": 36000000,
    "compounding": true
  },
  "distributed_validators": [
    {}
  ],
  "signature_aggregate": "0x85650c30ec29a3703934bf50a28da102975deda77e758579ea3dfe4136abf752",
  "lock_hash": "0xd2880980169ee4a0000f23feb8fad9a6c70f38312956fe67aa89e118f5b0e048",
  "node_signatures": [
    "text"
  ]
}

The cluster lock object

Retrieve a list of Distributed Validator Cluster Lock Objects

This endpoint is used to search for Cluster Lock Objects that match a substring of their lock_hash.

get

/lock/search/{network}

Path parameters

networkstringrequired

The network to retrieve clusters on

Example: {"summary":"Ethereum Mainnet","value":"mainnet"}

Query parameters

partialLockHashstringrequired

A substring of the lock_hash calculated for a cluster lock.

partialClusterNamestringrequired

A substring of the cluster name.

pageinteger · default: 0required

The page number to retrieve.

limitinteger · default: 100required

The number of cluster lock objects to return.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.obol.tech//lock/search/{network}?partialLockHash=text&partialClusterName=text&page=0&limit=100'

200

404

500

200

{
  "cluster_locks": [
    "text"
  ],
  "total_count": 2,
  "total_pages": 4
}

A list of Distributed Validator Clusters which the lock hash matches.

Retrieve a list of Distributed Validator Cluster Lock Objects

This endpoint is used to search for Cluster Lock Objects that match a substring of their lock_hash.

get

/v1/lock/search/{network}

Path parameters

networkstringrequired

The network to retrieve clusters on

Example: {"summary":"Ethereum Mainnet","value":"mainnet"}

Query parameters

partialLockHashstringrequired

A substring of the lock_hash calculated for a cluster lock.

partialClusterNamestringrequired

A substring of the cluster name.

pageinteger · default: 0required

The page number to retrieve.

limitinteger · default: 100required

The number of cluster lock objects to return.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.obol.tech//v1/lock/search/{network}?partialLockHash=text&partialClusterName=text&page=0&limit=100'

200

404

500

200

{
  "cluster_locks": [
    "text"
  ],
  "total_count": 2,
  "total_pages": 4
}

A list of Distributed Validator Clusters which the lock hash matches.

Push Distributed Validator Cluster Lock Data

This endpoint saves cluster lock objects that describe the created Distributed Validator Cluster.

post

/lock

Body

cluster_definitionall ofrequired

Cluster definition data that was used in dkg to generate cluster lock.

distributed_validatorsobject[]required

distributed validator keys and deposit data.

signature_aggregatestringrequired

Example: 0x85650c30ec29a3703934bf50a28da102975deda77e758579ea3dfe4136abf752

lock_hashstringrequired

Example: 0xd2880980169ee4a0000f23feb8fad9a6c70f38312956fe67aa89e118f5b0e048

node_signaturesstring[]required

Example: ["0xe6e531be7bbf6cee37d80ab489ade6491469e10743d3c1496a3e66fe989eb4c100c260eaee4ef1aa08fdb79ea05bb8c12970dec1a296abe627ac25a2515373b301"]

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.obol.tech//lock' \
  --header 'Content-Type: application/json' \
  --data '{
    "cluster_definition": {
      "name": "My Obol Cluster",
      "uuid": "0194FDC2-FA2F-FCC0-41D3-FF12045B73C8",
      "creator": {},
      "version": "v1.8.0",
      "num_validators": 5,
      "threshold": 3,
      "dkg_algorithm": "default",
      "fork_version": "0x00001020",
      "config_hash": "0x2204ba6c238ed2d6a8ff951d4513db993c8d6f8860468391342649bf735a87d7",
      "timestamp": "2022-07-19T18:19:58+02:00",
      "validators": [
        {}
      ],
      "deposit_amounts": [
        "8000000000",
        "16000000000",
        "8000000000"
      ],
      "definition_hash": "0xb656f5a4a5537b5817d6bcf735d043f17f5aff568b1a7ec9102a9f687bd4510c",
      "fee_recipient_address": "0x000000000000000000000000000000000000dead",
      "withdrawal_address": "0x000000000000000000000000000000000000dead",
      "operators": [
        {}
      ],
      "consensus_protocol": "qbft",
      "target_gas_limit": 36000000,
      "compounding": true
    },
    "distributed_validators": [
      {
        "distributed_public_key": "0xb51336c31c4f0cc365d6c7b5d8ff1b4b7d4cf7c70163f9fd51a2badc854f5e29823fa11e3d7749d207807867149508d6",
        "public_shares": [
          "text"
        ],
        "deposit_data": {
          "pubkey": "0xb51336c31c4f0cc365d6c7b5d8ff1b4b7d4cf7c70163f9fd51a2badc854f5e29823fa11e3d7749d207807867149508d6",
          "withdrawal_credentials": "0x01000000000000000000000086b8145c98e5bd25ba722645b15ed65f024a87ec",
          "amount": "32000000000",
          "deposit_data_root": "5e58a5d8f1e53479343cb6188f061f6b1a46c521c53eef0580b04f485ad62bad",
          "signature": "0x88fe84889608a8b2424bddae2047d2ee4b42f72c4d8201d69e732d7c3bfa1bcb00f930979770b7d00071673fde8f205108dabe8d83ec49aa6de1b7869966b555be80a159e6ad11e273c4e0234038cfa525923044d6a89a4924fdc178f333568b"
        },
        "builder_registration": {
          "message": {
            "fee_recipient": "0x86B8145c98e5BD25BA722645b15eD65f024a87EC",
            "gas_limit": 30000000,
            "timestamp": 1616508000,
            "pubkey": "0xb51336c31c4f0cc365d6c7b5d8ff1b4b7d4cf7c70163f9fd51a2badc854f5e29823fa11e3d7749d207807867149508d6"
          },
          "signature": "0x851e4f196b7e7bda6429b94cceb92d480f53fa9753e1d6c830ff2706acb8cd866d81d5533db7dcfac1dc9d00a16e5e4801d33f36bdf1c2a2003e1c586466109e7851c79179b2c46d69c53c4a59e361d2727186a7e72bbd11debad1f2fae6f97d"
        },
        "partial_deposit_data": {
          "pubkey": "0xb51336c31c4f0cc365d6c7b5d8ff1b4b7d4cf7c70163f9fd51a2badc854f5e29823fa11e3d7749d207807867149508d6",
          "withdrawal_credentials": "0x01000000000000000000000086b8145c98e5bd25ba722645b15ed65f024a87ec",
          "amount": "32000000000",
          "deposit_data_root": "5e58a5d8f1e53479343cb6188f061f6b1a46c521c53eef0580b04f485ad62bad",
          "signature": "0x88fe84889608a8b2424bddae2047d2ee4b42f72c4d8201d69e732d7c3bfa1bcb00f930979770b7d00071673fde8f205108dabe8d83ec49aa6de1b7869966b555be80a159e6ad11e273c4e0234038cfa525923044d6a89a4924fdc178f333568b"
        }
      }
    ],
    "signature_aggregate": "0x85650c30ec29a3703934bf50a28da102975deda77e758579ea3dfe4136abf752",
    "lock_hash": "0xd2880980169ee4a0000f23feb8fad9a6c70f38312956fe67aa89e118f5b0e048",
    "node_signatures": [
      "0xe6e531be7bbf6cee37d80ab489ade6491469e10743d3c1496a3e66fe989eb4c100c260eaee4ef1aa08fdb79ea05bb8c12970dec1a296abe627ac25a2515373b301"
    ]
  }'

201

400

404

409

500

201

{
  "cluster_definition": {
    "name": "My Obol Cluster",
    "uuid": "0194FDC2-FA2F-FCC0-41D3-FF12045B73C8",
    "creator": {},
    "version": "v1.8.0",
    "num_validators": 5,
    "threshold": 3,
    "dkg_algorithm": "default",
    "fork_version": "0x00001020",
    "config_hash": "0x2204ba6c238ed2d6a8ff951d4513db993c8d6f8860468391342649bf735a87d7",
    "timestamp": "2022-07-19T18:19:58+02:00",
    "validators": [
      {}
    ],
    "deposit_amounts": [
      "8000000000",
      "16000000000",
      "8000000000"
    ],
    "definition_hash": "0xb656f5a4a5537b5817d6bcf735d043f17f5aff568b1a7ec9102a9f687bd4510c",
    "fee_recipient_address": "0x000000000000000000000000000000000000dead",
    "withdrawal_address": "0x000000000000000000000000000000000000dead",
    "operators": [
      {}
    ],
    "consensus_protocol": "qbft",
    "target_gas_limit": 36000000,
    "compounding": true
  },
  "distributed_validators": [
    {}
  ],
  "signature_aggregate": "0x85650c30ec29a3703934bf50a28da102975deda77e758579ea3dfe4136abf752",
  "lock_hash": "0xd2880980169ee4a0000f23feb8fad9a6c70f38312956fe67aa89e118f5b0e048",
  "node_signatures": [
    "text"
  ]
}

The cluster lock object

Push Distributed Validator Cluster Lock Data

This endpoint saves cluster lock objects that describe the created Distributed Validator Cluster.

post

/v1/lock

Body

cluster_definitionall ofrequired

Cluster definition data that was used in dkg to generate cluster lock.

distributed_validatorsobject[]required

distributed validator keys and deposit data.

signature_aggregatestringrequired

Example: 0x85650c30ec29a3703934bf50a28da102975deda77e758579ea3dfe4136abf752

lock_hashstringrequired

Example: 0xd2880980169ee4a0000f23feb8fad9a6c70f38312956fe67aa89e118f5b0e048

node_signaturesstring[]required

Example: ["0xe6e531be7bbf6cee37d80ab489ade6491469e10743d3c1496a3e66fe989eb4c100c260eaee4ef1aa08fdb79ea05bb8c12970dec1a296abe627ac25a2515373b301"]

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.obol.tech//v1/lock' \
  --header 'Content-Type: application/json' \
  --data '{
    "cluster_definition": {
      "name": "My Obol Cluster",
      "uuid": "0194FDC2-FA2F-FCC0-41D3-FF12045B73C8",
      "creator": {},
      "version": "v1.8.0",
      "num_validators": 5,
      "threshold": 3,
      "dkg_algorithm": "default",
      "fork_version": "0x00001020",
      "config_hash": "0x2204ba6c238ed2d6a8ff951d4513db993c8d6f8860468391342649bf735a87d7",
      "timestamp": "2022-07-19T18:19:58+02:00",
      "validators": [
        {}
      ],
      "deposit_amounts": [
        "8000000000",
        "16000000000",
        "8000000000"
      ],
      "definition_hash": "0xb656f5a4a5537b5817d6bcf735d043f17f5aff568b1a7ec9102a9f687bd4510c",
      "fee_recipient_address": "0x000000000000000000000000000000000000dead",
      "withdrawal_address": "0x000000000000000000000000000000000000dead",
      "operators": [
        {}
      ],
      "consensus_protocol": "qbft",
      "target_gas_limit": 36000000,
      "compounding": true
    },
    "distributed_validators": [
      {
        "distributed_public_key": "0xb51336c31c4f0cc365d6c7b5d8ff1b4b7d4cf7c70163f9fd51a2badc854f5e29823fa11e3d7749d207807867149508d6",
        "public_shares": [
          "text"
        ],
        "deposit_data": {
          "pubkey": "0xb51336c31c4f0cc365d6c7b5d8ff1b4b7d4cf7c70163f9fd51a2badc854f5e29823fa11e3d7749d207807867149508d6",
          "withdrawal_credentials": "0x01000000000000000000000086b8145c98e5bd25ba722645b15ed65f024a87ec",
          "amount": "32000000000",
          "deposit_data_root": "5e58a5d8f1e53479343cb6188f061f6b1a46c521c53eef0580b04f485ad62bad",
          "signature": "0x88fe84889608a8b2424bddae2047d2ee4b42f72c4d8201d69e732d7c3bfa1bcb00f930979770b7d00071673fde8f205108dabe8d83ec49aa6de1b7869966b555be80a159e6ad11e273c4e0234038cfa525923044d6a89a4924fdc178f333568b"
        },
        "builder_registration": {
          "message": {
            "fee_recipient": "0x86B8145c98e5BD25BA722645b15eD65f024a87EC",
            "gas_limit": 30000000,
            "timestamp": 1616508000,
            "pubkey": "0xb51336c31c4f0cc365d6c7b5d8ff1b4b7d4cf7c70163f9fd51a2badc854f5e29823fa11e3d7749d207807867149508d6"
          },
          "signature": "0x851e4f196b7e7bda6429b94cceb92d480f53fa9753e1d6c830ff2706acb8cd866d81d5533db7dcfac1dc9d00a16e5e4801d33f36bdf1c2a2003e1c586466109e7851c79179b2c46d69c53c4a59e361d2727186a7e72bbd11debad1f2fae6f97d"
        },
        "partial_deposit_data": {
          "pubkey": "0xb51336c31c4f0cc365d6c7b5d8ff1b4b7d4cf7c70163f9fd51a2badc854f5e29823fa11e3d7749d207807867149508d6",
          "withdrawal_credentials": "0x01000000000000000000000086b8145c98e5bd25ba722645b15ed65f024a87ec",
          "amount": "32000000000",
          "deposit_data_root": "5e58a5d8f1e53479343cb6188f061f6b1a46c521c53eef0580b04f485ad62bad",
          "signature": "0x88fe84889608a8b2424bddae2047d2ee4b42f72c4d8201d69e732d7c3bfa1bcb00f930979770b7d00071673fde8f205108dabe8d83ec49aa6de1b7869966b555be80a159e6ad11e273c4e0234038cfa525923044d6a89a4924fdc178f333568b"
        }
      }
    ],
    "signature_aggregate": "0x85650c30ec29a3703934bf50a28da102975deda77e758579ea3dfe4136abf752",
    "lock_hash": "0xd2880980169ee4a0000f23feb8fad9a6c70f38312956fe67aa89e118f5b0e048",
    "node_signatures": [
      "0xe6e531be7bbf6cee37d80ab489ade6491469e10743d3c1496a3e66fe989eb4c100c260eaee4ef1aa08fdb79ea05bb8c12970dec1a296abe627ac25a2515373b301"
    ]
  }'

201

400

404

409

500

201

{
  "cluster_definition": {
    "name": "My Obol Cluster",
    "uuid": "0194FDC2-FA2F-FCC0-41D3-FF12045B73C8",
    "creator": {},
    "version": "v1.8.0",
    "num_validators": 5,
    "threshold": 3,
    "dkg_algorithm": "default",
    "fork_version": "0x00001020",
    "config_hash": "0x2204ba6c238ed2d6a8ff951d4513db993c8d6f8860468391342649bf735a87d7",
    "timestamp": "2022-07-19T18:19:58+02:00",
    "validators": [
      {}
    ],
    "deposit_amounts": [
      "8000000000",
      "16000000000",
      "8000000000"
    ],
    "definition_hash": "0xb656f5a4a5537b5817d6bcf735d043f17f5aff568b1a7ec9102a9f687bd4510c",
    "fee_recipient_address": "0x000000000000000000000000000000000000dead",
    "withdrawal_address": "0x000000000000000000000000000000000000dead",
    "operators": [
      {}
    ],
    "consensus_protocol": "qbft",
    "target_gas_limit": 36000000,
    "compounding": true
  },
  "distributed_validators": [
    {}
  ],
  "signature_aggregate": "0x85650c30ec29a3703934bf50a28da102975deda77e758579ea3dfe4136abf752",
  "lock_hash": "0xd2880980169ee4a0000f23feb8fad9a6c70f38312956fe67aa89e118f5b0e048",
  "node_signatures": [
    "text"
  ]
}

The cluster lock object

Redirect to the launchpad cluster status page

This endpoint is used to redirect users to the created cluster status page after DKG is completed.

get

/lock/{lockHash}/launchpad

Path parameters

lockHashstringrequired

The lock_hash calculated for a Distributed Validator Cluster.

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.obol.tech//lock/{lockHash}/launchpad'

200

302

404

500

200

No body

Redirect to the launchpad cluster status page

This endpoint is used to redirect users to the created cluster status page after DKG is completed.

get

/v1/lock/{lockHash}/launchpad

Path parameters

lockHashstringrequired

The lock_hash calculated for a Distributed Validator Cluster.

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.obol.tech//v1/lock/{lockHash}/launchpad'

200

302

404

500

200

No body

Retrieve a list of Distributed Validator Clusters for which this address is an operator

This endpoint fetches a number of Distributed Validator Clusters for which the address provided is a node operator.

get

/lock/operator/{address}

Path parameters

addressstringrequired

The operator address.

Query parameters

pageinteger · default: 0required

The page number to retrieve.

limitinteger · default: 100required

The number of cluster lock objects to return.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.obol.tech//lock/operator/{address}?page=0&limit=100'

200

500

200

{
  "cluster_locks": [
    "text"
  ],
  "total_count": 2,
  "total_pages": 4
}

A list of Distributed Validator Clusters which the operator is a member of.

Retrieve a list of Distributed Validator Clusters for which this address is an operator

This endpoint fetches a number of Distributed Validator Clusters for which the address provided is a node operator.

get

/v1/lock/operator/{address}

Path parameters

addressstringrequired

The operator address.

Query parameters

pageinteger · default: 0required

The page number to retrieve.

limitinteger · default: 100required

The number of cluster lock objects to return.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.obol.tech//v1/lock/operator/{address}?page=0&limit=100'

200

500

200

{
  "cluster_locks": [
    "text"
  ],
  "total_count": 2,
  "total_pages": 4
}

A list of Distributed Validator Clusters which the operator is a member of.

Retrieve a list of Distributed Validator Clusters for a given network

This endpoint fetches a number of cluster lock objects for a given network.

get

/lock/network/{network}

Path parameters

networkstringrequired

The network to retrieve clusters on

Example: {"summary":"Ethereum Mainnet","value":"mainnet"}

Query parameters

pageinteger · default: 0required

The page number to retrieve.

limitinteger · default: 100required

The number of cluster lock objects to return.

sortBystring · default: avg_effectiveness

numerical field to sort by

sortOrderstring · default: desc

order of sorting the field

poolstring

cluster type or pool

detailsstring · default: falserequired

The flag to populate cluster definition information.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.obol.tech//lock/network/{network}?page=0&limit=100&details=false'

200

400

500

200

{
  "cluster_locks": [
    "text"
  ],
  "total_count": 2,
  "total_pages": 4
}

A paged list of Distributed Validator Clusters on this network

Retrieve a list of Distributed Validator Clusters for a given network

This endpoint fetches a number of cluster lock objects for a given network.

get

/v1/lock/network/{network}

Path parameters

networkstringrequired

The network to retrieve clusters on

Example: {"summary":"Ethereum Mainnet","value":"mainnet"}

Query parameters

pageinteger · default: 0required

The page number to retrieve.

limitinteger · default: 100required

The number of cluster lock objects to return.

sortBystring · default: avg_effectiveness

numerical field to sort by

sortOrderstring · default: desc

order of sorting the field

poolstring

cluster type or pool

detailsstring · default: falserequired

The flag to populate cluster definition information.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.obol.tech//v1/lock/network/{network}?page=0&limit=100&details=false'

200

400

500

200

{
  "cluster_locks": [
    "text"
  ],
  "total_count": 2,
  "total_pages": 4
}

A paged list of Distributed Validator Clusters on this network

Retrieve a list of Distributed Validator Clusters for a given network

This endpoint fetches a nsummary of the lock files stored for a given network

get

/lock/network/summary/{network}

Path parameters

networkstringrequired

The network to retrieve clusters on

Example: {"summary":"Ethereum Mainnet","value":"mainnet"}

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.obol.tech//lock/network/summary/{network}'

200

400

500

200

{
  "eth_staked": 2,
  "total_clusters": 2,
  "total_operators": 4
}

A summary of the Distributed Validator locks for a given network

Retrieve a list of Distributed Validator Clusters for a given network

This endpoint fetches a nsummary of the lock files stored for a given network

get

/v1/lock/network/summary/{network}

Path parameters

networkstringrequired

The network to retrieve clusters on

Example: {"summary":"Ethereum Mainnet","value":"mainnet"}

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.obol.tech//v1/lock/network/summary/{network}'

200

400

500

200

{
  "eth_staked": 2,
  "total_clusters": 2,
  "total_operators": 4
}

A summary of the Distributed Validator locks for a given network

Verify Distributed Validator Cluster Lock Data

This endpoint verifies cluster lock data including BLS public keys and signatures created during the DKG phase.

post

/lock/verify

Body

cluster_definitionall ofrequired

Cluster definition data that was used in dkg to generate cluster lock.

distributed_validatorsobject[]required

distributed validator keys and deposit data.

signature_aggregatestringrequired

Example: 0x85650c30ec29a3703934bf50a28da102975deda77e758579ea3dfe4136abf752

lock_hashstringrequired

Example: 0xd2880980169ee4a0000f23feb8fad9a6c70f38312956fe67aa89e118f5b0e048

node_signaturesstring[]required

Example: ["0xe6e531be7bbf6cee37d80ab489ade6491469e10743d3c1496a3e66fe989eb4c100c260eaee4ef1aa08fdb79ea05bb8c12970dec1a296abe627ac25a2515373b301"]

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.obol.tech//lock/verify' \
  --header 'Content-Type: application/json' \
  --data '{
    "cluster_definition": {
      "name": "My Obol Cluster",
      "uuid": "0194FDC2-FA2F-FCC0-41D3-FF12045B73C8",
      "creator": {},
      "version": "v1.8.0",
      "num_validators": 5,
      "threshold": 3,
      "dkg_algorithm": "default",
      "fork_version": "0x00001020",
      "config_hash": "0x2204ba6c238ed2d6a8ff951d4513db993c8d6f8860468391342649bf735a87d7",
      "timestamp": "2022-07-19T18:19:58+02:00",
      "validators": [
        {}
      ],
      "deposit_amounts": [
        "8000000000",
        "16000000000",
        "8000000000"
      ],
      "definition_hash": "0xb656f5a4a5537b5817d6bcf735d043f17f5aff568b1a7ec9102a9f687bd4510c",
      "fee_recipient_address": "0x000000000000000000000000000000000000dead",
      "withdrawal_address": "0x000000000000000000000000000000000000dead",
      "operators": [
        {}
      ],
      "consensus_protocol": "qbft",
      "target_gas_limit": 36000000,
      "compounding": true
    },
    "distributed_validators": [
      {
        "distributed_public_key": "0xb51336c31c4f0cc365d6c7b5d8ff1b4b7d4cf7c70163f9fd51a2badc854f5e29823fa11e3d7749d207807867149508d6",
        "public_shares": [
          "text"
        ],
        "deposit_data": {
          "pubkey": "0xb51336c31c4f0cc365d6c7b5d8ff1b4b7d4cf7c70163f9fd51a2badc854f5e29823fa11e3d7749d207807867149508d6",
          "withdrawal_credentials": "0x01000000000000000000000086b8145c98e5bd25ba722645b15ed65f024a87ec",
          "amount": "32000000000",
          "deposit_data_root": "5e58a5d8f1e53479343cb6188f061f6b1a46c521c53eef0580b04f485ad62bad",
          "signature": "0x88fe84889608a8b2424bddae2047d2ee4b42f72c4d8201d69e732d7c3bfa1bcb00f930979770b7d00071673fde8f205108dabe8d83ec49aa6de1b7869966b555be80a159e6ad11e273c4e0234038cfa525923044d6a89a4924fdc178f333568b"
        },
        "builder_registration": {
          "message": {
            "fee_recipient": "0x86B8145c98e5BD25BA722645b15eD65f024a87EC",
            "gas_limit": 30000000,
            "timestamp": 1616508000,
            "pubkey": "0xb51336c31c4f0cc365d6c7b5d8ff1b4b7d4cf7c70163f9fd51a2badc854f5e29823fa11e3d7749d207807867149508d6"
          },
          "signature": "0x851e4f196b7e7bda6429b94cceb92d480f53fa9753e1d6c830ff2706acb8cd866d81d5533db7dcfac1dc9d00a16e5e4801d33f36bdf1c2a2003e1c586466109e7851c79179b2c46d69c53c4a59e361d2727186a7e72bbd11debad1f2fae6f97d"
        },
        "partial_deposit_data": {
          "pubkey": "0xb51336c31c4f0cc365d6c7b5d8ff1b4b7d4cf7c70163f9fd51a2badc854f5e29823fa11e3d7749d207807867149508d6",
          "withdrawal_credentials": "0x01000000000000000000000086b8145c98e5bd25ba722645b15ed65f024a87ec",
          "amount": "32000000000",
          "deposit_data_root": "5e58a5d8f1e53479343cb6188f061f6b1a46c521c53eef0580b04f485ad62bad",
          "signature": "0x88fe84889608a8b2424bddae2047d2ee4b42f72c4d8201d69e732d7c3bfa1bcb00f930979770b7d00071673fde8f205108dabe8d83ec49aa6de1b7869966b555be80a159e6ad11e273c4e0234038cfa525923044d6a89a4924fdc178f333568b"
        }
      }
    ],
    "signature_aggregate": "0x85650c30ec29a3703934bf50a28da102975deda77e758579ea3dfe4136abf752",
    "lock_hash": "0xd2880980169ee4a0000f23feb8fad9a6c70f38312956fe67aa89e118f5b0e048",
    "node_signatures": [
      "0xe6e531be7bbf6cee37d80ab489ade6491469e10743d3c1496a3e66fe989eb4c100c260eaee4ef1aa08fdb79ea05bb8c12970dec1a296abe627ac25a2515373b301"
    ]
  }'

200

400

500

200

No body

Lock data is valid

Verify Distributed Validator Cluster Lock Data

This endpoint verifies cluster lock data including BLS public keys and signatures created during the DKG phase.

post

/v1/lock/verify

Body

cluster_definitionall ofrequired

Cluster definition data that was used in dkg to generate cluster lock.

distributed_validatorsobject[]required

distributed validator keys and deposit data.

signature_aggregatestringrequired

Example: 0x85650c30ec29a3703934bf50a28da102975deda77e758579ea3dfe4136abf752

lock_hashstringrequired

Example: 0xd2880980169ee4a0000f23feb8fad9a6c70f38312956fe67aa89e118f5b0e048

node_signaturesstring[]required

Example: ["0xe6e531be7bbf6cee37d80ab489ade6491469e10743d3c1496a3e66fe989eb4c100c260eaee4ef1aa08fdb79ea05bb8c12970dec1a296abe627ac25a2515373b301"]

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.obol.tech//v1/lock/verify' \
  --header 'Content-Type: application/json' \
  --data '{
    "cluster_definition": {
      "name": "My Obol Cluster",
      "uuid": "0194FDC2-FA2F-FCC0-41D3-FF12045B73C8",
      "creator": {},
      "version": "v1.8.0",
      "num_validators": 5,
      "threshold": 3,
      "dkg_algorithm": "default",
      "fork_version": "0x00001020",
      "config_hash": "0x2204ba6c238ed2d6a8ff951d4513db993c8d6f8860468391342649bf735a87d7",
      "timestamp": "2022-07-19T18:19:58+02:00",
      "validators": [
        {}
      ],
      "deposit_amounts": [
        "8000000000",
        "16000000000",
        "8000000000"
      ],
      "definition_hash": "0xb656f5a4a5537b5817d6bcf735d043f17f5aff568b1a7ec9102a9f687bd4510c",
      "fee_recipient_address": "0x000000000000000000000000000000000000dead",
      "withdrawal_address": "0x000000000000000000000000000000000000dead",
      "operators": [
        {}
      ],
      "consensus_protocol": "qbft",
      "target_gas_limit": 36000000,
      "compounding": true
    },
    "distributed_validators": [
      {
        "distributed_public_key": "0xb51336c31c4f0cc365d6c7b5d8ff1b4b7d4cf7c70163f9fd51a2badc854f5e29823fa11e3d7749d207807867149508d6",
        "public_shares": [
          "text"
        ],
        "deposit_data": {
          "pubkey": "0xb51336c31c4f0cc365d6c7b5d8ff1b4b7d4cf7c70163f9fd51a2badc854f5e29823fa11e3d7749d207807867149508d6",
          "withdrawal_credentials": "0x01000000000000000000000086b8145c98e5bd25ba722645b15ed65f024a87ec",
          "amount": "32000000000",
          "deposit_data_root": "5e58a5d8f1e53479343cb6188f061f6b1a46c521c53eef0580b04f485ad62bad",
          "signature": "0x88fe84889608a8b2424bddae2047d2ee4b42f72c4d8201d69e732d7c3bfa1bcb00f930979770b7d00071673fde8f205108dabe8d83ec49aa6de1b7869966b555be80a159e6ad11e273c4e0234038cfa525923044d6a89a4924fdc178f333568b"
        },
        "builder_registration": {
          "message": {
            "fee_recipient": "0x86B8145c98e5BD25BA722645b15eD65f024a87EC",
            "gas_limit": 30000000,
            "timestamp": 1616508000,
            "pubkey": "0xb51336c31c4f0cc365d6c7b5d8ff1b4b7d4cf7c70163f9fd51a2badc854f5e29823fa11e3d7749d207807867149508d6"
          },
          "signature": "0x851e4f196b7e7bda6429b94cceb92d480f53fa9753e1d6c830ff2706acb8cd866d81d5533db7dcfac1dc9d00a16e5e4801d33f36bdf1c2a2003e1c586466109e7851c79179b2c46d69c53c4a59e361d2727186a7e72bbd11debad1f2fae6f97d"
        },
        "partial_deposit_data": {
          "pubkey": "0xb51336c31c4f0cc365d6c7b5d8ff1b4b7d4cf7c70163f9fd51a2badc854f5e29823fa11e3d7749d207807867149508d6",
          "withdrawal_credentials": "0x01000000000000000000000086b8145c98e5bd25ba722645b15ed65f024a87ec",
          "amount": "32000000000",
          "deposit_data_root": "5e58a5d8f1e53479343cb6188f061f6b1a46c521c53eef0580b04f485ad62bad",
          "signature": "0x88fe84889608a8b2424bddae2047d2ee4b42f72c4d8201d69e732d7c3bfa1bcb00f930979770b7d00071673fde8f205108dabe8d83ec49aa6de1b7869966b555be80a159e6ad11e273c4e0234038cfa525923044d6a89a4924fdc178f333568b"
        }
      }
    ],
    "signature_aggregate": "0x85650c30ec29a3703934bf50a28da102975deda77e758579ea3dfe4136abf752",
    "lock_hash": "0xd2880980169ee4a0000f23feb8fad9a6c70f38312956fe67aa89e118f5b0e048",
    "node_signatures": [
      "0xe6e531be7bbf6cee37d80ab489ade6491469e10743d3c1496a3e66fe989eb4c100c260eaee4ef1aa08fdb79ea05bb8c12970dec1a296abe627ac25a2515373b301"
    ]
  }'

200

400

500

200

No body

Lock data is valid