@optimystic/db-core 1.0.0-beta.2 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (180) hide show
  1. package/dist/src/cluster/structs.d.ts +62 -16
  2. package/dist/src/cluster/structs.d.ts.map +1 -1
  3. package/dist/src/cluster/structs.js +5 -3
  4. package/dist/src/cluster/structs.js.map +1 -1
  5. package/dist/src/cohort-topic/antidos/bootstrap-evidence-envelope.d.ts +2 -1
  6. package/dist/src/cohort-topic/antidos/bootstrap-evidence-envelope.d.ts.map +1 -1
  7. package/dist/src/cohort-topic/antidos/bootstrap-evidence-envelope.js +10 -3
  8. package/dist/src/cohort-topic/antidos/bootstrap-evidence-envelope.js.map +1 -1
  9. package/dist/src/cohort-topic/wire/codec.d.ts.map +1 -1
  10. package/dist/src/cohort-topic/wire/codec.js +8 -2
  11. package/dist/src/cohort-topic/wire/codec.js.map +1 -1
  12. package/dist/src/collection/collection.d.ts +467 -35
  13. package/dist/src/collection/collection.d.ts.map +1 -1
  14. package/dist/src/collection/collection.js +879 -149
  15. package/dist/src/collection/collection.js.map +1 -1
  16. package/dist/src/collection/struct.d.ts +109 -4
  17. package/dist/src/collection/struct.d.ts.map +1 -1
  18. package/dist/src/collection/struct.js +88 -1
  19. package/dist/src/collection/struct.js.map +1 -1
  20. package/dist/src/collections/diary/diary.d.ts +6 -2
  21. package/dist/src/collections/diary/diary.d.ts.map +1 -1
  22. package/dist/src/collections/diary/diary.js +5 -2
  23. package/dist/src/collections/diary/diary.js.map +1 -1
  24. package/dist/src/collections/tree/struct.d.ts +192 -5
  25. package/dist/src/collections/tree/struct.d.ts.map +1 -1
  26. package/dist/src/collections/tree/struct.js +134 -0
  27. package/dist/src/collections/tree/struct.js.map +1 -1
  28. package/dist/src/collections/tree/tree.d.ts +13 -3
  29. package/dist/src/collections/tree/tree.d.ts.map +1 -1
  30. package/dist/src/collections/tree/tree.js +109 -6
  31. package/dist/src/collections/tree/tree.js.map +1 -1
  32. package/dist/src/index.d.ts +2 -1
  33. package/dist/src/index.d.ts.map +1 -1
  34. package/dist/src/index.js +2 -1
  35. package/dist/src/index.js.map +1 -1
  36. package/dist/src/logger-registry.d.ts +57 -0
  37. package/dist/src/logger-registry.d.ts.map +1 -0
  38. package/dist/src/logger-registry.js +168 -0
  39. package/dist/src/logger-registry.js.map +1 -0
  40. package/dist/src/logger.d.ts.map +1 -1
  41. package/dist/src/logger.js +3 -0
  42. package/dist/src/logger.js.map +1 -1
  43. package/dist/src/matchmaking/wire.d.ts.map +1 -1
  44. package/dist/src/matchmaking/wire.js +8 -2
  45. package/dist/src/matchmaking/wire.js.map +1 -1
  46. package/dist/src/network/durability.d.ts +45 -0
  47. package/dist/src/network/durability.d.ts.map +1 -0
  48. package/dist/src/network/durability.js +114 -0
  49. package/dist/src/network/durability.js.map +1 -0
  50. package/dist/src/network/i-key-network.d.ts +14 -6
  51. package/dist/src/network/i-key-network.d.ts.map +1 -1
  52. package/dist/src/network/index.d.ts +3 -0
  53. package/dist/src/network/index.d.ts.map +1 -1
  54. package/dist/src/network/index.js +3 -0
  55. package/dist/src/network/index.js.map +1 -1
  56. package/dist/src/network/lineage.d.ts +39 -0
  57. package/dist/src/network/lineage.d.ts.map +1 -0
  58. package/dist/src/network/lineage.js +61 -0
  59. package/dist/src/network/lineage.js.map +1 -0
  60. package/dist/src/network/routing-key.d.ts +24 -0
  61. package/dist/src/network/routing-key.d.ts.map +1 -0
  62. package/dist/src/network/routing-key.js +9 -0
  63. package/dist/src/network/routing-key.js.map +1 -0
  64. package/dist/src/network/stale-failure.d.ts +5 -1
  65. package/dist/src/network/stale-failure.d.ts.map +1 -1
  66. package/dist/src/network/stale-failure.js +5 -1
  67. package/dist/src/network/stale-failure.js.map +1 -1
  68. package/dist/src/network/struct.d.ts +151 -8
  69. package/dist/src/network/struct.d.ts.map +1 -1
  70. package/dist/src/network/struct.js.map +1 -1
  71. package/dist/src/reactivity/wire.d.ts.map +1 -1
  72. package/dist/src/reactivity/wire.js +8 -2
  73. package/dist/src/reactivity/wire.js.map +1 -1
  74. package/dist/src/testing/test-transactor.d.ts +64 -7
  75. package/dist/src/testing/test-transactor.d.ts.map +1 -1
  76. package/dist/src/testing/test-transactor.js +150 -23
  77. package/dist/src/testing/test-transactor.js.map +1 -1
  78. package/dist/src/transaction/coordinator.d.ts +141 -21
  79. package/dist/src/transaction/coordinator.d.ts.map +1 -1
  80. package/dist/src/transaction/coordinator.js +408 -122
  81. package/dist/src/transaction/coordinator.js.map +1 -1
  82. package/dist/src/transaction/errors.d.ts +39 -10
  83. package/dist/src/transaction/errors.d.ts.map +1 -1
  84. package/dist/src/transaction/errors.js +34 -9
  85. package/dist/src/transaction/errors.js.map +1 -1
  86. package/dist/src/transaction/index.d.ts +1 -0
  87. package/dist/src/transaction/index.d.ts.map +1 -1
  88. package/dist/src/transaction/index.js.map +1 -1
  89. package/dist/src/transactor/block-floors.d.ts +78 -0
  90. package/dist/src/transactor/block-floors.d.ts.map +1 -0
  91. package/dist/src/transactor/block-floors.js +62 -0
  92. package/dist/src/transactor/block-floors.js.map +1 -0
  93. package/dist/src/transactor/change-notifier.d.ts +43 -0
  94. package/dist/src/transactor/change-notifier.d.ts.map +1 -1
  95. package/dist/src/transactor/change-notifier.js +3 -0
  96. package/dist/src/transactor/change-notifier.js.map +1 -1
  97. package/dist/src/transactor/index.d.ts +1 -0
  98. package/dist/src/transactor/index.d.ts.map +1 -1
  99. package/dist/src/transactor/index.js +1 -0
  100. package/dist/src/transactor/index.js.map +1 -1
  101. package/dist/src/transactor/network-transactor.d.ts +43 -6
  102. package/dist/src/transactor/network-transactor.d.ts.map +1 -1
  103. package/dist/src/transactor/network-transactor.js +279 -81
  104. package/dist/src/transactor/network-transactor.js.map +1 -1
  105. package/dist/src/transactor/transactor-source.d.ts +94 -4
  106. package/dist/src/transactor/transactor-source.d.ts.map +1 -1
  107. package/dist/src/transactor/transactor-source.js +120 -42
  108. package/dist/src/transactor/transactor-source.js.map +1 -1
  109. package/dist/src/transactor/transactor.d.ts +14 -1
  110. package/dist/src/transactor/transactor.d.ts.map +1 -1
  111. package/dist/src/transform/atomic.d.ts.map +1 -1
  112. package/dist/src/transform/atomic.js +12 -9
  113. package/dist/src/transform/atomic.js.map +1 -1
  114. package/dist/src/transform/base-pins.d.ts +50 -17
  115. package/dist/src/transform/base-pins.d.ts.map +1 -1
  116. package/dist/src/transform/base-pins.js +58 -11
  117. package/dist/src/transform/base-pins.js.map +1 -1
  118. package/dist/src/transform/cache-source.d.ts +75 -11
  119. package/dist/src/transform/cache-source.d.ts.map +1 -1
  120. package/dist/src/transform/cache-source.js +162 -36
  121. package/dist/src/transform/cache-source.js.map +1 -1
  122. package/dist/src/transform/digest.d.ts +8 -1
  123. package/dist/src/transform/digest.d.ts.map +1 -1
  124. package/dist/src/transform/digest.js +19 -9
  125. package/dist/src/transform/digest.js.map +1 -1
  126. package/dist/src/transform/helpers.d.ts +6 -2
  127. package/dist/src/transform/helpers.d.ts.map +1 -1
  128. package/dist/src/transform/helpers.js +8 -3
  129. package/dist/src/transform/helpers.js.map +1 -1
  130. package/dist/src/transform/tracker.d.ts +94 -14
  131. package/dist/src/transform/tracker.d.ts.map +1 -1
  132. package/dist/src/transform/tracker.js +222 -68
  133. package/dist/src/transform/tracker.js.map +1 -1
  134. package/dist/src/utility/structural-equals.d.ts +38 -0
  135. package/dist/src/utility/structural-equals.d.ts.map +1 -0
  136. package/dist/src/utility/structural-equals.js +77 -0
  137. package/dist/src/utility/structural-equals.js.map +1 -0
  138. package/package.json +2 -2
  139. package/src/cluster/structs.ts +298 -255
  140. package/src/cohort-topic/antidos/bootstrap-evidence-envelope.ts +260 -253
  141. package/src/cohort-topic/wire/codec.ts +222 -216
  142. package/src/collection/collection.ts +996 -158
  143. package/src/collection/struct.ts +99 -4
  144. package/src/collections/diary/diary.ts +71 -68
  145. package/src/collections/tree/struct.ts +248 -26
  146. package/src/collections/tree/tree.ts +130 -9
  147. package/src/index.ts +2 -1
  148. package/src/logger-registry.ts +224 -0
  149. package/src/logger.ts +4 -0
  150. package/src/matchmaking/wire.ts +8 -2
  151. package/src/network/durability.ts +123 -0
  152. package/src/network/i-key-network.ts +60 -52
  153. package/src/network/index.ts +10 -7
  154. package/src/network/lineage.ts +80 -0
  155. package/src/network/routing-key.ts +27 -0
  156. package/src/network/stale-failure.ts +5 -1
  157. package/src/network/struct.ts +156 -8
  158. package/src/reactivity/wire.ts +230 -224
  159. package/src/testing/test-transactor.ts +152 -24
  160. package/src/transaction/coordinator.ts +470 -131
  161. package/src/transaction/errors.ts +34 -9
  162. package/src/transaction/index.ts +1 -0
  163. package/src/transactor/block-floors.ts +105 -0
  164. package/src/transactor/change-notifier.ts +129 -80
  165. package/src/transactor/index.ts +1 -0
  166. package/src/transactor/network-transactor.ts +297 -84
  167. package/src/transactor/transactor-source.ts +131 -42
  168. package/src/transactor/transactor.ts +13 -1
  169. package/src/transform/atomic.ts +25 -22
  170. package/src/transform/base-pins.ts +76 -18
  171. package/src/transform/cache-source.ts +327 -194
  172. package/src/transform/digest.ts +21 -10
  173. package/src/transform/helpers.ts +8 -3
  174. package/src/transform/tracker.ts +423 -270
  175. package/src/utility/structural-equals.ts +72 -0
  176. package/dist/src/utility/block-id-to-bytes.d.ts +0 -3
  177. package/dist/src/utility/block-id-to-bytes.d.ts.map +0 -1
  178. package/dist/src/utility/block-id-to-bytes.js +0 -7
  179. package/dist/src/utility/block-id-to-bytes.js.map +0 -1
  180. package/src/utility/block-id-to-bytes.ts +0 -8
