From 83851f69195707a923226d24f6c402e3ad75c322 Mon Sep 17 00:00:00 2001 From: Nathaniel Jensen Date: Tue, 24 Mar 2020 13:39:27 +1100 Subject: [PATCH] Fix inaccuracies in test format documentation. * `block_header` operation to accept input of type `BeaconBlock` * `voluntary_exit` operation to accept input of type `SignedVoluntaryExit`. * sanity/blocks to note that inputs are of type `SignedBeaconBlock` --- tests/formats/operations/README.md | 20 ++++++++++---------- tests/formats/sanity/blocks.md | 2 +- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/tests/formats/operations/README.md b/tests/formats/operations/README.md index f1ec0429a..bb4636ec0 100644 --- a/tests/formats/operations/README.md +++ b/tests/formats/operations/README.md @@ -18,11 +18,11 @@ A YAML-encoded `BeaconState`, the state before applying the operation. Also available as `pre.ssz`. -### `.yaml` +### `.yaml` A YAML-encoded operation object, e.g. a `ProposerSlashing`, or `Deposit`. -Also available as `.ssz`. +Also available as `.ssz`. ### `post.yaml` @@ -39,14 +39,14 @@ This excludes the other parts of the block-transition. Operations: -| *`operation-name`* | *`operation-object`* | *`input name`* | *`processing call`* | -|-------------------------|----------------------|----------------------|--------------------------------------------------------| -| `attestation` | `Attestation` | `attestation` | `process_attestation(state, attestation)` | -| `attester_slashing` | `AttesterSlashing` | `attester_slashing` | `process_attester_slashing(state, attester_slashing)` | -| `block_header` | `Block` | **`block`** | `process_block_header(state, block)` | -| `deposit` | `Deposit` | `deposit` | `process_deposit(state, deposit)` | -| `proposer_slashing` | `ProposerSlashing` | `proposer_slashing` | `process_proposer_slashing(state, proposer_slashing)` | -| `voluntary_exit` | `VoluntaryExit` | `voluntary_exit` | `process_voluntary_exit(state, voluntary_exit)` | +| *`operation-name`* | *`operation-object`* | *`input name`* | *`processing call`* | +|-------------------------|-----------------------|----------------------|--------------------------------------------------------| +| `attestation` | `Attestation` | `attestation` | `process_attestation(state, attestation)` | +| `attester_slashing` | `AttesterSlashing` | `attester_slashing` | `process_attester_slashing(state, attester_slashing)` | +| `block_header` | `BeaconBlock` | **`block`** | `process_block_header(state, block)` | +| `deposit` | `Deposit` | `deposit` | `process_deposit(state, deposit)` | +| `proposer_slashing` | `ProposerSlashing` | `proposer_slashing` | `process_proposer_slashing(state, proposer_slashing)` | +| `voluntary_exit` | `SignedVoluntaryExit` | `voluntary_exit` | `process_voluntary_exit(state, voluntary_exit)` | Note that `block_header` is not strictly an operation (and is a full `Block`), but processed in the same manner, and hence included here. diff --git a/tests/formats/sanity/blocks.md b/tests/formats/sanity/blocks.md index 2b50d19ca..991bc35d2 100644 --- a/tests/formats/sanity/blocks.md +++ b/tests/formats/sanity/blocks.md @@ -25,7 +25,7 @@ Also available as `pre.ssz`. A series of files, with `` in range `[0, blocks_count)`. Blocks need to be processed in order, following the main transition function (i.e. process slot and epoch transitions in between blocks as normal) -Each file is a YAML-encoded `BeaconBlock`. +Each file is a YAML-encoded `SignedBeaconBlock`. Each block is also available as `blocks_.ssz`