STF Vectors

README.md

@@ -1,6 +1,51 @@
 # Test Vectors for the JAM Protocol
 
-## Index
+JAM protocol version 0.6.4
 
+## Codec
+
 - [Codec](./codec/README.md)
+
+## State Transition Functions
+
+We offer two types of test vectors:
+
+- **Tiny**: designed for quick adjustments and prototyping, with reduced
+  - validators count: 6
+  - cores count: 2
+  - epoch period: 12
+  - core assignment rotation period: 4
+  - ticket attempts: 3
+
+- **Full**: vectors with production specs
+  - validators count: 1023
+  - cores count: 341
+  - epoch period: 600
+  - core assignment rotation period: 10
+  - ticket attempts: 2
+
+### 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 each
+specific subsystem.
+
+### Vectors
+
 - [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)
+- [Preimages](./preimages/README.md)
+- [Accumulate](./accumulate/README.md)

accumulate/README.md

@@ -0,0 +1,86 @@
+# Accumulate STF Test Vectors
+
+Both JSON and SCALE formats conform to the JAM ASN.1 [schema](../jam-types-asn/jam-types.asn)
+and this subsystem STF specific [schema](./accumulate.asn).
+
+## Test Service Code
+
+Test vectors invoke the `accumulate` method of the provided [test-service](./test-service).  
+
+The PVM binary, which refers to the compiled version of the `test-service`, is
+generated using the [`jam-pvm-build`](https://crates.io/crates/jam-pvm-build)
+tool.
+
+Due to differences in dependencies and compiler versions, the resulting binary
+artifact frequently varies, even when generated from identical source code. As
+a result, you can just rely on the code blob embedded in the test vectors, which
+is available within the `accounts` map.
+
+## Tiny Vectors
+
+- [no_available_reports-1](./tiny/no_available_reports-1.json)
+  - No reports.
+- [process_one_immediate_report-1](./tiny/process_one_immediate_report-1.json)
+  - Report with no dependencies.
+- [enqueue_and_unlock_simple-1](./tiny/enqueue_and_unlock_simple-1.json)
+  - Report with unsatisfied dependency added to the ready-queue.
+- [enqueue_and_unlock_simple-2](./tiny/enqueue_and_unlock_simple-2.json)
+  - Report with no dependencies that resolves previous dependency.
+- [enqueue_and_unlock_with_sr_lookup-1](./tiny/enqueue_and_unlock_with_sr_lookup-1.json)
+  - Report with unsatisfied segment tree root dependency added to the ready-queue.
+- [enqueue_and_unlock_with_sr_lookup-2](./tiny/enqueue_and_unlock_with_sr_lookup-2.json)
+  - Report with no dependencies that resolves previous dependency.
+- [enqueue_and_unlock_chain-1](./tiny/enqueue_and_unlock_chain-1.json)
+  - Two reports with unsatisfied dependencies added to the ready-queue.
+- [enqueue_and_unlock_chain-2](./tiny/enqueue_and_unlock_chain-2.json)
+  - Two additional reports with unsatisfied dependencies added to the ready-queue.
+- [enqueue_and_unlock_chain-3](./tiny/enqueue_and_unlock_chain-3.json)
+  - Two additional reports. One with unsatisfied dependencies, thus added to the ready-queue.
+  - One report is accumulated and resolves two previously enqueued reports.
+- [enqueue_and_unlock_chain-4](./tiny/enqueue_and_unlock_chain-4.json)
+  - Report that resolves all remaining queued dependencies.
+- [enqueue_and_unlock_chain_wraps-1](./tiny/enqueue_and_unlock_chain_wraps-1.json)
+  - Two reports with unsatisfied dependencies added to the ready-queue.
+- [enqueue_and_unlock_chain_wraps-2](./tiny/enqueue_and_unlock_chain_wraps-2.json)
+  - Two additional reports, one with no dependencies and thus immediately accumulated.
+  - The other is pushed to the ready-queue which fills up and wraps around
+    (ready-queue is a ring buffer).
+- [enqueue_and_unlock_chain_wraps-3](./tiny/enqueue_and_unlock_chain_wraps-3.json)
+  - Two additional reports with unsatisfied dependencies pushed to the ready-queue.
+- [enqueue_and_unlock_chain_wraps-4](./tiny/enqueue_and_unlock_chain_wraps-4.json)
+  - Two additional reports, one with no dependencies and thus immediately accumulated.
+  - Three old entries in the ready-queue are removed.
+- [enqueue_and_unlock_chain_wraps-5](./tiny/enqueue_and_unlock_chain_wraps-5.json)
+  - Report with no dependencies resolves all previous enqueued reports.
+- [enqueue_self_referential-1](./tiny/enqueue_self_referential-1.json)
+  - Report with direct dependency on itself.
+  - This makes the report stale, but pushed to the ready-queue anyway.
+- [enqueue_self_referential-2](./tiny/enqueue_self_referential-2.json)
+  - Two reports with indirect circular dependency.
+  - This makes the reports stale, but pushed to the ready-queue anyway.
+- [enqueue_self_referential-3](./tiny/enqueue_self_referential-3.json)
+  - Two reports. First depends on second, which depends on unseen report.
+- [enqueue_self_referential-4](./tiny/enqueue_self_referential-4.json)
+  - New report creates a cycle with the previously queued reports.
+  - This makes the reports stale, but pushed to the ready-queue anyway.
+- [accumulate_ready_queued_reports-1](./tiny/accumulate_ready_queued_reports-1.json)
+  - There are some reports in the ready-queue ready to be accumulated.
+  - Even though we don't supply any new available work report these are processed.
+  - This condition may result because of gas exhausition during previous block execution.
+- [queues_are_shifted-1](./tiny/queues_are_shifted-1.json)
+  - Check that ready-queue and accumulated-reports queues are shifted.
+  - A new available report is supplied.
+- [queues_are_shifted-2](./tiny/queues_are_shifted-2.json)
+  - Check that ready-queue and accumulated-reports queues are shifted.
+  - No new report is supplied.
+- [ready_queue_editing-1](./tiny/ready_queue_editing-1.json)
+  - Two reports with unsatisfied dependencies added to the ready-queue.
+- [ready_queue_editing-2](./tiny/ready_queue_editing-2.json)
+  - Two reports, one with unsatisfied dependency added to the ready-queue.
+  - One accumulated. Ready queue items dependencies are edited.
+- [ready_queue_editing-3](./tiny/ready_queue_editing-3.json)
+  - One report unlocks reports in the ready-queue.
+
+## Full Vectors
+
+Currently, the same test cases as tiny vectors but at a larger scale.

accumulate/accumulate.asn

@@ -0,0 +1,57 @@
+-- Accumulate STF test vectors schema
+
+AccumulateModule DEFINITIONS ::= BEGIN
+
+IMPORTS
+    TimeSlot, ServiceId, ServiceInfo, WorkReport, OpaqueHash, ByteSequence,
+    Entropy, ReadyQueue, AccumulatedQueue, Privileges, AccumulateRoot
+        FROM JamTypes;
+
+
+PreimagesMapEntry ::= SEQUENCE {
+    hash OpaqueHash,
+    blob ByteSequence
+}
+
+-- Service account information relevant for this STF.
+Account ::= SEQUENCE {
+    -- [a_c, a_b, a_g, a_m, a_o, a_i] Service metadata.
+    service ServiceInfo,
+    --[a_p] Preimages blobs.
+    preimages SEQUENCE OF PreimagesMapEntry
+}
+
+AccountsMapEntry ::= SEQUENCE {
+    id ServiceId,
+    data Account
+}
+
+State ::= SEQUENCE {
+    slot TimeSlot,
+    entropy Entropy,
+    ready-queue ReadyQueue,
+    accumulated AccumulatedQueue,
+    privileges Privileges,
+	-- [δ] Relevant services account data. Refer to T(σ) in GP Appendix D.
+    accounts SEQUENCE OF AccountsMapEntry
+}
+
+Input ::= SEQUENCE {
+    -- [H_t] Block's timeslot.
+    slot TimeSlot,
+    reports SEQUENCE OF WorkReport
+}
+
+Output ::= CHOICE {
+    ok    AccumulateRoot,
+    err   NULL
+}
+
+TestCase ::= SEQUENCE {
+    input        Input,
+    pre-state    State,
+    output       Output,
+    post-state   State
+}
+
+END