Skip to content

Commit e8f2355

Browse files
rolfyonerolfyone
committed
deploy: 5091f41 
1 parent 58ed266 commit e8f2355

File tree

1 file changed

+187
-0
lines changed

1 file changed

+187
-0
lines changed

‎beacon-node-oapi.yaml‎

Lines changed: 187 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16874,6 +16874,7 @@ paths:
1687416874
get:
1687516875
operationId: getBlobSidecars
1687616876
summary: Get blob sidecars
16877+
deprecated: true
1687716878
description: |
1687816879
Retrieves blob sidecars for a given block id.
1687916880
Depending on `Accept` header it can be returned either as json or as bytes serialized by SSZ.
@@ -17240,6 +17241,177 @@ paths:
1724017241
example:
1724117242
code: 500
1724217243
message: Internal server error
17244+
'/eth/v1/beacon/blobs/{block_id}':
17245+
get:
17246+
operationId: getBlobs
17247+
summary: Get blobs
17248+
description: |
17249+
Retrieves blobs for a given block id.
17250+
Depending on `Accept` header it can be returned either as json or as bytes serialized by SSZ.
17251+
17252+
If the `versioned_hashes` parameter is specified, only the blobs for the specified versioned hashes will be returned. Blobs are
17253+
returned as an ordered list matching the order of their corresponding KZG commitments in the block.
17254+
17255+
After the Fulu fork, only supernodes (which custody all data columns) are required to return blobs. Clients may implement
17256+
blob reconstruction logic for non-super nodes.
17257+
tags:
17258+
- Beacon
17259+
parameters:
17260+
- name: block_id
17261+
in: path
17262+
required: true
17263+
example: head
17264+
schema:
17265+
type: string
17266+
description: |
17267+
Block identifier.
17268+
Can be one of: "head" (canonical head in node's view), "genesis", "finalized", \<slot\>, \<hex encoded blockRoot with 0x prefix\>.
17269+
- name: versioned_hashes
17270+
in: query
17271+
description: Array of versioned hashes for blobs to request for in the specified block. Returns all blobs in the block if not specified.
17272+
required: false
17273+
schema:
17274+
type: array
17275+
uniqueItems: true
17276+
items:
17277+
type: string
17278+
format: hex
17279+
pattern: '^0x[a-fA-F0-9]{64}$'
17280+
description: A versioned hash used to identify a Blob.
17281+
example: '0x01cf8e0d4e9587369b2301d0790347320302cc0943d5a1884560367e8208d920f2'
17282+
responses:
17283+
'200':
17284+
description: Successful response
17285+
content:
17286+
application/json:
17287+
schema:
17288+
title: GetBlobsResponse
17289+
type: object
17290+
required:
17291+
- execution_optimistic
17292+
- finalized
17293+
- data
17294+
properties:
17295+
execution_optimistic:
17296+
type: boolean
17297+
example: false
17298+
description: 'True if the response references an unverified execution payload. Optimistic information may be invalidated at a later time. If the field is not present, assume the False value.'
17299+
finalized:
17300+
type: boolean
17301+
example: false
17302+
description: 'True if the response references the finalized history of the chain, as determined by fork choice. If the field is not present, additional calls are necessary to compare the epoch of the requested information with the finalized checkpoint.'
17303+
data:
17304+
type: array
17305+
items:
17306+
type: string
17307+
format: hex
17308+
pattern: '^0x[a-fA-F0-9]{262144}$'
17309+
description: A blob is `FIELD_ELEMENTS_PER_BLOB * size_of(BLSFieldElement) = 4096 * 32 = 131072` bytes (`DATA`) representing a Blob as defined in Deneb
17310+
minItems: 0
17311+
maxItems: 4096
17312+
application/octet-stream:
17313+
schema:
17314+
description: 'SSZ serialized `List[Blob, MAX_BLOB_COMMITMENTS_PER_BLOCK]` bytes. Use Accept header to choose this response type'
17315+
'400':
17316+
description: The block ID supplied could not be parsed
17317+
content:
17318+
application/json:
17319+
schema:
17320+
type: object
17321+
required:
17322+
- code
17323+
- message
17324+
properties:
17325+
code:
17326+
description: Either specific error code in case of invalid request or http status code
17327+
type: number
17328+
example: 404
17329+
message:
17330+
description: Message describing error
17331+
type: string
17332+
stacktraces:
17333+
description: 'Optional stacktraces, sent when node is in debug mode'
17334+
type: array
17335+
items:
17336+
type: string
17337+
example:
17338+
code: 400
17339+
message: 'Invalid block ID: current'
17340+
'404':
17341+
description: Block not found
17342+
content:
17343+
application/json:
17344+
schema:
17345+
type: object
17346+
required:
17347+
- code
17348+
- message
17349+
properties:
17350+
code:
17351+
description: Either specific error code in case of invalid request or http status code
17352+
type: number
17353+
example: 404
17354+
message:
17355+
description: Message describing error
17356+
type: string
17357+
stacktraces:
17358+
description: 'Optional stacktraces, sent when node is in debug mode'
17359+
type: array
17360+
items:
17361+
type: string
17362+
example:
17363+
code: 404
17364+
message: Block not found
17365+
'406':
17366+
description: Accepted media type is not supported.
17367+
content:
17368+
application/json:
17369+
schema:
17370+
type: object
17371+
required:
17372+
- code
17373+
- message
17374+
properties:
17375+
code:
17376+
description: 'The media type in "Accept" header is unsupported, and the request has been rejected. This occurs when the server cannot produce a response in the format accepted by the client.'
17377+
type: number
17378+
example: 406
17379+
message:
17380+
description: Message describing error
17381+
type: string
17382+
stacktraces:
17383+
description: 'Optional stacktraces, sent when node is in debug mode'
17384+
type: array
17385+
items:
17386+
type: string
17387+
example:
17388+
code: 406
17389+
message: Accepted media type not supported
17390+
'500':
17391+
description: Beacon node internal error.
17392+
content:
17393+
application/json:
17394+
schema:
17395+
type: object
17396+
required:
17397+
- code
17398+
- message
17399+
properties:
17400+
code:
17401+
description: Either specific error code in case of invalid request or http status code
17402+
type: number
17403+
example: 404
17404+
message:
17405+
description: Message describing error
17406+
type: string
17407+
stacktraces:
17408+
description: 'Optional stacktraces, sent when node is in debug mode'
17409+
type: array
17410+
items:
17411+
type: string
17412+
example:
17413+
code: 500
17414+
message: Internal server error
1724317415
'/eth/v1/debug/beacon/data_column_sidecars/{block_id}':
1724417416
get:
1724517417
operationId: getDebugDataColumnSidecars
@@ -60898,6 +61070,21 @@ components:
6089861070
format: hex
6089961071
pattern: '^0x[a-fA-F0-9]{262144}$'
6090061072
description: A blob is `FIELD_ELEMENTS_PER_BLOB * size_of(BLSFieldElement) = 4096 * 32 = 131072` bytes (`DATA`) representing a Blob as defined in Deneb
61073+
Blobs:
61074+
type: array
61075+
items:
61076+
type: string
61077+
format: hex
61078+
pattern: '^0x[a-fA-F0-9]{262144}$'
61079+
description: A blob is `FIELD_ELEMENTS_PER_BLOB * size_of(BLSFieldElement) = 4096 * 32 = 131072` bytes (`DATA`) representing a Blob as defined in Deneb
61080+
minItems: 0
61081+
maxItems: 4096
61082+
VersionedHash:
61083+
type: string
61084+
format: hex
61085+
pattern: '^0x[a-fA-F0-9]{64}$'
61086+
description: A versioned hash used to identify a Blob.
61087+
example: '0x01cf8e0d4e9587369b2301d0790347320302cc0943d5a1884560367e8208d920f2'
6090161088
Deneb.BlobSidecars:
6090261089
type: array
6090361090
items:

0 commit comments

Comments
 (0)