Commit d979a06
refactor(ocap-kernel): branded kernel identifiers with runtime validation (#917)
Fixes #809
## Summary
- Add branded string types (`VatId`, `RemoteId`, `KRef`, `VRef`, `RRef`,
`SubclusterId`, `GCAction`, etc.) for kernel identifiers with runtime
validators (`isX`/`insistX`)
- Split `Message` into `KernelMessage` (kernel-space, KRef slots) and
`EndpointMessage` (endpoint-space, ERef slots)
- Remove public `kv` from `KernelStore` API, replace with typed accessor
methods
- Add `KernelOneResolution` type for kernel-space promise resolutions
- Add `KernelSyscallObject` discriminated union type for kernel-space
syscalls, removing casts from `VatSyscall`
- Add `makeGCAction` factory with runtime validation
- Remove redundant interior runtime validation where branded types
enforce correctness at compile time
- Tighten function signatures throughout OCAP URL redemption chain and
`kslot`/`makeStandinPromise` to use `KRef`
- Validate `coerceEndpointMessage` with `EndpointMessageStruct` at the
liveslots boundary
- Fix `getOwner` to handle `'kernel'` owner without throwing EndpointId
validation failure
- Document branded type trust model (types.ts header, store README)
- Add comprehensive tests for all ref validators and assertion functions
## TODO
- `kernel-ui` type safety is not fully addressed by this PR, and will be
implemented in a follow-up
- While the API of the kernel store is type safe, it is only type safe
by an established convention of `writeX(value: X): void` / `readX(): X`
pairs that use the same db keys internally. If we want to make the store
actually type safe, we would have to establish some kind of compile-time
mapping between db keys and value types. This may or may not be worth
the trouble, and we defer this decision to the future.
## Test plan
- [x] `yarn workspace @MetaMask/ocap-kernel lint:fix` passes
- [x] `yarn workspace @MetaMask/ocap-kernel build` passes
- [x] `yarn workspace @MetaMask/ocap-kernel test:dev:quiet` passes
- [x] `yarn workspace @metamask/kernel-node-runtime test:e2e:ci` passes
🤖 Generated with [Claude Code](https://claude.com/claude-code)
<!-- CURSOR_SUMMARY -->
---
> [!NOTE]
> **Medium Risk**
> Touches core kernel routing/queueing, remote comms, and persistence
access patterns; while largely type-safety refactors, signature changes
and reduced runtime checks could surface as behavioral regressions at
boundaries (RPC/liveslots/remotes) if any call sites or stored data
violate the new invariants.
>
> **Overview**
> **Branded kernel identifiers are enforced end-to-end.** This
introduces branded string types (e.g., `KRef`, `VatId`, `SubclusterId`)
with `is*`/`insist*` validators, and updates kernel/public RPC APIs
(e.g., `queueMessage`, `issueOcapURL`, `terminateSubcluster`) and UI
call sites to use these types.
>
> **Message and resolution types are split and tightened.** `Message` is
separated into `KernelMessage` vs `EndpointMessage`, promise resolution
flows switch to kernel-space types, and the
queue/router/service-manager/remotes paths are updated accordingly
(including narrowed `kslot`/`krefOf` behavior).
>
> **Raw KV access is removed from `KernelStore`.** `KernelStore.kv` is
no longer exposed; consumers/tests now use typed accessors for
initialization state, kernel-service krefs, remote identity values, and
known relay storage (with added validation on relay parsing).
>
> <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit
812f5bf. Bugbot is set up for automated
code reviews on this repo. Configure
[here](https://www.cursor.com/dashboard/bugbot).</sup>
<!-- /CURSOR_SUMMARY -->
---------
Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>1 parent a0c1560 commit d979a06
74 files changed
Lines changed: 1500 additions & 918 deletions
File tree
- packages
- kernel-store/src
- sqlite
- kernel-test/src
- kernel-ui/src
- components
- hooks
- services
- kernel-utils/src
- ocap-kernel/src
- garbage-collection
- liveslots
- remotes
- kernel
- rpc
- kernel-control
- vat-syscall
- vat
- store
- methods
- utils
- vats
- omnium-gatherum/src
Some content is hidden
Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
108 | 108 | | |
109 | 109 | | |
110 | 110 | | |
111 | | - | |
| 111 | + | |
| 112 | + | |
112 | 113 | | |
113 | | - | |
| 114 | + | |
| 115 | + | |
114 | 116 | | |
115 | 117 | | |
116 | 118 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
137 | 137 | | |
138 | 138 | | |
139 | 139 | | |
140 | | - | |
| 140 | + | |
| 141 | + | |
141 | 142 | | |
142 | | - | |
| 143 | + | |
| 144 | + | |
143 | 145 | | |
144 | 146 | | |
145 | 147 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | | - | |
3 | | - | |
| 2 | + | |
| 3 | + | |
4 | 4 | | |
5 | 5 | | |
6 | 6 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | 3 | | |
4 | | - | |
| 4 | + | |
5 | 5 | | |
6 | 6 | | |
7 | 7 | | |
| |||
153 | 153 | | |
154 | 154 | | |
155 | 155 | | |
156 | | - | |
| 156 | + | |
157 | 157 | | |
158 | 158 | | |
159 | 159 | | |
| |||
168 | 168 | | |
169 | 169 | | |
170 | 170 | | |
171 | | - | |
172 | | - | |
173 | | - | |
174 | | - | |
175 | | - | |
176 | | - | |
177 | | - | |
178 | | - | |
179 | | - | |
| 171 | + | |
| 172 | + | |
| 173 | + | |
| 174 | + | |
| 175 | + | |
| 176 | + | |
| 177 | + | |
| 178 | + | |
| 179 | + | |
180 | 180 | | |
181 | 181 | | |
182 | 182 | | |
183 | 183 | | |
184 | 184 | | |
185 | 185 | | |
186 | | - | |
187 | | - | |
| 186 | + | |
| 187 | + | |
188 | 188 | | |
189 | 189 | | |
190 | 190 | | |
191 | 191 | | |
192 | 192 | | |
193 | 193 | | |
194 | 194 | | |
195 | | - | |
| 195 | + | |
196 | 196 | | |
197 | 197 | | |
198 | 198 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
9 | 9 | | |
10 | 10 | | |
11 | 11 | | |
| 12 | + | |
12 | 13 | | |
13 | 14 | | |
14 | 15 | | |
| |||
68 | 69 | | |
69 | 70 | | |
70 | 71 | | |
71 | | - | |
| 72 | + | |
72 | 73 | | |
73 | 74 | | |
74 | 75 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
7 | 7 | | |
8 | 8 | | |
9 | 9 | | |
| 10 | + | |
10 | 11 | | |
11 | 12 | | |
12 | 13 | | |
| |||
15 | 16 | | |
16 | 17 | | |
17 | 18 | | |
18 | | - | |
| 19 | + | |
19 | 20 | | |
20 | 21 | | |
21 | | - | |
22 | | - | |
23 | | - | |
24 | | - | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
25 | 26 | | |
26 | 27 | | |
27 | 28 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
5 | 5 | | |
6 | 6 | | |
7 | 7 | | |
| 8 | + | |
8 | 9 | | |
9 | 10 | | |
10 | 11 | | |
| |||
17 | 18 | | |
18 | 19 | | |
19 | 20 | | |
20 | | - | |
21 | | - | |
22 | | - | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
23 | 24 | | |
24 | 25 | | |
25 | 26 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
2 | 2 | | |
3 | 3 | | |
4 | 4 | | |
| 5 | + | |
5 | 6 | | |
6 | 7 | | |
7 | 8 | | |
| |||
45 | 46 | | |
46 | 47 | | |
47 | 48 | | |
48 | | - | |
| 49 | + | |
49 | 50 | | |
50 | 51 | | |
51 | 52 | | |
| |||
120 | 121 | | |
121 | 122 | | |
122 | 123 | | |
123 | | - | |
| 124 | + | |
124 | 125 | | |
125 | 126 | | |
126 | 127 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
1 | 3 | | |
2 | 4 | | |
3 | 5 | | |
| |||
22 | 24 | | |
23 | 25 | | |
24 | 26 | | |
25 | | - | |
26 | | - | |
| 27 | + | |
| 28 | + | |
27 | 29 | | |
28 | 30 | | |
29 | 31 | | |
| |||
78 | 80 | | |
79 | 81 | | |
80 | 82 | | |
81 | | - | |
| 83 | + | |
82 | 84 | | |
83 | 85 | | |
84 | 86 | | |
| |||
87 | 89 | | |
88 | 90 | | |
89 | 91 | | |
90 | | - | |
| 92 | + | |
91 | 93 | | |
92 | 94 | | |
93 | 95 | | |
| |||
112 | 114 | | |
113 | 115 | | |
114 | 116 | | |
115 | | - | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
116 | 122 | | |
117 | 123 | | |
118 | 124 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | | - | |
| 1 | + | |
2 | 2 | | |
3 | 3 | | |
4 | 4 | | |
5 | 5 | | |
6 | 6 | | |
7 | 7 | | |
8 | | - | |
| 8 | + | |
9 | 9 | | |
10 | 10 | | |
11 | 11 | | |
| |||
37 | 37 | | |
38 | 38 | | |
39 | 39 | | |
40 | | - | |
| 40 | + | |
41 | 41 | | |
42 | 42 | | |
43 | 43 | | |
| |||
52 | 52 | | |
53 | 53 | | |
54 | 54 | | |
55 | | - | |
| 55 | + | |
56 | 56 | | |
57 | 57 | | |
58 | 58 | | |
| |||
67 | 67 | | |
68 | 68 | | |
69 | 69 | | |
70 | | - | |
| 70 | + | |
71 | 71 | | |
72 | 72 | | |
73 | 73 | | |
0 commit comments