Skip to content

Update getHeader and submitBlindedBlock to support blobs (EIP-4844) #61

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.

Sign up for GitHub

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

Merged
ralexstokes merged 18 commits into from
May 24, 2023
Merged

Update getHeader and submitBlindedBlock to support blobs (EIP-4844) #61

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
c05daf2
Add and update types for Capella
jimmygchen Jan 3, 2023
44c433d
Add and update types for EIP-4844
jimmygchen Jan 3, 2023
6933baf
Fix incorrect response example
jimmygchen Jan 12, 2023
f336350
Rename EIP-4844 fork to Deneb
jimmygchen Jan 19, 2023
e6a8988
Merge branch 'main' into eip4844
jimmygchen Feb 16, 2023
40db776
Merge branch 'main' into eip4844
jimmygchen May 11, 2023
38b1d43
Update Deneb builder bid type to include blinded_blobs
jimmygchen May 12, 2023
475ee0f
Update submitBlindeBlock endpoint to accept blinded blobs and return …
jimmygchen May 12, 2023
9e3d267
Add Deneb builder docs.
jimmygchen May 12, 2023
47cbb40
Fix builder doc
jimmygchen May 12, 2023
1ff694e
Update deneb builder doc
jimmygchen May 12, 2023
2a039e2
Update BlobsBundle description
jimmygchen May 12, 2023
117bbf7
Fix ExecutionPayloadAndBlobsBundle description
jimmygchen May 12, 2023
8e9aa72
Update example: execution_payload_and_blobs_bundle.json
jimmygchen May 13, 2023
ad8fe15
Update endpoint description
jimmygchen May 15, 2023
a97131c
Move `pubkey` to end of BuilderBid message for consistency
jimmygchen May 18, 2023
bd2c9b4
Update beacon-APIs submodule to latest
jimmygchen May 18, 2023
a74e5f4
Merge branch 'eip4844' of github.com:jimmygchen/builder-specs into ei…
jimmygchen May 18, 2023
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
13 changes: 11 additions & 2 deletions apis/builder/blinded_blocks.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ post:

If the builder is not able to unblind the corresponding
`ExecutionPayloadHeader`, it must error.

After Deneb, this endpoint will additionally accept `SignedBlindedBlobSidecars`, and return
with additional unblinded blobs in response.
tags:
- Builder
parameters:
Expand All @@ -19,19 +22,22 @@ post:
name: Eth-Consensus-Version
description: "Version of the block being submitted"
requestBody:
description: A `SignedBlindedBeaconBlock`.
description: A `SignedBlindedBeaconBlock` before Deneb, or `SignedBlindedBlockContents` after Deneb.
required: true
content:
application/json:
schema:
oneOf:
- $ref: "../../builder-oapi.yaml#/components/schemas/Bellatrix.SignedBlindedBeaconBlock"
- $ref: "../../builder-oapi.yaml#/components/schemas/Capella.SignedBlindedBeaconBlock"
- $ref: "../../builder-oapi.yaml#/components/schemas/Deneb.SignedBlindedBlockContents"
examples:
bellatrix:
$ref: "../../builder-oapi.yaml#/components/examples/Bellatrix.SignedBlindedBeaconBlock"
capella:
$ref: "../../builder-oapi.yaml#/components/examples/Capella.SignedBlindedBeaconBlock"
deneb:
$ref: "../../builder-oapi.yaml#/components/examples/Deneb.SignedBlindedBlockContents"

