Merge pull request #21 from davxy/master

Update

Author: qiweiii

CHANGELOG.md

@@ -1,4 +1,11 @@
-## [0.6.7] - 31-07-2025
+## [0.7.0] - Unreleased
+
+### Changed
+
+* Serialization: Move all variable-length items to end of encoding
+  (GP [#418](https://github.com/gavofyork/graypaper/pull/418))
+
+## [0.6.7] - 07-08-2025
 
 ### Changed
 

README.md

@@ -1,80 +1,73 @@
-# Test Vectors for the JAM Protocol
+# Test Vectors for the JAM Protocol (0.6.7)
 
-## Codec
- 
-- [Codec](./codec/README.md)
-
-## Erasure Coding
+## Classes
 
+- [Codec](./codec/README.md)
 - [Erasure Coding](./erasure/README.md)
+- [State Transition Function](./stf/README.md)
+- [Block Import Traces](./traces/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
-
-For more information refer to the community [docs](https://docs.jamcha.in/basics/chain-spec).
-
-### 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
+## Binary To JSON
 
-- [Safrole](./stf/safrole/README.md)
-- [Disputes](./stf/disputes/README.md)
-- [History](./stf/history/README.md)
-- [Assurances](./stf/assurances/README.md)
-- [Reports](./stf/reports/README.md)
-- [Statistics](./stf/statistics/README.md)
-- [Authorizations](./stf/authorizations/README.md)
-- [Preimages](./stf/preimages/README.md)
-- [Accumulate](./stf/accumulate/README.md)
+The repository binary test vector files can be converted to their JSON
+equivalents for easier inspection and debugging. Use the provided conversion
+script to transform binary files into human-readable JSON format:
 
-## Block Import Traces
+```bash
+./scripts/convert-all.sh
+```
 
-- [Fallback](./traces/fallback): fallback block authoring, no-safrole, no-work-reports
-- [Safrole](./traces/safrole): safrole block authoring, no-work-reports
-- [Work Reports L0](./traces/reports-l0): basic work reports, no-safrole
+This script requires the [jam-types](https://github.com/davxy/jam-types-py)
+Python library to be installed.
 
-## Vectors Validation
+## Validation
 
 Validation scripts are included to verify the JSON files against the expected
 ASN.1 syntax provided with the test vectors. These scripts currently rely on my
 [asn1tools](https://github.com/davxy/asn1tools) fork.
 
-## Binary To JSON
+```bash
+./scripts/validate-all.sh.sh
+```
 
-The repository binary test vector files can be converted to their JSON
-equivalents for easier inspection and debugging. Use the provided conversion
-script to transform binary files into human-readable JSON format:
+## Chainspec Parameters
 
-```bash
-./scripts/convert-all.sh
+For more information refer to the community [docs](https://docs.jamcha.in/basics/chain-spec).
+
+### Tiny
+
+```yaml
+chain: tiny
+num_validators: 6
+num_cores: 2
+preimage_expunge_period: 32
+slot_duration: 6
+epoch_duration: 12
+contest_duration: 10
+tickets_per_validator: 3
+max_tickets_per_extrinsic: 3
+rotation_period: 4
+num_ec_pieces_per_segment: 1026
+max_block_gas: 20000000
+max_refine_gas: 1000000000
 ```
 
-This conversion script requires the [jam-types](https://github.com/davxy/jam-types)
-Python library to be installed.
+### Full
+
+All parameters here must match the Gray Paper.
+
+```yaml
+chain: full
+num_validators: 1023
+num_cores: 341
+preimage_expunge_period: 19200
+slot_duration: 6
+epoch_duration: 600
+contest_duration: 500
+tickets_per_validator: 2
+max_tickets_per_extrinsic: 16
+rotation_period: 10
+num_ec_pieces_per_segment: 6
+max_block_gas: 3500000000
+max_refine_gas: 5000000000
+```

codec/convert.py

@@ -52,15 +52,16 @@
     "block": Block,
 }
 
-
 def convert(spec_name):
     print(f"\n[Converting codec ({spec_name})]")
     spec.set_spec(spec_name)
     for filename in glob.glob(f"{spec_name}/*.bin"):
-        print("* Converting ", filename)
         basename = os.path.splitext(os.path.basename(filename))[0]
         basename = re.sub(r'_\d+$', '', basename)
-        class_type = dump_classes[basename]
+        class_type = dump_classes.get(basename)
+        if class_type is None:
+            print("* Skipping: ", filename)
+            continue
         convert_to_json(filename, class_type)   
 
 for spec_name in ["tiny", "full"]:

codec/full/block.bin

@@ -4103,11 +4103,11 @@
             ]
         },
         "tickets_mark": null,
+        "author_index": 3,
+        "entropy_source": "0xae85d6635e9ae539d0846b911ec86a27fe000f619b78bcac8a74b77e36f6dbcf49a52360f74a0233cea0775356ab0512fafff0683df08fae3cb848122e296cbc50fed22418ea55f19e55b3c75eb8b0ec71dcae0d79823d39920bf8d6a2256c5f",
         "offenders_mark": [
             "0x4418fb8c85bb3985394a8c2756d3643457ce614546202a2f50b093d762499ace"
         ],
-        "author_index": 3,
-        "entropy_source": "0xae85d6635e9ae539d0846b911ec86a27fe000f619b78bcac8a74b77e36f6dbcf49a52360f74a0233cea0775356ab0512fafff0683df08fae3cb848122e296cbc50fed22418ea55f19e55b3c75eb8b0ec71dcae0d79823d39920bf8d6a2256c5f",
         "seal": "0x31dc5b1e9423eccff9bccd6549eae8034162158000d5be9339919cc03d14046e6431c14cbb172b3aed702b9e9869904b1f39a6fe1f3e904b0fd536f13e8cac496682e1c81898e88e604904fa7c3e496f9a8771ef1102cc29d567c4aad283f7b0"
     },
     "extrinsic": {
@@ -4159,6 +4159,7 @@
                     },
                     "core_index": 3,
                     "authorizer_hash": "0x022e5e165cc8bd586404257f5cd6f5a31177b5c951eb076c7c10174f90006eef",
+                    "auth_gas_used": 0,
                     "auth_output": "0x0102030405",
                     "segment_root_lookup": [],
                     "results": [
@@ -4194,8 +4195,7 @@
                                 "exports": 0
                             }
                         }
-                    ],
-                    "auth_gas_used": 0
+                    ]
                 },
                 "slot": 42,
                 "signatures": [

codec/full/block.json

@@ -47,6 +47,7 @@
                 },
                 "core_index": 3,
                 "authorizer_hash": "0x022e5e165cc8bd586404257f5cd6f5a31177b5c951eb076c7c10174f90006eef",
+                "auth_gas_used": 0,
                 "auth_output": "0x0102030405",
                 "segment_root_lookup": [],
                 "results": [
@@ -82,8 +83,7 @@
                             "exports": 0
                         }
                     }
-                ],
-                "auth_gas_used": 0
+                ]
             },
             "slot": 42,
             "signatures": [

codec/full/extrinsic.bin

@@ -18,6 +18,7 @@
             },
             "core_index": 3,
             "authorizer_hash": "0x022e5e165cc8bd586404257f5cd6f5a31177b5c951eb076c7c10174f90006eef",
+            "auth_gas_used": 0,
             "auth_output": "0x0102030405",
             "segment_root_lookup": [],
             "results": [
@@ -53,8 +54,7 @@
                         "exports": 0
                     }
                 }
-            ],
-            "auth_gas_used": 0
+            ]
         },
         "slot": 42,
         "signatures": [