STF Vectors

README.md

@@ -1,6 +1,14 @@
 # Test Vectors for the JAM Protocol
 
+JAM protocol version 0.5.2
+
 ## Index
 
 - [Codec](./codec/README.md)
 - [Safrole](./safrole/README.md)
+- [Disputes](./disputes/README.md)
+- [History](./history/README.md)
+- [Assurances](./assurances/README.md)
+- [Reports](./reports/README.md)
+- [Statistics](./statistics/README.md)
+- [Authorizations](./authorizations/README.md)

assurances/README.md

@@ -0,0 +1,54 @@
+# Availability Assurances STF Test Vectors
+
+We offer two types of test vectors:
+
+- Tiny: These are designed for quick adjustments and prototyping, with reduced validators (6)
+  and cores count (2).
+- Full: These vectors use production validators (1023) and cores count (341)
+
+Both JSON and SCALE formats conform to the JAM ASN.1 [schema](../jam-types-asn/jam-types.asn)
+and this subsystem STF specific [schema](./assurances.asn).
+
+## STF Output
+
+Technically, the STF execution process does not inherently produce auxiliary
+outputs beyond the success or failure result. In this context, we propose
+an extension to include additional information that may be beneficial for
+implementors or useful for executing other subsystems reliant on values
+generated post-STF execution.
+
+When the error or success values are not pertinent to your test vector
+processing procedures, you may disregard them as necessary.
+
+A mapping of error code semantics is provided within the ASN.1 schema for this
+subsystem.
+
+## Tiny Vectors
+
+- [no_assurances-1](tiny/no_assurances-1.json)🟢
+  - Progress with an empty assurances extrinsic.
+- [some_assurances-1](tiny/some_assurances-1.json) 🟢
+  - Several assurances contributing to establishing availability supermajority for some
+    of the cores.
+- [no_assurances_with_stale_report-1](tiny/no_assurances_with_stale_report-1.json) 🟢
+	- Progress with an empty assurances extrinsic.
+	- Stale work report assignment is removed (but not returned in the output).
+- [assurances_with_bad_signature-1](tiny/assurances_with_bad_signature-1.json)🔴
+  - One assurance has a bad signature.
+- [assurances_with_bad_validator_index-1](tiny/assurances_with_bad_validator_index-1.json)🔴
+  - One assurance has a bad validator index.
+- [assurance_for_not_engaged_core-1](tiny/assurance_for_not_engaged_core-1.json)🔴
+  - One assurance targets a core without any assigned work report.
+- [assurance_with_bad_attestation_parent-1](tiny/assurance_with_bad_attestation_parent-1.json)🔴
+  - One assurance has a bad attestation parent hash.
+- [assurances_for_stale_report-1](tiny/assurances_for_stale_report-1.json)🔴
+  - One assurance targets a core with a stale report.
+  - We are lenient on the stale report as far as it is available.
+- [assurers_not_sorted_or_unique-1](tiny/assurers_not_sorted_or_unique-1.json)🔴
+  - Assurers not sorted.
+- [assurers_not_sorted_or_unique-2](tiny/assurers_not_sorted_or_unique-2.json)🔴
+  - Duplicate assurer.
+
+## Full Vectors
+
+Currently, the same test cases as tiny vectors but at a larger scale.

assurances/assurances.asn

@@ -0,0 +1,59 @@
+-- Work reports assurances STF test vectors schema
+
+ReportsModule DEFINITIONS ::= BEGIN
+
+IMPORTS
+    TimeSlot, ValidatorsData, HeaderHash, WorkReport,
+    AvailabilityAssignments, AssurancesExtrinsic
+        FROM JamTypes;
+
+
+State ::= SEQUENCE {
+    -- [ρ†] Intermediate pending reports after that any work report judged as
+    -- uncertain or invalid has been removed from it. Mutated to ϱ‡.
+    avail-assignments AvailabilityAssignments,
+
+    -- [κ'] Posterior active validators.
+    curr-validators ValidatorsData
+}
+
+Input ::= SEQUENCE {
+    -- [E_A] Assurances extrinsic.
+    assurances AssurancesExtrinsic,
+
+    -- [H_t] Block's timeslot.
+    slot TimeSlot,
+
+    -- [H_p] Parent hash.
+    parent HeaderHash
+}
+
+-- State transition function execution error.
+-- Error codes **are not specified** in the the Graypaper.
+-- Feel free to ignore the actual value.
+ErrorCode ::= ENUMERATED {
+    bad-attestation-parent (0),
+    bad-validator-index (1),
+    core-not-engaged (2),
+    bad-signature (3),
+    not-sorted-or-unique-assurers (4)
+}
+
+OutputData ::= SEQUENCE {
+    -- Items removed from ρ† to get ρ'
+    reported SEQUENCE OF WorkReport
+}
+
+Output ::= CHOICE {
+    ok  OutputData,
+    err ErrorCode
+}
+
+TestCase ::= SEQUENCE {
+    input        Input,
+    pre-state    State,
+    output       Output,
+    post-state   State
+}
+
+END