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 API to retrieve blobs sidecar #298

Closed
wants to merge 1 commit into from
Closed
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
47 changes: 47 additions & 0 deletions apis/beacon/blobs_sidecar.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
get:
operationId: getBlobsSidecar
summary: Get Blobs Sidecar
description: |
Returns the `BlobsSidecar` for a given block ID.
Depending on `Accept` header it can be returned either as JSON or SSZ-serialized bytes.
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:
$ref: '../../beacon-node-oapi.yaml#/components/schemas/BlobsSidecar'
application/octet-stream:
schema:
description: "SSZ serialized BlobsSidecar 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: "Blobs Sidecar not found"
content:
application/json:
schema:
$ref: "../../../beacon-node-oapi.yaml#/components/schemas/ErrorMessage"
example:
code: 404
message: "BlobsSidecar not found"
"500":
$ref: "../../../beacon-node-oapi.yaml#/components/responses/InternalError"
4 changes: 4 additions & 0 deletions beacon-node-oapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,8 @@ paths:
$ref: "./apis/beacon/pool/voluntary_exists.yaml"
/eth/v1/beacon/pool/bls_to_execution_changes:
$ref: "./apis/beacon/pool/bls_to_execution_changes.yaml"
/eth/v1/beacon/blobs_sidecar:
$ref: "./apis/beacon/blobs_sidecar.yaml"

/eth/v2/debug/beacon/states/{state_id}:
$ref: './apis/debug/state.v2.yaml'
Expand Down Expand Up @@ -345,6 +347,8 @@ components:
$ref: './types/rewards.yaml#/BlockRewards'
AttestationsRewards:
$ref: './types/rewards.yaml#/AttestationsRewards'
BlobsSidecar:
$ref: './types/eip4844/block_and_blobs_sidecar.yaml#/EIP4844/BlobsSidecar'

parameters:
StateId:
Expand Down