diff --git a/.github/workflows/spellcheck.yml b/.github/workflows/spellcheck.yml new file mode 100644 index 00000000..3516f16f --- /dev/null +++ b/.github/workflows/spellcheck.yml @@ -0,0 +1,11 @@ +name: Spellcheck +on: [push, pull_request, workflow_dispatch] + +jobs: + build: + name: Spellcheck + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@master + - uses: rojopolis/spellcheck-github-actions@0.29.0 + name: Spellcheck diff --git a/apis/beacon/blocks/blinded_blocks.v2.yaml b/apis/beacon/blocks/blinded_blocks.v2.yaml index 762269da..ab642307 100644 --- a/apis/beacon/blocks/blinded_blocks.v2.yaml +++ b/apis/beacon/blocks/blinded_blocks.v2.yaml @@ -12,7 +12,7 @@ post: `BeaconBlock`, and a successful response (20X) only indicates that the broadcast has been successful. The beacon node is expected to integrate the new block into its state, and therefore validate the block internally, however blocks which fail the validation are still - broadcast but a different status code is returned (202). Pre-Bellatrix, this endpoint will accept + broadcast but a different status code is returned (202). Before Bellatrix, this endpoint will accept a `SignedBeaconBlock`. The broadcast behaviour may be adjusted via the `broadcast_validation` query parameter. parameters: diff --git a/apis/beacon/blocks/blinded_blocks.yaml b/apis/beacon/blocks/blinded_blocks.yaml index 75253448..703a2e34 100644 --- a/apis/beacon/blocks/blinded_blocks.yaml +++ b/apis/beacon/blocks/blinded_blocks.yaml @@ -12,7 +12,7 @@ post: `BeaconBlock`, and a successful response (20X) only indicates that the broadcast has been successful. The beacon node is expected to integrate the new block into its state, and therefore validate the block internally, however blocks which fail the validation are still - broadcast but a different status code is returned (202). Pre-Bellatrix, this endpoint will accept + broadcast but a different status code is returned (202). Before Bellatrix, this endpoint will accept a `SignedBeaconBlock`. parameters: - in: header diff --git a/apis/beacon/pool/bls_to_execution_changes.yaml b/apis/beacon/pool/bls_to_execution_changes.yaml index 39381cf8..56bd4d49 100644 --- a/apis/beacon/pool/bls_to_execution_changes.yaml +++ b/apis/beacon/pool/bls_to_execution_changes.yaml @@ -36,9 +36,9 @@ post: $ref: '../../../beacon-node-oapi.yaml#/components/schemas/SignedBLSToExecutionChange' responses: "200": - description: "Bls to execution changes were all stored to the pool and broadcast on the appropriate subnet." + description: "BLS to execution changes were all stored to the pool and broadcast on the appropriate subnet." "400": - description: "Errors in one or more bls to execution changes" + description: "Errors in one or more BLS to execution changes" content: application/json: schema: diff --git a/apis/beacon/states/validator_balances.yaml b/apis/beacon/states/validator_balances.yaml index fe7879a9..aca406a3 100644 --- a/apis/beacon/states/validator_balances.yaml +++ b/apis/beacon/states/validator_balances.yaml @@ -52,6 +52,15 @@ get: example: code: 400 message: "Invalid state ID: current" + "404": + description: "State not found" + content: + application/json: + schema: + $ref: "../../../beacon-node-oapi.yaml#/components/schemas/ErrorMessage" + example: + code: 404 + message: "State not found" "414": description: "Too many validator IDs" content: @@ -116,5 +125,14 @@ post: example: code: 400 message: "Invalid state ID: current" + "404": + description: "State not found" + content: + application/json: + schema: + $ref: "../../../beacon-node-oapi.yaml#/components/schemas/ErrorMessage" + example: + code: 404 + message: "State not found" "500": $ref: '../../../beacon-node-oapi.yaml#/components/responses/InternalError' diff --git a/apis/eventstream/index.yaml b/apis/eventstream/index.yaml index 0c429603..63e804c8 100644 --- a/apis/eventstream/index.yaml +++ b/apis/eventstream/index.yaml @@ -122,7 +122,7 @@ get: ignored by block builders and most other API consumers. value: | event: payload_attributes - data: {"version": "capella", "data": {"proposer_index": "123", "proposal_slot": "10", "parent_block_number": "9", "parent_block_root": "0xcf8e0d4e9587369b2301d0790347320302cc0943d5a1884560367e8208d920f2", "parent_block_hash": "0x9a2fefd2fdb57f74993c7780ea5b9030d2897b615b89f808011ca5aebed54eaf", "payload_attributes": {"timestamp": "123456", "prev_randao": "0xcf8e0d4e9587369b2301d0790347320302cc0943d5a1884560367e8208d920f2", "suggested_fee_recipient": "0x0000000000000000000000000000000000000000", "withdrawals": [{"index": "5", "validator_index": "10", "address": "0x0000000000000000000000000000000000000000", "amount": "15640"}]}}}, + data: {"version": "capella", "data": {"proposer_index": "123", "proposal_slot": "10", "parent_block_number": "9", "parent_block_root": "0xcf8e0d4e9587369b2301d0790347320302cc0943d5a1884560367e8208d920f2", "parent_block_hash": "0x9a2fefd2fdb57f74993c7780ea5b9030d2897b615b89f808011ca5aebed54eaf", "payload_attributes": {"timestamp": "123456", "prev_randao": "0xcf8e0d4e9587369b2301d0790347320302cc0943d5a1884560367e8208d920f2", "suggested_fee_recipient": "0x0000000000000000000000000000000000000000", "withdrawals": [{"index": "5", "validator_index": "10", "address": "0x0000000000000000000000000000000000000000", "amount": "15640"}]}}} blob_sidecar: description: The node has received a BlobSidecar (from P2P or API) that passes all gossip validations on the blob_sidecar_{subnet_id} topic value: | diff --git a/apis/validator/blinded_block.yaml b/apis/validator/blinded_block.yaml index d1b7a5d0..c64e4959 100644 --- a/apis/validator/blinded_block.yaml +++ b/apis/validator/blinded_block.yaml @@ -12,7 +12,7 @@ get: Metadata in the response indicates the type of block produced, and the supported types of block will be added to as forks progress. - Pre-Bellatrix, this endpoint will return a `BeaconBlock`. + Before Bellatrix, this endpoint will return a `BeaconBlock`. parameters: - name: slot in: path diff --git a/dictionary.dic b/dictionary.dic new file mode 100644 index 00000000..0924f5da Binary files /dev/null and b/dictionary.dic differ diff --git a/spellcheck.yaml b/spellcheck.yaml new file mode 100644 index 00000000..6192e0ce --- /dev/null +++ b/spellcheck.yaml @@ -0,0 +1,67 @@ +matrix: + - name: markdown + sources: + - '**/*.md|!node_modules/**' + aspell: + lang: en + d: en_US + ignore-case: true + run-together: true + run-together-min: 2 + run-together-limit: 256 + dictionary: + wordlists: + - wordlist.txt + encoding: utf-8 + pipeline: + - pyspelling.filters.markdown: + - pyspelling.filters.html: + comments: false + ignores: + - code + - pre + - name: schemas + sources: + - 'beacon-node-oapi.yaml' + - 'params/**/*.yaml' + - 'types/**/*.yaml' + - 'apis/**/*.yaml' + aspell: + lang: en + d: en_US + ignore-case: true + run-together: true + run-together-min: 2 + run-together-limit: 256 + dictionary: + wordlists: + - wordlist.txt + encoding: utf-8 + pipeline: + - pyspelling.filters.url: + - pyspelling.filters.context: + context_visible_first: true + delimiters: + - open: '' + content: 0x[a-fA-F0-9]+ + close: '' + - pyspelling.filters.context: + context_visible_first: true + delimiters: + - open: 'operationId:.*' + close: '$' + - pyspelling.filters.context: + context_visible_first: true + delimiters: + - open: 'example:.*' + close: '$' + - pyspelling.filters.context: + context_visible_first: true + delimiters: + - open: 'title:.*' + close: '$' + - pyspelling.filters.context: + context_visible_first: true + delimiters: + - open: 'data:.*' + close: '$' diff --git a/types/altair/block.yaml b/types/altair/block.yaml index a20d3df8..cd9cdd68 100644 --- a/types/altair/block.yaml +++ b/types/altair/block.yaml @@ -14,11 +14,11 @@ Altair: parent_root: allOf: - $ref: '../primitive.yaml#/Root' - - description: "The signing merkle root of the parent `BeaconBlock`." + - description: "The signing Merkle root of the parent `BeaconBlock`." state_root: allOf: - $ref: '../primitive.yaml#/Root' - - description: "The tree hash merkle root of the `BeaconState` for the `BeaconBlock`." + - description: "The tree hash Merkle root of the `BeaconState` for the `BeaconBlock`." BeaconBlockBody: type: object diff --git a/types/bellatrix/state.yaml b/types/bellatrix/state.yaml index 74a61d57..fd5dc6b5 100644 --- a/types/bellatrix/state.yaml +++ b/types/bellatrix/state.yaml @@ -45,7 +45,7 @@ Bellatrix: $ref: '../validator.yaml#/Validator' balances: type: array - description: "Validator balances in gwei. Variable length list, maximum 1099511627776 items" + description: "Validator balances in Gwei. Variable length list, maximum 1099511627776 items" items: $ref: '../primitive.yaml#/Uint64' randao_mixes: diff --git a/types/p2p.yaml b/types/p2p.yaml index 320318d9..dce9f71d 100644 --- a/types/p2p.yaml +++ b/types/p2p.yaml @@ -10,7 +10,7 @@ NetworkIdentity: items: allOf: - $ref: "./p2p.yaml#/Multiaddr" - - description: "Node's addresses on which eth2 rpc requests are served. [Read more](https://docs.libp2p.io/reference/glossary/#multiaddr)" + - description: "Node's addresses on which eth2 RPC requests are served. [Read more](https://docs.libp2p.io/reference/glossary/#multiaddr)" discovery_addresses: type: array items: diff --git a/wordlist.txt b/wordlist.txt new file mode 100644 index 00000000..35f7a54d --- /dev/null +++ b/wordlist.txt @@ -0,0 +1,37 @@ +eth +cli +oapi +redocly +JSON +BN +https +NodeJs +npmjs +npm +TBD +Teku +VC +UI +dev +BLS +SSZ +RANDAO +EIP +el +DVT +MEV +PayloadAttributesV +Gwei +prev +ENR +enr +attnets +trunc +Merkle +RPC +kzg +KZGCommitment +KZGProof +KZGProofs +KZGCommitmentInclusionProof +LMD