Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add register_validator endpoint #209

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions apis/validator/register_validator.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
post:
operationId: "registerValidator"
summary: Provide beacon node with registrations for the given validators to the external builder network.
description: |
Prepares the beacon node for engaging with external builders. The
information will be sent by the beacon node to the builder network. It is
expected that the validator client will send this information periodically
to ensure the beacon node has correct and timely registration information
to provide to builders. The validator client should not sign blinded beacon
blocks that do not adhere to their latest fee recipient and gas limit
preferences.

Note that requests containing currently inactive or unknown validator
pubkeys will be accepted, as they may become active at a later epoch.
tags:
- Validator
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '../../beacon-node-oapi.yaml#/components/schemas/SignedValidatorRegistration'
responses:
"200":
description: Registration information has been received.
"400":
$ref: '../../beacon-node-oapi.yaml#/components/responses/InvalidRequest'
"500":
$ref: '../../beacon-node-oapi.yaml#/components/responses/InternalError'
5 changes: 5 additions & 0 deletions beacon-node-oapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,8 @@ paths:
$ref: "./apis/validator/sync_committee_contribution_and_proof.yaml"
/eth/v1/validator/prepare_beacon_proposer:
$ref: "./apis/validator/prepare_beacon_proposer.yaml"
/eth/v1/validator/register_validator:
lightclient marked this conversation as resolved.
Show resolved Hide resolved
$ref: "./apis/validator/register_validator.yaml"
lightclient marked this conversation as resolved.
Show resolved Hide resolved

/eth/v1/events:
$ref: "./apis/eventstream/index.yaml"
Expand Down Expand Up @@ -273,6 +275,9 @@ components:
ConsensusVersion:
enum: [phase0, altair, bellatrix]
example: "phase0"
SignedValidatorRegistration:
$ref: './types/registration.yaml#/SignedValidatorRegistration'

parameters:
StateId:
$ref: './params/index.yaml#/StateId'
Expand Down
25 changes: 25 additions & 0 deletions types/registration.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
ValidatorRegistration:
type: object
description: "The `ValidatorRegistration` object from the Builder API specification."
properties:
fee_recipient:
$ref: 'primitive.yaml#/ExecutionAddress'
description: "Address to receive fees from the block."
gas_limit:
$ref: "primitive.yaml#/Uint64"
description: "Preferred gas limit of validator."
timestamp:
$ref: 'primitive.yaml#/Uint64'
description: "Unix timestamp of registration."
pubkey:
$ref: 'primitive.yaml#/Pubkey'
description: "BLS public key of validator."

SignedValidatorRegistration:
type: object
description: "The `SignedValidatorRegistration` object from the Builder API specification."
properties:
message:
$ref: "#/ValidatorRegistration"
signature:
$ref: "primitive.yaml#/Signature"