@serfab/cadre-host 0.10.0 → 0.11.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 (138) hide show
  1. package/dist/server/static.js +38 -38
  2. package/dist/ui/assets/index-C-iks41M.js.map +1 -1
  3. package/dist/ui/index.html +12 -12
  4. package/package.json +4 -4
  5. package/service/cadre-host.service.tmpl +16 -16
  6. package/service/com.serfab.cadre-host.plist.tmpl +35 -35
  7. package/service/install-service.ps1 +98 -98
  8. package/service/uninstall-service.ps1 +19 -19
  9. package/src/__tests__/build-targets.test.ts +26 -26
  10. package/src/__tests__/cli-invite.smoke.test.ts +192 -192
  11. package/src/__tests__/cli-nat.smoke.test.ts +212 -212
  12. package/src/__tests__/cli.smoke.test.ts +46 -46
  13. package/src/__tests__/global-setup.ts +51 -51
  14. package/src/__tests__/host-owner.smoke.test.ts +123 -123
  15. package/src/__tests__/orchestrator-env-scrub.test.ts +140 -140
  16. package/src/__tests__/orchestrator-node-identity.test.ts +204 -204
  17. package/src/__tests__/orchestrator-owner.test.ts +198 -198
  18. package/src/__tests__/orchestrator-pin-keys.test.ts +153 -153
  19. package/src/__tests__/orchestrator-push.test.ts +145 -145
  20. package/src/__tests__/orchestrator.test.ts +951 -951
  21. package/src/auth/__tests__/duration.test.ts +28 -28
  22. package/src/auth/__tests__/self-label.test.ts +85 -85
  23. package/src/auth/__tests__/trust-circle-store.test.ts +115 -115
  24. package/src/auth/__tests__/trust-circle.test.ts +445 -445
  25. package/src/auth/duration.ts +33 -33
  26. package/src/auth/index.ts +21 -21
  27. package/src/auth/self-label.ts +74 -74
  28. package/src/auth/trust-circle-store.ts +155 -155
  29. package/src/auth/types.ts +99 -99
  30. package/src/donation/__tests__/donation-service.test.ts +1068 -1068
  31. package/src/donation/__tests__/donation-supervisor.test.ts +510 -510
  32. package/src/donation/__tests__/fake-orchestrator.test.ts +168 -168
  33. package/src/donation/__tests__/fake-orchestrator.ts +225 -225
  34. package/src/donation/__tests__/grant-service.test.ts +213 -213
  35. package/src/donation/__tests__/grant-store.test.ts +113 -113
  36. package/src/donation/donation-service.ts +962 -962
  37. package/src/donation/donation-store.ts +171 -171
  38. package/src/donation/donation-supervisor.ts +388 -388
  39. package/src/donation/grant-service.ts +200 -200
  40. package/src/donation/grant-store.ts +152 -152
  41. package/src/donation/index.ts +64 -64
  42. package/src/donation/types.ts +243 -243
  43. package/src/installer/__tests__/identity.test.ts +34 -34
  44. package/src/installer/__tests__/paths.test.ts +47 -47
  45. package/src/installer/__tests__/service-host.test.ts +62 -62
  46. package/src/installer/__tests__/wizard.test.ts +64 -64
  47. package/src/installer/identity.ts +49 -49
  48. package/src/installer/paths.ts +109 -109
  49. package/src/installer/platform.ts +27 -27
  50. package/src/installer/service-host/index.ts +21 -21
  51. package/src/installer/service-host/template.ts +21 -21
  52. package/src/installer/wizard.ts +103 -103
  53. package/src/nat/__tests__/address-resolver.test.ts +82 -82
  54. package/src/nat/__tests__/ddns-duckdns.test.ts +83 -83
  55. package/src/nat/__tests__/ddns-updater.test.ts +253 -253
  56. package/src/nat/__tests__/external-ip.test.ts +124 -124
  57. package/src/nat/__tests__/nat-service.test.ts +497 -497
  58. package/src/nat/__tests__/nat-store.test.ts +93 -93
  59. package/src/nat/__tests__/port-mapper.test.ts +191 -191
  60. package/src/nat/__tests__/reachability.test.ts +24 -24
  61. package/src/nat/__tests__/secrets.test.ts +178 -178
  62. package/src/nat/address-resolver.ts +51 -51
  63. package/src/nat/ddns/duckdns.ts +76 -76
  64. package/src/nat/ddns/index.ts +55 -55
  65. package/src/nat/ddns/updater.ts +243 -243
  66. package/src/nat/external-ip.ts +154 -154
  67. package/src/nat/index.ts +71 -71
  68. package/src/nat/nat-service.ts +501 -501
  69. package/src/nat/nat-store.ts +154 -154
  70. package/src/nat/port-mapper.ts +329 -329
  71. package/src/nat/reachability.ts +34 -34
  72. package/src/nat/secrets/file-store.ts +130 -130
  73. package/src/nat/secrets/index.ts +112 -112
  74. package/src/nat/secrets/keytar-store.ts +67 -67
  75. package/src/nat/types.ts +159 -159
  76. package/src/orchestrator/__tests__/node-identity.test.ts +62 -62
  77. package/src/orchestrator/host-process-orchestrator.ts +1133 -1133
  78. package/src/orchestrator/index.ts +10 -10
  79. package/src/orchestrator/log-rotator.ts +53 -53
  80. package/src/orchestrator/node-identity.ts +40 -40
  81. package/src/orchestrator/pid-liveness.ts +24 -24
  82. package/src/orchestrator/port-allocator.ts +91 -91
  83. package/src/orchestrator/state-store.ts +90 -90
  84. package/src/orchestrator/types.ts +141 -141
  85. package/src/owner/__tests__/owner-node-client.test.ts +194 -194
  86. package/src/owner/index.ts +12 -12
  87. package/src/owner/owner-node-client.ts +259 -259
  88. package/src/push/__tests__/push.test.ts +90 -90
  89. package/src/push/index.ts +146 -146
  90. package/src/server/__tests__/bus.test.ts +38 -38
  91. package/src/server/__tests__/error-handler.test.ts +118 -118
  92. package/src/server/__tests__/grants-admin-route.test.ts +73 -73
  93. package/src/server/__tests__/grants-route.test.ts +263 -263
  94. package/src/server/__tests__/nodes-route.test.ts +259 -259
  95. package/src/server/__tests__/origin-guard.test.ts +72 -72
  96. package/src/server/__tests__/publishers.test.ts +216 -216
  97. package/src/server/__tests__/server.smoke.test.ts +253 -253
  98. package/src/server/__tests__/settings-route.test.ts +194 -194
  99. package/src/server/__tests__/sse-route.test.ts +119 -119
  100. package/src/server/__tests__/static.test.ts +145 -145
  101. package/src/server/__tests__/status-route.test.ts +134 -134
  102. package/src/server/__tests__/strands-route.test.ts +233 -233
  103. package/src/server/error-handler.ts +178 -178
  104. package/src/server/events/bus.ts +42 -42
  105. package/src/server/events/sse-route.ts +81 -81
  106. package/src/server/events/types.ts +23 -23
  107. package/src/server/index.ts +267 -267
  108. package/src/server/origin-guard.ts +84 -84
  109. package/src/server/routes/grants-admin.ts +41 -41
  110. package/src/server/routes/grants.ts +210 -210
  111. package/src/server/routes/nat.ts +63 -63
  112. package/src/server/routes/nodes.ts +170 -170
  113. package/src/server/routes/settings.ts +123 -123
  114. package/src/server/routes/status.ts +118 -118
  115. package/src/server/routes/strands.ts +54 -54
  116. package/src/server/routes/trust-circle.ts +49 -49
  117. package/src/server/routes/update.ts +43 -43
  118. package/src/server/server.ts +122 -122
  119. package/src/server/settings-store.ts +37 -37
  120. package/src/server/static.ts +207 -207
  121. package/src/strands/__tests__/strand-service.test.ts +165 -165
  122. package/src/strands/index.ts +14 -14
  123. package/src/strands/strand-service.ts +135 -135
  124. package/src/strands/types.ts +102 -102
  125. package/src/update/__tests__/apply.test.ts +158 -158
  126. package/src/update/__tests__/manifest.test.ts +128 -128
  127. package/src/update/__tests__/release-key.test.ts +42 -42
  128. package/src/update/__tests__/sign.test.ts +78 -78
  129. package/src/update/__tests__/store.test.ts +81 -81
  130. package/src/update/__tests__/update-service.integration.test.ts +256 -256
  131. package/src/update/__tests__/version.test.ts +31 -31
  132. package/src/update/apply.ts +190 -190
  133. package/src/update/index.ts +341 -341
  134. package/src/update/release-key.ts +71 -71
  135. package/src/update/sign.ts +74 -74
  136. package/src/update/store.ts +101 -101
  137. package/src/update/types.ts +109 -109
  138. package/src/update/version.ts +80 -80