@@ -1,253 +1,260 @@
1
- /**
2
- * Cohort-topic substrate — bootstrap-evidence envelope (anti-DoS, crypto-free).
3
- *
4
- * The on-the-wire structure a participant attaches to a cold-start `bootstrap: true` register, and the
5
- * byte-level canonicalization both sides agree on. This module owns only the **format** — the versioned
6
- * envelope, the canonical anti-replay bound image, and the proof-of-work puzzle's preimage/difficulty.
7
- * It embeds **no cryptography**: the actual PoW hashing, reputation-signature checks, and parent-topic
8
- * verification live in db-p2p (which binds the node's `RingHash` and peer-key crypto). The sibling
9
- * discipline of `wire/payloads.ts` / `sig/payloads.ts` — explicitly-ordered arrays, deterministic UTF-8
10
- * JSON, base64url without padding — so a participant who *mints* evidence and a cohort that *verifies*
11
- * it never re-canonicalize bytes independently.
12
- *
13
- * The envelope rides in the dedicated, signature-covered {@link RegisterV1.bootstrapEvidence} field
14
- * (not `appPayload`). A verifier reads only the kind its tier accepts; an absent kind, a malformed
15
- * envelope, or a wrong/future version all surface as "this kind not offered" (the parse is **total** —
16
- * like `verifyPeerSig`, any decode error yields `undefined`, never a throw), so a verifier fails its
17
- * check (→ `unwilling_cohort`) rather than crashing on attacker-supplied input.
18
- */
19
-
20
- import { b64urlToBytes, bytesToB64url } from "../wire/codec.js";
21
- import type { RegisterV1 } from "../wire/types.js";
22
-
23
- const utf8 = new TextEncoder();
24
- const utf8Decoder = new TextDecoder("utf-8", { fatal: true });
25
-
26
- /** Proof-of-work evidence (T2/T3 path). `nonce` is base64url, bound via {@link powPreimage}. */
27
- export interface PowEvidenceV1 {
28
- /** Base64url nonce; `hash(powPreimage(reg, nonce))` must satisfy {@link meetsDifficulty}. */
29
- nonce: string;
30
- }
31
-
32
- /** Signed parent-topic reference (all tiers). Both base64url; `sig` is over {@link parentRefSigningImage}. */
33
- export interface ParentRefEvidenceV1 {
34
- /** The committed parent topic id, base64url. */
35
- parentTopicId: string;
36
- /** Participant peer-key signature over {@link parentRefSigningImage} (the bound tuple extended with `parentTopicId`), base64url. */
37
- sig: string;
38
- }
39
-
40
- /**
41
- * Reputation endorsement (T2/T3 path). `referee` is the endorsing peer-id-string bytes (base64url) and
42
- * `sig` is that referee's peer-key signature over the bound image. The referee MAY equal the
43
- * participant (a reputable participant self-vouches).
44
- */
45
- export interface ReputationEvidenceV1 {
46
- /** Endorsing peer-id-string bytes, base64url. */
47
- referee: string;
48
- /** Referee's peer-key signature over the bound image, base64url. */
49
- sig: string;
50
- }
51
-
52
- /** V1 bootstrap-evidence envelope, base64url-encoded into {@link RegisterV1.bootstrapEvidence}. */
53
- export interface BootstrapEvidenceEnvelopeV1 {
54
- v: 1;
55
- /** Proof-of-work (T2/T3 path). Absent no PoW offered. */
56
- pow?: PowEvidenceV1;
57
- /** Signed parent-topic reference (all tiers). Absent → none offered. */
58
- parentRef?: ParentRefEvidenceV1;
59
- /** Reputation endorsement (T2/T3 path). Absent → none offered. */
60
- reputation?: ReputationEvidenceV1;
61
- }
62
-
63
- /**
64
- * The four register fields every bootstrap-evidence kind is bound to (the anti-replay tuple). The full
65
- * {@link RegisterV1} satisfies this, so a verifier passes its decoded register directly; the
66
- * participant-side builder passes just these fields (it has no full register yet).
67
- */
68
- export type BootstrapBoundFields = Pick<RegisterV1, "topicId" | "tier" | "participantCoord" | "timestamp">;
69
-
70
- /** Default PoW difficulty: leading zero bits required. ~2^bits hashes to mint, one hash to verify. */
71
- export const DEFAULT_POW_DIFFICULTY_BITS = 20;
72
-
73
- /**
74
- * The canonical bytes every bootstrap-evidence kind is bound to: `(topicId, tier, participantCoord,
75
- * timestamp)`. `topicId`/`participantCoord` are bound as their base64url wire strings verbatim (matching
76
- * `sig/payloads.ts`) so signer and verifier never re-canonicalize bytes independently. Binding all four
77
- * means evidence minted for one (topic, tier, peer, time) cannot be replayed for another; binding
78
- * `timestamp` additionally bounds a captured proof's reuse window, since the register replay guard drops
79
- * a `timestamp` older than its acceptance window.
80
- */
81
- export function bootstrapBoundImage(reg: BootstrapBoundFields): Uint8Array {
82
- return utf8.encode(JSON.stringify([
83
- "BootstrapEvidenceV1",
84
- reg.topicId,
85
- reg.tier,
86
- reg.participantCoord,
87
- reg.timestamp,
88
- ]));
89
- }
90
-
91
- /**
92
- * The canonical bytes a **signed parent-topic reference** binds: the {@link bootstrapBoundImage} tuple
93
- * `(topicId, tier, participantCoord, timestamp)` **extended with the referenced `parentTopicId`**, under a
94
- * distinct discriminator tag (`"BootstrapParentRefV1"`). Extending the image with `parentTopicId` means a
95
- * reference minted for one `(topic, tier, peer, time, parent)` cannot be lifted onto another register —
96
- * including onto a register naming a *different* parent; the distinct tag keeps it from colliding with a
97
- * {@link bootstrapBoundImage} reputation/PoW signature (domain separation). `topicId`/`participantCoord`/
98
- * `parentTopicId` are bound as their base64url wire strings verbatim, like {@link bootstrapBoundImage}, so
99
- * the participant who *signs* the reference and the cohort that *verifies* it never re-canonicalize bytes.
100
- */
101
- export function parentRefSigningImage(reg: BootstrapBoundFields, parentTopicId: string): Uint8Array {
102
- return utf8.encode(JSON.stringify([
103
- "BootstrapParentRefV1",
104
- reg.topicId,
105
- reg.tier,
106
- reg.participantCoord,
107
- reg.timestamp,
108
- parentTopicId,
109
- ]));
110
- }
111
-
112
- /**
113
- * The proof-of-work hash preimage: {@link bootstrapBoundImage} concatenated with `nonce`. db-p2p hashes
114
- * this (via the node's `RingHash`) and checks the digest against {@link meetsDifficulty}. Bound to the
115
- * register tuple ⇒ no cross-topic / cross-peer replay; cheap to verify (one hash + bit check), tunably
116
- * costly to produce.
117
- */
118
- export function powPreimage(reg: BootstrapBoundFields, nonce: Uint8Array): Uint8Array {
119
- const image = bootstrapBoundImage(reg);
120
- const out = new Uint8Array(image.length + nonce.length);
121
- out.set(image, 0);
122
- out.set(nonce, image.length);
123
- return out;
124
- }
125
-
126
- /**
127
- * True iff the first `bits` most-significant bits of `hash` are zero (the PoW difficulty target). Bits
128
- * are read MSB-first per byte (mirroring `addressing.ts`'s `prefixBits`). `bits = 0` is trivially met
129
- * (lets a config disable PoW cost for tests); a non-finite `bits` is a guard-failure (never met); a
130
- * negative `bits` clamps to 0; `bits` larger than `hash.length * 8` requires every bit of `hash` to be
131
- * zero and so is effectively unsatisfiable for a random hash.
132
- */
133
- export function meetsDifficulty(hash: Uint8Array, bits: number): boolean {
134
- if (!Number.isFinite(bits)) {
135
- return false; // NaN / ±Infinity → defensive guard, never satisfiable
136
- }
137
- let remaining = Math.floor(bits);
138
- if (remaining <= 0) {
139
- return true; // 0 (or clamped-negative) leading zero bits is trivially met
140
- }
141
- for (let i = 0; i < hash.length && remaining > 0; i++) {
142
- const byte = hash[i]!;
143
- if (remaining >= 8) {
144
- if (byte !== 0) {
145
- return false;
146
- }
147
- remaining -= 8;
148
- } else {
149
- // Check only the top `remaining` MSBs of this partial final byte (MSB-first).
150
- const mask = (0xff << (8 - remaining)) & 0xff;
151
- if ((byte & mask) !== 0) {
152
- return false;
153
- }
154
- remaining = 0;
155
- }
156
- }
157
- // Exhausted the hash before satisfying `bits` (oversize target) → unsatisfiable.
158
- return remaining === 0;
159
- }
160
-
161
- /** Serialize an envelope to the base64url JSON string carried in {@link RegisterV1.bootstrapEvidence}. */
162
- export function serializeBootstrapEvidenceEnvelope(env: BootstrapEvidenceEnvelopeV1): string {
163
- // Rebuild in a fixed field order so serialization is a pure function of the logical content
164
- // (serialize∘parse is stable regardless of how a caller ordered the source object's keys).
165
- const out: BootstrapEvidenceEnvelopeV1 = { v: 1 };
166
- if (env.pow !== undefined) {
167
- out.pow = { nonce: env.pow.nonce };
168
- }
169
- if (env.parentRef !== undefined) {
170
- out.parentRef = { parentTopicId: env.parentRef.parentTopicId, sig: env.parentRef.sig };
171
- }
172
- if (env.reputation !== undefined) {
173
- out.reputation = { referee: env.reputation.referee, sig: env.reputation.sig };
174
- }
175
- return bytesToB64url(utf8.encode(JSON.stringify(out)));
176
- }
177
-
178
- /**
179
- * Decode {@link RegisterV1.bootstrapEvidence} (base64url → JSON), structurally validate it, and return
180
- * the {@link BootstrapEvidenceEnvelopeV1}. **Total**: returns `undefined` on an absent/empty field, a
181
- * non-base64url or non-JSON body, a wrong/future `v`, or a structurally-invalid kind — never throws. A
182
- * verifier treats `undefined` as "this kind not offered" and fails its check (fails closed).
183
- */
184
- export function parseBootstrapEvidenceEnvelope(reg: Pick<RegisterV1, "bootstrapEvidence">): BootstrapEvidenceEnvelopeV1 | undefined {
185
- const raw = reg.bootstrapEvidence;
186
- if (raw === undefined || raw === "") {
187
- return undefined; // not offered
188
- }
189
- let parsed: unknown;
190
- try {
191
- parsed = JSON.parse(utf8Decoder.decode(b64urlToBytes(raw)));
192
- } catch {
193
- return undefined; // not base64url / not UTF-8 / not JSON fail closed
194
- }
195
- return narrowEnvelope(parsed);
196
- }
197
-
198
- /** Structurally narrow an already-parsed value to a v1 envelope, or `undefined`. */
199
- function narrowEnvelope(value: unknown): BootstrapEvidenceEnvelopeV1 | undefined {
200
- if (typeof value !== "object" || value === null || Array.isArray(value)) {
201
- return undefined;
202
- }
203
- const obj = value as Record<string, unknown>;
204
- if (obj["v"] !== 1) {
205
- return undefined; // wrong / future version fail closed under the v1 reader
206
- }
207
- const out: BootstrapEvidenceEnvelopeV1 = { v: 1 };
208
-
209
- if (obj["pow"] !== undefined) {
210
- const nonce = b64urlSubfield(obj["pow"], "nonce");
211
- if (nonce === undefined) {
212
- return undefined;
213
- }
214
- out.pow = { nonce };
215
- }
216
-
217
- if (obj["parentRef"] !== undefined) {
218
- const parentTopicId = b64urlSubfield(obj["parentRef"], "parentTopicId");
219
- const sig = b64urlSubfield(obj["parentRef"], "sig");
220
- if (parentTopicId === undefined || sig === undefined) {
221
- return undefined;
222
- }
223
- out.parentRef = { parentTopicId, sig };
224
- }
225
-
226
- if (obj["reputation"] !== undefined) {
227
- const referee = b64urlSubfield(obj["reputation"], "referee");
228
- const sig = b64urlSubfield(obj["reputation"], "sig");
229
- if (referee === undefined || sig === undefined) {
230
- return undefined;
231
- }
232
- out.reputation = { referee, sig };
233
- }
234
-
235
- return out;
236
- }
237
-
238
- /** A required base64url sub-field: a non-empty string that decodes cleanly, else `undefined`. */
239
- function b64urlSubfield(container: unknown, key: string): string | undefined {
240
- if (typeof container !== "object" || container === null || Array.isArray(container)) {
241
- return undefined;
242
- }
243
- const value = (container as Record<string, unknown>)[key];
244
- if (typeof value !== "string" || value === "") {
245
- return undefined; // missing, non-string, or empty treat as absent
246
- }
247
- try {
248
- b64urlToBytes(value); // structural: must decode as base64url
249
- } catch {
250
- return undefined;
251
- }
252
- return value;
253
- }
1
+ /**
2
+ * Cohort-topic substrate — bootstrap-evidence envelope (anti-DoS, crypto-free).
3
+ *
4
+ * The on-the-wire structure a participant attaches to a cold-start `bootstrap: true` register, and the
5
+ * byte-level canonicalization both sides agree on. This module owns only the **format** — the versioned
6
+ * envelope, the canonical anti-replay bound image, and the proof-of-work puzzle's preimage/difficulty.
7
+ * It embeds **no cryptography**: the actual PoW hashing, reputation-signature checks, and parent-topic
8
+ * verification live in db-p2p (which binds the node's `RingHash` and peer-key crypto). The sibling
9
+ * discipline of `wire/payloads.ts` / `sig/payloads.ts` — explicitly-ordered arrays, deterministic UTF-8
10
+ * JSON, base64url without padding — so a participant who *mints* evidence and a cohort that *verifies*
11
+ * it never re-canonicalize bytes independently.
12
+ *
13
+ * The envelope rides in the dedicated, signature-covered {@link RegisterV1.bootstrapEvidence} field
14
+ * (not `appPayload`). A verifier reads only the kind its tier accepts; an absent kind, a malformed
15
+ * envelope, or a wrong/future version all surface as "this kind not offered" (the parse is **total** —
16
+ * like `verifyPeerSig`, any decode error yields `undefined`, never a throw), so a verifier fails its
17
+ * check (→ `unwilling_cohort`) rather than crashing on attacker-supplied input.
18
+ */
19
+
20
+ import { b64urlToBytes, bytesToB64url } from "../wire/codec.js";
21
+ import type { RegisterV1 } from "../wire/types.js";
22
+
23
+ const utf8 = new TextEncoder();
24
+ // Built on first use, not at module load: Hermes (React Native) has no native `TextDecoder`, so a
25
+ // module-scope construction fails the import itself whenever it runs ahead of the host's polyfill.
26
+ let utf8DecoderInstance: TextDecoder | undefined;
27
+ const utf8Decoder = (): TextDecoder => utf8DecoderInstance ??= new TextDecoder("utf-8", { fatal: true });
28
+
29
+ /** Proof-of-work evidence (T2/T3 path). `nonce` is base64url, bound via {@link powPreimage}. */
30
+ export interface PowEvidenceV1 {
31
+ /** Base64url nonce; `hash(powPreimage(reg, nonce))` must satisfy {@link meetsDifficulty}. */
32
+ nonce: string;
33
+ }
34
+
35
+ /** Signed parent-topic reference (all tiers). Both base64url; `sig` is over {@link parentRefSigningImage}. */
36
+ export interface ParentRefEvidenceV1 {
37
+ /** The committed parent topic id, base64url. */
38
+ parentTopicId: string;
39
+ /** Participant peer-key signature over {@link parentRefSigningImage} (the bound tuple extended with `parentTopicId`), base64url. */
40
+ sig: string;
41
+ }
42
+
43
+ /**
44
+ * Reputation endorsement (T2/T3 path). `referee` is the endorsing peer-id-string bytes (base64url) and
45
+ * `sig` is that referee's peer-key signature over the bound image. The referee MAY equal the
46
+ * participant (a reputable participant self-vouches).
47
+ */
48
+ export interface ReputationEvidenceV1 {
49
+ /** Endorsing peer-id-string bytes, base64url. */
50
+ referee: string;
51
+ /** Referee's peer-key signature over the bound image, base64url. */
52
+ sig: string;
53
+ }
54
+
55
+ /** V1 bootstrap-evidence envelope, base64url-encoded into {@link RegisterV1.bootstrapEvidence}. */
56
+ export interface BootstrapEvidenceEnvelopeV1 {
57
+ v: 1;
58
+ /** Proof-of-work (T2/T3 path). Absent → no PoW offered. */
59
+ pow?: PowEvidenceV1;
60
+ /** Signed parent-topic reference (all tiers). Absent → none offered. */
61
+ parentRef?: ParentRefEvidenceV1;
62
+ /** Reputation endorsement (T2/T3 path). Absent → none offered. */
63
+ reputation?: ReputationEvidenceV1;
64
+ }
65
+
66
+ /**
67
+ * The four register fields every bootstrap-evidence kind is bound to (the anti-replay tuple). The full
68
+ * {@link RegisterV1} satisfies this, so a verifier passes its decoded register directly; the
69
+ * participant-side builder passes just these fields (it has no full register yet).
70
+ */
71
+ export type BootstrapBoundFields = Pick<RegisterV1, "topicId" | "tier" | "participantCoord" | "timestamp">;
72
+
73
+ /** Default PoW difficulty: leading zero bits required. ~2^bits hashes to mint, one hash to verify. */
74
+ export const DEFAULT_POW_DIFFICULTY_BITS = 20;
75
+
76
+ /**
77
+ * The canonical bytes every bootstrap-evidence kind is bound to: `(topicId, tier, participantCoord,
78
+ * timestamp)`. `topicId`/`participantCoord` are bound as their base64url wire strings verbatim (matching
79
+ * `sig/payloads.ts`) so signer and verifier never re-canonicalize bytes independently. Binding all four
80
+ * means evidence minted for one (topic, tier, peer, time) cannot be replayed for another; binding
81
+ * `timestamp` additionally bounds a captured proof's reuse window, since the register replay guard drops
82
+ * a `timestamp` older than its acceptance window.
83
+ */
84
+ export function bootstrapBoundImage(reg: BootstrapBoundFields): Uint8Array {
85
+ return utf8.encode(JSON.stringify([
86
+ "BootstrapEvidenceV1",
87
+ reg.topicId,
88
+ reg.tier,
89
+ reg.participantCoord,
90
+ reg.timestamp,
91
+ ]));
92
+ }
93
+
94
+ /**
95
+ * The canonical bytes a **signed parent-topic reference** binds: the {@link bootstrapBoundImage} tuple
96
+ * `(topicId, tier, participantCoord, timestamp)` **extended with the referenced `parentTopicId`**, under a
97
+ * distinct discriminator tag (`"BootstrapParentRefV1"`). Extending the image with `parentTopicId` means a
98
+ * reference minted for one `(topic, tier, peer, time, parent)` cannot be lifted onto another register
99
+ * including onto a register naming a *different* parent; the distinct tag keeps it from colliding with a
100
+ * {@link bootstrapBoundImage} reputation/PoW signature (domain separation). `topicId`/`participantCoord`/
101
+ * `parentTopicId` are bound as their base64url wire strings verbatim, like {@link bootstrapBoundImage}, so
102
+ * the participant who *signs* the reference and the cohort that *verifies* it never re-canonicalize bytes.
103
+ */
104
+ export function parentRefSigningImage(reg: BootstrapBoundFields, parentTopicId: string): Uint8Array {
105
+ return utf8.encode(JSON.stringify([
106
+ "BootstrapParentRefV1",
107
+ reg.topicId,
108
+ reg.tier,
109
+ reg.participantCoord,
110
+ reg.timestamp,
111
+ parentTopicId,
112
+ ]));
113
+ }
114
+
115
+ /**
116
+ * The proof-of-work hash preimage: {@link bootstrapBoundImage} concatenated with `nonce`. db-p2p hashes
117
+ * this (via the node's `RingHash`) and checks the digest against {@link meetsDifficulty}. Bound to the
118
+ * register tuple ⇒ no cross-topic / cross-peer replay; cheap to verify (one hash + bit check), tunably
119
+ * costly to produce.
120
+ */
121
+ export function powPreimage(reg: BootstrapBoundFields, nonce: Uint8Array): Uint8Array {
122
+ const image = bootstrapBoundImage(reg);
123
+ const out = new Uint8Array(image.length + nonce.length);
124
+ out.set(image, 0);
125
+ out.set(nonce, image.length);
126
+ return out;
127
+ }
128
+
129
+ /**
130
+ * True iff the first `bits` most-significant bits of `hash` are zero (the PoW difficulty target). Bits
131
+ * are read MSB-first per byte (mirroring `addressing.ts`'s `prefixBits`). `bits = 0` is trivially met
132
+ * (lets a config disable PoW cost for tests); a non-finite `bits` is a guard-failure (never met); a
133
+ * negative `bits` clamps to 0; `bits` larger than `hash.length * 8` requires every bit of `hash` to be
134
+ * zero and so is effectively unsatisfiable for a random hash.
135
+ */
136
+ export function meetsDifficulty(hash: Uint8Array, bits: number): boolean {
137
+ if (!Number.isFinite(bits)) {
138
+ return false; // NaN / ±Infinity → defensive guard, never satisfiable
139
+ }
140
+ let remaining = Math.floor(bits);
141
+ if (remaining <= 0) {
142
+ return true; // 0 (or clamped-negative) leading zero bits is trivially met
143
+ }
144
+ for (let i = 0; i < hash.length && remaining > 0; i++) {
145
+ const byte = hash[i]!;
146
+ if (remaining >= 8) {
147
+ if (byte !== 0) {
148
+ return false;
149
+ }
150
+ remaining -= 8;
151
+ } else {
152
+ // Check only the top `remaining` MSBs of this partial final byte (MSB-first).
153
+ const mask = (0xff << (8 - remaining)) & 0xff;
154
+ if ((byte & mask) !== 0) {
155
+ return false;
156
+ }
157
+ remaining = 0;
158
+ }
159
+ }
160
+ // Exhausted the hash before satisfying `bits` (oversize target) → unsatisfiable.
161
+ return remaining === 0;
162
+ }
163
+
164
+ /** Serialize an envelope to the base64url JSON string carried in {@link RegisterV1.bootstrapEvidence}. */
165
+ export function serializeBootstrapEvidenceEnvelope(env: BootstrapEvidenceEnvelopeV1): string {
166
+ // Rebuild in a fixed field order so serialization is a pure function of the logical content
167
+ // (serialize∘parse is stable regardless of how a caller ordered the source object's keys).
168
+ const out: BootstrapEvidenceEnvelopeV1 = { v: 1 };
169
+ if (env.pow !== undefined) {
170
+ out.pow = { nonce: env.pow.nonce };
171
+ }
172
+ if (env.parentRef !== undefined) {
173
+ out.parentRef = { parentTopicId: env.parentRef.parentTopicId, sig: env.parentRef.sig };
174
+ }
175
+ if (env.reputation !== undefined) {
176
+ out.reputation = { referee: env.reputation.referee, sig: env.reputation.sig };
177
+ }
178
+ return bytesToB64url(utf8.encode(JSON.stringify(out)));
179
+ }
180
+
181
+ /**
182
+ * Decode {@link RegisterV1.bootstrapEvidence} (base64url JSON), structurally validate it, and return
183
+ * the {@link BootstrapEvidenceEnvelopeV1}. **Total**: returns `undefined` on an absent/empty field, a
184
+ * non-base64url or non-JSON body, a wrong/future `v`, or a structurally-invalid kind — never throws on its input
185
+ * (a host missing its `TextDecoder` polyfill does throw — a misconfiguration, not bad evidence). A
186
+ * verifier treats `undefined` as "this kind not offered" and fails its check (fails closed).
187
+ */
188
+ export function parseBootstrapEvidenceEnvelope(reg: Pick<RegisterV1, "bootstrapEvidence">): BootstrapEvidenceEnvelopeV1 | undefined {
189
+ const raw = reg.bootstrapEvidence;
190
+ if (raw === undefined || raw === "") {
191
+ return undefined; // not offered
192
+ }
193
+ // Fetched outside the try: a missing `TextDecoder` polyfill is a host misconfiguration and must
194
+ // throw as one, not quietly read every offered envelope as "not offered".
195
+ const decoder = utf8Decoder();
196
+ let parsed: unknown;
197
+ try {
198
+ parsed = JSON.parse(decoder.decode(b64urlToBytes(raw)));
199
+ } catch {
200
+ return undefined; // not base64url / not UTF-8 / not JSON → fail closed
201
+ }
202
+ return narrowEnvelope(parsed);
203
+ }
204
+
205
+ /** Structurally narrow an already-parsed value to a v1 envelope, or `undefined`. */
206
+ function narrowEnvelope(value: unknown): BootstrapEvidenceEnvelopeV1 | undefined {
207
+ if (typeof value !== "object" || value === null || Array.isArray(value)) {
208
+ return undefined;
209
+ }
210
+ const obj = value as Record<string, unknown>;
211
+ if (obj["v"] !== 1) {
212
+ return undefined; // wrong / future version → fail closed under the v1 reader
213
+ }
214
+ const out: BootstrapEvidenceEnvelopeV1 = { v: 1 };
215
+
216
+ if (obj["pow"] !== undefined) {
217
+ const nonce = b64urlSubfield(obj["pow"], "nonce");
218
+ if (nonce === undefined) {
219
+ return undefined;
220
+ }
221
+ out.pow = { nonce };
222
+ }
223
+
224
+ if (obj["parentRef"] !== undefined) {
225
+ const parentTopicId = b64urlSubfield(obj["parentRef"], "parentTopicId");
226
+ const sig = b64urlSubfield(obj["parentRef"], "sig");
227
+ if (parentTopicId === undefined || sig === undefined) {
228
+ return undefined;
229
+ }
230
+ out.parentRef = { parentTopicId, sig };
231
+ }
232
+
233
+ if (obj["reputation"] !== undefined) {
234
+ const referee = b64urlSubfield(obj["reputation"], "referee");
235
+ const sig = b64urlSubfield(obj["reputation"], "sig");
236
+ if (referee === undefined || sig === undefined) {
237
+ return undefined;
238
+ }
239
+ out.reputation = { referee, sig };
240
+ }
241
+
242
+ return out;
243
+ }
244
+
245
+ /** A required base64url sub-field: a non-empty string that decodes cleanly, else `undefined`. */
246
+ function b64urlSubfield(container: unknown, key: string): string | undefined {
247
+ if (typeof container !== "object" || container === null || Array.isArray(container)) {
248
+ return undefined;
249
+ }
250
+ const value = (container as Record<string, unknown>)[key];
251
+ if (typeof value !== "string" || value === "") {
252
+ return undefined; // missing, non-string, or empty → treat as absent
253
+ }
254
+ try {
255
+ b64urlToBytes(value); // structural: must decode as base64url
256
+ } catch {
257
+ return undefined;
258
+ }
259
+ return value;
260
+ }