Skip to content

Commit 67b536e

Browse files
authored
Update all docs (#64)
- **bump deps** - **update all docs** --------- Signed-off-by: Oliver Tale-Yazdi <oliver@tasty.limo>
1 parent fcee7e8 commit 67b536e

5 files changed

Lines changed: 1387 additions & 1091 deletions

File tree

docs/knowledge/rpc/jip2-gav.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ sidebar_position: 1
66
slug: /advanced/rpc/jip2-node-rpc
77
---
88

9-
(source https://hackmd.io/@polkadot/jip2 from 2025-09-19)
9+
(source https://hackmd.io/@polkadot/jip2 from 2025-12-04)
1010

1111
<!-- The raw MD from above will be downloaded and appended -->
1212
# JIP-2: Node RPC

docs/knowledge/simple-networking/spec.md

Lines changed: 73 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ sidebar_position: 1
55
slug: /knowledge/advanced/simple-networking/spec
66
---
77

8-
(source https://github.com/zdave-parity/jam-np/blob/main/simple.md from 2025-09-19)
8+
(source https://github.com/zdave-parity/jam-np/blob/main/simple.md from 2025-12-04)
99

1010
<!-- The raw MD from above will be downloaded and appended -->
1111
# JAM Simple Networking Protocol (JAMNP-S)
@@ -180,9 +180,12 @@ Core Index = u16
180180
181181
Ed25519 Signature = [u8; 64]
182182
183+
Segments-Root = [u8; 32]
183184
Erasure-Root = [u8; 32]
184185
Shard Index = u16
186+
Work-Package Bundle = [u8] (Encoded as in GP)
185187
Bundle Shard = [u8]
188+
Segment = [u8; 4104]
186189
Segment Shard = [u8; 4104 / R] (R is the recovery threshold; 342 with 1023 validators, 2 with 6)
187190
```
188191

@@ -362,8 +365,9 @@ Submission of a work-package from a builder to a guarantor.
362365
The second message should contain all the extrinsic data referenced by the work-package, formatted
363366
as in work-package bundles, which are defined in the Computation of Work Results section of the GP.
364367

365-
Note that the content of imported segments _should not_ be sent; it is the responsibility of the
366-
receiving guarantor to fetch this data from the availability system.
368+
Note that if the builder can provide the content of imported segments, CE 146 should be used to submit
369+
the full work-package bundle. Otherwise it is the responsibility of the receiving guarantor to fetch
370+
this data from the availability system.
367371

368372
```
369373
Work-Package = As in GP
@@ -377,6 +381,31 @@ Builder -> Guarantor
377381
<-- FIN
378382
```
379383

384+
### CE 146: Work-package bundle submission
385+
386+
Submission of a complete work-package bundle from a builder to a guarantor.
387+
388+
Note that the bundle parts are sent in separate messages to allow for authorizing the work-package before reading the rest of the bundle.
389+
390+
The import proof corresponds to $\mathit{J}$ as defined in the gray paper.
391+
392+
```
393+
Work-Package = As in GP
394+
Extrinsic = [u8]
395+
Import-Proof = len++[Hash]
396+
Segments-Root Mappings = len++[Work-Package Hash ++ Segments-Root]
397+
398+
Builder -> Guarantor
399+
400+
--> Core Index ++ Segments-Root Mappings
401+
--> Work-Package
402+
--> [Extrinsic] (Message size should equal sum of extrinsic data lengths)
403+
--> [Segment] (All imported segments)
404+
--> [Import-Proof] (Import proofs for all imported segments)
405+
--> FIN
406+
<-- FIN
407+
```
408+
380409
### CE 134: Work-package sharing
381410

382411
Sharing of a work-package between guarantors on the same core assignment.
@@ -406,9 +435,7 @@ mappings cannot be verified, the guarantor may, at their discretion, either refu
406435
work-package or blindly trust the mappings.
407436

408437
```
409-
Segments-Root = [u8; 32]
410438
Segments-Root Mappings = len++[Work-Package Hash ++ Segments-Root]
411-
Work-Package Bundle = As in GP
412439
413440
Guarantor -> Guarantor
414441
@@ -541,6 +568,21 @@ Auditor -> Assurer
541568
<-- FIN
542569
```
543570

571+
### CE 147: Bundle request
572+
573+
Request for a work-package bundle.
574+
575+
This protocol should be used by auditors to request work-package bundle from guarantors
576+
for auditing. In case the guarantor fails to provide the valid bundle, the auditor should fall back to recovering the bundle with CE 138
577+
```
578+
Auditor -> Guarantor
579+
580+
--> Erasure-Root
581+
--> FIN
582+
<-- Work-Package Bundle
583+
<-- FIN
584+
```
585+
544586
### CE 139/140: Segment shard request
545587

546588
Request for one or more segment shards.
@@ -594,6 +636,31 @@ Guarantor -> Assurer
594636
<-- FIN
595637
```
596638

639+
### CE 148: Segment request
640+
641+
Request for one or more segments.
642+
643+
This protocol should be used by guarantors or builders to request import segments from other guarantors in order
644+
to complete work-package bundles.
645+
646+
The number of segments requested in a single stream should not exceed $W_M$ ($W_M = 3072$,
647+
this constant is defined in the GP).
648+
649+
If the guarantor fails to return the valid data, the requestor should fall back to using CE 139/140
650+
651+
```
652+
Segment Index = u16
653+
Import-Proof = len++[Hash]
654+
655+
Guarantor -> Guarantor
656+
657+
--> [Segments-Root ++ len++[Segment Index]]
658+
--> FIN
659+
<-- [Segment]
660+
<-- [Import-Proof]
661+
<-- FIN
662+
```
663+
597664
### CE 141: Assurance distribution
598665

599666
Distribution of an availability assurance ready for inclusion in a block.
@@ -654,7 +721,7 @@ is expected to be checked against a different database.
654721
```
655722
Preimage = [u8]
656723
657-
Node -> Node
724+
Validator -> Node
658725
659726
--> Hash
660727
--> FIN

docs/knowledge/testing/pvm/host-call-log.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ sidebar_label: Log Host Call
44
sidebar_position: 1
55
---
66

7-
(source https://hackmd.io/@polkadot/jip1 from 2025-09-19)
7+
(source https://hackmd.io/@polkadot/jip1 from 2025-12-04)
88

99
<!-- The raw MD from above will be downloaded and appended -->
1010
# JIP-1: Debug message host call

package.json

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,21 +17,21 @@
1717
"convert-yaml": "node scripts/yml-to-md.js"
1818
},
1919
"dependencies": {
20-
"@docusaurus/core": "3.8.1",
21-
"@docusaurus/preset-classic": "3.8.1",
20+
"@docusaurus/core": "3.9.2",
21+
"@docusaurus/preset-classic": "3.9.2",
2222
"@mdx-js/react": "^3.1.1",
2323
"clsx": "^2.0.0",
2424
"prism-react-renderer": "^2.3.0",
25-
"react": "^19.1.1",
26-
"react-dom": "^19.1.1",
25+
"react": "^19.2.1",
26+
"react-dom": "^19.2.1",
2727
"rehype-katex": "^7.0.1",
2828
"remark-math": "^6.0.0"
2929
},
3030
"devDependencies": {
31-
"@docusaurus/module-type-aliases": "3.8.1",
32-
"@docusaurus/tsconfig": "3.8.1",
33-
"@docusaurus/types": "3.8.1",
34-
"typescript": "~5.9.2"
31+
"@docusaurus/module-type-aliases": "3.9.2",
32+
"@docusaurus/tsconfig": "3.9.2",
33+
"@docusaurus/types": "3.9.2",
34+
"typescript": "~5.9.3"
3535
},
3636
"browserslist": {
3737
"production": [

0 commit comments

Comments
 (0)