@serfab/cadre-core 1.16.0 → 1.17.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.
- package/README.md +1 -1
- package/dist/bootstrap-peer-store-file.js +1 -1
- package/dist/bootstrap-peer-store.d.ts +1 -1
- package/dist/bootstrap-peer-store.js +4 -4
- package/dist/cadre-invite-protocol.d.ts +55 -138
- package/dist/cadre-invite-protocol.js +94 -449
- package/dist/cadre-invite-protocol.js.map +1 -1
- package/dist/cadre-join-request.d.ts +15 -2
- package/dist/cadre-join-request.js +22 -3
- package/dist/cadre-join-request.js.map +1 -1
- package/dist/cadre-node.d.ts +530 -247
- package/dist/cadre-node.js +1046 -525
- package/dist/cadre-node.js.map +1 -1
- package/dist/control-authorization.d.ts +36 -14
- package/dist/control-authorization.js +20 -3
- package/dist/control-authorization.js.map +1 -1
- package/dist/control-cohort.d.ts +22 -23
- package/dist/control-cohort.js +24 -24
- package/dist/control-cohort.js.map +1 -1
- package/dist/control-database.d.ts +416 -136
- package/dist/control-database.js +757 -378
- package/dist/control-database.js.map +1 -1
- package/dist/control-protocol-guard.d.ts +5 -4
- package/dist/control-protocol-guard.js +6 -3
- package/dist/control-protocol-guard.js.map +1 -1
- package/dist/control-schema-version.d.ts +80 -0
- package/dist/control-schema-version.js +203 -0
- package/dist/control-schema-version.js.map +1 -0
- package/dist/control-schema.d.ts +45 -5
- package/dist/control-schema.js +254 -70
- package/dist/control-schema.js.map +1 -1
- package/dist/control-write-retry.d.ts +5 -5
- package/dist/control-write-retry.js +10 -8
- package/dist/control-write-retry.js.map +1 -1
- package/dist/delegate-admission.d.ts +13 -0
- package/dist/delegate-admission.js +27 -0
- package/dist/delegate-admission.js.map +1 -1
- package/dist/ed25519-key.d.ts +10 -7
- package/dist/ed25519-key.js +23 -20
- package/dist/ed25519-key.js.map +1 -1
- package/dist/edge-node/config.d.ts +122 -0
- package/dist/edge-node/config.js +199 -0
- package/dist/edge-node/config.js.map +1 -0
- package/dist/edge-node/dissolve.d.ts +95 -0
- package/dist/edge-node/dissolve.js +184 -0
- package/dist/edge-node/dissolve.js.map +1 -0
- package/dist/edge-node/edge-join.d.ts +44 -0
- package/dist/edge-node/edge-join.js +227 -0
- package/dist/edge-node/edge-join.js.map +1 -0
- package/dist/edge-node/edge-node.d.ts +295 -0
- package/dist/edge-node/edge-node.js +704 -0
- package/dist/edge-node/edge-node.js.map +1 -0
- package/dist/edge-node/index.d.ts +18 -0
- package/dist/edge-node/index.js +18 -0
- package/dist/edge-node/index.js.map +1 -0
- package/dist/edge-node/join-credential.d.ts +11 -0
- package/dist/edge-node/join-credential.js +11 -0
- package/dist/edge-node/join-credential.js.map +1 -0
- package/dist/edge-node/lazy-raw-storage.d.ts +40 -0
- package/dist/edge-node/lazy-raw-storage.js +134 -0
- package/dist/edge-node/lazy-raw-storage.js.map +1 -0
- package/dist/edge-node/node-local.d.ts +60 -0
- package/dist/edge-node/node-local.js +58 -0
- package/dist/edge-node/node-local.js.map +1 -0
- package/dist/edge-node/options.d.ts +83 -0
- package/dist/edge-node/options.js +110 -0
- package/dist/edge-node/options.js.map +1 -0
- package/dist/edge-node/owner-grant.d.ts +41 -0
- package/dist/edge-node/owner-grant.js +38 -0
- package/dist/edge-node/owner-grant.js.map +1 -0
- package/dist/edge-node/platform.d.ts +140 -0
- package/dist/edge-node/platform.js +12 -0
- package/dist/edge-node/platform.js.map +1 -0
- package/dist/edge-node/strand-move.d.ts +115 -0
- package/dist/edge-node/strand-move.js +223 -0
- package/dist/edge-node/strand-move.js.map +1 -0
- package/dist/edge-node/strands.d.ts +28 -0
- package/dist/edge-node/strands.js +60 -0
- package/dist/edge-node/strands.js.map +1 -0
- package/dist/index.d.ts +16 -7
- package/dist/index.js +26 -7
- package/dist/index.js.map +1 -1
- package/dist/joined-strand-store.d.ts +3 -3
- package/dist/joined-strand-store.js +3 -3
- package/dist/joined-strand-store.js.map +1 -1
- package/dist/key-store.d.ts +9 -4
- package/dist/key-store.js +9 -4
- package/dist/key-store.js.map +1 -1
- package/dist/machine-removal.d.ts +19 -39
- package/dist/machine-removal.js +24 -98
- package/dist/machine-removal.js.map +1 -1
- package/dist/member-redemption.d.ts +250 -0
- package/dist/member-redemption.js +485 -0
- package/dist/member-redemption.js.map +1 -0
- package/dist/owner-anchor-sync.d.ts +4 -4
- package/dist/owner-anchor-sync.js +16 -15
- package/dist/owner-anchor-sync.js.map +1 -1
- package/dist/owner-grant-protocol.d.ts +247 -0
- package/dist/owner-grant-protocol.js +330 -0
- package/dist/owner-grant-protocol.js.map +1 -0
- package/dist/owner-key-export.d.ts +70 -0
- package/dist/owner-key-export.js +279 -0
- package/dist/owner-key-export.js.map +1 -0
- package/dist/owner-key-flows.d.ts +55 -0
- package/dist/owner-key-flows.js +60 -0
- package/dist/owner-key-flows.js.map +1 -0
- package/dist/owner-key-store.d.ts +31 -0
- package/dist/owner-key-store.js +81 -0
- package/dist/owner-key-store.js.map +1 -0
- package/dist/owner-keys.d.ts +78 -0
- package/dist/owner-keys.js +133 -0
- package/dist/owner-keys.js.map +1 -0
- package/dist/owner-signer.d.ts +54 -0
- package/dist/owner-signer.js +51 -0
- package/dist/owner-signer.js.map +1 -0
- package/dist/peer-authorization.d.ts +83 -18
- package/dist/peer-authorization.js +123 -53
- package/dist/peer-authorization.js.map +1 -1
- package/dist/provider/rent-node.js +1 -1
- package/dist/provider/rent-node.js.map +1 -1
- package/dist/seed-bootstrap.d.ts +131 -109
- package/dist/seed-bootstrap.js +260 -248
- package/dist/seed-bootstrap.js.map +1 -1
- package/dist/seed-trust-policy.js +4 -4
- package/dist/strand-addr-protocol.d.ts +4 -1
- package/dist/strand-addr-protocol.js +8 -2
- package/dist/strand-addr-protocol.js.map +1 -1
- package/dist/strand-cohort.d.ts +3 -0
- package/dist/strand-cohort.js.map +1 -1
- package/dist/strand-database.d.ts +1 -0
- package/dist/strand-database.js +3 -0
- package/dist/strand-database.js.map +1 -1
- package/dist/strand-first-sync-gate.d.ts +4 -3
- package/dist/strand-first-sync-gate.js +4 -3
- package/dist/strand-first-sync-gate.js.map +1 -1
- package/dist/strand-instance-manager.d.ts +1 -1
- package/dist/strand-membership-writer.d.ts +13 -2
- package/dist/strand-membership-writer.js +52 -16
- package/dist/strand-membership-writer.js.map +1 -1
- package/dist/strand-move.d.ts +6 -5
- package/dist/strand-move.js +31 -30
- package/dist/strand-move.js.map +1 -1
- package/dist/strand-peer-redial.js +2 -3
- package/dist/strand-peer-redial.js.map +1 -1
- package/dist/types.d.ts +286 -103
- package/dist/types.js.map +1 -1
- package/package.json +11 -2
- package/src/bootstrap-peer-store-file.ts +44 -44
- package/src/bootstrap-peer-store.ts +214 -214
- package/src/cadre-invite-protocol.ts +652 -1052
- package/src/cadre-join-request.ts +24 -3
- package/src/cadre-node.ts +1166 -541
- package/src/control-authorization.ts +47 -14
- package/src/control-cohort.ts +127 -128
- package/src/control-database.ts +940 -456
- package/src/control-protocol-guard.ts +7 -4
- package/src/control-schema-version.ts +251 -0
- package/src/control-schema.ts +265 -70
- package/src/control-write-retry.ts +569 -567
- package/src/delegate-admission.ts +37 -0
- package/src/ed25519-key.ts +174 -171
- package/src/edge-node/config.ts +277 -0
- package/src/edge-node/dissolve.ts +251 -0
- package/src/edge-node/edge-join.ts +319 -0
- package/src/edge-node/edge-node.ts +1045 -0
- package/src/edge-node/index.ts +59 -0
- package/src/edge-node/join-credential.ts +16 -0
- package/src/edge-node/lazy-raw-storage.ts +178 -0
- package/src/edge-node/node-local.ts +84 -0
- package/src/edge-node/options.ts +179 -0
- package/src/edge-node/owner-grant.ts +63 -0
- package/src/edge-node/platform.ts +151 -0
- package/src/edge-node/strand-move.ts +270 -0
- package/src/edge-node/strands.ts +72 -0
- package/src/index.ts +886 -789
- package/src/joined-strand-store.ts +4 -4
- package/src/key-store.ts +10 -4
- package/src/machine-removal.ts +26 -111
- package/src/member-redemption.ts +642 -0
- package/src/owner-anchor-sync.ts +19 -18
- package/src/owner-grant-protocol.ts +532 -0
- package/src/owner-key-export.ts +348 -0
- package/src/owner-key-flows.ts +109 -0
- package/src/owner-key-store.ts +85 -0
- package/src/owner-keys.ts +178 -0
- package/src/owner-signer.ts +94 -0
- package/src/peer-authorization.ts +558 -488
- package/src/provider/rent-node.ts +1 -1
- package/src/seed-bootstrap.ts +301 -312
- package/src/seed-trust-policy.ts +4 -4
- package/src/strand-addr-protocol.ts +547 -538
- package/src/strand-cohort.ts +4 -0
- package/src/strand-database.ts +3 -0
- package/src/strand-first-sync-gate.ts +4 -3
- package/src/strand-instance-manager.ts +1 -1
- package/src/strand-membership-writer.ts +61 -16
- package/src/strand-move.ts +45 -36
- package/src/strand-peer-redial.ts +2 -3
- package/src/types.ts +304 -103
|
@@ -1,44 +1,44 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Node-only file-backed {@link BootstrapPeerStore}: one JSON file per party under
|
|
3
|
-
* a configured directory (the node's state directory — `cadre-cli` passes
|
|
4
|
-
* `ResolvedConfig.nodeStateDir`), holding the node-local, non-replicated dial
|
|
5
|
-
* targets learned out of band (a seed's
|
|
6
|
-
*
|
|
7
|
-
* Nothing but the file itself lives here: the envelope, load policy, per-entry
|
|
8
|
-
* validation (shape only — never signatures; see the `bootstrap-peer-store.ts`
|
|
9
|
-
* module comment for why nothing persisted here is trust-bearing) and the
|
|
10
|
-
* serialised snapshot writes are cross-platform in
|
|
11
|
-
* `PersistentBootstrapPeerStore` / `node-local-snapshot.ts`, and the file is a
|
|
12
|
-
* `FileDurableSlot`. This module exists only so the `node:fs` edge stays out of
|
|
13
|
-
* the package's cross-platform default entry (`./index.js`) — import it from the
|
|
14
|
-
* dedicated subpath instead:
|
|
15
|
-
*
|
|
16
|
-
* ```ts
|
|
17
|
-
* import { FileBootstrapPeerStore } from '@serfab/cadre-core/bootstrap-peer-store-file';
|
|
18
|
-
* ```
|
|
19
|
-
*
|
|
20
|
-
* A React Native / browser entry graph never resolves this path, so the
|
|
21
|
-
* `node:fs` edge never reaches a bundler that cannot satisfy it (same isolation
|
|
22
|
-
* pattern as `trusted-owner-store-file.ts` / `key-store-file.ts`).
|
|
23
|
-
*/
|
|
24
|
-
import { FileDurableSlot } from './file-durable-slot.js';
|
|
25
|
-
import { PersistentBootstrapPeerStore } from './bootstrap-peer-store.js';
|
|
26
|
-
import type { BootstrapPeerStore } from './bootstrap-peer-store.js';
|
|
27
|
-
|
|
28
|
-
/** Base name of the store file: `<dir>/bootstrap-peers.<encoded partyId>.json`. */
|
|
29
|
-
const SLOT_NAME = 'bootstrap-peers';
|
|
30
|
-
|
|
31
|
-
/**
|
|
32
|
-
* File-backed {@link BootstrapPeerStore}. Open via {@link open}, which loads the
|
|
33
|
-
* existing file and returns the cross-platform store over it; an absent, corrupt, or wrong-party file is a cold
|
|
34
|
-
* start (empty store) and structurally junk entries are dropped, while a
|
|
35
|
-
* present-but-unreadable file throws. Those rules and their reasoning live on
|
|
36
|
-
* `NodeLocalSnapshot.open` — including the in-process-only write serialisation,
|
|
37
|
-
* which two nodes sharing one directory for one party would defeat.
|
|
38
|
-
*/
|
|
39
|
-
export const FileBootstrapPeerStore = {
|
|
40
|
-
/** Load (or cold-start) the party's retained dial targets from a file in `dir`. */
|
|
41
|
-
async open(dir: string, partyId: string): Promise<BootstrapPeerStore> {
|
|
42
|
-
return PersistentBootstrapPeerStore.open(new FileDurableSlot(dir, SLOT_NAME, partyId), partyId);
|
|
43
|
-
}
|
|
44
|
-
};
|
|
1
|
+
/**
|
|
2
|
+
* Node-only file-backed {@link BootstrapPeerStore}: one JSON file per party under
|
|
3
|
+
* a configured directory (the node's state directory — `cadre-cli` passes
|
|
4
|
+
* `ResolvedConfig.nodeStateDir`), holding the node-local, non-replicated dial
|
|
5
|
+
* targets learned out of band (a seed's preferred peers, and nodes this node added).
|
|
6
|
+
*
|
|
7
|
+
* Nothing but the file itself lives here: the envelope, load policy, per-entry
|
|
8
|
+
* validation (shape only — never signatures; see the `bootstrap-peer-store.ts`
|
|
9
|
+
* module comment for why nothing persisted here is trust-bearing) and the
|
|
10
|
+
* serialised snapshot writes are cross-platform in
|
|
11
|
+
* `PersistentBootstrapPeerStore` / `node-local-snapshot.ts`, and the file is a
|
|
12
|
+
* `FileDurableSlot`. This module exists only so the `node:fs` edge stays out of
|
|
13
|
+
* the package's cross-platform default entry (`./index.js`) — import it from the
|
|
14
|
+
* dedicated subpath instead:
|
|
15
|
+
*
|
|
16
|
+
* ```ts
|
|
17
|
+
* import { FileBootstrapPeerStore } from '@serfab/cadre-core/bootstrap-peer-store-file';
|
|
18
|
+
* ```
|
|
19
|
+
*
|
|
20
|
+
* A React Native / browser entry graph never resolves this path, so the
|
|
21
|
+
* `node:fs` edge never reaches a bundler that cannot satisfy it (same isolation
|
|
22
|
+
* pattern as `trusted-owner-store-file.ts` / `key-store-file.ts`).
|
|
23
|
+
*/
|
|
24
|
+
import { FileDurableSlot } from './file-durable-slot.js';
|
|
25
|
+
import { PersistentBootstrapPeerStore } from './bootstrap-peer-store.js';
|
|
26
|
+
import type { BootstrapPeerStore } from './bootstrap-peer-store.js';
|
|
27
|
+
|
|
28
|
+
/** Base name of the store file: `<dir>/bootstrap-peers.<encoded partyId>.json`. */
|
|
29
|
+
const SLOT_NAME = 'bootstrap-peers';
|
|
30
|
+
|
|
31
|
+
/**
|
|
32
|
+
* File-backed {@link BootstrapPeerStore}. Open via {@link open}, which loads the
|
|
33
|
+
* existing file and returns the cross-platform store over it; an absent, corrupt, or wrong-party file is a cold
|
|
34
|
+
* start (empty store) and structurally junk entries are dropped, while a
|
|
35
|
+
* present-but-unreadable file throws. Those rules and their reasoning live on
|
|
36
|
+
* `NodeLocalSnapshot.open` — including the in-process-only write serialisation,
|
|
37
|
+
* which two nodes sharing one directory for one party would defeat.
|
|
38
|
+
*/
|
|
39
|
+
export const FileBootstrapPeerStore = {
|
|
40
|
+
/** Load (or cold-start) the party's retained dial targets from a file in `dir`. */
|
|
41
|
+
async open(dir: string, partyId: string): Promise<BootstrapPeerStore> {
|
|
42
|
+
return PersistentBootstrapPeerStore.open(new FileDurableSlot(dir, SLOT_NAME, partyId), partyId);
|
|
43
|
+
}
|
|
44
|
+
};
|
|
@@ -1,214 +1,214 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Node-local, NON-replicated bootstrap-peer store: dial targets a node learned
|
|
3
|
-
* out of band, kept so it can dial those peers when nothing better is known.
|
|
4
|
-
* Two sources feed it:
|
|
5
|
-
*
|
|
6
|
-
* - **A seed's
|
|
7
|
-
*
|
|
8
|
-
* `SeedBootstrapService.applySeed` dials those
|
|
9
|
-
* best-effort; when that dial fails (
|
|
10
|
-
* up, not yet vouched) the node has an empty `CadrePeer` table and no
|
|
11
|
-
* connection, and `CadreNode.reconcileControlCohort`'s cold-start branch is
|
|
12
|
-
* the only way back — it re-dials these retained addresses every pass.
|
|
13
|
-
* - **Nodes this node added.** `CadreNode.addDrone` is handed the added node's
|
|
14
|
-
* addresses, but that node's `CadrePeer` row stays unsigned, and therefore
|
|
15
|
-
* unresolvable, until the node self-publishes — which needs a connection, and
|
|
16
|
-
* a node that cannot listen (a phone) is never dialed by it. The steady-state
|
|
17
|
-
* reconcile pass falls back to these addresses for a sibling whose signed
|
|
18
|
-
* record and address-book entry both yield nothing, including after a
|
|
19
|
-
* relaunch that outlived the record's freshness window.
|
|
20
|
-
*
|
|
21
|
-
* Held only in memory, either kind dies with the process and the node is left
|
|
22
|
-
* with no address to dial, which is what this store exists to prevent.
|
|
23
|
-
*
|
|
24
|
-
* Three implementations, mirroring `trusted-owner-store.ts` (read that first —
|
|
25
|
-
* it solves the same "must outlive the process, storage differs per platform"
|
|
26
|
-
* problem, the two stores are deliberately symmetrical, and both persistent
|
|
27
|
-
* forms share `node-local-snapshot.ts`):
|
|
28
|
-
* - {@link MemoryBootstrapPeerStore} (this module, cross-platform) — ephemeral;
|
|
29
|
-
* the default when no store is injected via `CadreNodeConfig.bootstrapPeers`.
|
|
30
|
-
* - {@link PersistentBootstrapPeerStore} (this module, cross-platform) — durable
|
|
31
|
-
* over any `DurableSlot` the embedding app supplies (IndexedDB, a LevelDB KV,
|
|
32
|
-
* SQLite, …).
|
|
33
|
-
* - `FileBootstrapPeerStore` — the above over a Node file in the node's state
|
|
34
|
-
* directory; Node-only, behind the subpath
|
|
35
|
-
* `@serfab/cadre-core/bootstrap-peer-store-file` (same isolation pattern as
|
|
36
|
-
* `key-store-file`) so `node:fs` never lands in the RN/browser entry graph.
|
|
37
|
-
*
|
|
38
|
-
* **Nothing here is trust-bearing, and a loader must not try to re-verify it.**
|
|
39
|
-
* Only *dial targets* are retained — never a seed, a signature, or an authority
|
|
40
|
-
* claim. A seed was signature-checked against the node-local trusted-owner
|
|
41
|
-
* anchor before its addresses were retained, and an added node's addresses were
|
|
42
|
-
* supplied by the owner that chose to add it. Either way a dial grants no
|
|
43
|
-
* authority: `CadreNode.bootstrapDialAddrs` binds every address to the peer id it
|
|
44
|
-
* was retained under, so a dial cannot be redirected to whoever answers. What a
|
|
45
|
-
* persistent backend's loader DOES owe is dropping structurally junk entries
|
|
46
|
-
* (unparseable peer id, empty address list, non-string address) rather than
|
|
47
|
-
* carrying them into the dial loop.
|
|
48
|
-
*/
|
|
49
|
-
import debug from 'debug';
|
|
50
|
-
import { peerIdFromString } from '@libp2p/peer-id';
|
|
51
|
-
import { NodeLocalSnapshot, type DurableSlot, type NodeLocalSnapshotSpec } from './node-local-snapshot.js';
|
|
52
|
-
|
|
53
|
-
const log = debug('sereus:cadre:bootstrap-peer-store');
|
|
54
|
-
|
|
55
|
-
/**
|
|
56
|
-
* One retained dial target learned out of band:
|
|
57
|
-
* or a node this node added.
|
|
58
|
-
*/
|
|
59
|
-
export interface BootstrapPeerEntry {
|
|
60
|
-
/** Multiaddr strings exactly as they were handed over (parsed at dial time). */
|
|
61
|
-
addrs: string[];
|
|
62
|
-
/** Wall-clock ms the entry was last recorded (diagnostics / future eviction). */
|
|
63
|
-
recordedAt: number;
|
|
64
|
-
}
|
|
65
|
-
|
|
66
|
-
export interface BootstrapPeerStore {
|
|
67
|
-
/** Party this store is scoped to. */
|
|
68
|
-
readonly partyId: string;
|
|
69
|
-
|
|
70
|
-
/**
|
|
71
|
-
* Every retained target, peerId -> entry. Every backend copies the map per call,
|
|
72
|
-
* so the result is a snapshot decoupled from later {@link record} and
|
|
73
|
-
* {@link forget} calls and is safe to iterate while recording. The entry objects
|
|
74
|
-
* need no copy: `record` REPLACES an entry rather than mutating it in place.
|
|
75
|
-
*/
|
|
76
|
-
all(): ReadonlyMap<string, BootstrapPeerEntry>;
|
|
77
|
-
|
|
78
|
-
/**
|
|
79
|
-
* Retain (or REPLACE) a peer's dial addresses. Replace, not merge, so a
|
|
80
|
-
* re-seed after an owner's address changed drops the stale address instead of
|
|
81
|
-
* accumulating dead ones.
|
|
82
|
-
*
|
|
83
|
-
* Implementations MUST reflect the entry in {@link all} SYNCHRONOUSLY; the
|
|
84
|
-
* returned promise tracks durability only. That is what lets the synchronous
|
|
85
|
-
* `CadreNode.recordSeedBootstrapPeers` keep its signature while a file
|
|
86
|
-
* backend persists in the background.
|
|
87
|
-
*
|
|
88
|
-
* NOTE: entries are never evicted (only a local `removePeer` {@link forget}s
|
|
89
|
-
* one), and a persistent backend's file therefore grows across the node's whole
|
|
90
|
-
* lifetime rather than one process. Fine while a seed nominates one or a few
|
|
91
|
-
* owners, a node adds a handful of machines, and entries are keyed by peer id;
|
|
92
|
-
* if a node ever applies seeds naming many distinct owners or adds many
|
|
93
|
-
* machines, add eviction (oldest {@link BootstrapPeerEntry.recordedAt} first, or
|
|
94
|
-
* a cap) rather than letting the file grow unbounded — `recordedAt` exists so
|
|
95
|
-
* eviction has something to sort by.
|
|
96
|
-
*/
|
|
97
|
-
record(peerId: string, addrs: readonly string[]): Promise<void>;
|
|
98
|
-
|
|
99
|
-
/**
|
|
100
|
-
* Drop a peer's retained dial addresses — for a peer this node removed from the
|
|
101
|
-
* party, which must not stay a dial target. Forgetting a peer with no entry is a
|
|
102
|
-
* no-op.
|
|
103
|
-
*
|
|
104
|
-
* Same contract as {@link record}: the removal is reflected in {@link all}
|
|
105
|
-
* SYNCHRONOUSLY, and the returned promise tracks durability only.
|
|
106
|
-
*/
|
|
107
|
-
forget(peerId: string): Promise<void>;
|
|
108
|
-
}
|
|
109
|
-
|
|
110
|
-
/**
|
|
111
|
-
* Ephemeral in-memory store for nodes without durable storage (tests, browser
|
|
112
|
-
* demos, not-yet-persisted mobile). Same contract, no disk: a node using this
|
|
113
|
-
* loses its retry targets on restart and must be re-seeded to rejoin.
|
|
114
|
-
*/
|
|
115
|
-
export class MemoryBootstrapPeerStore implements BootstrapPeerStore {
|
|
116
|
-
private readonly peers = new Map<string, BootstrapPeerEntry>();
|
|
117
|
-
|
|
118
|
-
constructor(readonly partyId: string) {}
|
|
119
|
-
|
|
120
|
-
all(): ReadonlyMap<string, BootstrapPeerEntry> {
|
|
121
|
-
return new Map(this.peers);
|
|
122
|
-
}
|
|
123
|
-
|
|
124
|
-
async record(peerId: string, addrs: readonly string[]): Promise<void> {
|
|
125
|
-
this.peers.set(peerId, { addrs: [...addrs], recordedAt: Date.now() });
|
|
126
|
-
log('bootstrap peer retained (party=%s, peer=%s, addrs=%d)', this.partyId, peerId, addrs.length);
|
|
127
|
-
}
|
|
128
|
-
|
|
129
|
-
async forget(peerId: string): Promise<void> {
|
|
130
|
-
if (this.peers.delete(peerId)) {
|
|
131
|
-
log('bootstrap peer forgotten (party=%s, peer=%s)', this.partyId, peerId);
|
|
132
|
-
}
|
|
133
|
-
}
|
|
134
|
-
}
|
|
135
|
-
|
|
136
|
-
/**
|
|
137
|
-
* What the store persists: `peers` maps peerId -> {@link BootstrapPeerEntry}.
|
|
138
|
-
*
|
|
139
|
-
* A structurally junk entry is DROPPED and its siblings retained — nothing here
|
|
140
|
-
* is trust-bearing (see the module comment) and the record is a stranded node's
|
|
141
|
-
* only way back into its party, so discarding the whole set over one bad entry
|
|
142
|
-
* would be strictly worse. What "junk" means: an unparseable peer id (the dial
|
|
143
|
-
* path binds every address to this id, so an id that cannot parse is not a dial
|
|
144
|
-
* target at all), an empty address list, or a non-string address — each would
|
|
145
|
-
* otherwise log a parse failure once per reconcile pass forever.
|
|
146
|
-
*/
|
|
147
|
-
const BOOTSTRAP_PEER_SNAPSHOT: NodeLocalSnapshotSpec<BootstrapPeerEntry> = {
|
|
148
|
-
label: 'bootstrap-peer store',
|
|
149
|
-
payloadKey: 'peers',
|
|
150
|
-
unusableEntry: 'drop-entry',
|
|
151
|
-
acceptEntry: (peerId, entry) => {
|
|
152
|
-
if (typeof entry !== 'object' || entry === null) return undefined;
|
|
153
|
-
const { addrs, recordedAt } = entry as { addrs?: unknown; recordedAt?: unknown };
|
|
154
|
-
if (!Array.isArray(addrs) || addrs.length === 0) return undefined;
|
|
155
|
-
if (addrs.some((addr) => typeof addr !== 'string' || addr.length === 0)) return undefined;
|
|
156
|
-
if (typeof recordedAt !== 'number') return undefined;
|
|
157
|
-
try {
|
|
158
|
-
peerIdFromString(peerId);
|
|
159
|
-
} catch {
|
|
160
|
-
return undefined;
|
|
161
|
-
}
|
|
162
|
-
return { addrs: [...(addrs as string[])], recordedAt };
|
|
163
|
-
}
|
|
164
|
-
};
|
|
165
|
-
|
|
166
|
-
/**
|
|
167
|
-
* Durable {@link BootstrapPeerStore} over an app-supplied {@link DurableSlot} —
|
|
168
|
-
* the cross-platform half of every persistent backend (the Node
|
|
169
|
-
* `FileBootstrapPeerStore` is this class over a file slot).
|
|
170
|
-
*
|
|
171
|
-
* Construct via {@link open}. Load and persist policy — what an absent, corrupt,
|
|
172
|
-
* foreign-party or unreadable slot does, and what a failed persist does — is
|
|
173
|
-
* documented once on `NodeLocalSnapshot`; this class only supplies the payload
|
|
174
|
-
* shape and the drop-the-bad-entry policy above.
|
|
175
|
-
*/
|
|
176
|
-
export class PersistentBootstrapPeerStore implements BootstrapPeerStore {
|
|
177
|
-
private constructor(private readonly snapshot: NodeLocalSnapshot<BootstrapPeerEntry>) {}
|
|
178
|
-
|
|
179
|
-
/** Load (or cold-start) the party's retained dial targets from `slot`. */
|
|
180
|
-
static async open(slot: DurableSlot, partyId: string): Promise<PersistentBootstrapPeerStore> {
|
|
181
|
-
return new PersistentBootstrapPeerStore(
|
|
182
|
-
await NodeLocalSnapshot.open(slot, partyId, BOOTSTRAP_PEER_SNAPSHOT)
|
|
183
|
-
);
|
|
184
|
-
}
|
|
185
|
-
|
|
186
|
-
get partyId(): string {
|
|
187
|
-
return this.snapshot.partyId;
|
|
188
|
-
}
|
|
189
|
-
|
|
190
|
-
all(): ReadonlyMap<string, BootstrapPeerEntry> {
|
|
191
|
-
return this.snapshot.entrySnapshot();
|
|
192
|
-
}
|
|
193
|
-
|
|
194
|
-
/**
|
|
195
|
-
* Retain a peer's dial addresses: visible via {@link all} synchronously, then
|
|
196
|
-
* the full snapshot is persisted (see `NodeLocalSnapshot.put`).
|
|
197
|
-
*/
|
|
198
|
-
record(peerId: string, addrs: readonly string[]): Promise<void> {
|
|
199
|
-
log('bootstrap peer retained (party=%s, peer=%s, addrs=%d); persisting', this.partyId, peerId, addrs.length);
|
|
200
|
-
return this.snapshot.put(peerId, { addrs: [...addrs], recordedAt: Date.now() });
|
|
201
|
-
}
|
|
202
|
-
|
|
203
|
-
/**
|
|
204
|
-
* Drop a peer's dial addresses: gone from {@link all} synchronously, then the
|
|
205
|
-
* full snapshot is persisted — unless there was no entry, which writes nothing
|
|
206
|
-
* (see `NodeLocalSnapshot.remove`).
|
|
207
|
-
*/
|
|
208
|
-
forget(peerId: string): Promise<void> {
|
|
209
|
-
if (this.snapshot.has(peerId)) {
|
|
210
|
-
log('bootstrap peer forgotten (party=%s, peer=%s); persisting', this.partyId, peerId);
|
|
211
|
-
}
|
|
212
|
-
return this.snapshot.remove(peerId);
|
|
213
|
-
}
|
|
214
|
-
}
|
|
1
|
+
/**
|
|
2
|
+
* Node-local, NON-replicated bootstrap-peer store: dial targets a node learned
|
|
3
|
+
* out of band, kept so it can dial those peers when nothing better is known.
|
|
4
|
+
* Two sources feed it:
|
|
5
|
+
*
|
|
6
|
+
* - **A seed's preferred peers.** A newcomer applies a signed seed nominating
|
|
7
|
+
* the machine that minted it and the party's always-on machines, with the
|
|
8
|
+
* addresses they answer on. `SeedBootstrapService.applySeed` dials those peers
|
|
9
|
+
* exactly once, best-effort; when that dial fails (peer briefly down, relay reservation not
|
|
10
|
+
* up, not yet vouched) the node has an empty `CadrePeer` table and no
|
|
11
|
+
* connection, and `CadreNode.reconcileControlCohort`'s cold-start branch is
|
|
12
|
+
* the only way back — it re-dials these retained addresses every pass.
|
|
13
|
+
* - **Nodes this node added.** `CadreNode.addDrone` is handed the added node's
|
|
14
|
+
* addresses, but that node's `CadrePeer` row stays unsigned, and therefore
|
|
15
|
+
* unresolvable, until the node self-publishes — which needs a connection, and
|
|
16
|
+
* a node that cannot listen (a phone) is never dialed by it. The steady-state
|
|
17
|
+
* reconcile pass falls back to these addresses for a sibling whose signed
|
|
18
|
+
* record and address-book entry both yield nothing, including after a
|
|
19
|
+
* relaunch that outlived the record's freshness window.
|
|
20
|
+
*
|
|
21
|
+
* Held only in memory, either kind dies with the process and the node is left
|
|
22
|
+
* with no address to dial, which is what this store exists to prevent.
|
|
23
|
+
*
|
|
24
|
+
* Three implementations, mirroring `trusted-owner-store.ts` (read that first —
|
|
25
|
+
* it solves the same "must outlive the process, storage differs per platform"
|
|
26
|
+
* problem, the two stores are deliberately symmetrical, and both persistent
|
|
27
|
+
* forms share `node-local-snapshot.ts`):
|
|
28
|
+
* - {@link MemoryBootstrapPeerStore} (this module, cross-platform) — ephemeral;
|
|
29
|
+
* the default when no store is injected via `CadreNodeConfig.bootstrapPeers`.
|
|
30
|
+
* - {@link PersistentBootstrapPeerStore} (this module, cross-platform) — durable
|
|
31
|
+
* over any `DurableSlot` the embedding app supplies (IndexedDB, a LevelDB KV,
|
|
32
|
+
* SQLite, …).
|
|
33
|
+
* - `FileBootstrapPeerStore` — the above over a Node file in the node's state
|
|
34
|
+
* directory; Node-only, behind the subpath
|
|
35
|
+
* `@serfab/cadre-core/bootstrap-peer-store-file` (same isolation pattern as
|
|
36
|
+
* `key-store-file`) so `node:fs` never lands in the RN/browser entry graph.
|
|
37
|
+
*
|
|
38
|
+
* **Nothing here is trust-bearing, and a loader must not try to re-verify it.**
|
|
39
|
+
* Only *dial targets* are retained — never a seed, a signature, or an authority
|
|
40
|
+
* claim. A seed was signature-checked against the node-local trusted-owner
|
|
41
|
+
* anchor before its addresses were retained, and an added node's addresses were
|
|
42
|
+
* supplied by the owner that chose to add it. Either way a dial grants no
|
|
43
|
+
* authority: `CadreNode.bootstrapDialAddrs` binds every address to the peer id it
|
|
44
|
+
* was retained under, so a dial cannot be redirected to whoever answers. What a
|
|
45
|
+
* persistent backend's loader DOES owe is dropping structurally junk entries
|
|
46
|
+
* (unparseable peer id, empty address list, non-string address) rather than
|
|
47
|
+
* carrying them into the dial loop.
|
|
48
|
+
*/
|
|
49
|
+
import debug from 'debug';
|
|
50
|
+
import { peerIdFromString } from '@libp2p/peer-id';
|
|
51
|
+
import { NodeLocalSnapshot, type DurableSlot, type NodeLocalSnapshotSpec } from './node-local-snapshot.js';
|
|
52
|
+
|
|
53
|
+
const log = debug('sereus:cadre:bootstrap-peer-store');
|
|
54
|
+
|
|
55
|
+
/**
|
|
56
|
+
* One retained dial target learned out of band: a preferred peer a seed nominated,
|
|
57
|
+
* or a node this node added.
|
|
58
|
+
*/
|
|
59
|
+
export interface BootstrapPeerEntry {
|
|
60
|
+
/** Multiaddr strings exactly as they were handed over (parsed at dial time). */
|
|
61
|
+
addrs: string[];
|
|
62
|
+
/** Wall-clock ms the entry was last recorded (diagnostics / future eviction). */
|
|
63
|
+
recordedAt: number;
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
export interface BootstrapPeerStore {
|
|
67
|
+
/** Party this store is scoped to. */
|
|
68
|
+
readonly partyId: string;
|
|
69
|
+
|
|
70
|
+
/**
|
|
71
|
+
* Every retained target, peerId -> entry. Every backend copies the map per call,
|
|
72
|
+
* so the result is a snapshot decoupled from later {@link record} and
|
|
73
|
+
* {@link forget} calls and is safe to iterate while recording. The entry objects
|
|
74
|
+
* need no copy: `record` REPLACES an entry rather than mutating it in place.
|
|
75
|
+
*/
|
|
76
|
+
all(): ReadonlyMap<string, BootstrapPeerEntry>;
|
|
77
|
+
|
|
78
|
+
/**
|
|
79
|
+
* Retain (or REPLACE) a peer's dial addresses. Replace, not merge, so a
|
|
80
|
+
* re-seed after an owner's address changed drops the stale address instead of
|
|
81
|
+
* accumulating dead ones.
|
|
82
|
+
*
|
|
83
|
+
* Implementations MUST reflect the entry in {@link all} SYNCHRONOUSLY; the
|
|
84
|
+
* returned promise tracks durability only. That is what lets the synchronous
|
|
85
|
+
* `CadreNode.recordSeedBootstrapPeers` keep its signature while a file
|
|
86
|
+
* backend persists in the background.
|
|
87
|
+
*
|
|
88
|
+
* NOTE: entries are never evicted (only a local `removePeer` {@link forget}s
|
|
89
|
+
* one), and a persistent backend's file therefore grows across the node's whole
|
|
90
|
+
* lifetime rather than one process. Fine while a seed nominates one or a few
|
|
91
|
+
* owners, a node adds a handful of machines, and entries are keyed by peer id;
|
|
92
|
+
* if a node ever applies seeds naming many distinct owners or adds many
|
|
93
|
+
* machines, add eviction (oldest {@link BootstrapPeerEntry.recordedAt} first, or
|
|
94
|
+
* a cap) rather than letting the file grow unbounded — `recordedAt` exists so
|
|
95
|
+
* eviction has something to sort by.
|
|
96
|
+
*/
|
|
97
|
+
record(peerId: string, addrs: readonly string[]): Promise<void>;
|
|
98
|
+
|
|
99
|
+
/**
|
|
100
|
+
* Drop a peer's retained dial addresses — for a peer this node removed from the
|
|
101
|
+
* party, which must not stay a dial target. Forgetting a peer with no entry is a
|
|
102
|
+
* no-op.
|
|
103
|
+
*
|
|
104
|
+
* Same contract as {@link record}: the removal is reflected in {@link all}
|
|
105
|
+
* SYNCHRONOUSLY, and the returned promise tracks durability only.
|
|
106
|
+
*/
|
|
107
|
+
forget(peerId: string): Promise<void>;
|
|
108
|
+
}
|
|
109
|
+
|
|
110
|
+
/**
|
|
111
|
+
* Ephemeral in-memory store for nodes without durable storage (tests, browser
|
|
112
|
+
* demos, not-yet-persisted mobile). Same contract, no disk: a node using this
|
|
113
|
+
* loses its retry targets on restart and must be re-seeded to rejoin.
|
|
114
|
+
*/
|
|
115
|
+
export class MemoryBootstrapPeerStore implements BootstrapPeerStore {
|
|
116
|
+
private readonly peers = new Map<string, BootstrapPeerEntry>();
|
|
117
|
+
|
|
118
|
+
constructor(readonly partyId: string) {}
|
|
119
|
+
|
|
120
|
+
all(): ReadonlyMap<string, BootstrapPeerEntry> {
|
|
121
|
+
return new Map(this.peers);
|
|
122
|
+
}
|
|
123
|
+
|
|
124
|
+
async record(peerId: string, addrs: readonly string[]): Promise<void> {
|
|
125
|
+
this.peers.set(peerId, { addrs: [...addrs], recordedAt: Date.now() });
|
|
126
|
+
log('bootstrap peer retained (party=%s, peer=%s, addrs=%d)', this.partyId, peerId, addrs.length);
|
|
127
|
+
}
|
|
128
|
+
|
|
129
|
+
async forget(peerId: string): Promise<void> {
|
|
130
|
+
if (this.peers.delete(peerId)) {
|
|
131
|
+
log('bootstrap peer forgotten (party=%s, peer=%s)', this.partyId, peerId);
|
|
132
|
+
}
|
|
133
|
+
}
|
|
134
|
+
}
|
|
135
|
+
|
|
136
|
+
/**
|
|
137
|
+
* What the store persists: `peers` maps peerId -> {@link BootstrapPeerEntry}.
|
|
138
|
+
*
|
|
139
|
+
* A structurally junk entry is DROPPED and its siblings retained — nothing here
|
|
140
|
+
* is trust-bearing (see the module comment) and the record is a stranded node's
|
|
141
|
+
* only way back into its party, so discarding the whole set over one bad entry
|
|
142
|
+
* would be strictly worse. What "junk" means: an unparseable peer id (the dial
|
|
143
|
+
* path binds every address to this id, so an id that cannot parse is not a dial
|
|
144
|
+
* target at all), an empty address list, or a non-string address — each would
|
|
145
|
+
* otherwise log a parse failure once per reconcile pass forever.
|
|
146
|
+
*/
|
|
147
|
+
const BOOTSTRAP_PEER_SNAPSHOT: NodeLocalSnapshotSpec<BootstrapPeerEntry> = {
|
|
148
|
+
label: 'bootstrap-peer store',
|
|
149
|
+
payloadKey: 'peers',
|
|
150
|
+
unusableEntry: 'drop-entry',
|
|
151
|
+
acceptEntry: (peerId, entry) => {
|
|
152
|
+
if (typeof entry !== 'object' || entry === null) return undefined;
|
|
153
|
+
const { addrs, recordedAt } = entry as { addrs?: unknown; recordedAt?: unknown };
|
|
154
|
+
if (!Array.isArray(addrs) || addrs.length === 0) return undefined;
|
|
155
|
+
if (addrs.some((addr) => typeof addr !== 'string' || addr.length === 0)) return undefined;
|
|
156
|
+
if (typeof recordedAt !== 'number') return undefined;
|
|
157
|
+
try {
|
|
158
|
+
peerIdFromString(peerId);
|
|
159
|
+
} catch {
|
|
160
|
+
return undefined;
|
|
161
|
+
}
|
|
162
|
+
return { addrs: [...(addrs as string[])], recordedAt };
|
|
163
|
+
}
|
|
164
|
+
};
|
|
165
|
+
|
|
166
|
+
/**
|
|
167
|
+
* Durable {@link BootstrapPeerStore} over an app-supplied {@link DurableSlot} —
|
|
168
|
+
* the cross-platform half of every persistent backend (the Node
|
|
169
|
+
* `FileBootstrapPeerStore` is this class over a file slot).
|
|
170
|
+
*
|
|
171
|
+
* Construct via {@link open}. Load and persist policy — what an absent, corrupt,
|
|
172
|
+
* foreign-party or unreadable slot does, and what a failed persist does — is
|
|
173
|
+
* documented once on `NodeLocalSnapshot`; this class only supplies the payload
|
|
174
|
+
* shape and the drop-the-bad-entry policy above.
|
|
175
|
+
*/
|
|
176
|
+
export class PersistentBootstrapPeerStore implements BootstrapPeerStore {
|
|
177
|
+
private constructor(private readonly snapshot: NodeLocalSnapshot<BootstrapPeerEntry>) {}
|
|
178
|
+
|
|
179
|
+
/** Load (or cold-start) the party's retained dial targets from `slot`. */
|
|
180
|
+
static async open(slot: DurableSlot, partyId: string): Promise<PersistentBootstrapPeerStore> {
|
|
181
|
+
return new PersistentBootstrapPeerStore(
|
|
182
|
+
await NodeLocalSnapshot.open(slot, partyId, BOOTSTRAP_PEER_SNAPSHOT)
|
|
183
|
+
);
|
|
184
|
+
}
|
|
185
|
+
|
|
186
|
+
get partyId(): string {
|
|
187
|
+
return this.snapshot.partyId;
|
|
188
|
+
}
|
|
189
|
+
|
|
190
|
+
all(): ReadonlyMap<string, BootstrapPeerEntry> {
|
|
191
|
+
return this.snapshot.entrySnapshot();
|
|
192
|
+
}
|
|
193
|
+
|
|
194
|
+
/**
|
|
195
|
+
* Retain a peer's dial addresses: visible via {@link all} synchronously, then
|
|
196
|
+
* the full snapshot is persisted (see `NodeLocalSnapshot.put`).
|
|
197
|
+
*/
|
|
198
|
+
record(peerId: string, addrs: readonly string[]): Promise<void> {
|
|
199
|
+
log('bootstrap peer retained (party=%s, peer=%s, addrs=%d); persisting', this.partyId, peerId, addrs.length);
|
|
200
|
+
return this.snapshot.put(peerId, { addrs: [...addrs], recordedAt: Date.now() });
|
|
201
|
+
}
|
|
202
|
+
|
|
203
|
+
/**
|
|
204
|
+
* Drop a peer's dial addresses: gone from {@link all} synchronously, then the
|
|
205
|
+
* full snapshot is persisted — unless there was no entry, which writes nothing
|
|
206
|
+
* (see `NodeLocalSnapshot.remove`).
|
|
207
|
+
*/
|
|
208
|
+
forget(peerId: string): Promise<void> {
|
|
209
|
+
if (this.snapshot.has(peerId)) {
|
|
210
|
+
log('bootstrap peer forgotten (party=%s, peer=%s); persisting', this.partyId, peerId);
|
|
211
|
+
}
|
|
212
|
+
return this.snapshot.remove(peerId);
|
|
213
|
+
}
|
|
214
|
+
}
|