Update reserved libp2p error documentation

The spec reserves the libp2p error code range `[3, 127]` for future use
but actually defines error code `3` as `ResourceUnavailable`. This patch
updates the reserved range to `[4, 127]`.
This commit is contained in:
Etan Kissling 2022-01-27 23:57:52 +01:00
parent 420ec14713
commit 20c8d0d641
No known key found for this signature in database
GPG Key ID: B21DA824C5A3D03D
2 changed files with 2 additions and 7 deletions

View File

@ -196,11 +196,6 @@ This builds on top of the protocol identification and encoding spec which was in
Note that DAS networking uses a different protocol prefix: `/eth2/das/req` Note that DAS networking uses a different protocol prefix: `/eth2/das/req`
The result codes are extended with:
- 3: **ResourceUnavailable** -- when the request was valid but cannot be served at this point in time.
TODO: unify with phase0? Lighthoue already defined this in their response codes enum.
### Messages ### Messages
#### DASQuery #### DASQuery

View File

@ -569,11 +569,11 @@ The response code can have one of the following values, encoded as a single unsi
The response payload adheres to the `ErrorMessage` schema (described below). The response payload adheres to the `ErrorMessage` schema (described below).
- 3: **ResourceUnavailable** -- the responder does not have requested resource. - 3: **ResourceUnavailable** -- the responder does not have requested resource.
The response payload adheres to the `ErrorMessage` schema (described below). The response payload adheres to the `ErrorMessage` schema (described below).
*Note*: This response code is only valid as a response to `BlocksByRange`. *Note*: This response code is only valid as a response where specified.
Clients MAY use response codes above `128` to indicate alternative, erroneous request-specific responses. Clients MAY use response codes above `128` to indicate alternative, erroneous request-specific responses.
The range `[3, 127]` is RESERVED for future usages, and should be treated as error if not recognized expressly. The range `[4, 127]` is RESERVED for future usages, and should be treated as error if not recognized expressly.
The `ErrorMessage` schema is: The `ErrorMessage` schema is: