Skip to content

Commit

Permalink
add change log entries
Browse files Browse the repository at this point in the history
  • Loading branch information
@mehdi-aouadi
mehdi-aouadi committed May 28, 2024
1 parent 0da1243 commit fe3cc11
Show file tree
Hide file tree
Showing 6 changed files with 111 additions and 19 deletions.
21 changes: 13 additions & 8 deletions CHANGES.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,20 @@ These endpoints have been added or updated since the last release.

There are likely to be descriptions etc outside of the list below, but new query parameters, changes to headers, new endpoints should be listed.

| Endpoint | [Lighthouse](https://github.com/sigp/lighthouse) | [Lodestar](https://github.com/ChainSafe/lodestar) | [Nimbus](https://github.com/status-im/nimbus-eth2) | [Prysm](https://github.com/prysmaticlabs/prysm) | [Teku](https://github.com/ConsenSys/teku) |
|---------------------------------------------------------------------------------------------------------------------|--------------------------------------------------|---------------------------------------------------|----------------------------------------------------|-------------------------------------------------|-------------------------------------------|
| [#350](https://github.com/ethereum/beacon-APIs/pull/350) `blob_sidecar EVENT` added | | v1.12.0 | | | |
| [#358](https://github.com/ethereum/beacon-APIs/pull/358) `/eth/v3/validator/blocks` added `consensus_block_value` to response | | v1.13.0 | | | |
| [#367](https://github.com/ethereum/beacon-APIs/pull/367) `POST /eth/v1/beacon/states/{state_id}/validators` added | | - | | | |
| [#367](https://github.com/ethereum/beacon-APIs/pull/367) `POST /eth/v1/beacon/states/{state_id}/validator_balances` added | | - | | | |
| [#376](https://github.com/ethereum/beacon-APIs/pull/376) `proposer_slashing, attester_slashing EVENT` added | | v1.16.0 | | | |
| Endpoint | [Lighthouse](https://github.com/sigp/lighthouse) | [Lodestar](https://github.com/ChainSafe/lodestar) | [Nimbus](https://github.com/status-im/nimbus-eth2) | [Prysm](https://github.com/prysmaticlabs/prysm) | [Teku](https://github.com/ConsenSys/teku) |
|----------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------|---------------------------------------------------|----------------------------------------------------|-------------------------------------------------|-------------------------------------------|
| [#350](https://github.com/ethereum/beacon-APIs/pull/350) `blob_sidecar EVENT` added | | v1.12.0 | | | |
| [#358](https://github.com/ethereum/beacon-APIs/pull/358) `/eth/v3/validator/blocks` added `consensus_block_value` to response | | v1.13.0 | | | |
| [#367](https://github.com/ethereum/beacon-APIs/pull/367) `POST /eth/v1/beacon/states/{state_id}/validators` added | | - | | | |
| [#367](https://github.com/ethereum/beacon-APIs/pull/367) `POST /eth/v1/beacon/states/{state_id}/validator_balances` added | | - | | | |
| [#376](https://github.com/ethereum/beacon-APIs/pull/376) `proposer_slashing, attester_slashing EVENT` added | | v1.16.0 | | | |
| [#386](https://github.com/ethereum/beacon-APIs/pull/386) `/eth/v3/validator/blocks` added `builder_boost_factor` query parameter | | v1.14.0 | | | |
| [#405](https://github.com/ethereum/beacon-APIs/pull/405) `block_gossip EVENT` added | | - | | | |
| [#405](https://github.com/ethereum/beacon-APIs/pull/405) `block_gossip EVENT` added | | - | | | |
| [#448](https://github.com/ethereum/beacon-APIs/pull/448) `GET /eth/v2/beacon/blocks/{block_id}/attestations` added | | - | | | |
| [#448](https://github.com/ethereum/beacon-APIs/pull/448) `GET /eth/v2/beacon/pool/attestations` added | | - | | | |
| [#448](https://github.com/ethereum/beacon-APIs/pull/448) `POST /eth/v2/beacon/pool/attestations` added | | - | | | |
| [#448](https://github.com/ethereum/beacon-APIs/pull/448) `GET /eth/v2/beacon/pool/attester_slashings` added | | - | | | |
| [#448](https://github.com/ethereum/beacon-APIs/pull/448) `POST /eth/v2/beacon/pool/attester_slashings` added | | - | | | |


## Version 2.4.2
Expand Down
85 changes: 85 additions & 0 deletions apis/beacon/pool/attestations.v2.yaml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
get:
operationId: getPoolAttestationsV2
summary: Get Attestations from operations pool
description: Retrieves attestations known by the node but not necessarily incorporated into any block
parameters:
- name: slot
in: query
required: false
schema:
$ref: '../../../beacon-node-oapi.yaml#/components/schemas/Uint64'
- name: committee_index
in: query
required: false
schema:
$ref: '../../../beacon-node-oapi.yaml#/components/schemas/Uint64'
tags:
- Beacon
responses:
"200":
description: Successful response
headers:
Eth-Consensus-Version:
$ref: '../../../beacon-node-oapi.yaml#/components/headers/Eth-Consensus-Version'
content:
application/json:
schema:
title: GetPoolAttestationsV2Response
type: object
required: [data]
properties:
data:
anyOf:
- type: array
items:
$ref: '../../../beacon-node-oapi.yaml#/components/schemas/Attestation'
- type: array
items:
$ref: '../../../beacon-node-oapi.yaml#/components/schemas/Electra.Attestation'
"400":
description: "The slot or committee index could not be parsed"
content:
application/json:
schema:
$ref: "../../../beacon-node-oapi.yaml#/components/schemas/ErrorMessage"
example:
code: 400
message: "Invalid slot: current"
"500":
$ref: '../../../beacon-node-oapi.yaml#/components/responses/InternalError'

post:
operationId: submitPoolAttestationsV2
summary: Submit Attestation objects to node
description: |
Submits Attestation objects to the node. Each attestation in the request body is processed individually.
If an attestation is validated successfully the node MUST publish that attestation on the appropriate subnet.
If one or more attestations fail validation the node MUST return a 400 error with details of which attestations have failed, and why.
tags:
- Beacon
- ValidatorRequiredApi
requestBody:
required: true
content:
application/json:
schema:
anyOf:
- type: array
items:
$ref: '../../../beacon-node-oapi.yaml#/components/schemas/Attestation'
- type: array
items:
$ref: '../../../beacon-node-oapi.yaml#/components/schemas/Electra.Attestation'
responses:
"200":
description: Attestations are stored in pool and broadcast on appropriate subnet
"400":
description: "Errors with one or more attestations"
content:
application/json:
schema:
$ref: "../../../beacon-node-oapi.yaml#/components/schemas/IndexedErrorMessage"
"500":
$ref: '../../../beacon-node-oapi.yaml#/components/responses/InternalError'
15 changes: 5 additions & 10 deletions apis/beacon/pool/attestations.yaml
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
get:
operationId: getPoolAttestations
summary: Get Attestations from operations pool
deprecated: true
description: Retrieves attestations known by the node but not necessarily incorporated into any block
parameters:
- name: slot
Expand All @@ -18,9 +19,6 @@ get:
responses:
"200":
description: Successful response
headers:
Eth-Consensus-Version:
$ref: '../../../beacon-node-oapi.yaml#/components/headers/Eth-Consensus-Version'
content:
application/json:
schema:
Expand All @@ -29,13 +27,9 @@ get:
required: [data]
properties:
data:
anyOf:
- type: array
items:
$ref: '../../../beacon-node-oapi.yaml#/components/schemas/Attestation'
- type: array
items:
$ref: '../../../beacon-node-oapi.yaml#/components/schemas/Electra.Attestation'
type: array
items:
$ref: '../../../beacon-node-oapi.yaml#/components/schemas/Attestation'
"400":
description: "The slot or committee index could not be parsed"
content:
Expand All @@ -51,6 +45,7 @@ get:
post:
operationId: submitPoolAttestations
summary: Submit Attestation objects to node
deprecated: true
description: |
Submits Attestation objects to the node. Each attestation in the request body is processed individually.
Expand Down
2 changes: 1 addition & 1 deletion apis/beacon/pool/attester_slashings_v2.yaml → apis/beacon/pool/attester_slashings.v2.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ get:
$ref: '../../../beacon-node-oapi.yaml#/components/responses/InternalError'

post:
operationId: submitPoolAttesterSlashings
operationId: submitPoolAttesterSlashingsV2
summary: Submit AttesterSlashing object to node's pool
description: Submits AttesterSlashing object to node's pool and if passes validation node MUST broadcast it to network.
tags:
Expand Down
1 change: 1 addition & 0 deletions apis/beacon/pool/attester_slashings.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ get:
post:
operationId: submitPoolAttesterSlashings
summary: Submit AttesterSlashing object to node's pool
deprecated: true
description: Submits AttesterSlashing object to node's pool and if passes validation node MUST broadcast it to network.
tags:
- Beacon
Expand Down
6 changes: 6 additions & 0 deletions beacon-node-oapi.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,8 @@ paths:
$ref: "./apis/beacon/blocks/root.yaml"
/eth/v1/beacon/blocks/{block_id}/attestations:
$ref: "./apis/beacon/blocks/attestations.yaml"
/eth/v2/beacon/blocks/{block_id}/attestations:
$ref: "./apis/beacon/blocks/attestations.v2.yaml"
/eth/v1/beacon/blob_sidecars/{block_id}:
$ref: "./apis/beacon/blob_sidecars/blob_sidecars.yaml"
/eth/v1/beacon/rewards/sync_committee/{block_id}:
Expand All @@ -121,8 +123,12 @@ paths:
$ref: "./apis/beacon/light_client/optimistic_update.yaml"
/eth/v1/beacon/pool/attestations:
$ref: "./apis/beacon/pool/attestations.yaml"
/eth/v2/beacon/pool/attestations:
$ref: "./apis/beacon/pool/attestations.v2.yaml"
/eth/v1/beacon/pool/attester_slashings:
$ref: "./apis/beacon/pool/attester_slashings.yaml"
/eth/v2/beacon/pool/attester_slashings:
$ref: "./apis/beacon/pool/attester_slashings.v2.yaml"
/eth/v1/beacon/pool/proposer_slashings:
$ref: "./apis/beacon/pool/proposer_slashings.yaml"
/eth/v1/beacon/pool/sync_committees:
Expand Down

0 comments on commit fe3cc11

Please sign in to comment.