-
Notifications
You must be signed in to change notification settings - Fork 171
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 blob download endpoint (getBlobs) #286
Merged
Merged
Changes from 28 commits
Commits
Show all changes
29 commits
Select commit
Hold shift + click to select a range
5502da1
Update types to support EIP-4844 (#271)
jimmygchen 85a715d
Add getBlobsSidecar endpoint
jimmygchen e702695
Merge remote-tracking branch 'upstream/master' into EIP4844
rolfyone fd02cd2
Introduce Deneb to remove EIP-4844 references
rolfyone ca3dd1b
Remove `_sidecar` from blobs endpoint path. Add endpoint to CHANGES.md
jimmygchen 09ca1dd
Merge remote-tracking branch 'upstream/master' into eip_rename
rolfyone 709ccd6
fix lint - couldnt find any evidence of capella transactions, so put …
rolfyone 652b865
Merge branch 'eip_rename' into download-blob-api
jimmygchen f300afe
Merge branch 'master' into eip_rename
rolfyone b1bbe28
Merge branch 'master' into download-blob-api
jimmygchen 30b2d05
Update endpoint to return `BlobSidecar` container from latest CL spec
jimmygchen 1d8e599
Add recommendation to do blob retrieval by slot
jimmygchen 39efcbe
Merge branch 'eip_rename' into download-blob-api
jimmygchen 1ec6931
Merge branch 'master' into download-blob-api
jimmygchen fe595c3
Merge branch 'master' into download-blob-api
jimmygchen 27ac4b8
Add blob indices query paraemter
jimmygchen 7f5e792
Merge branch 'master' into download-blob-api
jimmygchen 7ee3525
Remove old block_and_blobs_sidecar type
jimmygchen 4ccaaa6
Address review comments.
jimmygchen 4ded8d7
Merge branch 'master' into download-blob-api
rolfyone 61b4663
Merge branch 'master' into download-blob-api
rolfyone 27e4451
Merge branch 'master' into download-blob-api
jimmygchen e3dfda2
Apply review comment, change RanDAO to RANDAO
jimmygchen 354ff9f
Add more details to getBlobs response
jimmygchen eb7bc1f
Merge branch 'download-blob-api' of github.com:jimmygchen/beacon-APIs…
jimmygchen df43224
Update spacing
jimmygchen 775e93c
Merge branch 'master' into download-blob-api
jimmygchen a6d1c36
Update getBlobSidecars endpoint path
jimmygchen 096aadc
Reuse BlobSidecars type in getBlobSidecars response
jimmygchen File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
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,64 @@ | ||
get: | ||
operationId: getBlobSidecars | ||
summary: Get blob sidecars | ||
description: | | ||
Retrieves blob sidecars for a given block id. | ||
Depending on `Accept` header it can be returned either as json or as bytes serialized by SSZ. | ||
|
||
If the `indices` paramneter is specified, only the blob sidecars with the specified indices will be returned. There are no guarantees | ||
for the returned blob sidecars in terms of ordering. | ||
tags: | ||
- Beacon | ||
parameters: | ||
- name: block_id | ||
in: path | ||
required: true | ||
$ref: '../../../beacon-node-oapi.yaml#/components/parameters/BlockId' | ||
- name: indices | ||
in: query | ||
description: Array of indices for blob sidecars to request for in the specified block. Returns all blob sidecars in the block if not speicfied. | ||
required: false | ||
schema: | ||
type: array | ||
uniqueItems: true | ||
items: | ||
$ref: '../../../beacon-node-oapi.yaml#/components/schemas/Uint64' | ||
responses: | ||
"200": | ||
description: "Successful response" | ||
content: | ||
application/json: | ||
schema: | ||
title: GetBlobsResponse | ||
type: object | ||
properties: | ||
data: | ||
type: array | ||
items: | ||
oneOf: | ||
- $ref: "../../../beacon-node-oapi.yaml#/components/schemas/Deneb.BlobSidecar" | ||
minItems: 0 | ||
maxItems: 4 | ||
application/octet-stream: | ||
schema: | ||
description: "SSZ serialized `BlobSidecars` 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: "Block not found" | ||
content: | ||
application/json: | ||
schema: | ||
$ref: "../../../beacon-node-oapi.yaml#/components/schemas/ErrorMessage" | ||
example: | ||
code: 404 | ||
message: "Block 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -86,5 +86,3 @@ Deneb: | |
$ref: "#/Deneb/BlindedBlobSidecar" | ||
signature: | ||
$ref: "../primitive.yaml#/Signature" | ||
|
||
|
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 was deleted.
Oops, something went wrong.
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
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.
We appear to have the type
BlobSidecars
that is an array of blob sidecars with the same parameters as this. Should that be used in place of redefining the array here?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.
Good catch! Updated in 096aadc, thanks!