Replace allow_partial_import with contains_slashable_data (#9)

Author: michaelsproul

README.md

@@ -21,7 +21,7 @@ For example:
   "steps": [
     {
       "should_succeed": true,
-      "allow_partial_import": false,
+      "contains_slashable_data": false,
       "interchange": {
         "metadata": {
           "interchange_format_version": "5",
@@ -68,9 +68,8 @@ which are as follows:
   against.
 * `steps[i].should_succeed: bool`: whether the `steps[i].interchange` given is valid and should
   be imported successfully.
-* `steps[i].allow_partial_import: bool`: whether the `steps[i].interchange` contains some
-  slashable data with respect to itself or the existing contents of the database, and therefore
-  a partial import is justified.
+* `steps[i].contains_slashable_data: bool`: whether the `steps[i].interchange` contains some
+  slashable data with respect to itself or the existing contents of the database.
 * `steps[i].interchange: Interchange`: slashing protection interchange data as described
   by the spec.
 * `steps[i].blocks: [object]`: a list of block signings to be attempted **after**
@@ -115,6 +114,21 @@ Note that the top-level `genesis_validators_root` is not necessarily the same
 as the GVR contained in the interchange, to allow us to test the case where
 they are mismatched.
 
+## Handling Slashable Data
+
+The `contains_slashable_data` parameter is to be interpreted as follows:
+
+- If `should_succeed` is false, then `contains_slashable_data` is irrelevant
+- If `contains_slashable_data` is false, then the given interchange **must** be imported
+  successfully, and the given block/attestation checks must pass.
+- If `contains_slashable_data` is true, then implementations have the option to do one of two
+  things:
+  	- Import the interchange successfully, working around the slashable data by minification
+	  or some other mechanism. If the import succeeds, all checks must pass and the test
+	  should continue to the next step.
+	- Reject the interchange (or partially import it), in which case the block/attestation
+	  checks and all future steps should be ignored.
+
 ## Downloading the tests
 
 The `tests` directory is released as a versioned `.tar.gz` on the [Releases](https://github.com/eth2-clients/slashing-protection-interchange-tests/releases) page.

tests/generated/duplicate_pubkey_not_slashable.json

@@ -4,7 +4,7 @@
   "steps": [
     {
       "should_succeed": true,
-      "allow_partial_import": false,
+      "contains_slashable_data": false,
       "interchange": {
         "metadata": {
           "interchange_format_version": "5",

tests/generated/duplicate_pubkey_slashable_attestation.json

@@ -4,7 +4,7 @@
   "steps": [
     {
       "should_succeed": true,
-      "allow_partial_import": true,
+      "contains_slashable_data": true,
       "interchange": {
         "metadata": {
           "interchange_format_version": "5",

tests/generated/duplicate_pubkey_slashable_block.json

@@ -4,7 +4,7 @@
   "steps": [
     {
       "should_succeed": true,
-      "allow_partial_import": true,
+      "contains_slashable_data": true,
       "interchange": {
         "metadata": {
           "interchange_format_version": "5",

tests/generated/multiple_interchanges_single_validator_fail_iff_imported.json

@@ -4,7 +4,7 @@
   "steps": [
     {
       "should_succeed": true,
-      "allow_partial_import": false,
+      "contains_slashable_data": false,
       "interchange": {
         "metadata": {
           "interchange_format_version": "5",
@@ -27,7 +27,7 @@
     },
     {
       "should_succeed": true,
-      "allow_partial_import": true,
+      "contains_slashable_data": true,
       "interchange": {
         "metadata": {
           "interchange_format_version": "5",

tests/generated/multiple_interchanges_single_validator_single_message_gap.json

@@ -4,7 +4,7 @@
   "steps": [
     {
       "should_succeed": true,
-      "allow_partial_import": false,
+      "contains_slashable_data": false,
       "interchange": {
         "metadata": {
           "interchange_format_version": "5",
@@ -32,7 +32,7 @@
     },
     {
       "should_succeed": true,
-      "allow_partial_import": false,
+      "contains_slashable_data": false,
       "interchange": {
         "metadata": {
           "interchange_format_version": "5",

tests/generated/multiple_interchanges_single_validator_single_message_out_of_order.json

@@ -4,7 +4,7 @@
   "steps": [
     {
       "should_succeed": true,
-      "allow_partial_import": false,
+      "contains_slashable_data": false,
       "interchange": {
         "metadata": {
           "interchange_format_version": "5",
@@ -27,7 +27,7 @@
     },
     {
       "should_succeed": true,
-      "allow_partial_import": true,
+      "contains_slashable_data": true,
       "interchange": {
         "metadata": {
           "interchange_format_version": "5",

tests/generated/multiple_validators_multiple_blocks_and_attestations.json

@@ -4,7 +4,7 @@
   "steps": [
     {
       "should_succeed": true,
-      "allow_partial_import": false,
+      "contains_slashable_data": false,
       "interchange": {
         "metadata": {
           "interchange_format_version": "5",

tests/generated/multiple_validators_same_slot_blocks.json

@@ -4,7 +4,7 @@
   "steps": [
     {
       "should_succeed": true,
-      "allow_partial_import": false,
+      "contains_slashable_data": false,
       "interchange": {
         "metadata": {
           "interchange_format_version": "5",

tests/generated/single_validator_genesis_attestation.json

@@ -4,7 +4,7 @@
   "steps": [
     {
       "should_succeed": true,
-      "allow_partial_import": false,
+      "contains_slashable_data": false,
       "interchange": {
         "metadata": {
           "interchange_format_version": "5",