diff --git a/apis/beacon/states/proposer_lookahead.yaml b/apis/beacon/states/proposer_lookahead.yaml new file mode 100644 index 00000000..52466cc0 --- /dev/null +++ b/apis/beacon/states/proposer_lookahead.yaml @@ -0,0 +1,49 @@ +get: + operationId: "getProposerLookahead" + summary: "Get State Proposer Lookahead" + description: | + Returns proposer lookahead for state with given 'stateId'. Should return 400 if the state retrieved is prior to Fulu. + tags: + - Beacon + parameters: + - name: state_id + in: path + $ref: '../../../beacon-node-oapi.yaml#/components/parameters/StateId' + responses: + "200": + description: Success + headers: + Eth-Consensus-Version: + $ref: '../../../beacon-node-oapi.yaml#/components/headers/Eth-Consensus-Version' + description: "The active consensus version to which the proposer lookahead data belongs." + content: + application/json: + schema: + title: GetProposerLookaheadResponse + type: object + required: [version, execution_optimistic, finalized, data] + properties: + version: + $ref: "../../../beacon-node-oapi.yaml#/components/schemas/ConsensusVersion" + example: "fulu" + execution_optimistic: + $ref: "../../../beacon-node-oapi.yaml#/components/schemas/ExecutionOptimistic" + finalized: + $ref: "../../../beacon-node-oapi.yaml#/components/schemas/Finalized" + data: + type: array + items: + $ref: '../../../beacon-node-oapi.yaml#/components/schemas/Uint64' + maxItems: 64 + application/octet-stream: + schema: + description: "SSZ serialized `List[Uint64, (MIN_SEED_LOOKAHEAD + 1) * SLOTS_PER_EPOCH]` bytes. Use Accept header to choose this response type" + "400": + $ref: '../../../beacon-node-oapi.yaml#/components/responses/InvalidRequest' + "404": + $ref: '../../../beacon-node-oapi.yaml#/components/responses/NotFound' + "406": + $ref: '../../../beacon-node-oapi.yaml#/components/responses/NotAcceptable' + "500": + $ref: '../../../beacon-node-oapi.yaml#/components/responses/InternalError' + diff --git a/beacon-node-oapi.yaml b/beacon-node-oapi.yaml index e6b9b248..efc8127a 100644 --- a/beacon-node-oapi.yaml +++ b/beacon-node-oapi.yaml @@ -95,6 +95,8 @@ paths: $ref: "./apis/beacon/states/pending_deposits.yaml" /eth/v1/beacon/states/{state_id}/pending_partial_withdrawals: $ref: "./apis/beacon/states/pending_partial_withdrawals.yaml" + /eth/v1/beacon/states/{state_id}/proposer_lookahead: + $ref: "./apis/beacon/states/proposer_lookahead.yaml" /eth/v1/beacon/headers: $ref: "./apis/beacon/blocks/headers.yaml"