responses:
"200":
Expand All @@ -44,17 +50,20 @@ post:
properties:
version:
type: string
enum: [ bellatrix, capella ]
enum: [ bellatrix, capella, deneb ]
example: "bellatrix"
data:
oneOf:
- $ref: "../../builder-oapi.yaml#/components/schemas/Bellatrix.ExecutionPayload"
- $ref: "../../builder-oapi.yaml#/components/schemas/Capella.ExecutionPayload"
- $ref: "../../builder-oapi.yaml#/components/schemas/Deneb.ExecutionPayloadAndBlobsBundle"
examples:
bellatrix:
$ref: "../../builder-oapi.yaml#/components/examples/Bellatrix.ExecutionPayload"
capella:
$ref: "../../builder-oapi.yaml#/components/examples/Capella.ExecutionPayload"
deneb:
$ref: "../../builder-oapi.yaml#/components/examples/Deneb.ExecutionPayloadAndBlobsBundle"
"400":
description: Error response.
content:
Expand Down
5 changes: 4 additions & 1 deletion apis/builder/header.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,17 +50,20 @@ get:
properties:
version:
type: string
enum: [ bellatrix, capella ]
enum: [ bellatrix, capella, deneb ]
example: "bellatrix"
data:
oneOf:
- $ref: "../../builder-oapi.yaml#/components/schemas/Bellatrix.SignedBuilderBid"
- $ref: "../../builder-oapi.yaml#/components/schemas/Capella.SignedBuilderBid"
- $ref: "../../builder-oapi.yaml#/components/schemas/Deneb.SignedBuilderBid"
examples:
bellatrix:
$ref: "../../builder-oapi.yaml#/components/examples/Bellatrix.SignedBuilderBid"
capella:
$ref: "../../builder-oapi.yaml#/components/examples/Capella.SignedBuilderBid"
deneb:
$ref: "../../builder-oapi.yaml#/components/examples/Deneb.SignedBuilderBid"
"204":
description: No header is available.
"400":
Expand Down
2 changes: 1 addition & 1 deletion beacon-apis
Open in desktop
Submodule beacon-apis updated 59 files
+13 −30 CHANGES.md
+6 −7 README.md
+59 −0 apis/beacon/blob_sidecars/blob_sidecars.yaml
+2 −1 apis/beacon/blocks/blinded_block.yaml
+80 −0 apis/beacon/blocks/blinded_blocks.v2.yaml
+3 −1 apis/beacon/blocks/blinded_blocks.yaml
+2 −1 apis/beacon/blocks/block.v2.yaml
+79 −0 apis/beacon/blocks/blocks.v2.yaml
+3 −1 apis/beacon/blocks/blocks.yaml
+2 −2 apis/beacon/light_client/bootstrap.yaml
+2 −2 apis/beacon/light_client/finality_update.yaml
+2 −2 apis/beacon/light_client/optimistic_update.yaml
+2 −2 apis/beacon/light_client/updates.yaml
+0 −2 apis/beacon/rewards/attestations.yaml
+1 −2 apis/beacon/states/fork.yaml
+61 −0 apis/builder/states/expected_withdrawals.yaml
+3 −3 apis/config/spec.yaml
+0 −27 apis/debug/heads.yaml
+2 −1 apis/debug/state.v2.yaml
+31 −0 apis/eventstream/index.yaml
+2 −1 apis/validator/blinded_block.yaml
+2 −1 apis/validator/block.v2.yaml
+2 −0 apis/validator/sync_committee_selections.yaml
+45 −4 beacon-node-oapi.yaml
+1 −0 index.html
+3 −3 types/altair/block.yaml
+3 −3 types/altair/light_client.yaml
+1 −1 types/altair/state.yaml
+1 −1 types/altair/sync_aggregate.yaml
+5 −0 types/api.yaml
+4 −4 types/attestation.yaml
+1 −1 types/attester_slashing.yaml
+6 −6 types/bellatrix/block.yaml
+3 −2 types/bellatrix/execution_payload.yaml
+1 −1 types/bellatrix/state.yaml
+5 −5 types/block.yaml
+2 −3 types/bls_to_execution_change.yaml
+10 −14 types/capella/block.yaml
+3 −2 types/capella/execution_payload.yaml
+9 −0 types/capella/historical_summary.yaml
+1 −1 types/capella/light_client.yaml
+7 −2 types/capella/state.yaml
+88 −0 types/deneb/blob_sidecar.yaml
+97 −0 types/deneb/block.yaml
+37 −0 types/deneb/block_contents.yaml
+56 −0 types/deneb/execution_payload.yaml
+93 −0 types/deneb/state.yaml
+2 −2 types/deposit.yaml
+1 −1 types/eth1.yaml
+1 −1 types/fork_choice.yaml
+2 −2 types/misc.yaml
+1 −1 types/p2p.yaml
+19 −0 types/primitive.yaml
+1 −1 types/proposer_slashing.yaml
+11 −11 types/rewards.yaml
+1 −1 types/state.yaml
+2 −2 types/validator.yaml
+2 −3 types/voluntary_exit.yaml
+3 −3 validator-flow.md
13 changes: 13 additions & 0 deletions builder-oapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,12 @@ components:
$ref: "./beacon-apis/types/capella/block.yaml#/Capella/SignedBlindedBeaconBlock"
Capella.SignedBuilderBid:
$ref: "./types/capella/bid.yaml#/Capella/SignedBuilderBid"
Deneb.SignedBlindedBlockContents:
$ref: "./beacon-apis/types/deneb/block_contents.yaml#/Deneb/SignedBlindedBlockContents"
Deneb.SignedBuilderBid:
$ref: "./types/deneb/bid.yaml#/Deneb/SignedBuilderBid"
Deneb.ExecutionPayloadAndBlobsBundle:
$ref: "./types/deneb/execution_payload_and_blobs_bundle.yaml#/Deneb/ExecutionPayloadAndBlobsBundle"
SignedValidatorRegistration:
$ref: "./beacon-apis/types/registration.yaml#/SignedValidatorRegistration"

