Add blob download endpoint (getBlobs) #286
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| get: | ||
| operationId: getBlobsSidecar | ||
| summary: Get blobs sidecar | ||
| description: | | ||
| Retrieves blobs sidecar for given block id. | ||
| Depending on `Accept` header it can be returned either as json or as bytes serialized by SSZ | ||
| tags: | ||
| - Beacon | ||
| parameters: | ||
| - name: block_id | ||
| in: path | ||
| required: true | ||
| $ref: '../../../beacon-node-oapi.yaml#/components/parameters/BlockId' | ||
| responses: | ||
| "200": | ||
| description: "Successful response" | ||
| content: | ||
| application/json: | ||
| schema: | ||
| title: GetBlobsSidecarResponse | ||
| type: object | ||
| properties: | ||
| data: | ||
| oneOf: | ||
| - $ref: "../../../beacon-node-oapi.yaml#/components/schemas/BlobsSidecar" | ||
| application/octet-stream: | ||
| schema: | ||
| description: "SSZ serialized block bytes. Use Accept header to choose this response type" | ||
| "400": | ||
| description: "The block ID supplied could not be parsed" | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: "../../../beacon-node-oapi.yaml#/components/schemas/ErrorMessage" | ||
| example: | ||
| code: 400 | ||
| message: "Invalid block ID: current" | ||
| "404": | ||
| description: "Blob sidecar not found" | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: "../../../beacon-node-oapi.yaml#/components/schemas/ErrorMessage" | ||
| example: | ||
| code: 404 | ||
| message: "Blob sidecar not found" | ||
| "500": | ||
| $ref: "../../../beacon-node-oapi.yaml#/components/responses/InternalError" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| BlobsSidecar: | ||
| type: object | ||
| description: "The `BlobsSidecar` object from the EIP-4844 CL spec." | ||
| properties: | ||
| beacon_block_root: | ||
| $ref: "./primitive.yaml#/Root" | ||
| beacon_block_slot: | ||
| $ref: "./primitive.yaml#/Uint64" | ||
| blobs: | ||
| type: array | ||
| maxItems: 4 | ||
| minItems: 0 | ||
| items: | ||
| $ref: "#/Blob" | ||
| kzg_aggregated_proof: | ||
| $ref: "#/KZGProof" | ||
|
|
||
| KZGProof: | ||
| type: string | ||
| format: hex | ||
| pattern: "^0x[a-fA-F0-9]{96}$" | ||
| description: "An aggregated KZG proof. Same check as `KZGCommitment`" | ||
|
|
||
| Blob: | ||
| type: string | ||
| format: hex | ||
| pattern: "^0x[a-fA-F0-9]{262144}$" | ||
| description: "A blob is `FIELD_ELEMENTS_PER_BLOB * size_of(BLSFieldElement) = 4096 * 32 = 131072` bytes (`DATA`) representing a SSZ-encoded Blob as defined in EIP-4844" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| EIP4844: | ||
| BeaconBlockBodyCommon: | ||
| # An abstract object to collect the common fields between the BeaconBlockBody and the BlindedBeaconBlockBody objects | ||
| type: object | ||
| description: "The [`BeaconBlockBody`](https://github.com/ethereum/consensus-specs/blob/master/specs/eip4844/beacon-chain.md#beaconblockbody) object from the CL EIP-4844 spec." | ||
rolfyone marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| properties: | ||
| randao_reveal: | ||
| allOf: | ||
| - $ref: '../primitive.yaml#/Signature' | ||
| - description: "The RanDAO reveal value provided by the validator." | ||
| eth1_data: | ||
| $ref: '../eth1.yaml#/Eth1Data' | ||
| graffiti: | ||
| $ref: '../primitive.yaml#/Graffiti' | ||
| proposer_slashings: | ||
| type: array | ||
| items: | ||
| $ref: '../proposer_slashing.yaml#/ProposerSlashing' | ||
| attester_slashings: | ||
| type: array | ||
| items: | ||
| $ref: '../attester_slashing.yaml#/AttesterSlashing' | ||
| attestations: | ||
| type: array | ||
| items: | ||
| $ref: '../attestation.yaml#/Attestation' | ||
| deposits: | ||
| type: array | ||
| items: | ||
| $ref: '../deposit.yaml#/Deposit' | ||
| voluntary_exits: | ||
| type: array | ||
| items: | ||
| $ref: '../voluntary_exit.yaml#/SignedVoluntaryExit' | ||
| sync_aggregate: | ||
| $ref: '../altair/sync_aggregate.yaml#/Altair/SyncAggregate' | ||
| bls_to_execution_changes: | ||
| type: array | ||
| items: | ||
| $ref: '../bls_to_execution_change.yaml#/SignedBLSToExecutionChange' | ||
| blob_kzg_commitments: | ||
| type: array | ||
| items: | ||
| $ref: '../primitive.yaml#/KZGCommitment' | ||
|
|
||
| BeaconBlockBody: | ||
| allOf: | ||
| - $ref: '#/EIP4844/BeaconBlockBodyCommon' | ||
| - type: object | ||
| properties: | ||
| execution_payload: | ||
| $ref: './execution_payload.yaml#/EIP4844/ExecutionPayload' | ||
|
|
||
| BeaconBlock: | ||
| description: "The [`BeaconBlock`](https://github.com/ethereum/consensus-specs/blob/master/specs/EIP4844/beacon-chain.md#beaconblock) object from the CL EIP-4844 spec." | ||
rolfyone marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| allOf: | ||
| - $ref: '../altair/block.yaml#/Altair/BeaconBlockCommon' | ||
| - type: object | ||
| properties: | ||
| body: | ||
| $ref: '#/EIP4844/BeaconBlockBody' | ||
|
|
||
| SignedBeaconBlock: | ||
| type: object | ||
| description: "The [`SignedBeaconBlock`](https://github.com/ethereum/consensus-specs/blob/master/specs/eip4844/beacon-chain.md#signedbeaconblock) object envelope from the CL EIP-4844 spec." | ||
rolfyone marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| properties: | ||
| message: | ||
| $ref: "#/EIP4844/BeaconBlock" | ||
| signature: | ||
| $ref: "../primitive.yaml#/Signature" | ||
|
|
||
| BlindedBeaconBlockBody: | ||
| description: "A variant of the [`BeaconBlockBody`](https://github.com/ethereum/consensus-specs/blob/master/specs/eip4844/beacon-chain.md#beaconblockbody) object from the CL EIP-4844 spec, which contains a transactions root rather than a full transactions list." | ||
rolfyone marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| allOf: | ||
| - $ref: '#/EIP4844/BeaconBlockBodyCommon' | ||
| - type: object | ||
| properties: | ||
| execution_payload_header: | ||
| $ref: './execution_payload.yaml#/EIP4844/ExecutionPayloadHeader' | ||
|
|
||
| BlindedBeaconBlock: | ||
| description: "A variant of the the [`BeaconBlock`](https://github.com/ethereum/consensus-specs/blob/master/specs/eip4844/beacon-chain.md#beaconblock) object from the CL EIP-4844 spec, which contains a `BlindedBeaconBlockBody` rather than a `BeaconBlockBody`." | ||
rolfyone marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| allOf: | ||
| - $ref: '../altair/block.yaml#/Altair/BeaconBlockCommon' | ||
| - type: object | ||
| properties: | ||
| body: | ||
| $ref: '#/EIP4844/BlindedBeaconBlockBody' | ||
|
|
||
| SignedBlindedBeaconBlock: | ||
| type: object | ||
| description: "A variant of the the the [`SignedBeaconBlock`](https://github.com/ethereum/consensus-specs/blob/master/specs/eip4844/beacon-chain.md#signedbeaconblock) object envelope from the CL EIP-4844 spec, which contains a `BlindedBeaconBlock` rather than a `BeaconBlock`." | ||
rolfyone marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| properties: | ||
| message: | ||
| $ref: "#/EIP4844/BlindedBeaconBlock" | ||
| signature: | ||
| $ref: "../primitive.yaml#/Signature" | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd actually be inclined to make this the same pattern as attestations, so the path would be more like
/eth/v1/beacon/blocks/{block_id}/blobsThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wouldn't that imply that the blobs are part of the block structure, though?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated to
/eth/v1/beacon/blobs/{block_id}