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.

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: introduce exchangeCapabilities #364

Merged
merged 5 commits into from
Jan 26, 2023
Merged
Changes from 1 commit
Commits
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
28 changes: 28 additions & 0 deletions src/engine/experimental/capabilities.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Engine API -- Capabilities

Specification of `engine_getCapabilities` method returning a list of Engine API methods supported by the server (execution layer client) down to a version of each method.

The proposed method should become a part of [`common.md`](../common.md) document if accepted.

## Methods

### engine_getCapabilities

*Note:* The method itself doesn't have a version suffix.

#### Request

* method: `engine_getCapabilities`
* timeout: 1s

#### Response

`Array of string` -- Array of strings, each string is a name of a method supported by execution layer client software.

#### Specification

1. Client software **MUST** return a list of currently supported Engine API methods down to a version of each method. Consider the following response examples:
* `["engine_newPayloadV1", "engine_newPayloadV2", ...]` -- the software currently supports `V1` and `V2` versions of `engine_newPayload` method,
* `["engine_newPayloadV2", "engine_newPayloadV3", ...]` -- `V1` version has been deprecated, and `V3` have been introduced with respect to the above response.

2. The `engine_getCapabilities` method **MUST NOT** be returned in the response list.