Skip to content

Commit c82e04f

Browse files
committed
README update
1 parent 33f9445 commit c82e04f

File tree

1 file changed

+13
-17
lines changed

1 file changed

+13
-17
lines changed

codec/README.md

Lines changed: 13 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,23 @@ their content.
55

66
They are provided for a tiny validator set (6), epoch duration (12) and core count (2).
77

8-
## Comparison with SCALE
8+
## Variable-Length encoding
99

10-
The JAM Codec closely resembles the SCALE encoding format, with the primary
11-
difference being in the encoding of *"compact"* integers. Currently, this
12-
difference only applies to the encoding of the length of variable-length
13-
sequences.
10+
The JAM Codec is very similar to the SCALE encoding format, with the
11+
main distinction lying in the compact encoding of integers
12+
13+
We use this variable-length encoding exclusively for the prefix of
14+
variable-length sequences.
15+
16+
Although this may not be explicitly stated for some internal types within the
17+
encoded structures, we follow the guideline from the GP that immediately follows
18+
the variable-length definition. The relevant sentence is as follows:
19+
20+
> *Note that at present this is utilized only in encoding the length prefix of variable-length sequences.*
1421
1522
For detailed information, please refer to Appendix C of the GP.
1623

17-
## ⚠️ Correctness ⚠️
24+
## Semantic Correctness
1825

1926
These test vectors are designed to be syntactically correct only.
2027

@@ -28,17 +35,6 @@ handling of the data structures required by the protocol.
2835
Protocol logic constraints are validated through dedicated STF test vectors and
2936
any other future vectors focused on logic testing.
3037

31-
## Variable-length integers
32-
33-
We provide variable-length encoding solely for the prefix of variable-length
34-
sequences.
35-
36-
Although this may not be explicitly stated for some internal types within the
37-
encoded structures, we follow the guideline from the GP that immediately follows
38-
the variable-length definition. The relevant sentence is as follows:
39-
40-
> *Note that at present this is utilized only in encoding the length prefix of variable-length sequences.*
41-
4238
## Vectors
4339

4440
- [refine_context](data/refine_context.json)

0 commit comments

Comments
 (0)