deploy: 30f0568

beacon-node-oapi.yaml

@@ -1659,6 +1659,188 @@ paths:
               example:
                 code: 500
                 message: Internal server error
+  '/eth/v1/beacon/states/{state_id}/validator_identities':
+    post:
+      operationId: postStateValidatorIdentities
+      summary: Get validator identities from state
+      description: |
+        Returns filterable list of validators identities.
+
+        Identities will be returned for all indices or public keys that match known validators. If an index or public key does not
+        match any known validator, no identity will be returned but this will not cause an error. There are no guarantees for the
+        returned data in terms of ordering.
+
+         Depending on `Accept` header data can be returned either as JSON or as bytes serialized by SSZ.
+      tags:
+        - Beacon
+      parameters:
+        - name: state_id
+          in: path
+          required: true
+          example: head
+          schema:
+            type: string
+          description: |
+            State identifier.
+            Can be one of: "head" (canonical head in node's view), "genesis", "finalized", "justified", \<slot\>, \<hex encoded stateRoot with 0x prefix\>.
+      requestBody:
+        description: 'An array of values, with each value either a hex encoded public key (any bytes48 with 0x prefix) or a validator index.'
+        required: false
+        content:
+          application/json:
+            schema:
+              type: array
+              uniqueItems: true
+              items:
+                description: Either hex encoded public key (any bytes48 with 0x prefix) or validator index
+                type: string
+      responses:
+        '200':
+          description: Success
+          content:
+            application/json:
+              schema:
+                title: PostStateValidatorIdentitiesResponse
+                type: object
+                required:
+                  - execution_optimistic
+                  - finalized
+                  - data
+                properties:
+                  execution_optimistic:
+                    type: boolean
+                    example: false
+                    description: 'True if the response references an unverified execution payload. Optimistic information may be invalidated at a later time. If the field is not present, assume the False value.'
+                  finalized:
+                    type: boolean
+                    example: false
+                    description: 'True if the response references the finalized history of the chain, as determined by fork choice. If the field is not present, additional calls are necessary to compare the epoch of the requested information with the finalized checkpoint.'
+                  data:
+                    type: array
+                    items:
+                      type: object
+                      required:
+                        - index
+                        - pubkey
+                        - activation_epoch
+                      properties:
+                        index:
+                          description: Index of validator in validator registry.
+                          type: string
+                          example: '1'
+                        pubkey:
+                          description: Public key of validator.
+                          type: string
+                          format: hex
+                          pattern: '^0x[a-fA-F0-9]{96}$'
+                          example: '0x93247f2209abcacf57b75a51dafae777f9dd38bc7053d1af526f220a7489a6d3a2753e5f3e8b1cfe39b56f43611df74a'
+                        activation_epoch:
+                          description: Epoch when validator activated. 'FAR_FUTURE_EPOCH' if not activated
+                          type: string
+                          example: '1'
+            application/octet-stream:
+              schema:
+                description: SSZ serialized results. Use Accept header to choose this response type
+        '400':
+          description: Invalid state ID or malformed request
+          content:
+            application/json:
+              schema:
+                type: object
+                required:
+                  - code
+                  - message
+                properties:
+                  code:
+                    description: Either specific error code in case of invalid request or http status code
+                    type: number
+                    example: 404
+                  message:
+                    description: Message describing error
+                    type: string
+                  stacktraces:
+                    description: 'Optional stacktraces, sent when node is in debug mode'
+                    type: array
+                    items:
+                      type: string
+              example:
+                code: 400
+                message: 'Invalid state ID: current'
+        '404':
+          description: State not found
+          content:
+            application/json:
+              schema:
+                type: object
+                required:
+                  - code
+                  - message
+                properties:
+                  code:
+                    description: Either specific error code in case of invalid request or http status code
+                    type: number
+                    example: 404
+                  message:
+                    description: Message describing error
+                    type: string
+                  stacktraces:
+                    description: 'Optional stacktraces, sent when node is in debug mode'
+                    type: array
+                    items:
+                      type: string
+              example:
+                code: 404
+                message: State not found
+        '406':
+          description: Accepted media type is not supported.
+          content:
+            application/json:
+              schema:
+                type: object
+                required:
+                  - code
+                  - message
+                properties:
+                  code:
+                    description: 'The media type in "Accept" header is unsupported, and the request has been rejected. This occurs when the server cannot produce a response in the format accepted by the client.'
+                    type: number
+                    example: 406
+                  message:
+                    description: Message describing error
+                    type: string
+                  stacktraces:
+                    description: 'Optional stacktraces, sent when node is in debug mode'
+                    type: array
+                    items:
+                      type: string
+              example:
+                code: 406
+                message: Accepted media type not supported
+        '500':
+          description: Beacon node internal error.
+          content:
+            application/json:
+              schema:
+                type: object
+                required:
+                  - code
+                  - message
+                properties:
+                  code:
+                    description: Either specific error code in case of invalid request or http status code
+                    type: number
+                    example: 404
+                  message:
+                    description: Message describing error
+                    type: string
+                  stacktraces:
+                    description: 'Optional stacktraces, sent when node is in debug mode'
+                    type: array
+                    items:
+                      type: string
+              example:
+                code: 500
+                message: Internal server error
   '/eth/v1/beacon/states/{state_id}/committees':
     get:
       operationId: getEpochCommittees
@@ -58519,6 +58701,27 @@ components:
           description: Current validator balance in gwei.
           type: string
           example: '1'
+    ValidatorIdentityResponse:
+      type: object
+      required:
+        - index
+        - pubkey
+        - activation_epoch
+      properties:
+        index:
+          description: Index of validator in validator registry.
+          type: string
+          example: '1'
+        pubkey:
+          description: Public key of validator.
+          type: string
+          format: hex
+          pattern: '^0x[a-fA-F0-9]{96}$'
+          example: '0x93247f2209abcacf57b75a51dafae777f9dd38bc7053d1af526f220a7489a6d3a2753e5f3e8b1cfe39b56f43611df74a'
+        activation_epoch:
+          description: Epoch when validator activated. 'FAR_FUTURE_EPOCH' if not activated
+          type: string
+          example: '1'
     ValidatorStatus:
       description: |
         Possible statuses: