@serfab/cadre-core 0.9.0 → 0.10.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 (162) hide show
  1. package/README.md +4 -2
  2. package/dist/bootstrap-peer-store-file.d.ts +13 -0
  3. package/dist/bootstrap-peer-store-file.js +42 -0
  4. package/dist/bootstrap-peer-store-file.js.map +1 -0
  5. package/dist/bootstrap-peer-store.d.ts +73 -0
  6. package/dist/bootstrap-peer-store.js +128 -0
  7. package/dist/bootstrap-peer-store.js.map +1 -0
  8. package/dist/cadre-node.d.ts +918 -53
  9. package/dist/cadre-node.js +1843 -190
  10. package/dist/cadre-node.js.map +1 -1
  11. package/dist/control-authorization.d.ts +93 -0
  12. package/dist/control-authorization.js +57 -0
  13. package/dist/control-authorization.js.map +1 -0
  14. package/dist/control-database.d.ts +990 -50
  15. package/dist/control-database.js +1459 -108
  16. package/dist/control-database.js.map +1 -1
  17. package/dist/control-formation-recorder.d.ts +89 -10
  18. package/dist/control-formation-recorder.js +129 -14
  19. package/dist/control-formation-recorder.js.map +1 -1
  20. package/dist/control-schema.d.ts +1 -1
  21. package/dist/control-schema.js +774 -210
  22. package/dist/control-schema.js.map +1 -1
  23. package/dist/control-stream.d.ts +38 -4
  24. package/dist/control-stream.js +70 -4
  25. package/dist/control-stream.js.map +1 -1
  26. package/dist/control-write-retry.d.ts +151 -0
  27. package/dist/control-write-retry.js +411 -0
  28. package/dist/control-write-retry.js.map +1 -0
  29. package/dist/delegate-admission.d.ts +134 -0
  30. package/dist/delegate-admission.js +244 -0
  31. package/dist/delegate-admission.js.map +1 -0
  32. package/dist/device-token.d.ts +11 -11
  33. package/dist/device-token.js +14 -13
  34. package/dist/device-token.js.map +1 -1
  35. package/dist/ed25519-key.d.ts +26 -0
  36. package/dist/ed25519-key.js +56 -1
  37. package/dist/ed25519-key.js.map +1 -1
  38. package/dist/file-durable-slot.d.ts +20 -0
  39. package/dist/file-durable-slot.js +53 -0
  40. package/dist/file-durable-slot.js.map +1 -0
  41. package/dist/formation-approval.d.ts +157 -0
  42. package/dist/formation-approval.js +375 -0
  43. package/dist/formation-approval.js.map +1 -0
  44. package/dist/fs-atomic.d.ts +38 -0
  45. package/dist/fs-atomic.js +97 -0
  46. package/dist/fs-atomic.js.map +1 -0
  47. package/dist/identity-key.d.ts +49 -0
  48. package/dist/identity-key.js +81 -0
  49. package/dist/identity-key.js.map +1 -0
  50. package/dist/index.d.ts +16 -6
  51. package/dist/index.js +39 -5
  52. package/dist/index.js.map +1 -1
  53. package/dist/key-store-file.d.ts +2 -24
  54. package/dist/key-store-file.js +10 -77
  55. package/dist/key-store-file.js.map +1 -1
  56. package/dist/membership-connection-gater.d.ts +146 -0
  57. package/dist/membership-connection-gater.js +180 -0
  58. package/dist/membership-connection-gater.js.map +1 -0
  59. package/dist/node-local-snapshot.d.ts +109 -0
  60. package/dist/node-local-snapshot.js +182 -0
  61. package/dist/node-local-snapshot.js.map +1 -0
  62. package/dist/peer-authorization.d.ts +135 -18
  63. package/dist/peer-authorization.js +152 -21
  64. package/dist/peer-authorization.js.map +1 -1
  65. package/dist/peer-record.d.ts +21 -8
  66. package/dist/peer-record.js +26 -10
  67. package/dist/peer-record.js.map +1 -1
  68. package/dist/relay-addrs.d.ts +45 -0
  69. package/dist/relay-addrs.js +103 -0
  70. package/dist/relay-addrs.js.map +1 -0
  71. package/dist/relay-reservation.d.ts +266 -0
  72. package/dist/relay-reservation.js +613 -0
  73. package/dist/relay-reservation.js.map +1 -0
  74. package/dist/seed-bootstrap.d.ts +221 -56
  75. package/dist/seed-bootstrap.js +328 -188
  76. package/dist/seed-bootstrap.js.map +1 -1
  77. package/dist/seed-trust-policy.d.ts +47 -21
  78. package/dist/seed-trust-policy.js +24 -15
  79. package/dist/seed-trust-policy.js.map +1 -1
  80. package/dist/strand-addr-protocol.d.ts +42 -13
  81. package/dist/strand-addr-protocol.js +58 -52
  82. package/dist/strand-addr-protocol.js.map +1 -1
  83. package/dist/strand-backfill.d.ts +109 -0
  84. package/dist/strand-backfill.js +279 -0
  85. package/dist/strand-backfill.js.map +1 -0
  86. package/dist/strand-formation-manager.d.ts +38 -9
  87. package/dist/strand-formation-manager.js +120 -17
  88. package/dist/strand-formation-manager.js.map +1 -1
  89. package/dist/strand-formation-protocol.d.ts +103 -4
  90. package/dist/strand-formation-protocol.js +232 -4
  91. package/dist/strand-formation-protocol.js.map +1 -1
  92. package/dist/strand-instance-manager.d.ts +39 -1
  93. package/dist/strand-instance-manager.js +92 -14
  94. package/dist/strand-instance-manager.js.map +1 -1
  95. package/dist/strand-member-registry.d.ts +5 -5
  96. package/dist/strand-member-registry.js +18 -10
  97. package/dist/strand-member-registry.js.map +1 -1
  98. package/dist/strand-membership-writer.d.ts +482 -88
  99. package/dist/strand-membership-writer.js +757 -136
  100. package/dist/strand-membership-writer.js.map +1 -1
  101. package/dist/strand-solicitation.d.ts +99 -33
  102. package/dist/strand-solicitation.js +100 -52
  103. package/dist/strand-solicitation.js.map +1 -1
  104. package/dist/strand-transport-key.d.ts +40 -0
  105. package/dist/strand-transport-key.js +56 -0
  106. package/dist/strand-transport-key.js.map +1 -0
  107. package/dist/strand-wake-protocol.d.ts +9 -7
  108. package/dist/strand-wake-protocol.js +22 -46
  109. package/dist/strand-wake-protocol.js.map +1 -1
  110. package/dist/strand-watcher.d.ts +17 -2
  111. package/dist/strand-watcher.js +47 -3
  112. package/dist/strand-watcher.js.map +1 -1
  113. package/dist/trusted-owner-store-file.d.ts +12 -0
  114. package/dist/trusted-owner-store-file.js +39 -0
  115. package/dist/trusted-owner-store-file.js.map +1 -0
  116. package/dist/trusted-owner-store.d.ts +64 -0
  117. package/dist/trusted-owner-store.js +126 -0
  118. package/dist/trusted-owner-store.js.map +1 -0
  119. package/dist/types.d.ts +275 -20
  120. package/dist/types.js +13 -0
  121. package/dist/types.js.map +1 -1
  122. package/package.json +19 -8
  123. package/src/bootstrap-peer-store-file.ts +44 -0
  124. package/src/bootstrap-peer-store.ts +172 -0
  125. package/src/cadre-node.ts +1992 -202
  126. package/src/control-authorization.ts +114 -0
  127. package/src/control-database.ts +1704 -146
  128. package/src/control-formation-recorder.ts +172 -19
  129. package/src/control-schema.ts +786 -222
  130. package/src/control-stream.ts +81 -4
  131. package/src/control-write-retry.ts +473 -0
  132. package/src/delegate-admission.ts +302 -0
  133. package/src/device-token.ts +18 -13
  134. package/src/ed25519-key.ts +134 -69
  135. package/src/file-durable-slot.ts +61 -0
  136. package/src/formation-approval.ts +604 -0
  137. package/src/fs-atomic.ts +107 -0
  138. package/src/identity-key.ts +109 -0
  139. package/src/index.ts +136 -5
  140. package/src/key-store-file.ts +10 -81
  141. package/src/membership-connection-gater.ts +204 -0
  142. package/src/node-local-snapshot.ts +260 -0
  143. package/src/peer-authorization.ts +199 -21
  144. package/src/peer-record.ts +28 -10
  145. package/src/relay-addrs.ts +111 -0
  146. package/src/relay-reservation.ts +823 -0
  147. package/src/seed-bootstrap.ts +397 -197
  148. package/src/seed-trust-policy.ts +58 -25
  149. package/src/strand-addr-protocol.ts +84 -53
  150. package/src/strand-backfill.ts +366 -0
  151. package/src/strand-formation-manager.ts +145 -19
  152. package/src/strand-formation-protocol.ts +309 -8
  153. package/src/strand-instance-manager.ts +111 -14
  154. package/src/strand-member-registry.ts +18 -13
  155. package/src/strand-membership-writer.ts +1430 -640
  156. package/src/strand-solicitation.ts +155 -90
  157. package/src/strand-transport-key.ts +58 -0
  158. package/src/strand-wake-protocol.ts +29 -46
  159. package/src/strand-watcher.ts +66 -3
  160. package/src/trusted-owner-store-file.ts +41 -0
  161. package/src/trusted-owner-store.ts +171 -0
  162. package/src/types.ts +292 -21
