-
Notifications
You must be signed in to change notification settings - Fork 442
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
7
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
7 commits
Select commit
Hold shift + click to select a range
c806cf3
Add initial FOCIL spec
jihoonsong b727b7c
Move EIP-7805 spec under experimental folder
jihoonsong 7d38fd7
Use primitive type instead of new structures to not make dependency
jihoonsong a9292df
Specify the upper bound of a list of inclusion lists
jihoonsong b04e532
Add rules to ignore any blob transactions in the ILs
jihoonsong 1c22e31
Rebase onto Osaka
jihoonsong ae719c0
Reflect changes in the queue
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
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,133 @@ | ||
# Engine API -- EIP-7805 | ||
|
||
Engine API changes introduced in EIP-7805. | ||
|
||
This specification is based on and extends [Engine API - Osaka](./osaka.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) | ||
- [Structures](#structures) | ||
- [PayloadAttributesV4](#payloadattributesv4) | ||
- [Routines](#routines) | ||
- [Payload building](#payload-building) | ||
- [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_forkchoiceUpdatedV4](#engine_forkchoiceupdatedv4) | ||
- [Request](#request-2) | ||
- [Response](#response-2) | ||
- [Specification](#specification-2) | ||
|
||
<!-- END doctoc generated TOC please keep comment here to allow auto update --> | ||
|
||
## Constants | ||
|
||
| Name | Value | | ||
| - | - | | ||
| `MAX_BYTES_PER_INCLUSION_LIST` | `uint64(8192) = 2**13` | | ||
|
||
## Structures | ||
|
||
### PayloadAttributesV4 | ||
|
||
This structure has the syntax of [`PayloadAttributesV3`](./cancun.md#payloadattributesv3) and appends a single field: `inclusionListTransactions`. | ||
|
||
- `timestamp`: `QUANTITY`, 64 Bits - value for the `timestamp` field of the new payload | ||
- `prevRandao`: `DATA`, 32 Bytes - value for the `prevRandao` field of the new payload | ||
- `suggestedFeeRecipient`: `DATA`, 20 Bytes - suggested value for the `feeRecipient` field of the new payload | ||
- `withdrawals`: `Array of WithdrawalV1` - Array of withdrawals, each object is an `OBJECT` containing the fields of a `WithdrawalV1` structure. | ||
- `parentBeaconBlockRoot`: `DATA`, 32 Bytes - Root of the parent beacon block. | ||
- `inclusionListTransactions`: `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). | ||
|
||
## Routines | ||
|
||
### Payload building | ||
|
||
This routine follows the same specification as [Payload building](./paris.md#payload-building) with the following changes to the processing flow: | ||
|
||
1. Client software **SHOULD** take `payloadAttributes.inclusionList` into account during the payload build process. The built `ExecutionPayload` **MUST** satisfy the inclusion list constraints with respect to `payloadAttributes.inclusionList` as defined in [EIP-7805](https://eips.ethereum.org/EIPS/eip-7805). | ||
|
||
## Methods | ||
|
||
### engine_newPayloadV5 | ||
|
||
Method parameter list is extended with `inclusionListTransactions`. | ||
|
||
#### 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. `inclusionListTransactions`: `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 | ||
|
||
* result: [`PayloadStatusV1`](./paris.md#payloadstatusv1), values of the `status` field are modified in the following way: | ||
- `INVALID_BLOCK_HASH` status value is supplanted by `INVALID`. | ||
- `INCLUSION_LIST_UNSATISFIED` status value is appended. | ||
* error: code and message set in case an exception happens while processing the payload. | ||
|
||
#### Specification | ||
|
||
This method follows the same specification as [`engine_newPayloadV4`](./prague.md#engine_newpayloadv4) with the following changes: | ||
|
||
1. Client software **MUST** return `{status: INCLUSION_LIST_UNSATISFIED, latestValidHash: null, validationError: null}` if `executionPayload` fails to satisfy the inclusion list constraints with respect to `inclusionListTransactions` as defined in [EIP-7805](https://eips.ethereum.org/EIPS/eip-7805). | ||
|
||
### 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: `inclusionListTransactions`: `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. | ||
|
||
4. Client software **MUST** return `-38006: Unknown parent` error if a block with the given `parentHash` does not exist. | ||
|
||
### engine_forkchoiceUpdatedV4 | ||
|
||
#### Request | ||
|
||
* method: `engine_forkchoiceUpdatedV4` | ||
* params: | ||
1. `forkchoiceState`: [`ForkchoiceStateV1`](./paris.md#forkchoicestatev1). | ||
2. `payloadAttributes`: `Object|null` - Instance of [`PayloadAttributesV4`](#payloadattributesv4) or `null`. | ||
* timeout: 8s | ||
|
||
#### Response | ||
|
||
Refer to the response for [`engine_forkchoiceUpdatedV3`](./cancun.md#engine_forkchoiceupdatedv3). | ||
|
||
#### Specification | ||
mkalinin marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
This method follows the same specification as [`engine_forkchoiceUpdatedV3`](./cancun.md#engine_forkchoiceupdatedv3) with the following changes to the processing flow: | ||
|
||
1. Extend point (7) of the `engine_forkchoiceUpdatedV1` [specification](./paris.md#specification-1) by defining the following sequence of checks that **MUST** be run over `payloadAttributes`: | ||
|
||
1. `payloadAttributes` matches the [`PayloadAttributesV4`](#payloadattributesv4) structure, return `-38003: Invalid payload attributes` on failure. |
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.
Uh oh!
There was an error while loading. Please reload this page.