-
Notifications
You must be signed in to change notification settings - Fork 419
Add initial FOCIL spec #609
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
Open
jihoonsong
wants to merge
5
commits into
ethereum:main
Choose a base branch
from
jihoonsong:focil
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
21018ef
Add initial FOCIL spec
jihoonsong 0a54c89
Move EIP-7805 spec under experimental folder
jihoonsong 81f30c0
Use primitive type instead of new structures to not make dependency
jihoonsong 5c85918
Specify the upper bound of a list of inclusion lists
jihoonsong 572c54c
Add rules to ignore any blob transactions in the ILs
jihoonsong 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 hidden or 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,115 @@ | ||
# Engine API -- EIP-7805 | ||
|
||
Engine API changes introduced in EIP-7805. | ||
|
||
This specification is based on and extends [Engine API - Prague](./prague.md) specification. | ||
|
||
## Table of contents | ||
|
||
<!-- START doctoc generated TOC please keep comment here to allow auto update --> | ||
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> | ||
|
||
- [Constants](#constants) | ||
- [Methods](#methods) | ||
- [engine_newPayloadV5](#engine_newpayloadv5) | ||
- [Request](#request) | ||
- [Response](#response) | ||
- [Specification](#specification) | ||
- [engine_getInclusionListV1](#engine_getinclusionlistv1) | ||
- [Request](#request-1) | ||
- [Response](#response-1) | ||
- [Specification](#specification-1) | ||
- [engine_updatePayloadWithInclusionListV1](#engine_updatepayloadwithinclusionlistv1) | ||
- [Request](#request-2) | ||
- [Response](#response-2) | ||
- [Specification](#specification-2) | ||
- [Update the methods of previous forks](#update-the-methods-of-previous-forks) | ||
|
||
<!-- END doctoc generated TOC please keep comment here to allow auto update --> | ||
|
||
## Constants | ||
|
||
| Name | Value | | ||
| - | - | | ||
| `MAX_BYTES_PER_INCLUSION_LIST` | `uint64(8192) = 2**13` | | ||
|
||
## Methods | ||
|
||
### engine_newPayloadV5 | ||
|
||
Method parameter list is extended with `inclusionList`. | ||
|
||
#### Request | ||
|
||
* method: `engine_newPayloadV5` | ||
* params: | ||
1. `executionPayload`: [`ExecutionPayloadV3`](./cancun.md#executionpayloadv3). | ||
2. `expectedBlobVersionedHashes`: `Array of DATA`, 32 Bytes - Array of expected blob versioned hashes to validate. | ||
3. `parentBeaconBlockRoot`: `DATA`, 32 Bytes - Root of the parent beacon block. | ||
4. `executionRequests`: `Array of DATA` - List of execution layer triggered requests. Each list element is a `requests` byte array as defined by [EIP-7685](https://eips.ethereum.org/EIPS/eip-7685). The first byte of each element is the `request_type` and the remaining bytes are the `request_data`. Elements of the list **MUST** be ordered by `request_type` in ascending order. Elements with empty `request_data` **MUST** be excluded from the list. | ||
5. `inclusionList`: `Array of DATA` - Array of transaction objects, each object is a byte list (`DATA`) representing `TransactionType || TransactionPayload` or `LegacyTransaction` as defined in [EIP-2718](https://eips.ethereum.org/EIPS/eip-2718). | ||
|
||
#### Response | ||
|
||
Refer to the response for [`engine_newPayloadV4`](./prague.md#engine_newpayloadv4). | ||
|
||
#### Specification | ||
|
||
This method follows the same specification as [`engine_newPayloadV4`](./prague.md#engine_newpayloadv4) with the following changes: | ||
|
||
1. Client software **MUST** return `{status: INVALID_INCLUSION_LIST, latestValidHash: null, validationError: null}` if there are any transactions of `inclusionList` that are not part of the `executionPayload`, even if they can be appended at the end of the `executionPayload`. | ||
|
||
### engine_getInclusionListV1 | ||
|
||
#### Request | ||
|
||
* method: `engine_getInclusionListV1` | ||
* params: | ||
1. `parentHash`: `DATA`, 32 Bytes - parent hash which returned inclusion list should be built upon. | ||
* timeout: 1s | ||
|
||
#### Response | ||
|
||
* result: `inclusionList`: `Array of DATA` - Array of transaction objects, each object is a byte list (`DATA`) representing `TransactionType || TransactionPayload` or `LegacyTransaction` as defined in [EIP-2718](https://eips.ethereum.org/EIPS/eip-2718). | ||
* error: code and message set in case an exception happens while getting the inclusion list. | ||
|
||
#### Specification | ||
|
||
1. Client software **MUST** provide a list of transactions for the inclusion list based on local view of the mempool and according to the config specifications. | ||
|
||
2. Client software **MUST** provide a list of transactions within upperbound `MAX_BYTES_PER_INCLUSION_LIST`. | ||
|
||
3. Client software **MUST NOT** include any [blob transaction](https://eips.ethereum.org/EIPS/eip-4844#blob-transaction) within the provided list. | ||
|
||
### engine_updatePayloadWithInclusionListV1 | ||
|
||
#### Request | ||
|
||
* method: `engine_updatePayloadWithInclusionListV1` | ||
* params: | ||
1. `payloadId`: `DATA`, 8 Bytes - Identifier of the payload build process. | ||
2. `inclusionList`: `inclusionList`: `Array of DATA` - Array of transaction objects, each object is a byte list (`DATA`) representing `TransactionType || TransactionPayload` or `LegacyTransaction` as defined in [EIP-2718](https://eips.ethereum.org/EIPS/eip-2718). | ||
* timeout: 1s | ||
|
||
#### Response | ||
|
||
* result: `payloadId`: `DATA|null`, 8 Bytes - identifier of the payload build process or `null` | ||
* error: code and message set in case an exception happens while getting the inclusion list. | ||
|
||
#### Specification | ||
|
||
1. Given the `payloadId` client software **MUST** update payload build process building with`inclusionList`. The transactions must be part of the execution payload unless it fails to be included at the end of it. | ||
|
||
2. Client software **SHOULD** ignore any [blob transactions](https://eips.ethereum.org/EIPS/eip-4844#blob-transaction) present in the `inclusionList` when updating the execution payload. | ||
|
||
### Update the methods of previous forks | ||
|
||
This document defines how FOCIL payload should be handled by the [`Prague API`](./prague.md). | ||
|
||
For the following methods: | ||
|
||
- [`engine_newPayloadV4`](./prague.md#engine_newpayloadV4) | ||
|
||
a validation **MUST** be added: | ||
|
||
1. Client software **MUST** return `-38005: Unsupported fork` error if the `timestamp` of payload or payloadAttributes greater or equal to the FOCIL activation timestamp. |
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 guess it's worth adding the max inclusion list size
MAX_BYTES_PER_INCLUSION_LIST
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.
Applied, thanks a lot!