@@ -1,243 +1,243 @@
1
- /**
2
- * Donation grant-token types for cadre-host.
3
- *
4
- * A **grant token** is a high-entropy base64url secret the host admin issues,
5
- * out-of-band (QR / copy-paste), to one *grantee* — a friend or family member
6
- * whose cadre authority (their phone) may then ask this host to spawn donated
7
- * nodes. The grantee presents the token as `Authorization: Bearer <grant-token>`
8
- * on every donation request (the grantee-facing surface lands in the
9
- * `2-donation-service` ticket).
10
- *
11
- * This module owns the grant's identity, expiry, and per-grantee quota. The
12
- * *live-node tally* it checks the quota against is owned by the donation
13
- * service, not by the grant layer — see `GrantValidator.validateForProvision`.
14
- *
15
- * **Grant ≠ trust-circle membership.** A trust-circle invite (`auth/`)
16
- * authorises a device to join *the host's own* cadre. A donation grant
17
- * authorises an external cadre authority to ask the host to spawn a node that
18
- * joins *the grantee's* cadre. The two token flows are deliberately separate
19
- * modules; this one reuses the *shape* of the trust-circle store (atomic
20
- * write-then-rename JSON, token-keyed rows) but with grant — not invite —
21
- * semantics: a grant is long-lived and reusable up to a quota, never
22
- * one-time-redeemed.
23
- */
24
-
25
- /** A grant the host admin issued to one grantee (friend/family). */
26
- export interface Grant {
27
- /** base64url secret; also the bearer credential. The store key. */
28
- token: string;
29
- /** Human label chosen by the admin, e.g. "Alice's cadre". Display-only. */
30
- label: string;
31
- /** Max concurrently-live donated nodes this grant may hold. */
32
- maxNodes: number;
33
- /** ISO timestamp when the grant was issued. */
34
- createdAt: string;
35
- /** ISO expiry; absent = no expiry. */
36
- expiresAt?: string;
37
- /** Set when the admin revokes; a revoked grant validates as denied. */
38
- revokedAt?: string;
39
- }
40
-
41
- /** Why a presented grant token was denied. */
42
- export type GrantDenyReason =
43
- | 'unknown_token' // no such grant
44
- | 'expired'
45
- | 'revoked'
46
- | 'quota_exceeded'; // live node count already at maxNodes
47
-
48
- /** Result of validating a presented bearer token. */
49
- export interface GrantValidation {
50
- ok: boolean;
51
- /** The matched grant, when the token names one (present even on some denials). */
52
- grant?: Grant;
53
- /** Set when `ok` is false. */
54
- reason?: GrantDenyReason;
55
- }
56
-
57
- /**
58
- * The slice `2-donation-service` depends on. Keeps that ticket decoupled from
59
- * the store implementation: it holds a `GrantValidator`, not a `GrantStore`.
60
- *
61
- * Both methods are pure functions of the store state (and, for provision, the
62
- * caller-supplied count) — they never throw for a bad token, they return a
63
- * denial. Issuance/revocation (which mutate) live on `GrantService`.
64
- */
65
- export interface GrantValidator {
66
- /**
67
- * Validate a presented bearer token for a *new* provision request.
68
- *
69
- * `liveNodeCount(token)` is supplied by the donation service — the grant
70
- * layer owns identity/expiry/revocation; the donation service owns the
71
- * authoritative live-node tally (it holds the grant→node records). The count
72
- * is only consulted once identity/expiry/revocation have passed, so an
73
- * unknown or dead token never invokes it.
74
- */
75
- validateForProvision(
76
- token: string,
77
- liveNodeCount: (token: string) => number,
78
- ): GrantValidation;
79
- /**
80
- * Validate for a non-provisioning op (peer/seed/terminate): identity + not
81
- * expired/revoked. No quota check.
82
- */
83
- validate(token: string): GrantValidation;
84
- }
85
-
86
- /** On-disk shape of `grants.json`. */
87
- export interface GrantFile {
88
- version: 1;
89
- /** keyed by token. */
90
- grants: Record<string, Omit<Grant, 'token'>>;
91
- }
92
-
93
- /**
94
- * Typed handlers exposed to the loopback management server for the **admin**
95
- * grant surface (`/grants-admin`). Distinct from the grantee-facing `/grants`
96
- * provisioning surface (`2-donation-service`): the admin surface is loopback,
97
- * no bearer — same-machine admin, matching cadre-host's local-UI "no login"
98
- * posture.
99
- *
100
- * Handlers throw a `GrantError` whose `.code` the server maps to an HTTP
101
- * status (see `server/error-handler.ts`).
102
- */
103
- export interface GrantAdminHandlers {
104
- postGrant(body: { label: string; maxNodes?: number; ttlMs?: number }): Promise<{ grant: Grant }>;
105
- listGrants(): Promise<{ grants: Grant[] }>;
106
- deleteGrant(token: string): Promise<void>;
107
- }
108
-
109
- /* ──────────────── donation lifecycle (2-donation-service) ──────────────── */
110
-
111
- /**
112
- * Lifecycle of one donated node:
113
- * provisioning → the child process is being spawned.
114
- * awaiting_seed → spawned + reachable; waiting for the requester to present
115
- * its phone-signed seed (`PUT /grants/:id/seed`).
116
- * seeded → the seed was applied; the node has joined the requester's cadre.
117
- * error → provisioning failed (orchestrator resources reclaimed).
118
- * terminated → stopped + removed (kept in the store for audit).
119
- *
120
- * A donation is "live" (counts against a grant's `maxNodes` quota) while it is
121
- * `provisioning`, `awaiting_seed`, or `seeded` — see `DonationStore.liveNodeCount`.
122
- */
123
- export type DonationStatus =
124
- | 'provisioning'
125
- | 'awaiting_seed'
126
- | 'seeded'
127
- | 'error'
128
- | 'terminated';
129
-
130
- /**
131
- * One donated node, tracked host-side and persisted to `donations.json`.
132
- *
133
- * The host contributes capacity only: `partyId` is the REQUESTER's cadre (a
134
- * foreign party), and `seedToken` gates the node's own `POST /seed` — it is
135
- * minted host-side, persisted here (so a host restart in the request→seed gap
136
- * can still present the seed), and NEVER returned to the grantee.
137
- *
138
- * The record also carries every input the original spawn consumed
139
- * (`partyId` + `profile` + `bootstrapNodes` + `ownerKeys`), so a crashed node can
140
- * be re-spawned from the record alone — see `DonationService.respawn`. Records
141
- * written before those two fields existed have neither; such a record is NOT
142
- * respawnable and is skipped (never crashes a sweep).
143
- */
144
- export interface Donation {
145
- /** "grn_<nanoid>" — also the donated node's orchestrator containerId. */
146
- id: string;
147
- /** The grant token that authorized this donation (the quota key). */
148
- grantToken: string;
149
- /** The REQUESTER's cadre (a foreign party this host merely hosts a node for). */
150
- partyId: string;
151
- /**
152
- * Requester control-network bootstrap multiaddrs — replayed on respawn.
153
- * Absent on records written before respawn support; those are not respawnable.
154
- */
155
- bootstrapNodes?: string[];
156
- /**
157
- * Requester owner public key(s), base64url — replayed as the node's pinned
158
- * seed-trust anchors (`CADRE_OWNER_KEYS`) on respawn. Absent on records written
159
- * before respawn support; those are not respawnable.
160
- */
161
- ownerKeys?: string[];
162
- /**
163
- * Respawn bookkeeping, owned by the supervisor's backoff. Absent until the
164
- * first respawn attempt. Not secret — it rides along in `DonationView` so the
165
- * borrower's `GET /grants/:id` shows the counters for free.
166
- */
167
- respawn?: { attempts: number; lastAttemptAt: string };
168
- /** Node profile. Defaults to `storage` so the node participates and is dialable. */
169
- profile: 'storage' | 'transaction';
170
- status: DonationStatus;
171
- /** Orchestrator handle (opaque `pid:token`), set once the child is spawned. */
172
- dockerId?: string;
173
- /**
174
- * Reserved: a donation's live peer identity is read fresh from the node's
175
- * `/status` on each `getPeer` call and is NOT persisted here — this field is
176
- * currently never written. Kept for a future cache if `/status` fan-out ever
177
- * shows up as hot.
178
- */
179
- peerId?: string;
180
- /** The node's loopback `POST /seed` URL. Host-internal — stripped from the wire view. */
181
- seedEndpoint?: string;
182
- /** Host↔node bearer gating `POST /seed`. Persisted; NEVER leaves the host. */
183
- seedToken?: string;
184
- createdAt: string;
185
- updatedAt: string;
186
- /** Failure detail when `status === 'error'`. */
187
- error?: string;
188
- }
189
-
190
- /**
191
- * Redacted wire shape returned to the grantee: the host-only secrets
192
- * (`seedToken`) and host-internal loopback URL (`seedEndpoint`) are stripped.
193
- */
194
- export type DonationView = Omit<Donation, 'seedToken' | 'seedEndpoint'>;
195
-
196
- /** On-disk shape of `donations.json`. Keyed by donation id. */
197
- export interface DonationFile {
198
- version: 1;
199
- donations: Record<string, Omit<Donation, 'id'>>;
200
- }
201
-
202
- /** Error codes thrown by the donation service / grantee-facing routes. */
203
- export type DonationErrorCode =
204
- | 'unauthorized' // 401 — missing / unknown grant bearer
205
- | 'forbidden' // 403 — revoked or expired grant
206
- | 'quota_exceeded' // 429 — grant already at its maxNodes cap
207
- | 'invalid_request' // 400 — malformed body
208
- | 'not_found' // 404 — no such donation (or not owned by this grant)
209
- | 'invalid_state' // 409 — op invalid for the donation's current status
210
- | 'seed_failed' // 502 — the node rejected the presented seed
211
- | 'peer_unavailable' // 503 — the node has no peer identity yet
212
- | 'orchestrator_error' // 500 — spawn / stop failure
213
- | 'storage_error'; // 500 — donations.json read/write failure
214
-
215
- /** Typed donation error carrying a stable `code` for HTTP mapping. */
216
- export class DonationError extends Error {
217
- readonly code: DonationErrorCode;
218
-
219
- constructor(code: DonationErrorCode, message: string) {
220
- super(message);
221
- this.name = 'DonationError';
222
- this.code = code;
223
- }
224
- }
225
-
226
- /** Error codes thrown by GrantStore / GrantService. */
227
- export type GrantErrorCode =
228
- | 'not_found' // unknown token on revoke
229
- | 'invalid_label'
230
- | 'invalid_max_nodes'
231
- | 'invalid_ttl'
232
- | 'storage_error';
233
-
234
- /** Typed error carrying a stable `code` for HTTP mapping. */
235
- export class GrantError extends Error {
236
- readonly code: GrantErrorCode;
237
-
238
- constructor(code: GrantErrorCode, message: string) {
239
- super(message);
240
- this.name = 'GrantError';
241
- this.code = code;
242
- }
243
- }
1
+ /**
2
+ * Donation grant-token types for cadre-host.
3
+ *
4
+ * A **grant token** is a high-entropy base64url secret the host admin issues,
5
+ * out-of-band (QR / copy-paste), to one *grantee* — a friend or family member
6
+ * whose cadre authority (their phone) may then ask this host to spawn donated
7
+ * nodes. The grantee presents the token as `Authorization: Bearer <grant-token>`
8
+ * on every donation request (the grantee-facing surface lands in the
9
+ * `2-donation-service` ticket).
10
+ *
11
+ * This module owns the grant's identity, expiry, and per-grantee quota. The
12
+ * *live-node tally* it checks the quota against is owned by the donation
13
+ * service, not by the grant layer — see `GrantValidator.validateForProvision`.
14
+ *
15
+ * **Grant ≠ trust-circle membership.** A trust-circle invite (`auth/`)
16
+ * authorises a device to join *the host's own* cadre. A donation grant
17
+ * authorises an external cadre authority to ask the host to spawn a node that
18
+ * joins *the grantee's* cadre. The two token flows are deliberately separate
19
+ * modules; this one reuses the *shape* of the trust-circle store (atomic
20
+ * write-then-rename JSON, token-keyed rows) but with grant — not invite —
21
+ * semantics: a grant is long-lived and reusable up to a quota, never
22
+ * one-time-redeemed.
23
+ */
24
+
25
+ /** A grant the host admin issued to one grantee (friend/family). */
26
+ export interface Grant {
27
+ /** base64url secret; also the bearer credential. The store key. */
28
+ token: string;
29
+ /** Human label chosen by the admin, e.g. "Alice's cadre". Display-only. */
30
+ label: string;
31
+ /** Max concurrently-live donated nodes this grant may hold. */
32
+ maxNodes: number;
33
+ /** ISO timestamp when the grant was issued. */
34
+ createdAt: string;
35
+ /** ISO expiry; absent = no expiry. */
36
+ expiresAt?: string;
37
+ /** Set when the admin revokes; a revoked grant validates as denied. */
38
+ revokedAt?: string;
39
+ }
40
+
41
+ /** Why a presented grant token was denied. */
42
+ export type GrantDenyReason =
43
+ | 'unknown_token' // no such grant
44
+ | 'expired'
45
+ | 'revoked'
46
+ | 'quota_exceeded'; // live node count already at maxNodes
47
+
48
+ /** Result of validating a presented bearer token. */
49
+ export interface GrantValidation {
50
+ ok: boolean;
51
+ /** The matched grant, when the token names one (present even on some denials). */
52
+ grant?: Grant;
53
+ /** Set when `ok` is false. */
54
+ reason?: GrantDenyReason;
55
+ }
56
+
57
+ /**
58
+ * The slice `2-donation-service` depends on. Keeps that ticket decoupled from
59
+ * the store implementation: it holds a `GrantValidator`, not a `GrantStore`.
60
+ *
61
+ * Both methods are pure functions of the store state (and, for provision, the
62
+ * caller-supplied count) — they never throw for a bad token, they return a
63
+ * denial. Issuance/revocation (which mutate) live on `GrantService`.
64
+ */
65
+ export interface GrantValidator {
66
+ /**
67
+ * Validate a presented bearer token for a *new* provision request.
68
+ *
69
+ * `liveNodeCount(token)` is supplied by the donation service — the grant
70
+ * layer owns identity/expiry/revocation; the donation service owns the
71
+ * authoritative live-node tally (it holds the grant→node records). The count
72
+ * is only consulted once identity/expiry/revocation have passed, so an
73
+ * unknown or dead token never invokes it.
74
+ */
75
+ validateForProvision(
76
+ token: string,
77
+ liveNodeCount: (token: string) => number,
78
+ ): GrantValidation;
79
+ /**
80
+ * Validate for a non-provisioning op (peer/seed/terminate): identity + not
81
+ * expired/revoked. No quota check.
82
+ */
83
+ validate(token: string): GrantValidation;
84
+ }
85
+
86
+ /** On-disk shape of `grants.json`. */
87
+ export interface GrantFile {
88
+ version: 1;
89
+ /** keyed by token. */
90
+ grants: Record<string, Omit<Grant, 'token'>>;
91
+ }
92
+
93
+ /**
94
+ * Typed handlers exposed to the loopback management server for the **admin**
95
+ * grant surface (`/grants-admin`). Distinct from the grantee-facing `/grants`
96
+ * provisioning surface (`2-donation-service`): the admin surface is loopback,
97
+ * no bearer — same-machine admin, matching cadre-host's local-UI "no login"
98
+ * posture.
99
+ *
100
+ * Handlers throw a `GrantError` whose `.code` the server maps to an HTTP
101
+ * status (see `server/error-handler.ts`).
102
+ */
103
+ export interface GrantAdminHandlers {
104
+ postGrant(body: { label: string; maxNodes?: number; ttlMs?: number }): Promise<{ grant: Grant }>;
105
+ listGrants(): Promise<{ grants: Grant[] }>;
106
+ deleteGrant(token: string): Promise<void>;
107
+ }
108
+
109
+ /* ──────────────── donation lifecycle (2-donation-service) ──────────────── */
110
+
111
+ /**
112
+ * Lifecycle of one donated node:
113
+ * provisioning → the child process is being spawned.
114
+ * awaiting_seed → spawned + reachable; waiting for the requester to present
115
+ * its phone-signed seed (`PUT /grants/:id/seed`).
116
+ * seeded → the seed was applied; the node has joined the requester's cadre.
117
+ * error → provisioning failed (orchestrator resources reclaimed).
118
+ * terminated → stopped + removed (kept in the store for audit).
119
+ *
120
+ * A donation is "live" (counts against a grant's `maxNodes` quota) while it is
121
+ * `provisioning`, `awaiting_seed`, or `seeded` — see `DonationStore.liveNodeCount`.
122
+ */
123
+ export type DonationStatus =
124
+ | 'provisioning'
125
+ | 'awaiting_seed'
126
+ | 'seeded'
127
+ | 'error'
128
+ | 'terminated';
129
+
130
+ /**
131
+ * One donated node, tracked host-side and persisted to `donations.json`.
132
+ *
133
+ * The host contributes capacity only: `partyId` is the REQUESTER's cadre (a
134
+ * foreign party), and `seedToken` gates the node's own `POST /seed` — it is
135
+ * minted host-side, persisted here (so a host restart in the request→seed gap
136
+ * can still present the seed), and NEVER returned to the grantee.
137
+ *
138
+ * The record also carries every input the original spawn consumed
139
+ * (`partyId` + `profile` + `bootstrapNodes` + `ownerKeys`), so a crashed node can
140
+ * be re-spawned from the record alone — see `DonationService.respawn`. Records
141
+ * written before those two fields existed have neither; such a record is NOT
142
+ * respawnable and is skipped (never crashes a sweep).
143
+ */
144
+ export interface Donation {
145
+ /** "grn_<nanoid>" — also the donated node's orchestrator containerId. */
146
+ id: string;
147
+ /** The grant token that authorized this donation (the quota key). */
148
+ grantToken: string;
149
+ /** The REQUESTER's cadre (a foreign party this host merely hosts a node for). */
150
+ partyId: string;
151
+ /**
152
+ * Requester control-network bootstrap multiaddrs — replayed on respawn.
153
+ * Absent on records written before respawn support; those are not respawnable.
154
+ */
155
+ bootstrapNodes?: string[];
156
+ /**
157
+ * Requester owner public key(s), base64url — replayed as the node's pinned
158
+ * seed-trust anchors (`CADRE_OWNER_KEYS`) on respawn. Absent on records written
159
+ * before respawn support; those are not respawnable.
160
+ */
161
+ ownerKeys?: string[];
162
+ /**
163
+ * Respawn bookkeeping, owned by the supervisor's backoff. Absent until the
164
+ * first respawn attempt. Not secret — it rides along in `DonationView` so the
165
+ * borrower's `GET /grants/:id` shows the counters for free.
166
+ */
167
+ respawn?: { attempts: number; lastAttemptAt: string };
168
+ /** Node profile. Defaults to `storage` so the node participates and is dialable. */
169
+ profile: 'storage' | 'transaction';
170
+ status: DonationStatus;
171
+ /** Orchestrator handle (opaque `pid:token`), set once the child is spawned. */
172
+ dockerId?: string;
173
+ /**
174
+ * Reserved: a donation's live peer identity is read fresh from the node's
175
+ * `/status` on each `getPeer` call and is NOT persisted here — this field is
176
+ * currently never written. Kept for a future cache if `/status` fan-out ever
177
+ * shows up as hot.
178
+ */
179
+ peerId?: string;
180
+ /** The node's loopback `POST /seed` URL. Host-internal — stripped from the wire view. */
181
+ seedEndpoint?: string;
182
+ /** Host↔node bearer gating `POST /seed`. Persisted; NEVER leaves the host. */
183
+ seedToken?: string;
184
+ createdAt: string;
185
+ updatedAt: string;
186
+ /** Failure detail when `status === 'error'`. */
187
+ error?: string;
188
+ }
189
+
190
+ /**
191
+ * Redacted wire shape returned to the grantee: the host-only secrets
192
+ * (`seedToken`) and host-internal loopback URL (`seedEndpoint`) are stripped.
193
+ */
194
+ export type DonationView = Omit<Donation, 'seedToken' | 'seedEndpoint'>;
195
+
196
+ /** On-disk shape of `donations.json`. Keyed by donation id. */
197
+ export interface DonationFile {
198
+ version: 1;
199
+ donations: Record<string, Omit<Donation, 'id'>>;
200
+ }
201
+
202
+ /** Error codes thrown by the donation service / grantee-facing routes. */
203
+ export type DonationErrorCode =
204
+ | 'unauthorized' // 401 — missing / unknown grant bearer
205
+ | 'forbidden' // 403 — revoked or expired grant
206
+ | 'quota_exceeded' // 429 — grant already at its maxNodes cap
207
+ | 'invalid_request' // 400 — malformed body
208
+ | 'not_found' // 404 — no such donation (or not owned by this grant)
209
+ | 'invalid_state' // 409 — op invalid for the donation's current status
210
+ | 'seed_failed' // 502 — the node rejected the presented seed
211
+ | 'peer_unavailable' // 503 — the node has no peer identity yet
212
+ | 'orchestrator_error' // 500 — spawn / stop failure
213
+ | 'storage_error'; // 500 — donations.json read/write failure
214
+
215
+ /** Typed donation error carrying a stable `code` for HTTP mapping. */
216
+ export class DonationError extends Error {
217
+ readonly code: DonationErrorCode;
218
+
219
+ constructor(code: DonationErrorCode, message: string) {
220
+ super(message);
221
+ this.name = 'DonationError';
222
+ this.code = code;
223
+ }
224
+ }
225
+
226
+ /** Error codes thrown by GrantStore / GrantService. */
227
+ export type GrantErrorCode =
228
+ | 'not_found' // unknown token on revoke
229
+ | 'invalid_label'
230
+ | 'invalid_max_nodes'
231
+ | 'invalid_ttl'
232
+ | 'storage_error';
233
+
234
+ /** Typed error carrying a stable `code` for HTTP mapping. */
235
+ export class GrantError extends Error {
236
+ readonly code: GrantErrorCode;
237
+
238
+ constructor(code: GrantErrorCode, message: string) {
239
+ super(message);
240
+ this.name = 'GrantError';
241
+ this.code = code;
242
+ }
243
+ }
@@ -1,34 +1,34 @@
1
- import { afterEach, beforeEach, describe, expect, it } from 'vitest';
2
- import { mkdtempSync, rmSync, statSync } from 'node:fs';
3
- import { tmpdir } from 'node:os';
4
- import { join } from 'node:path';
5
-
6
- import { generateIdentity, loadIdentity } from '../identity.js';
7
-
8
- describe('installer identity', () => {
9
- let tmp: string;
10
-
11
- beforeEach(() => {
12
- tmp = mkdtempSync(join(tmpdir(), 'cadre-host-id-'));
13
- });
14
-
15
- afterEach(() => {
16
- rmSync(tmp, { recursive: true, force: true });
17
- });
18
-
19
- it('round-trips an Ed25519 keypair through the file', async () => {
20
- const path = join(tmp, 'identity.key');
21
- const generated = await generateIdentity(path);
22
- expect(generated.peerId).toMatch(/^12D3Koo/);
23
-
24
- const loaded = loadIdentity(path);
25
- expect(loaded.peerId).toBe(generated.peerId);
26
- });
27
-
28
- it.runIf(process.platform !== 'win32')('persists with mode 0600 on POSIX', async () => {
29
- const path = join(tmp, 'identity.key');
30
- await generateIdentity(path);
31
- const mode = statSync(path).mode & 0o777;
32
- expect(mode).toBe(0o600);
33
- });
34
- });
1
+ import { afterEach, beforeEach, describe, expect, it } from 'vitest';
2
+ import { mkdtempSync, rmSync, statSync } from 'node:fs';
3
+ import { tmpdir } from 'node:os';
4
+ import { join } from 'node:path';
5
+
6
+ import { generateIdentity, loadIdentity } from '../identity.js';
7
+
8
+ describe('installer identity', () => {
9
+ let tmp: string;
10
+
11
+ beforeEach(() => {
12
+ tmp = mkdtempSync(join(tmpdir(), 'cadre-host-id-'));
13
+ });
14
+
15
+ afterEach(() => {
16
+ rmSync(tmp, { recursive: true, force: true });
17
+ });
18
+
19
+ it('round-trips an Ed25519 keypair through the file', async () => {
20
+ const path = join(tmp, 'identity.key');
21
+ const generated = await generateIdentity(path);
22
+ expect(generated.peerId).toMatch(/^12D3Koo/);
23
+
24
+ const loaded = loadIdentity(path);
25
+ expect(loaded.peerId).toBe(generated.peerId);
26
+ });
27
+
28
+ it.runIf(process.platform !== 'win32')('persists with mode 0600 on POSIX', async () => {
29
+ const path = join(tmp, 'identity.key');
30
+ await generateIdentity(path);
31
+ const mode = statSync(path).mode & 0o777;
32
+ expect(mode).toBe(0o600);
33
+ });
34
+ });
@@ -1,47 +1,47 @@
1
- import { describe, expect, it } from 'vitest';
2
-
3
- import { defaultDataDir, serviceInstallPath } from '../paths.js';
4
-
5
- describe('defaultDataDir', () => {
6
- it('honors XDG_DATA_HOME on linux', () => {
7
- expect(defaultDataDir('linux', { XDG_DATA_HOME: '/tmp/xdg', HOME: '/home/me' }, '/home/me'))
8
- .toBe('/tmp/xdg/cadre-host');
9
- });
10
-
11
- it('falls back to ~/.local/share on linux', () => {
12
- expect(defaultDataDir('linux', { HOME: '/home/me' }, '/home/me'))
13
- .toBe('/home/me/.local/share/cadre-host');
14
- });
15
-
16
- it('uses Application Support on darwin', () => {
17
- expect(defaultDataDir('darwin', { HOME: '/Users/me' }, '/Users/me'))
18
- .toBe('/Users/me/Library/Application Support/CadreHost');
19
- });
20
-
21
- it('uses LocalAppData on win32', () => {
22
- expect(defaultDataDir('win32', { LocalAppData: 'C:\\Users\\me\\AppData\\Local' }, 'C:\\Users\\me'))
23
- .toBe('C:\\Users\\me\\AppData\\Local\\CadreHost');
24
- });
25
-
26
- it('falls back to ~/AppData/Local on win32 without LocalAppData', () => {
27
- expect(defaultDataDir('win32', {}, 'C:\\Users\\me'))
28
- .toBe('C:\\Users\\me\\AppData\\Local\\CadreHost');
29
- });
30
- });
31
-
32
- describe('serviceInstallPath', () => {
33
- it('honors XDG_CONFIG_HOME on linux', () => {
34
- expect(serviceInstallPath('linux', { XDG_CONFIG_HOME: '/tmp/cfg', HOME: '/home/me' }, '/home/me'))
35
- .toBe('/tmp/cfg/systemd/user/cadre-host.service');
36
- });
37
-
38
- it('uses LaunchAgents on darwin', () => {
39
- expect(serviceInstallPath('darwin', { HOME: '/Users/me' }, '/Users/me'))
40
- .toBe('/Users/me/Library/LaunchAgents/com.serfab.cadre-host.plist');
41
- });
42
-
43
- it('returns a registry-style path on win32 (for logging only)', () => {
44
- expect(serviceInstallPath('win32', {}, 'C:\\Users\\me'))
45
- .toMatch(/CadreHost/);
46
- });
47
- });
1
+ import { describe, expect, it } from 'vitest';
2
+
3
+ import { defaultDataDir, serviceInstallPath } from '../paths.js';
4
+
5
+ describe('defaultDataDir', () => {
6
+ it('honors XDG_DATA_HOME on linux', () => {
7
+ expect(defaultDataDir('linux', { XDG_DATA_HOME: '/tmp/xdg', HOME: '/home/me' }, '/home/me'))
8
+ .toBe('/tmp/xdg/cadre-host');
9
+ });
10
+
11
+ it('falls back to ~/.local/share on linux', () => {
12
+ expect(defaultDataDir('linux', { HOME: '/home/me' }, '/home/me'))
13
+ .toBe('/home/me/.local/share/cadre-host');
14
+ });
15
+
16
+ it('uses Application Support on darwin', () => {
17
+ expect(defaultDataDir('darwin', { HOME: '/Users/me' }, '/Users/me'))
18
+ .toBe('/Users/me/Library/Application Support/CadreHost');
19
+ });
20
+
21
+ it('uses LocalAppData on win32', () => {
22
+ expect(defaultDataDir('win32', { LocalAppData: 'C:\\Users\\me\\AppData\\Local' }, 'C:\\Users\\me'))
23
+ .toBe('C:\\Users\\me\\AppData\\Local\\CadreHost');
24
+ });
25
+
26
+ it('falls back to ~/AppData/Local on win32 without LocalAppData', () => {
27
+ expect(defaultDataDir('win32', {}, 'C:\\Users\\me'))
28
+ .toBe('C:\\Users\\me\\AppData\\Local\\CadreHost');
29
+ });
30
+ });
31
+
32
+ describe('serviceInstallPath', () => {
33
+ it('honors XDG_CONFIG_HOME on linux', () => {
34
+ expect(serviceInstallPath('linux', { XDG_CONFIG_HOME: '/tmp/cfg', HOME: '/home/me' }, '/home/me'))
35
+ .toBe('/tmp/cfg/systemd/user/cadre-host.service');
36
+ });
37
+
38
+ it('uses LaunchAgents on darwin', () => {
39
+ expect(serviceInstallPath('darwin', { HOME: '/Users/me' }, '/Users/me'))
40
+ .toBe('/Users/me/Library/LaunchAgents/com.serfab.cadre-host.plist');
41
+ });
42
+
43
+ it('returns a registry-style path on win32 (for logging only)', () => {
44
+ expect(serviceInstallPath('win32', {}, 'C:\\Users\\me'))
45
+ .toMatch(/CadreHost/);
46
+ });
47
+ });