Skip to content

Commit f081f57

Browse files
committed
Better preimages stats docs
1 parent 22b69f8 commit f081f57

File tree

3 files changed

+10
-9
lines changed

3 files changed

+10
-9
lines changed

preimages/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@ and this subsystem STF specific [schema](./preimages.asn).
55

66
## Statistics
77

8-
A subset of `ServiceActivityRecord` structure is updated by the STF involved
9-
processing these test vectors.
8+
A subset of service activity statistics ($π_S$) updated by the STF subsystem used
9+
to process these test vectors.
1010

11-
In particular the `provided-count` and `provided-size` items are updated
12-
when new preimages are provided to be included in the chain storage via the
13-
extrinsic.
11+
In particular the `provided-count` (p.0) and `provided-size` (p.1) items are
12+
updated when new preimages are provided to be included in the chain storage via
13+
the extrinsic.
1414

1515
## Vectors
1616

preimages/preimages.asn

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,16 +36,17 @@ AccountsMapEntry ::= SEQUENCE {
3636
}
3737

3838
State ::= SEQUENCE {
39-
-- Relevant services account data [δ]. Refer to T(σ) in GP Appendix D.
39+
-- [δ] Relevant services account data. Refer to T(σ) in GP Appendix D.
4040
accounts SEQUENCE OF AccountsMapEntry,
41-
-- Statistics updated by the preimages STF subsystem.
41+
-- [π_S] Services statistics.
42+
-- Note: Only stats related to preimages STF are updated, in particular:
43+
-- provided_count (p.0), provided_size (p.1).
4244
statistics ServicesStatistics
4345
}
4446

4547
Input ::= SEQUENCE {
4648
-- [E_P] Preimages extrinsic.
4749
preimages PreimagesExtrinsic,
48-
4950
-- [H_t] Block's timeslot.
5051
slot TimeSlot
5152
}

statistics/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ These vectors exclusively contribute to updating validator-related statistics
1010

1111
In contrast, service and core statistics ($π_S$ and $π_C$) are updated by
1212
vectors that more directly influence the state changes relevant to those
13-
metrics (i.e. see `preimages`, `reports` and `accumulate`).
13+
metrics (i.e. see [preimages](../preimages/README.md#statistics), `reports` and `accumulate`).
1414

1515
## ⚠️Extrinsic Semantic Validity
1616

0 commit comments

Comments
 (0)