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 timeouts (redux) #216

Merged
merged 2 commits into from
May 5, 2022
Merged

engine timeouts (redux) #216

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
774d577
add engine api timeouts
djrtwo Apr 5, 2022
fb13942
mod timeouts to be 8s and 1s
djrtwo May 4, 2022
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
11 changes: 11 additions & 0 deletions src/engine/specification.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ This document specifies the Engine API methods that the Consensus Layer uses to
- [Message ordering](#message-ordering)
- [Load-balancing and advanced configurations](#load-balancing-and-advanced-configurations)
- [Errors](#errors)
- [Timeouts](#timeouts)
- [Structures](#structures)
- [ExecutionPayloadV1](#executionpayloadv1)
- [ForkchoiceStateV1](#forkchoicestatev1)
Expand Down Expand Up @@ -132,6 +133,12 @@ $ curl https://localhost:8550 \
}
```

## Timeouts

Consensus Layer client software **MUST** wait for a specified `timeout` before aborting the call. In such an event, the Consensus Layer client software **MAY** retry the call.

Consensus Layer client software **MAY** wait for response longer than it is specified by the `timeout` parameter.

## Structures

Values of a field of `DATA` type **MUST** be encoded as a hexadecimal string with a `0x` prefix matching the regular expression `^0x(?:[a-fA-F0-9]{2})*$`.
Expand Down Expand Up @@ -239,6 +246,7 @@ The payload build process is specified as follows:
* method: `engine_newPayloadV1`
* params:
1. [`ExecutionPayloadV1`](#ExecutionPayloadV1)
* timeout: 8s

#### Response

Expand Down Expand Up @@ -275,6 +283,7 @@ The payload build process is specified as follows:
* params:
1. `forkchoiceState`: `Object` - instance of [`ForkchoiceStateV1`](#ForkchoiceStateV1)
2. `payloadAttributes`: `Object|null` - instance of [`PayloadAttributesV1`](#PayloadAttributesV1) or `null`
* timeout: 8s

#### Response

Expand Down Expand Up @@ -319,6 +328,7 @@ The payload build process is specified as follows:
* method: `engine_getPayloadV1`
* params:
1. `payloadId`: `DATA`, 8 Bytes - Identifier of the payload build process
* timeout: 1s

#### Response

Expand All @@ -340,6 +350,7 @@ The payload build process is specified as follows:
* method: `engine_exchangeTransitionConfigurationV1`
* params:
1. `transitionConfiguration`: `Object` - instance of [`TransitionConfigurationV1`](#TransitionConfigurationV1)
* timeout: 1s

#### Response

Expand Down