Expand All @@ -89,3 +95,10 @@ components:
$ref: "./examples/capella/execution_payload.json"
Capella.SignedBuilderBid:
$ref: "./examples/capella/signed_builder_bid.json"
Deneb.SignedBlindedBlockContents:
$ref: "./examples/deneb/signed_blinded_block_contents.json"
Deneb.ExecutionPayloadAndBlobsBundle:
$ref: "./examples/deneb/execution_payload_and_blobs_bundle.json"
Deneb.SignedBuilderBid:
$ref: "./examples/deneb/signed_builder_bid.json"

39 changes: 39 additions & 0 deletions examples/deneb/execution_payload_and_blobs_bundle.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
{
"value": {
Copy link

@realbigsean realbigsean May 12, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't actually have this top level value field right?

Copy link
Contributor

@g11tech g11tech May 12, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

Copy link
Contributor Author

@jimmygchen jimmygchen May 13, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh I think this is the format openapi lint expects when validating the example files - we have them in all other example jsons, and is required for lint to work.

"version": "deneb",
"data": {
"execution_payload": {
"parent_hash": "0xcf8e0d4e9587369b2301d0790347320302cc0943d5a1884560367e8208d920f2",
"fee_recipient": "0xabcf8e0d4e9587369b2301d0790347320302cc09",
"state_root": "0xcf8e0d4e9587369b2301d0790347320302cc0943d5a1884560367e8208d920f2",
"receipts_root": "0xcf8e0d4e9587369b2301d0790347320302cc0943d5a1884560367e8208d920f2",
"logs_bloom": "0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
"prev_randao": "0xcf8e0d4e9587369b2301d0790347320302cc0943d5a1884560367e8208d920f2",
"block_number": "1",
"gas_limit": "1",
"gas_used": "1",
"timestamp": "1",
"extra_data": "0xcf8e0d4e9587369b2301d0790347320302cc0943d5a1884560367e8208d920f2",
"base_fee_per_gas": "1",
"excess_data_gas": "1",
"block_hash": "0xcf8e0d4e9587369b2301d0790347320302cc0943d5a1884560367e8208d920f2",
"transactions": [
"0x02f878831469668303f51d843b9ac9f9843b9aca0082520894c93269b73096998db66be0441e836d873535cb9c8894a19041886f000080c001a031cc29234036afbf9a1fb9476b463367cb1f957ac0b919b69bbc798436e604aaa018c4e9c3914eb27aadd0b91e10b18655739fcf8c1fc398763a9f1beecb8ddc86"
],
"withdrawals": [
{
"index": "1",
"validator_index": "1",
"address": "0xabcf8e0d4e9587369b2301d0790347320302cc09",
"amount": "32000000000"
}
]
},
"blobs_bundle": {
"commitments": ["0x8dab030c51e16e84be9caab84ee3d0b8bbec1db4a0e4de76439da8424d9b957370a10a78851f97e4b54d2ce1ab0d686f"],
"proofs": ["0xb4021b0de10f743893d4f71e1bf830c019e832958efd6795baf2f83b8699a9eccc5dc99015d8d4d8ec370d0cc333c06a"],
"blobs": ["0x24564723180fcb3d994104538d351c8dcbde12d541676bb736cf678018ca4739"]
}
}
}
}
Loading