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.

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

Engine API: inform CL with details on validation error #135

Merged
merged 5 commits into from
Nov 30, 2021
Merged

Engine API: inform CL with details on validation error #135

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a2920cd
Engine API: inform CL with details on validation error
mkalinin Nov 24, 2021
2577e48
move validation error to structure section
lightclient Nov 24, 2021
3eaafaf
use integer instead of quantity
lightclient Nov 24, 2021
80a159f
Engine API: suffix ValidationError with V1
mkalinin Nov 29, 2021
9121a9a
Engine API: make validationError of a String type
mkalinin Nov 29, 2021
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
4 changes: 2 additions & 2 deletions src/engine/specification.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ This structure contains the attributes required to initiate a payload build proc
* result: `object`
- `status`: `enum` - `"VALID" | "INVALID" | "SYNCING"`
- `latestValidHash`: `DATA|null`, 32 Bytes - the hash of the most recent *valid* block in the branch defined by payload and its ancestors
- `message`: `STRING|null` - the message providing additional details on the response to the method call if needed
- `validationError`: `String|null` - a message providing additional details on the validation error if the payload is deemed `INVALID`
* error: code and message set in case an exception happens while executing the payload.

#### Specification
Expand All @@ -179,7 +179,7 @@ This structure contains the attributes required to initiate a payload build proc

3. Client software **MUST** return `{status: SYNCING, latestValidHash: null}` if the sync process is already in progress or if requisite data for payload validation is missing. In the event that requisite data to validate the payload is missing (e.g. does not have payload identified by `parentHash`), the client software **SHOULD** initiate the sync process.

4. Client software **MAY** provide additional details on the payload validation by utilizing `message` field in the response object. For example, particular error message occurred during the payload execution may accompany a response with `INVALID` status.
4. Client software **MAY** provide additional details on the validation error if the payload is deemed `INVALID` by assigning the corresponding message to the `validationError` field.

### engine_forkchoiceUpdatedV1

Expand Down