@@ -0,0 +1,366 @@
1
+ import debug from 'debug';
2
+ import type { Connection, Libp2p, PeerId } from '@libp2p/interface';
3
+ import type { ActionId, IPeerNetwork } from '@optimystic/db-core';
4
+ import { BlockTransferClient, type IRawStorage } from '@optimystic/db-p2p';
5
+
6
+ // NOTE: this copies the WHOLE local store to every newly connected strand peer, which is
7
+ // right while a strand mesh is one party's handful of machines (see docs/architecture.md →
8
+ // Replication cluster size, "On a strand, the machine count is not a party count"). If
9
+ // strand meshes ever get large, filter the pushed set by FRET cohort responsibility for
10
+ // each block id instead of pushing everything.
11
+ //
12
+ // NOTE: this lives in cadre-core only because `../optimystic` is read-only from this repo.
13
+ // If Optimystic ever grows a cohort-join catch-up of its own, delete this module rather
14
+ // than running two.
15
+ //
16
+ // Membership: anything connected on the strand's own libp2p network already receives
17
+ // cohort replicas of new commits, so pushing older blocks to it exposes nothing new. No
18
+ // membership gate here — adding one would diverge from what ordinary replication already
19
+ // does on this network. A peer that does NOT speak this strand's block-transfer protocol
20
+ // (a bare circuit relay or bootstrap node the strand node also connects to) cannot receive
21
+ // anything: the protocol id is namespaced per strand, so the dial fails and the push is
22
+ // dropped.
23
+ //
24
+ // NOTE: that failing case costs one dial timeout per connection:open from such a peer, and
25
+ // is never memoized (only clean runs are). Bounded today by the debounce plus the
26
+ // unreachable-peer bail in `runCatchUp` — one dial per event, not one per chunk. If a strand
27
+ // node ever holds many non-strand connections, or the enumeration ahead of the first chunk
28
+ // gets expensive, pre-check `libp2p.peerStore` for this strand's block-transfer protocol
29
+ // before enumerating.
30
+ //
31
+ // NOTE: a run that fails is retried only when that peer next opens a connection. Over a
32
+ // stable connection a transient push failure therefore leaves the peer partially copied
33
+ // until the next reconnect (read repair still covers reads meanwhile). If strand meshes
34
+ // ever hold long-lived connections where that matters, re-arm the debounce timer with a
35
+ // backoff on a non-clean run instead of waiting for connection:open.
36
+
37
+ const log = debug('sereus:cadre:strand-backfill');
38
+
39
+ /**
40
+ * The block-transfer protocol's hard cap on one length-prefixed message. Mirrors
41
+ * `MAX_BLOCK_MESSAGE_BYTES` in `@optimystic/db-p2p`'s `protocol-limits.ts` (8 MiB), which
42
+ * that package does not re-export from its index — keep the two in sync if upstream ever
43
+ * changes it or starts exporting it.
44
+ */
45
+ export const MAX_BLOCK_MESSAGE_BYTES = 8 * 1024 * 1024;
46
+
47
+ /** Tuning for the per-peer strand catch-up. Every field optional; defaults in {@link DEFAULT_STRAND_BACKFILL}. */
48
+ export interface StrandBackfillConfig {
49
+ /** Default true. False disables the catch-up entirely (the pre-existing behaviour). */
50
+ enabled?: boolean;
51
+ /** Settle time after a connection opens before catching that peer up, ms. Default 1000. */
52
+ debounceMs?: number;
53
+ /** Ceiling on blocks copied in one catch-up. Default 10_000. Reaching it is LOGGED, never silent. */
54
+ maxBlocks?: number;
55
+ /** Soft byte budget per push message. Default 1 MiB. Protocol hard cap is {@link MAX_BLOCK_MESSAGE_BYTES} (8 MiB). */
56
+ maxChunkBytes?: number;
57
+ /** Max blocks per push message. Default 64. */
58
+ maxChunkBlocks?: number;
59
+ /** Per-push dial deadline, ms. Default 3000 (matches SpreadOnChurnMonitor). */
60
+ dialTimeoutMs?: number;
61
+ /** Per-push response deadline, ms. Default 10_000 (matches SpreadOnChurnMonitor). */
62
+ responseTimeoutMs?: number;
63
+ }
64
+
65
+ /** The resolved defaults every {@link StrandBackfill} starts from. */
66
+ export const DEFAULT_STRAND_BACKFILL: Required<StrandBackfillConfig> = {
67
+ enabled: true,
68
+ debounceMs: 1000,
69
+ maxBlocks: 10_000,
70
+ maxChunkBytes: 1024 * 1024,
71
+ maxChunkBlocks: 64,
72
+ dialTimeoutMs: 3000,
73
+ responseTimeoutMs: 10_000
74
+ };
75
+
76
+ /**
77
+ * The one capability the catch-up needs from a transfer client. Structural (rather than
78
+ * the concrete `BlockTransferClient`) so unit tests can capture pushes without dialing
79
+ * libp2p — see {@link StrandBackfillDeps.createPushClient}.
80
+ */
81
+ export type StrandBackfillPushClient = Pick<BlockTransferClient, 'pushBlocks'>;
82
+
83
+ export interface StrandBackfillDeps {
84
+ strandId: string;
85
+ /** The STRAND's libp2p node (not the control node) — source of connection events and peer ids. */
86
+ libp2p: Libp2p;
87
+ /** `node.keyNetwork`, the IPeerNetwork BlockTransferClient dials through. */
88
+ peerNetwork: IPeerNetwork;
89
+ /** This strand's own raw block store — the same instance handed to the libp2p node. */
90
+ storage: IRawStorage;
91
+ /** Must equal the prefix the receiver registered its handler under: `/optimystic/strand-<strandId>`. */
92
+ protocolPrefix: string;
93
+ /**
94
+ * Test seam: build the per-peer push client. Defaults to a real
95
+ * `BlockTransferClient` over {@link peerNetwork} + {@link protocolPrefix}.
96
+ */
97
+ createPushClient?: (peerId: PeerId) => StrandBackfillPushClient;
98
+ }
99
+
100
+ /** What one peer's catch-up actually did. Returned for tests and logged at the end of each run. */
101
+ export interface StrandBackfillResult {
102
+ /** Blocks offered: had a committed `latest` AND materialized content locally. */
103
+ offered: number;
104
+ /** Blocks the remote reported it persisted. */
105
+ accepted: number;
106
+ /** Block ids the remote reported in `missing` (parse or persist failure on its side). */
107
+ rejected: string[];
108
+ /** Skipped: metadata has no `latest` (pending-only — not yet a durability claim here). */
109
+ uncommitted: number;
110
+ /** Skipped: `latest` exists but no materialized block is stored for that actionId. */
111
+ unmaterialized: number;
112
+ /** Not attempted because `maxBlocks` was reached. */
113
+ capped: number;
114
+ /** Skipped: a single block whose wire size alone exceeds {@link MAX_BLOCK_MESSAGE_BYTES}. */
115
+ oversized: string[];
116
+ }
117
+
118
+ function emptyResult(): StrandBackfillResult {
119
+ return { offered: 0, accepted: 0, rejected: [], uncommitted: 0, unmaterialized: 0, capped: 0, oversized: [] };
120
+ }
121
+
122
+ /** One in-flight push message being accumulated. */
123
+ interface Chunk {
124
+ ids: string[];
125
+ buffers: Uint8Array[];
126
+ meta: Record<string, { rev: number; actionId: ActionId }>;
127
+ bytes: number;
128
+ }
129
+
130
+ /**
131
+ * Base64 wire size of a raw buffer — `pushBlocks` base64-encodes each block into the JSON
132
+ * request, so the protocol cap must be judged against the encoded size, not the raw bytes.
133
+ */
134
+ function base64WireBytes(rawBytes: number): number {
135
+ return Math.ceil(rawBytes / 3) * 4;
136
+ }
137
+
138
+ /**
139
+ * Copies every block in one strand's own raw store to each peer its libp2p node connects
140
+ * to, so a peer that joined the strand after blocks were committed still ends up holding
141
+ * them physically (the receiver persists each push via `saveReplicatedBlock`, which is
142
+ * monotonic and idempotent — crossing pushes from both ends cannot regress a revision).
143
+ *
144
+ * Best-effort throughout: nothing here throws into a libp2p event handler or into
145
+ * `buildStrandRuntime`; a failed chunk is logged and the run continues. A peer is marked
146
+ * fully caught up ONLY after a run with no thrown chunk and an empty `missing` list, so
147
+ * the next `connection:open` from a peer whose catch-up failed retries it.
148
+ */
149
+ export class StrandBackfill {
150
+ private readonly config: Required<StrandBackfillConfig>;
151
+ private readonly createPushClient: (peerId: PeerId) => StrandBackfillPushClient;
152
+ private started = false;
153
+ private stopped = false;
154
+ /** Peers fully caught up this runtime (never retried until the runtime is rebuilt). */
155
+ private readonly done = new Set<string>();
156
+ /** Peers with a catch-up currently running (suppresses concurrent duplicates). */
157
+ private readonly inFlight = new Set<string>();
158
+ /** Pending per-peer debounce timers, cleared on stop. */
159
+ private readonly timers = new Map<string, ReturnType<typeof setTimeout>>();
160
+ private readonly onConnectionOpen: (evt: CustomEvent<Connection>) => void;
161
+ private loggedNoListBlockIds = false;
162
+
163
+ constructor(private readonly deps: StrandBackfillDeps, config?: StrandBackfillConfig) {
164
+ this.config = { ...DEFAULT_STRAND_BACKFILL, ...config };
165
+ this.createPushClient = deps.createPushClient
166
+ ?? ((peerId) => new BlockTransferClient(peerId, deps.peerNetwork, deps.protocolPrefix));
167
+ this.onConnectionOpen = (evt) => this.schedulePeer(evt.detail.remotePeer);
168
+ }
169
+
170
+ /** Subscribe to connection:open AND schedule a catch-up for peers already connected. */
171
+ start(): void {
172
+ if (this.started || this.stopped || !this.config.enabled) return;
173
+ this.started = true;
174
+ this.deps.libp2p.addEventListener('connection:open', this.onConnectionOpen);
175
+ // A runtime rebuilt over live connections (resumeStrand) never sees their
176
+ // connection:open, so walk what is already connected once.
177
+ const existing = this.deps.libp2p.getConnections();
178
+ for (const connection of existing) {
179
+ this.schedulePeer(connection.remotePeer);
180
+ }
181
+ log('[%s] started (%d peer(s) already connected)', this.deps.strandId, existing.length);
182
+ }
183
+
184
+ /** Unsubscribe, clear timers; in-flight runs observe the stopped flag and bail. */
185
+ stop(): void {
186
+ if (this.stopped) return;
187
+ this.stopped = true;
188
+ if (this.started) {
189
+ this.deps.libp2p.removeEventListener('connection:open', this.onConnectionOpen);
190
+ }
191
+ for (const timer of this.timers.values()) {
192
+ clearTimeout(timer);
193
+ }
194
+ this.timers.clear();
195
+ log('[%s] stopped', this.deps.strandId);
196
+ }
197
+
198
+ /** Debounced entry point for connection churn: one run per peer per settle window. */
199
+ private schedulePeer(peerId: PeerId): void {
200
+ const key = peerId.toString();
201
+ if (this.stopped || this.done.has(key) || this.inFlight.has(key)) return;
202
+ const existing = this.timers.get(key);
203
+ if (existing) clearTimeout(existing);
204
+ this.timers.set(key, setTimeout(() => {
205
+ this.timers.delete(key);
206
+ void this.catchUpPeer(peerId);
207
+ }, this.config.debounceMs));
208
+ }
209
+
210
+ /**
211
+ * Run one peer's catch-up now, bypassing the debounce. Never rejects. Returns an
212
+ * all-zero result without pushing when the peer is already caught up, already being
213
+ * caught up, or this backfill is stopped.
214
+ */
215
+ async catchUpPeer(peerId: PeerId): Promise<StrandBackfillResult> {
216
+ const key = peerId.toString();
217
+ if (this.stopped || this.done.has(key) || this.inFlight.has(key)) {
218
+ return emptyResult();
219
+ }
220
+ this.inFlight.add(key);
221
+ try {
222
+ const { result, clean } = await this.runCatchUp(peerId);
223
+ // NOTE: a run that hit `maxBlocks` is still "clean" and still memoizes the peer, so
224
+ // the tail past the ceiling never reaches it. Deliberate: enumeration is not
225
+ // resumable, so not memoizing would re-push the same prefix on every reconnect
226
+ // without ever advancing. Loud in the log below (capped > 0). If a strand's store can
227
+ // realistically exceed maxBlocks, the fix is a resumable cursor, not either policy.
228
+ if (clean && !this.stopped) {
229
+ this.done.add(key);
230
+ }
231
+ log('[%s] catch-up peer=%s offered=%d accepted=%d rejected=%d uncommitted=%d unmaterialized=%d capped=%d oversized=%d done=%s',
232
+ this.deps.strandId, key, result.offered, result.accepted, result.rejected.length,
233
+ result.uncommitted, result.unmaterialized, result.capped, result.oversized.length, clean);
234
+ return result;
235
+ } catch (error) {
236
+ // runCatchUp already contains a per-chunk catch; this guards the enumeration and
237
+ // metadata reads too — a backfill fault must never surface through a libp2p event.
238
+ log('[%s] catch-up peer=%s failed: %o', this.deps.strandId, key, error);
239
+ return emptyResult();
240
+ } finally {
241
+ this.inFlight.delete(key);
242
+ }
243
+ }
244
+
245
+ /** The actual copy. `clean` = every chunk pushed and the remote persisted every block. */
246
+ private async runCatchUp(peerId: PeerId): Promise<{ result: StrandBackfillResult; clean: boolean }> {
247
+ const result = emptyResult();
248
+ const { storage } = this.deps;
249
+
250
+ if (!storage.listBlockIds) {
251
+ if (!this.loggedNoListBlockIds) {
252
+ this.loggedNoListBlockIds = true;
253
+ log('[%s] raw storage does not implement listBlockIds(); backfill is inert', this.deps.strandId);
254
+ }
255
+ return { result, clean: false };
256
+ }
257
+
258
+ const client = this.createPushClient(peerId);
259
+ const encoder = new TextEncoder();
260
+ let chunk: Chunk = { ids: [], buffers: [], meta: {}, bytes: 0 };
261
+ let chunkFailed = false;
262
+ let anyChunkDelivered = false;
263
+ /**
264
+ * A peer that has answered no push at all, and failed one, is not reachable on this
265
+ * protocol — abandon rather than spend a dial timeout per remaining chunk. Once ONE
266
+ * push has been answered the peer demonstrably speaks it, so a later failure is a
267
+ * transient blip and the rest of the store is still worth pushing.
268
+ */
269
+ const peerUnreachable = (): boolean => chunkFailed && !anyChunkDelivered;
270
+
271
+ const flush = async (): Promise<void> => {
272
+ if (chunk.ids.length === 0) return;
273
+ const { ids, buffers, meta } = chunk;
274
+ chunk = { ids: [], buffers: [], meta: {}, bytes: 0 };
275
+ try {
276
+ const response = await client.pushBlocks(ids, buffers, 'replication', meta, {
277
+ dialTimeoutMs: this.config.dialTimeoutMs,
278
+ responseTimeoutMs: this.config.responseTimeoutMs
279
+ });
280
+ anyChunkDelivered = true;
281
+ const missing = new Set(response.missing);
282
+ for (const id of ids) {
283
+ if (missing.has(id)) {
284
+ result.rejected.push(id);
285
+ } else {
286
+ result.accepted += 1;
287
+ }
288
+ }
289
+ if (response.missing.length > 0) {
290
+ log('[%s] peer=%s rejected %d block(s): %o', this.deps.strandId, peerId.toString(), response.missing.length, response.missing);
291
+ }
292
+ } catch (error) {
293
+ chunkFailed = true;
294
+ log('[%s] push to peer=%s failed for %d block(s): %s', this.deps.strandId, peerId.toString(), ids.length, (error as Error).message);
295
+ }
296
+ };
297
+
298
+ for await (const blockId of storage.listBlockIds()) {
299
+ if (this.stopped) break;
300
+ if (result.offered >= this.config.maxBlocks) {
301
+ // Past the ceiling: count what is left (id enumeration only — no more reads or
302
+ // pushes) so the cap is loud in the end-of-run log rather than silent.
303
+ result.capped += 1;
304
+ continue;
305
+ }
306
+
307
+ const metadata = await storage.getMetadata(blockId);
308
+ const latest = metadata?.latest;
309
+ if (!latest) {
310
+ result.uncommitted += 1;
311
+ continue;
312
+ }
313
+ // NOTE: a block whose latest revision is a DELETE materializes to nothing (a
314
+ // tombstone), so it is skipped here — a peer that joins after such a delete never
315
+ // receives the tombstone from this path and relies on read repair for it. Fine
316
+ // while nothing deletes whole blocks pre-join; if the whole-store coverage gate in
317
+ // strand-membership-closed-strand-e2e ever reports a tombstone residue, teach this
318
+ // to push the promoted delete transform instead of skipping.
319
+ const block = await storage.getMaterializedBlock(blockId, latest.actionId);
320
+ if (!block) {
321
+ result.unmaterialized += 1;
322
+ log('[%s] block=%s has latest rev %d but no materialized content; skipped', this.deps.strandId, blockId, latest.rev);
323
+ continue;
324
+ }
325
+
326
+ const buffer = encoder.encode(JSON.stringify(block));
327
+ // NOTE: MAX_BLOCK_MESSAGE_BYTES caps the whole framed request, not one block, and
328
+ // this test ignores the request envelope (ids array, blockMeta, JSON punctuation).
329
+ // A lone block within a few KiB of the cap therefore still ships and is rejected by
330
+ // the receiver's length-prefix decoder — a permanent chunk failure for that peer. No
331
+ // block in a strand comes close today; if one ever can, subtract a measured envelope
332
+ // allowance here rather than raising the cap.
333
+ if (base64WireBytes(buffer.length) >= MAX_BLOCK_MESSAGE_BYTES) {
334
+ result.oversized.push(blockId);
335
+ log('[%s] block=%s is %d bytes (%d on the wire) — exceeds the %d-byte protocol cap alone; skipped',
336
+ this.deps.strandId, blockId, buffer.length, base64WireBytes(buffer.length), MAX_BLOCK_MESSAGE_BYTES);
337
+ continue;
338
+ }
339
+
340
+ // Flush before adding when this block would overflow either budget. A single block
341
+ // larger than maxChunkBytes still ships — alone, in its own chunk.
342
+ if (chunk.ids.length > 0
343
+ && (chunk.ids.length + 1 > this.config.maxChunkBlocks || chunk.bytes + buffer.length > this.config.maxChunkBytes)) {
344
+ await flush();
345
+ if (this.stopped || peerUnreachable()) break;
346
+ }
347
+ chunk.ids.push(blockId);
348
+ chunk.buffers.push(buffer);
349
+ chunk.meta[blockId] = { rev: latest.rev, actionId: latest.actionId };
350
+ chunk.bytes += buffer.length;
351
+ result.offered += 1;
352
+ }
353
+
354
+ if (!this.stopped && !peerUnreachable()) {
355
+ await flush();
356
+ }
357
+
358
+ if (result.capped > 0) {
359
+ log('[%s] peer=%s catch-up CAPPED at %d blocks; %d block id(s) not attempted',
360
+ this.deps.strandId, peerId.toString(), this.config.maxBlocks, result.capped);
361
+ }
362
+
363
+ const clean = !chunkFailed && result.rejected.length === 0;
364
+ return { result, clean };
365
+ }
366
+ }
@@ -1,10 +1,18 @@
1
1
  import debug from 'debug';
