Merge pull request #5 from davxy/safrole-vectors-full

Author: gavofyork

safrole/README.md

@@ -1,83 +1,121 @@
 # Safrole Test Vectors
 
-For details refer to ASN.1 [schema](./safrole.asn).
+We offer two types of test vectors:
 
-## NOTES
+- Tiny: These are designed for quick adjustments and prototyping, with reduced validators (6)
+  and a shorter epoch duration (12). They are provided in both JSON format for easy inspection
+  and modification, and in SCALE format, which is the production binary codec.
 
-- Error codes returned as output are not part of the specification. Feel free to ignore actual values.
-- On error, post-state must match pre-state.
-- Ring verifier is constructed using [ark-ec-vrfs](https://github.com/davxy/ark-ec-vrfs) procedures.
+- Full: These vectors use production validators count (1023) and epoch duration (600).
+  Similar to the tiny vectors, they are available in JSON and SCALE format.
 
-## TODO
+Both JSON and SCALE formats conform to the specified ASN.1 schema provided [here](./safrole.asn).
 
-- Better specify the procedure used to construct test ring verifier.
+## zk-SNARK SRS
 
-## Vectors
+Ring proofs were constructed using a SNARK built using the the [Zcash SRS paramaters](zcash-srs-2-11-uncompressed.bin).
+([powers of tau ceremony details](https://zfnd.org/conclusion-of-the-powers-of-tau-ceremony)).
 
-- [enact-epoch-change-no-tickets-1.json](enact-epoch-change-with-no-tickets-1.json)
-  - Progress from slot 0 to 1.
-  - No tickets extrinsic.
-- [enact-epoch-change-no-tickets-2.json](enact-epoch-change-with-no-tickets-2.json)
-  - Progress from slot 1 to slot 1.
+For construction and usage refer to Bandersnatch vrfs spec [example](https://github.com/davxy/bandersnatch-vrfs-spec/tree/main/example).
+
+NOTE: for "tiny" initialize the `RingContext` with `ring_size = 6`; while for full `ring size = 1023`.
+
+## Safrole **is not** Sassafras
+
+You can use the Sassafras [RFC](https://github.com/polkadot-fellows/RFCs/blob/main/text/0026-sassafras-consensus.md)
+as a guideline provided it does not conflict with the protocol described by the *Graypaper*
+If case of any discrepancy, the *Graypaper* **must** be considered the authoritative source
+for the JAM protocol.
+
+Here are some key differences:
+- Safrole does not use a threshold to determine if a ticket score should be considered.
+  A ticket is persisted in the state if the ticket accumulator is not full or if the
+  score is lower than the highest score currently in the accumulator (which is removed
+  after the new ticket is inserted).
+- Safrole requires the entire ticket accumulator to be filled before it can be used.
+  If not enough tickets are received, a fallback mechanism is enacted. In contrast,
+  Sassafras can operate with an epoch that is only partially filled with tickets.
+- In Safrole, the ticket envelope contains no additional application-specific data,
+  it includes only the "attempt" and the "ring proof".
+
+Most of these differences aim to provide a clear and concise protocol specification.
+
+## Error Output
+
+On STF (State Transition Function) execution error, post-state must match pre-state.
+
+Possible error codes returned as output are not part of the specification,
+feel free to ignore actual numeric values.
+
+A map for errors codes semantics used by for the test vectors is given in the ASN.1 schema.
+
+## Tiny Vectors
+
+- [enact-epoch-change-with-no-tickets-1.json](./tiny/enact-epoch-change-with-no-tickets-1.json)
+  - Progress by one slot.
+  - Randomness accumulator is updated.
+- [enact-epoch-change-with-no-tickets-2.json](./tiny/enact-epoch-change-with-no-tickets-2.json)
+  - Progress from slot X to slot X.
   - Fail: Timeslot must be strictly monotonic.
-- [enact-epoch-change-no-tickets-3.json](enact-epoch-change-with-no-tickets-3.json)
-  - Progress from slot 1 to a slot in epoch's tail.
-  - Tickets mark is not generated (no enough ticket).
-- [enact-epoch-change-no-tickets-4.json](enact-epoch-change-with-no-tickets-4.json)
+- [enact-epoch-change-with-no-tickets-3.json](./tiny/enact-epoch-change-with-no-tickets-3.json)
+  - Progress from a slot at the begin of the epoch to a slot in the epoch's tail.
+  - Tickets mark is not generated (no enough tickets).
+- [enact-epoch-change-with-no-tickets-4.json](./tiny/enact-epoch-change-with-no-tickets-4.json)
   - Progress from epoch's tail to next epoch.
-  - Authorities / entropies rotated.
-  - Epoch mark generated.
-
-- [skip-epochs-1](skip-epochs-1.json)
-  - Progress by skipping epochs.
-  - Accumulated tickets are discarded>
-  - Tickets mark is not generated (skipped epochs).
+  - Authorities and entropies are rotated.
+  - Epoch mark is generated.
+- [skip-epochs-1](./tiny/skip-epochs-1.json)
+  - Progress skipping epochs with a full tickets accumulator.
+  - Tickets mark is not generated.
+  - Accumulated tickets are discarded.
   - Fallback method is enacted.
-
-- [skip-epoch-tail-1](skip-epoch-tail-1.json)
-  - Progress to next epoch by skipping epochs tail.
+- [skip-epoch-tail-1](./tiny/skip-epoch-tail-1.json)
+  - Progress to next epoch by skipping epochs tail with a full tickets accumulator.
   - Tickets mark has no chance to be generated.
-  - Even tough we have enough tickets, these are discarded when next epoch is enacted.
+  - Accumulated tickets are discarded.
   - Fallback method is enacted.
-
-- [publish-tickets-no-mark-1](publish-tickets-no-mark-1.json)
-  - Fail: Submit an extrinsic with more tickets than allwed.
-- [publish-tickets-no-mark-2](publish-tickets-no-mark-2.json)
-  - Submit tickets extrinsics from authority 0 and 1.
-- [publish-tickets-no-mark-3](publish-tickets-no-mark-3.json)
-  - Fail: Re-submit tickets from authority 0.
-- [publish-tickets-no-mark-4](publish-tickets-no-mark-4.json)
+- [publish-tickets-no-mark-1](./tiny/publish-tickets-no-mark-1.json)
+  - Fail: Submit an extrinsic with a bad ticket attempt number.
+- [publish-tickets-no-mark-2](./tiny/publish-tickets-no-mark-2.json)
+  - Submit good tickets extrinsics from some authorities.
+- [publish-tickets-no-mark-3](./tiny/publish-tickets-no-mark-3.json)
+  - Fail: Re-submit one ticket already in the state.
+- [publish-tickets-no-mark-4](./tiny/publish-tickets-no-mark-4.json)
   - Fail: Submit tickets in bad order.
-- [publish-tickets-no-mark-5](publish-tickets-no-mark-5.json)
+- [publish-tickets-no-mark-5](./tiny/publish-tickets-no-mark-5.json)
   - Fail: Submit tickets with bad ring proof.
-- [publish-tickets-no-mark-6](publish-tickets-no-mark-6.json)
-  - Submit a ticket from authority 2.
-- [publish-tickets-no-mark-7](publish-tickets-no-mark-7.json)
-  - Fail: Submit a ticket while in epoch's tail.
-- [publish-tickets-no-mark-8](publish-tickets-no-mark-8.json)
+- [publish-tickets-no-mark-6](./tiny/publish-tickets-no-mark-6.json)
+  - Submit some tickets.
+- [publish-tickets-no-mark-7](./tiny/publish-tickets-no-mark-7.json)
+  - Fail: Submit tickets while in epoch's tail.
+- [publish-tickets-no-mark-8](./tiny/publish-tickets-no-mark-8.json)
   - Progress into epoch tail.
-  - No enough tickets, thus no tickets mark.
-  - TODO: technically we can already drop the tickets from accumulator (check graypaper).
-- [publish-tickets-no-mark-9](publish-tickets-no-mark-9.json)
+  - No enough tickets, thus no tickets mark is generated.
+- [publish-tickets-no-mark-9](./tiny/publish-tickets-no-mark-9.json)
   - Progress into next epoch with no enough tickets.
-  - Tickets are dropped.
+  - Accumulated tickets are discarded.
+  - Epoch mark is generated.
   - Fallback method is enacted.
-
-- [pubblish-tickets-with-mark-1](publish-tickets-with-mark-1.json)
-  - Publish some tickets with a half filled accumulator.
-  - Accumulator is not filled yet.
-  - No ticket is dropped from accumulator.
-- [pubblish-tickets-with-mark-2](publish-tickets-with-mark-2.json)
+- [publish-tickets-with-mark-1](./tiny/publish-tickets-with-mark-1.json)
+  - Publish some tickets with an almost full tickets accumulator.
+  - Tickets accumulator is not full yet.
+  - No ticket are dropped from accumulator.
+- [publish-tickets-with-mark-2](./tiny/publish-tickets-with-mark-2.json)
   - Publish some more tickets.
-  - Accumulator is filled.
-  - One old ticket is removed from the accumulator.
-- [pubblish-tickets-with-mark-3](publish-tickets-with-mark-3.json)
+  - Tickets accumulator is filled.
+  - Two old ticket are removed from the accumulator.
+- [publish-tickets-with-mark-3](./tiny/publish-tickets-with-mark-3.json)
   - Publish some more tickets.
-  - Accumulator is filled.
+  - Accumulator is full before execution.
   - Some old ticket are removed to make space for new ones.
-- [pubblish-tickets-with-mark-4](publish-tickets-with-mark-4.json)
+- [publish-tickets-with-mark-4](./tiny/publish-tickets-with-mark-4.json)
   - Progress into epoch tail.
-  - Tickets mark is produced.
-- [pubblish-tickets-with-mark-5](publish-tickets-with-mark-5.json)
+  - Tickets mark is generated.
+- [publish-tickets-with-mark-5](./tiny/publish-tickets-with-mark-5.json)
   - Progress into next epoch.
+  - Epoch mark is generated.
   - Tickets are enacted.
+
+## Full Vectors
+
+Currently, the same test cases as tiny vectors but at a larger scale.

safrole/full.asn

@@ -0,0 +1,6 @@
+SafroleConstants DEFINITIONS ::= BEGIN
+
+validators-count INTEGER ::= 1023
+epoch-length INTEGER ::= 600
+
+END