/ types / api.yaml
api.yaml
 1  # API specific types
 2  
 3  ValidatorResponse:
 4    type: object
 5    properties:
 6      index:
 7        allOf:
 8          - $ref: './primitive.yaml#/Uint64'
 9          - description: "Index of validator in validator registry."
10      balance:
11        allOf:
12          - $ref: "./primitive.yaml#/Gwei"
13          - description: "Current validator balance in gwei."
14      status:
15        $ref: "#/ValidatorStatus"
16      validator:
17        $ref: "./validator.yaml#/Validator"
18  
19  ValidatorBalanceResponse:
20    type: object
21    properties:
22      index:
23        allOf:
24          - $ref: './primitive.yaml#/Uint64'
25          - description: "Index of validator in validator registry."
26      balance:
27        allOf:
28          - $ref: "./primitive.yaml#/Gwei"
29          - description: "Current validator balance in gwei."
30  
31  ValidatorStatus:
32    description: |
33      Possible statuses:
34      - **pending_initialized** - When the first deposit is processed, but not enough funds are available (or not yet the end of the first epoch) to get validator into the activation queue.
35      - **pending_queued** - When validator is waiting to get activated, and have enough funds etc. while in the queue, validator activation epoch keeps changing until it gets to the front and make it through (finalization is a requirement here too).
36      - **active_ongoing** - When validator must be attesting, and have not initiated any exit.
37      - **active_exiting** - When validator is still active, but filed a voluntary request to exit.
38      - **active_slashed** - When validator is still active, but have a slashed status and is scheduled to exit.
39      - **exited_unslashed** - When validator has reached reguler exit epoch, not being slashed, and doesn't have to attest any more, but cannot withdraw yet.
40      - **exited_slashed** - When validator has reached reguler exit epoch, but was slashed, have to wait for a longer withdrawal period.
41      - **withdrawal_possible** - After validator has exited, a while later is permitted to move funds, and is truly out of the system.
42      - **withdrawal_done** - (not possible in phase0, except slashing full balance) - actually having moved funds away
43  
44      [Validator status specification](https://hackmd.io/ofFJ5gOmQpu1jjHilHbdQQ)
45    enum: ["pending_initialized", "pending_queued", "active_ongoing", "active_exiting", "active_slashed", "exited_unslashed", "exited_slashed", "withdrawal_possible", "withdrawal_done"]
46    example: "active_ongoing"
47  
48  
49  Committee:
50    description: Group of validators assigned to attest at specific slot and that have the same committee index (shard in phase 1)
51    type: object
52    properties:
53      index:
54        allOf:
55          - $ref: './primitive.yaml#/Uint64'
56          - description: Committee index at a slot
57      slot:
58        $ref: './primitive.yaml#/Uint64'
59  
60      validators:
61        type: array
62        description: "List of validator indices assigned to this committee"
63        items:
64          $ref: './primitive.yaml#/Uint64'