2
+ import { fromString as uint8ArrayFromString } from 'uint8arrays';
2
3
  import type { Libp2p } from '@libp2p/interface';
3
4
  import type {
4
5
  OpenInvitation,
5
6
  FormStrandResult,
6
7
  StrandFormationDisclosure
7
8
  } from './types.js';
9
+ import {
10
+ FormationApprovalError,
11
+ type FormationApprovalFailure
12
+ } from './formation-approval.js';
13
+ // control-database does not import this manager, so this import introduces no cycle.
14
+ import { FormationAbortedError, InvitationExhaustedError } from './control-database.js';
15
+ import { canonicalJson } from './canonical-json.js';
8
16
  import type {
9
17
  DisclosureValidator,
10
18
  FormationUsageRecorder,
@@ -14,6 +22,8 @@ import type {
14
22
  } from './strand-solicitation.js';
15
23
  import {
16
24
  FormationListener,
25
+ INVALID_TOKEN_REASON,
26
+ PROVISION_RESPONSE_TRAVEL_MARGIN_MS,
17
27
  dialFormation,
18
28
  isValidResponderCreatesResult,
19
29
  type FormationContactMessage,
@@ -24,6 +34,28 @@ import {
24
34
 
25
35
  const log = debug('sereus:cadre:formation-manager');
26
36
 
37
+ /**
38
+ * Largest serialized disclosure a responder will accept (8 KiB). The disclosure is
39
+ * attacker-influenced text destined for a replicated table (`FormationUsage.Disclosure`)
40
+ * and for the approval hook's signed digest — the cap bounds both, and is enforced BEFORE
41
+ * any database read or hook contact so an oversized blob costs nothing downstream.
42
+ */
43
+ const MAX_DISCLOSURE_BYTES = 8 * 1024;
44
+
45
+ /**
46
+ * Rejection reason a would-be joiner is told for each approval-failure category
47
+ * (see {@link FormationApprovalFailure}). Distinct per category on purpose: mapping any
48
+ * of these onto the generic 'Formation conflict, retry' would tell an operator to retry
49
+ * what retrying can never fix (e.g. a non-enrolled validation key).
50
+ */
51
+ const APPROVAL_REJECTION_REASONS: Record<FormationApprovalFailure, string> = {
52
+ refused: 'Formation approval refused',
53
+ unavailable: 'Formation approval unavailable, retry',
54
+ malformed: 'Formation approval invalid',
55
+ unenrolled: 'Formation approval key is not enrolled',
56
+ misconfigured: 'Formation approval misconfigured'
57
+ };
58
+
27
59
  /**
28
60
  * Configuration for StrandFormationManager
29
61
  */
@@ -32,6 +64,14 @@ export interface StrandFormationManagerConfig {
32
64
  sessionTimeoutMs?: number;
33
65
  /** Step timeout in milliseconds */
34
66
  stepTimeoutMs?: number;
67
+ /**
68
+ * Provisioning budget in milliseconds for the RESPONDER's `provisionStrand` hook call.
69
+ * The initiator's `await-response` wait is derived automatically from this value plus
70
+ * `PROVISION_RESPONSE_TRAVEL_MARGIN_MS` (`strand-formation-protocol.ts`) — never set
71
+ * directly — so the ordering documented there (approval hook < responder provisioning <
72
+ * initiator await-response < session) cannot collapse when this is configured.
73
+ */
74
+ provisionTimeoutMs?: number;
35
75
  /** Maximum concurrent sessions */
36
76
  maxConcurrentSessions?: number;
37
77
  /** Enable debug logging */
@@ -97,11 +137,12 @@ export class StrandFormationManager {
97
137
  this.listener = new FormationListener({
98
138
  validateToken: (token) => this.validateToken(token),
99
139
  validateDisclosure: (token, disclosure) => this.validateDisclosure(token, disclosure),
100
- provisionStrand: (token, initiatorPartyId, disclosure) =>
101
- this.provisionAsResponder(token, initiatorPartyId, disclosure),
140
+ provisionStrand: (contact, signal) =>
141
+ this.provisionAsResponder(contact, signal),
102
142
  getResponderIdentity: () => ({ partyId: this.partyId, cadrePeerAddrs: this.cadrePeerAddrs }),
103
143
  sessionTimeoutMs: this.config.sessionTimeoutMs,
104
144
  stepTimeoutMs: this.config.stepTimeoutMs,
145
+ provisionTimeoutMs: this.config.provisionTimeoutMs,
105
146
  maxConcurrentSessions: this.config.maxConcurrentSessions
106
147
  });
107
148
 
@@ -138,12 +179,15 @@ export class StrandFormationManager {
138
179
  * Form a strand with a responder via an open invitation (initiator side).
139
180
  *
140
181
  * Builds a contact message carrying the real token + disclosure + this party's
141
- * real cadre addresses, dials the responder over the native protocol, and
142
- * validates the responder's result before returning.
182
+ * real cadre addresses + the joiner's consent (minted and signed by the
183
+ * solicitation layer — this manager only places it on the contact), dials the
184
+ * responder over the native protocol, and validates the responder's result
185
+ * before returning.
143
186
  */
144
187
  async formStrand(
145
188
  invitation: OpenInvitation,
146
189
  disclosure: StrandFormationDisclosure,
190
+ consent: { peerKey: string; usageStampId: string; peerSignature: string },
147
191
  node: Libp2p
148
192
  ): Promise<FormStrandResult> {
149
193
  log('Forming strand with invitation token: %s', invitation.token);
@@ -151,6 +195,9 @@ export class StrandFormationManager {
151
195
  const contact: FormationContactMessage = {
152
196
  token: invitation.token,
153
197
  partyId: disclosure.partyId ?? this.partyId,
198
+ peerKey: consent.peerKey,
199
+ usageStampId: consent.usageStampId,
200
+ peerSignature: consent.peerSignature,
154
201
  disclosure,
155
202
  cadrePeerAddrs: this.cadrePeerAddrs
156
203
  };
@@ -163,6 +210,7 @@ export class StrandFormationManager {
163
210
  validateResponse: (response) => this.validateResponse(invitation, disclosure, response),
164
211
  sessionTimeoutMs: this.config.sessionTimeoutMs,
165
212
  stepTimeoutMs: this.config.stepTimeoutMs,
213
+ provisionTimeoutMs: this.initiatorProvisionTimeoutMs(),
166
214
  protocolId: this.config.protocolId
167
215
  });
168
216
 
@@ -189,6 +237,20 @@ export class StrandFormationManager {
189
237
  return { listeners: this.listener.activeCount, dialers: this.dialerSessions };
190
238
  }
191
239
 
240
+ /**
241
+ * Derive the initiator's await-response budget from the configured RESPONDER budget —
242
+ * never the same number (see `StrandFormationManagerConfig.provisionTimeoutMs`). Mirrors
243
+ * `resolveProvisionTimeoutMs`'s own "`0`/negative means unset" rule so an unset config
244
+ * still lets both sides fall back to their own independent defaults; must NOT hardcode
245
+ * `DEFAULT_PROVISION_TIMEOUT_MS` here, or the per-role clamping downstream is defeated.
246
+ * A value too large for the session is clamped per role, and the responder's ceiling holds
247
+ * the same margin back, so the ordering survives there too.
248
+ */
249
+ private initiatorProvisionTimeoutMs(): number | undefined {
250
+ const host = this.config.provisionTimeoutMs;
251
+ return host && host > 0 ? host + PROVISION_RESPONSE_TRAVEL_MARGIN_MS : undefined;
252
+ }
253
+
192
254
  // ── Responder-side hooks ─────────────────────────────────────────────────────
193
255
 
194
256
  private async validateToken(token: string): Promise<{ valid: boolean }> {
@@ -234,18 +296,33 @@ export class StrandFormationManager {
234
296
  * deferred `StrandExists` CHECK at commit and drop the frame.
235
297
  * - **unbound** (no binding): the responder-provisions fallback — see {@link provisionUnbound}.
236
298
  *
237
- * Defense-in-depth: known provisioning/redeem failures (notably the concurrent
238
- * `(Token, UseNumber)` PK collision when two redemptions of one unbound single-use invite
239
- * race) are caught and mapped to a logged, retry-suggesting rejection rather than a thrown
240
- * insert + a silently-closed stream. The LOG-before-reject keeps this a deliberate
241
- * internal-error→protocol-rejection conversion (AGENTS.md: don't eat exceptions silently),
242
- * not control-flow-by-exception.
299
+ * Defense-in-depth: known provisioning/redeem failures are caught and mapped to a logged
300
+ * protocol rejection rather than a thrown insert + a silently-closed stream. The mapping is
301
+ * per-failure, NOT blanket retry-suggesting: an exhausted invitation
302
+ * ({@link InvitationExhaustedError}, raised by `ControlDatabase` whenever a redemption's use
303
+ * number is past the invite's seat budget — including a first attempt racing another
304
+ * redemption of the same token on this node, not only a retry) is reported as `'Invalid
305
+ * token'`, because retrying it can never succeed. The
306
+ * `(Token, UseNumber)` PK collision that concurrent redemptions of one invite used to
307
+ * surface here is now retried a layer down and no longer reaches this method. The
308
+ * LOG-before-reject keeps this a deliberate internal-error→protocol-rejection conversion
309
+ * (AGENTS.md: don't eat exceptions silently), not control-flow-by-exception.
243
310
  */
244
311
  private async provisionAsResponder(
245
- token: string,
246
- initiatorPartyId: string,
247
- _disclosure: StrandFormationDisclosure
312
+ contact: FormationContactMessage,
313
+ signal?: AbortSignal
248
314
  ): Promise<ResponderProvisionOutcome> {
315
+ const token = contact.token;
316
+ // CANONICALLY serialized — both sides derive the identical string: this is the exact
317
+ // text the joiner signed (consent), the approver signs (vouch), and the recorder writes
318
+ // to `FormationUsage.Disclosure` — a re-serialization anywhere below would break the
319
+ // signature-over-stored-bytes invariant.
320
+ const disclosureText = canonicalJson(contact.disclosure);
321
+ if (uint8ArrayFromString(disclosureText, 'utf8').byteLength > MAX_DISCLOSURE_BYTES) {
322
+ log('Disclosure over %d bytes; rejecting token %s', MAX_DISCLOSURE_BYTES, token);
323
+ return { approved: false, reason: 'Disclosure too large' };
324
+ }
325
+
249
326
  const recorder = this.formationUsageRecorder;
250
327
  const resolved: ResolvedHostStrand = recorder?.resolveStrand
251
328
  ? await recorder.resolveStrand(token)
@@ -255,7 +332,15 @@ export class StrandFormationManager {
255
332
  switch (resolved.kind) {
256
333
  case 'bound': {
257
334
  // recorder is guaranteed non-null here: only resolveStrand can yield 'bound'.
258
- await recorder!.recordUsage(token, initiatorPartyId, resolved.strandId);
335
+ await recorder!.recordUsage({
336
+ token,
337
+ peerKey: contact.peerKey,
338
+ peerSignature: contact.peerSignature,
339
+ usageStampId: contact.usageStampId,
340
+ strandId: resolved.strandId,
341
+ disclosure: disclosureText,
342
+ signal
343
+ });
259
344
  return this.approve({
260
345
  strand: { strandId: resolved.strandId, createdBy: 'responder' },
261
346
  memberPrivateKey: resolved.memberPrivateKey ?? undefined,
@@ -267,9 +352,40 @@ export class StrandFormationManager {
267
352
  return { approved: false, reason: 'Host strand not yet available on this responder' };
268
353
  }
269
354
  case 'unbound':
270
- return await this.provisionUnbound(token, initiatorPartyId);
355
+ return await this.provisionUnbound(contact, disclosureText, signal);
271
356
  }
272
357
  } catch (err) {
358
+ if (err instanceof FormationAbortedError) {
359
+ // The listener's timeout path owns the reply for an abandoned provisioning; mapping
360
+ // this onto 'Formation conflict, retry' would misreport it as a conflict.
361
+ throw err;
362
+ }
363
+ if (err instanceof FormationApprovalError) {
364
+ log('approval failed (%s) for token %s: %o', err.failure, token, err);
365
+ return { approved: false, reason: APPROVAL_REJECTION_REASONS[err.failure] };
366
+ }
367
+ if (err instanceof InvitationExhaustedError) {
368
+ // Shares `INVALID_TOKEN_REASON` with the up-front `validateToken` rejection so the loser
369
+ // of the race that exposed the spent invite — same-node, first attempt, or a retry that
370
+ // ran out — sees exactly what a non-racing latecomer sees. No wire-visible distinction between "invalid" and "exhausted" — the
371
+ // operator signal lives in this log line instead.
372
+ // NOTE: if a joining client ever has to tell "never valid" from "used up" WITHOUT node
373
+ // logs, that is a new protocol reason string, not a local change here.
374
+ log(
375
+ 'invitation exhausted for token %s: use #%d past limit of %d',
376
+ err.token,
377
+ err.useNumber,
378
+ err.totalUses
379
+ );
380
+ return { approved: false, reason: INVALID_TOKEN_REASON };
381
+ }
382
+ // An approval obtained before landing here is RETRIED, not discarded: the database
383
+ // layer re-presents the same approver sign-off under a fresh use number when it loses
384
+ // one to a writer its local write queue does not serialize — another node of the cadre,
385
+ // another `Database` handle over the same store (see
386
+ // `ControlDatabase.withUseNumberRetry`). Reaching this catch-all means either that retry
387
+ // ran out (surfaced above as `InvitationExhaustedError`) or the failure was never
388
+ // retryable to begin with.
273
389
  log('provisionAsResponder failed for token %s: %o', token, err);
274
390
  return { approved: false, reason: 'Formation conflict, retry' };
275
391
  }
@@ -297,13 +413,23 @@ export class StrandFormationManager {
297
413
  * at all?" question lives in backlog `formation-initiatorcreates-cover-or-remove`.
298
414
  */
299
415
  private async provisionUnbound(
300
- token: string,
301
- initiatorPartyId: string
416
+ contact: FormationContactMessage,
417
+ disclosureText: string,
418
+ signal?: AbortSignal
302
419
  ): Promise<ResponderProvisionOutcome> {
420
+ const token = contact.token;
303
421
  const recorder = this.formationUsageRecorder;
304
422
  if (recorder?.provisionAndRecord) {
305
423
  const sAppId = await this.resolveInviteSAppId(token);
306
- const provisioned = await recorder.provisionAndRecord(token, initiatorPartyId, sAppId);
424
+ const provisioned = await recorder.provisionAndRecord({
425
+ token,
426
+ peerKey: contact.peerKey,
427
+ peerSignature: contact.peerSignature,
428
+ usageStampId: contact.usageStampId,
429
+ sAppId,
430
+ disclosure: disclosureText,
431
+ signal
432
+ });
307
433
  return this.approve({
308
434
  strand: { strandId: provisioned.strandId, createdBy: 'responder' },
309
435
  memberPrivateKey: provisioned.memberPrivateKey ?? undefined,
@@ -313,7 +439,7 @@ export class StrandFormationManager {
313
439
 
314
440
  if (this.strandProvisioner) {
315
441
  const sAppId = await this.resolveInviteSAppId(token);
316
- const result = await this.strandProvisioner.provisionStrand(sAppId, initiatorPartyId, this.partyId);
442
+ const result = await this.strandProvisioner.provisionStrand(sAppId, contact.partyId, this.partyId);
317
443
  return this.approve({
318
444
  strand: { strandId: result.strandId, createdBy: 'responder' },
319
445
  dbConnectionInfo: { endpoint: 'local', credentialsRef: '' }