@totemsdk/omnia-host 0.9.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.
- package/LICENSE +202 -21
- package/NOTICE +60 -0
- package/README.md +44 -0
- package/dist/api/jsonrpc.d.ts +12 -0
- package/dist/api/jsonrpc.js +100 -1
- package/dist/api/methods.d.ts +135 -3
- package/dist/api/methods.js +1986 -45
- package/dist/chain/totem-node-adapter.js +1 -1
- package/dist/cli.js +67 -0
- package/dist/config.d.ts +20 -0
- package/dist/config.js +33 -1
- package/dist/identity.js +1 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.js +20 -1
- package/dist/lifecycle.d.ts +22 -0
- package/dist/lifecycle.js +422 -5
- package/dist/observe/bus.d.ts +13 -0
- package/dist/observe/bus.js +29 -0
- package/dist/observe/emitter.d.ts +61 -0
- package/dist/observe/emitter.js +133 -0
- package/dist/observe/index.d.ts +5 -0
- package/dist/observe/index.js +21 -0
- package/dist/observe/snapshot.d.ts +38 -0
- package/dist/observe/snapshot.js +101 -0
- package/dist/observe/store.d.ts +31 -0
- package/dist/observe/store.js +82 -0
- package/dist/observe/types.d.ts +106 -0
- package/dist/observe/types.js +14 -0
- package/dist/pairing.d.ts +109 -0
- package/dist/pairing.js +231 -0
- package/dist/reply-cache.d.ts +21 -0
- package/dist/reply-cache.js +62 -0
- package/dist/signer-port.d.ts +27 -0
- package/dist/signer-port.js +79 -0
- package/dist/signing.d.ts +11 -0
- package/dist/signing.js +27 -0
- package/dist/stores/operations.d.ts +3 -2
- package/dist/stores/operations.js +96 -83
- package/dist/stores/sqlite-store.d.ts +8 -5
- package/dist/stores/sqlite-store.js +45 -42
- package/package.json +16 -14
package/LICENSE
CHANGED
|
@@ -1,21 +1,202 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
package/NOTICE
ADDED
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
Totem SDK
|
|
2
|
+
Copyright 2024-2026 Totem SDK Contributors
|
|
3
|
+
|
|
4
|
+
This product includes software and material derived from the projects listed
|
|
5
|
+
below. The notices are provided for attribution and do not modify the Apache
|
|
6
|
+
License, Version 2.0.
|
|
7
|
+
|
|
8
|
+
Minima
|
|
9
|
+
------
|
|
10
|
+
Minima protocol and application
|
|
11
|
+
https://github.com/minima-global/Minima
|
|
12
|
+
Licensed under the Apache License, Version 2.0.
|
|
13
|
+
|
|
14
|
+
Portions of the Totem SDK core, KISSVM, serialization, transaction and wallet
|
|
15
|
+
surfaces are translated or adapted from Minima's Java implementation. Those
|
|
16
|
+
portions remain subject to the Apache License, Version 2.0 and retain the
|
|
17
|
+
applicable copyright and attribution notices.
|
|
18
|
+
|
|
19
|
+
Bouncy Castle
|
|
20
|
+
-------------
|
|
21
|
+
Legion of the Bouncy Castle Inc.
|
|
22
|
+
https://www.bouncycastle.org/
|
|
23
|
+
Licensed under the Bouncy Castle License (MIT-style).
|
|
24
|
+
|
|
25
|
+
The Winternitz/GMSS-compatible WOTS implementation follows the algorithms and
|
|
26
|
+
behaviour of Bouncy Castle's WinternitzOTSignature, WinternitzOTSVerify and
|
|
27
|
+
GMSSRandom classes.
|
|
28
|
+
|
|
29
|
+
QVAC
|
|
30
|
+
----
|
|
31
|
+
QVAC SDK
|
|
32
|
+
https://www.npmjs.com/package/@qvac/sdk
|
|
33
|
+
Licensed under the Apache License, Version 2.0.
|
|
34
|
+
|
|
35
|
+
The vendored type surface in packages/qvac/src/vendor/qvac-sdk.d.ts is
|
|
36
|
+
reconstructed from the @qvac/sdk type declarations for build-time use.
|
|
37
|
+
|
|
38
|
+
Protocol Buffers
|
|
39
|
+
----------------
|
|
40
|
+
Protocol Buffers - Google's data interchange format
|
|
41
|
+
Copyright 2008 Google Inc. All rights reserved.
|
|
42
|
+
https://developers.google.com/protocol-buffers/
|
|
43
|
+
Licensed under the BSD 3-Clause License.
|
|
44
|
+
|
|
45
|
+
The generated file packages/agent-policy/src/generated/google/protobuf/struct.ts
|
|
46
|
+
retains its original BSD 3-Clause header.
|
|
47
|
+
|
|
48
|
+
BIP39
|
|
49
|
+
-----
|
|
50
|
+
BIP39 English word list
|
|
51
|
+
https://github.com/bitcoin/bips/blob/master/bip-0039/english.txt
|
|
52
|
+
Licensed under the MIT License.
|
|
53
|
+
|
|
54
|
+
Contributor Covenant
|
|
55
|
+
--------------------
|
|
56
|
+
Contributor Covenant, version 2.1
|
|
57
|
+
https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
|
|
58
|
+
Licensed under the Creative Commons Attribution 4.0 International License.
|
|
59
|
+
|
|
60
|
+
The Totem SDK Code of Conduct is adapted from Contributor Covenant 2.1.
|
package/README.md
CHANGED
|
@@ -23,6 +23,10 @@ The daemon configuration is read from environment variables:
|
|
|
23
23
|
| `OMNIA_CHAIN_RPC` | `http://127.0.0.1:9005` | Totem node RPC endpoint |
|
|
24
24
|
| `OMNIA_CHAIN_RPC_PASSWORD` | unset | Totem node RPC password |
|
|
25
25
|
| `OMNIA_ANALYTICS_DB` | unset | Optional DuckDB analytics path |
|
|
26
|
+
| `OMNIA_OBSERVE` | on | `0`/`false` disables the durable observation feed |
|
|
27
|
+
| `OMNIA_OBSERVE_DB` | `<OMNIA_HOST_DB dir>/observe.sqlite` | Observation journal (via `@totemsdk/storage`) |
|
|
28
|
+
| `OMNIA_NETWORK_ID` | `omnia` | Observation network id |
|
|
29
|
+
| `OMNIA_SOURCE_NODE_ID` | `OMNIA_LOCAL_PARTY_ID` or `omnia-host` | Stable observation source id |
|
|
26
30
|
| `OMNIA_RELAY` | native swarm | Optional relay URL |
|
|
27
31
|
| `OMNIA_LOCAL_PUBKEY` | unset | Local Omnia identity |
|
|
28
32
|
| `OMNIA_LOCAL_PARTY_ID` | unset | Local channel party ID required for mutations |
|
|
@@ -35,9 +39,49 @@ The daemon configuration is read from environment variables:
|
|
|
35
39
|
| `OMNIA_HOST_READ_ONLY` | unset | `1` forces read-only mode even with keys present |
|
|
36
40
|
| `OMNIA_HOST_IDENTITY_FILE` | unset | Optional delegated identity claim JSON (operator root → service delegate) |
|
|
37
41
|
| `OMNIA_HOST_SERVICE_TYPE` | `omnia-router` | EdgeServiceManifest serviceType |
|
|
42
|
+
| `OMNIA_P2P_HUB_PORT` | unset | Enable the RFC-062 loopback P2P hub on this port |
|
|
43
|
+
| `OMNIA_P2P_HUB_HOST` | `127.0.0.1` | Hub bind address; keep loopback unless explicitly remote |
|
|
44
|
+
| `OMNIA_P2P_HUB_TOKEN` | unset | Hub bearer token (use a per-client credential in production) |
|
|
45
|
+
| `OMNIA_P2P_HUB_ORIGINS` | unset | Comma-separated browser Origin allowlist |
|
|
46
|
+
| `OMNIA_P2P_HUB_TOPICS` | unset | Comma-separated topic prefixes (e.g. `omnia,dex.v1`) |
|
|
47
|
+
|
|
48
|
+
### Observation feed (read-only)
|
|
49
|
+
|
|
50
|
+
Every host runs a durable, replayable observation journal (RFC-0011 Amendment A)
|
|
51
|
+
built on `@totemsdk/storage` (`createJournal` + `SqliteStore`) — **not** a direct
|
|
52
|
+
SQLite/DuckDB write. It records domain transitions (channel open/update/HTLC/
|
|
53
|
+
settle/close, factory/VC, splice, VTXO, pool, operation, transport) with identity,
|
|
54
|
+
correlation, exact amounts, chain/evidence refs and a compact before/after diff.
|
|
55
|
+
|
|
56
|
+
```text
|
|
57
|
+
GET /observe/snapshot → current state + journal cursor
|
|
58
|
+
GET /observe/events?after=<cursor> → SSE replay + live tail (Last-Event-ID)
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
Both endpoints use the control-plane origin allowlist and `OMNIA_CONTROL_TOKEN`
|
|
62
|
+
bearer auth. Events never include seeds, private keys, preimages or raw
|
|
63
|
+
signatures (only hashes/indices). The emitter persists asynchronously and never
|
|
64
|
+
blocks a mutation.
|
|
65
|
+
|
|
66
|
+
**Persistence.** All host persistence — the channel store, the operation journal
|
|
67
|
+
and the observation events — goes through `@totemsdk/storage`. The channel and
|
|
68
|
+
operation stores use the synchronous `@totemsdk/storage/sqlite-sync` adapter
|
|
69
|
+
(same codec/envelope as `SqliteStore`); legacy `omnia_channels` /
|
|
70
|
+
`omnia_operations` tables are migrated automatically on open. `omnia-host` does
|
|
71
|
+
not import `better-sqlite3` directly.
|
|
38
72
|
|
|
39
73
|
### Signing model
|
|
40
74
|
|
|
75
|
+
Pairing a local node with the extension (RFC-062):
|
|
76
|
+
|
|
77
|
+
```bash
|
|
78
|
+
OMNIA_HOST_DB=~/.totem/omnia/omnia.sqlite OMNIA_P2P_HUB_PORT=7788 omnia-host pair
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
The command prints a one-time code, node fingerprint and endpoint. Open Totem →
|
|
82
|
+
Settings → **PAIR NODE**, paste them, verify the fingerprint and confirm. The
|
|
83
|
+
pairing service listens on `127.0.0.1:${OMNIA_PAIR_PORT:-7789}` by default.
|
|
84
|
+
|
|
41
85
|
`OMNIA_HOST_SEED` (or the keyfile) is the base seed. The host derives the unified
|
|
42
86
|
child TreeKey (`createUnifiedChildTreeKey(baseSeed, localAddressIndex)`) and signs
|
|
43
87
|
every channel state (and the boot manifest) with serialized TreeSignatures; the
|
package/dist/api/jsonrpc.d.ts
CHANGED
|
@@ -1,5 +1,8 @@
|
|
|
1
1
|
import type { AddressInfo } from 'node:net';
|
|
2
2
|
import { type WebSocket } from 'ws';
|
|
3
|
+
import type { ObservationBus } from '../observe/bus.js';
|
|
4
|
+
import type { ObservationStore } from '../observe/types.js';
|
|
5
|
+
import type { ObserveSnapshot } from '../observe/types.js';
|
|
3
6
|
export interface JsonRpcRequest {
|
|
4
7
|
jsonrpc?: '2.0';
|
|
5
8
|
id?: string | number | null;
|
|
@@ -36,6 +39,15 @@ export interface ControlServerOptions {
|
|
|
36
39
|
* over the WebSocket handshake.
|
|
37
40
|
*/
|
|
38
41
|
authToken?: string;
|
|
42
|
+
/**
|
|
43
|
+
* Read-only observation feed (RFC-0011 Amendment A). Snapshot and SSE are
|
|
44
|
+
* guarded by the same origin allowlist + bearer token as the RPC surface.
|
|
45
|
+
*/
|
|
46
|
+
observe?: {
|
|
47
|
+
store: ObservationStore;
|
|
48
|
+
bus: ObservationBus;
|
|
49
|
+
snapshot: () => ObserveSnapshot | Promise<ObserveSnapshot>;
|
|
50
|
+
};
|
|
39
51
|
}
|
|
40
52
|
export interface ControlServer {
|
|
41
53
|
listen(): Promise<void>;
|
package/dist/api/jsonrpc.js
CHANGED
|
@@ -98,6 +98,83 @@ function safeTokenEqual(provided, expected) {
|
|
|
98
98
|
return false;
|
|
99
99
|
return node_crypto_1.default.timingSafeEqual(a, b);
|
|
100
100
|
}
|
|
101
|
+
function authorizeControlPlane(req, allowedOrigins, authToken) {
|
|
102
|
+
if (!isOriginAllowed(req, allowedOrigins))
|
|
103
|
+
return false;
|
|
104
|
+
if (authToken !== undefined && !safeTokenEqual(bearerToken(req), authToken))
|
|
105
|
+
return false;
|
|
106
|
+
return true;
|
|
107
|
+
}
|
|
108
|
+
function parseObserveCursor(req) {
|
|
109
|
+
const url = new URL(req.url ?? '/', 'http://localhost');
|
|
110
|
+
const after = Number(url.searchParams.get('after') ?? NaN);
|
|
111
|
+
if (Number.isFinite(after) && after >= 0)
|
|
112
|
+
return Math.floor(after);
|
|
113
|
+
const lastEventId = req.headers['last-event-id'];
|
|
114
|
+
const raw = Array.isArray(lastEventId) ? lastEventId[0] : lastEventId;
|
|
115
|
+
const parsed = Number(raw ?? NaN);
|
|
116
|
+
return Number.isFinite(parsed) && parsed >= 0 ? Math.floor(parsed) : 0;
|
|
117
|
+
}
|
|
118
|
+
async function streamObservations(req, res, observe) {
|
|
119
|
+
res.writeHead(200, {
|
|
120
|
+
'content-type': 'text/event-stream',
|
|
121
|
+
'cache-control': 'no-cache',
|
|
122
|
+
connection: 'keep-alive',
|
|
123
|
+
'x-accel-buffering': 'no',
|
|
124
|
+
});
|
|
125
|
+
let last = parseObserveCursor(req);
|
|
126
|
+
let closed = false;
|
|
127
|
+
let live = false;
|
|
128
|
+
const pending = new Map();
|
|
129
|
+
const write = (obs) => {
|
|
130
|
+
if (closed || obs.sourceSequence <= last)
|
|
131
|
+
return;
|
|
132
|
+
last = obs.sourceSequence;
|
|
133
|
+
res.write(`id: ${obs.sourceSequence}\nevent: observation\ndata: ${JSON.stringify(obs)}\n\n`);
|
|
134
|
+
};
|
|
135
|
+
const unsubscribe = observe.bus.subscribe((obs) => {
|
|
136
|
+
if (obs.sourceSequence <= last)
|
|
137
|
+
return;
|
|
138
|
+
if (live)
|
|
139
|
+
write(obs);
|
|
140
|
+
else
|
|
141
|
+
pending.set(obs.sourceSequence, obs);
|
|
142
|
+
});
|
|
143
|
+
const heartbeat = setInterval(() => {
|
|
144
|
+
if (!closed)
|
|
145
|
+
res.write(': keep-alive\n\n');
|
|
146
|
+
}, 15_000);
|
|
147
|
+
heartbeat.unref?.();
|
|
148
|
+
const cleanup = () => {
|
|
149
|
+
if (closed)
|
|
150
|
+
return;
|
|
151
|
+
closed = true;
|
|
152
|
+
clearInterval(heartbeat);
|
|
153
|
+
unsubscribe();
|
|
154
|
+
res.end();
|
|
155
|
+
};
|
|
156
|
+
req.on('close', cleanup);
|
|
157
|
+
req.on('error', cleanup);
|
|
158
|
+
try {
|
|
159
|
+
const cursor = await observe.store.head();
|
|
160
|
+
res.write(`event: cursor\ndata: ${JSON.stringify({ cursor })}\n\n`);
|
|
161
|
+
// Replay the durable journal, then flush anything the bus delivered while
|
|
162
|
+
// replaying. The journal is the source of truth; no gap, no duplication.
|
|
163
|
+
for (const obs of await observe.store.readSince(last))
|
|
164
|
+
write(obs);
|
|
165
|
+
live = true;
|
|
166
|
+
for (const seq of Array.from(pending.keys()).sort((a, b) => a - b)) {
|
|
167
|
+
const obs = pending.get(seq);
|
|
168
|
+
if (obs)
|
|
169
|
+
write(obs);
|
|
170
|
+
}
|
|
171
|
+
pending.clear();
|
|
172
|
+
}
|
|
173
|
+
catch (error) {
|
|
174
|
+
console.error('[observe] stream failed:', error instanceof Error ? error.message : String(error));
|
|
175
|
+
cleanup();
|
|
176
|
+
}
|
|
177
|
+
}
|
|
101
178
|
function createControlServer(options) {
|
|
102
179
|
// RFC-020 H1: a non-loopback bind must be authenticated. Refuse to start a
|
|
103
180
|
// network-exposed control plane without a token.
|
|
@@ -119,7 +196,29 @@ function createControlServer(options) {
|
|
|
119
196
|
sendJson(res, ready ? 200 : 503, { ok: ready });
|
|
120
197
|
return;
|
|
121
198
|
}
|
|
122
|
-
|
|
199
|
+
const route = pathname(req.url);
|
|
200
|
+
if (req.method === 'GET' && (route === '/observe/snapshot' || route === '/observe/events')) {
|
|
201
|
+
if (!options.observe) {
|
|
202
|
+
sendJson(res, 404, { error: 'Observation feed not enabled' });
|
|
203
|
+
return;
|
|
204
|
+
}
|
|
205
|
+
if (!authorizeControlPlane(req, allowedOrigins, authToken)) {
|
|
206
|
+
sendJson(res, 403, { error: 'Forbidden' });
|
|
207
|
+
return;
|
|
208
|
+
}
|
|
209
|
+
if (route === '/observe/snapshot') {
|
|
210
|
+
try {
|
|
211
|
+
sendJson(res, 200, await options.observe.snapshot());
|
|
212
|
+
}
|
|
213
|
+
catch (error) {
|
|
214
|
+
sendJson(res, 500, { error: error instanceof Error ? error.message : String(error) });
|
|
215
|
+
}
|
|
216
|
+
return;
|
|
217
|
+
}
|
|
218
|
+
await streamObservations(req, res, options.observe);
|
|
219
|
+
return;
|
|
220
|
+
}
|
|
221
|
+
if (req.method !== 'POST' || route !== wsPath) {
|
|
123
222
|
sendJson(res, 404, { error: 'Not found' });
|
|
124
223
|
return;
|
|
125
224
|
}
|
package/dist/api/methods.d.ts
CHANGED
|
@@ -1,22 +1,32 @@
|
|
|
1
|
-
import
|
|
1
|
+
import { buildSettlementSigningRequest } from '@totemsdk/omnia';
|
|
2
|
+
import type { ChannelParticipant, ChannelSigner, CustodyMode, OmniaChannel, OmniaPeer, OmniaSwarm, SignRequest, SignerPort, UnsignedStateUpdate, ChannelOpeningPlan } from '@totemsdk/omnia';
|
|
3
|
+
import { type OmniaVtxo, type OmniaVtxoPool, type VtxoOperatorReceipt } from '@totemsdk/omnia-vtxo';
|
|
4
|
+
import { type LiquidityAllocation, type LiquidityBondRegistryState, type LiquidityPoolManifest, type LiquidityPosition, type WithdrawalIntent } from '@totemsdk/liquidity-bond';
|
|
2
5
|
import type { ChainStateProvider } from '@totemsdk/chain-provider';
|
|
3
6
|
import type { WotsLeaseProvider } from '@totemsdk/wots-lease';
|
|
4
|
-
import { type ChannelFactory, type WotsLeaseBundle } from '@totemsdk/omnia-factory';
|
|
5
|
-
import { type SpliceAcceptance, type SpliceLeaseProvider, type SpliceProposal } from '@totemsdk/omnia-splice';
|
|
7
|
+
import { type ChannelFactory, type FactoryOpeningPlan, type WotsLeaseBundle } from '@totemsdk/omnia-factory';
|
|
8
|
+
import { type QuiescedChannel, type SpliceAcceptance, type SpliceLeaseProvider, type SpliceProposal, type UnsignedSpliceProposal } from '@totemsdk/omnia-splice';
|
|
6
9
|
import type { JsonRpcHandler } from './jsonrpc.js';
|
|
7
10
|
import type { RoutingProvider } from '../router/routing-provider.js';
|
|
8
11
|
import type { OperationStore } from '../stores/operations.js';
|
|
12
|
+
import type { ObservationEmitter } from '../observe/emitter.js';
|
|
9
13
|
export type OperationStoreLike = Pick<OperationStore, 'get' | 'create' | 'transition' | 'listByStatus'>;
|
|
10
14
|
export interface HostApiContext {
|
|
11
15
|
channels: Map<string, OmniaChannel>;
|
|
12
16
|
routing: RoutingProvider;
|
|
13
17
|
refreshRouting?: () => void;
|
|
14
18
|
operations?: OperationStoreLike;
|
|
19
|
+
/** Durable observation emitter (optional; behind OMNIA_OBSERVE). */
|
|
20
|
+
observe?: ObservationEmitter;
|
|
15
21
|
signer?: ChannelSigner;
|
|
16
22
|
leaseProvider?: WotsLeaseProvider;
|
|
17
23
|
chainProvider?: ChainStateProvider;
|
|
18
24
|
swarm?: OmniaSwarm;
|
|
25
|
+
/** Last authenticated peer seen for each channel; reply over it directly. */
|
|
26
|
+
channelPeers?: Map<string, OmniaPeer>;
|
|
19
27
|
localParticipant?: ChannelParticipant;
|
|
28
|
+
/** Native transport identity, published in the signed manifest. */
|
|
29
|
+
transportPubkey?: string;
|
|
20
30
|
/**
|
|
21
31
|
* Signs the funding-transaction digest with the funding coin's key, so
|
|
22
32
|
* openChannel can assemble the funding witness without the caller reproducing
|
|
@@ -30,6 +40,38 @@ export interface HostApiContext {
|
|
|
30
40
|
spliceLeaseProvider?: SpliceLeaseProvider;
|
|
31
41
|
/** When true, only read-only methods are registered (no signer material). */
|
|
32
42
|
readOnly?: boolean;
|
|
43
|
+
/** Deployment custody mode (RFC-058); defaults to self. */
|
|
44
|
+
custodyMode?: CustodyMode;
|
|
45
|
+
/** RFC-058 signer port; when absent the local signer path is used. */
|
|
46
|
+
signerPort?: SignerPort;
|
|
47
|
+
/** Coordinator-mode prepared channel updates awaiting wallet signatures. */
|
|
48
|
+
preparedPay?: Map<string, PreparedPayEntry>;
|
|
49
|
+
/** Coordinator-mode cooperative settlements awaiting the local signature. */
|
|
50
|
+
preparedSettle?: Map<string, PreparedSettleEntry>;
|
|
51
|
+
/** Coordinator-mode channel openings awaiting the funding signature. */
|
|
52
|
+
preparedOpen?: Map<string, PreparedOpenEntry>;
|
|
53
|
+
/** Coordinator-mode splices awaiting wallet signatures. */
|
|
54
|
+
preparedSplice?: Map<string, PreparedSpliceEntry>;
|
|
55
|
+
/** Coordinator-mode factory openings awaiting the creator signature. */
|
|
56
|
+
preparedFactory?: Map<string, PreparedFactoryEntry>;
|
|
57
|
+
/** VTXO pools, live claims and unsigned/signed receipts. */
|
|
58
|
+
vtxoPools?: Map<string, OmniaVtxoPool>;
|
|
59
|
+
vtxos?: Map<string, OmniaVtxo>;
|
|
60
|
+
vtxoReceipts?: Map<string, VtxoOperatorReceipt>;
|
|
61
|
+
preparedVtxoReceipts?: Map<string, PreparedVtxoReceiptEntry>;
|
|
62
|
+
/** Liquidity pools and their live registry state. */
|
|
63
|
+
pools?: Map<string, {
|
|
64
|
+
manifest: LiquidityPoolManifest;
|
|
65
|
+
registry: LiquidityBondRegistryState;
|
|
66
|
+
}>;
|
|
67
|
+
poolPositions?: Map<string, {
|
|
68
|
+
position: LiquidityPosition;
|
|
69
|
+
registry: LiquidityBondRegistryState;
|
|
70
|
+
allocation?: LiquidityAllocation;
|
|
71
|
+
intent?: WithdrawalIntent;
|
|
72
|
+
}>;
|
|
73
|
+
/** True when the host has no signer and exposes prepare/submit only. */
|
|
74
|
+
coordinator?: boolean;
|
|
33
75
|
/** Opt-in host identity (address, publicKeyDigest, optional delegation). */
|
|
34
76
|
identity?: {
|
|
35
77
|
address: string;
|
|
@@ -39,10 +81,100 @@ export interface HostApiContext {
|
|
|
39
81
|
};
|
|
40
82
|
/** Boot-time signed EdgeServiceManifest. */
|
|
41
83
|
manifest?: unknown;
|
|
84
|
+
/** RFC-062 loopback P2P hub endpoint, when enabled. */
|
|
85
|
+
p2pHubUrl?: string;
|
|
42
86
|
}
|
|
43
87
|
/**
|
|
44
88
|
* CAN-006: a fully serializable channel-state view so RPC/HTTP consumers can
|
|
45
89
|
* read everything they need without reaching into `getStore()`/`getMethods()`.
|
|
46
90
|
*/
|
|
47
91
|
export declare function channelStateView(channel: OmniaChannel): Record<string, unknown>;
|
|
92
|
+
/**
|
|
93
|
+
* Wait for the counterparty to acknowledge a channel proposal. A channel is not
|
|
94
|
+
* usable on both sides until the peer has accepted it; without this, an
|
|
95
|
+
* immediate `pay()` can race ahead of the peer's accept and its STATE_UPDATE is
|
|
96
|
+
* dropped ("Unknown channel"). Resolves true on ACK, false on ERROR/timeout.
|
|
97
|
+
*/
|
|
98
|
+
interface PeerReply {
|
|
99
|
+
type: string;
|
|
100
|
+
channelId?: string;
|
|
101
|
+
nonce?: number;
|
|
102
|
+
payload?: unknown;
|
|
103
|
+
}
|
|
104
|
+
interface ReplyPeer {
|
|
105
|
+
sendMessage(msg: PeerReply & {
|
|
106
|
+
channelId: string;
|
|
107
|
+
}): Promise<void>;
|
|
108
|
+
onMessage(cb: (msg: PeerReply) => void): () => void;
|
|
109
|
+
onReconnected?(cb: () => void): () => void;
|
|
110
|
+
}
|
|
111
|
+
/**
|
|
112
|
+
* Send a proposal and wait for its ACK/ERROR reply.
|
|
113
|
+
*
|
|
114
|
+
* The message is resent with the SAME nonce when the peer reconnects (a
|
|
115
|
+
* proposal or its reply may have been lost when the old stream closed) and
|
|
116
|
+
* once mid-flight in case the reply was lost without the stream closing.
|
|
117
|
+
* Receivers are expected to deduplicate by `(type, channelId, nonce)` so a
|
|
118
|
+
* resend never consumes another WOTS leaf or yields a different signature.
|
|
119
|
+
*/
|
|
120
|
+
export declare function requestPeerReply(peer: ReplyPeer, msg: PeerReply & {
|
|
121
|
+
channelId: string;
|
|
122
|
+
}, channelId: string, timeoutMs: number, types?: string[]): Promise<PeerReply | null>;
|
|
123
|
+
export interface PreparedPayEntry {
|
|
124
|
+
channelId: string;
|
|
125
|
+
unsigned: UnsignedStateUpdate;
|
|
126
|
+
intent: import('@totemsdk/omnia').SignRequest;
|
|
127
|
+
update: import('@totemsdk/omnia').SignRequest;
|
|
128
|
+
settlement: import('@totemsdk/omnia').SignRequest;
|
|
129
|
+
expiresAt: number;
|
|
130
|
+
}
|
|
131
|
+
export interface PreparedOpenEntry {
|
|
132
|
+
plan: ChannelOpeningPlan;
|
|
133
|
+
fundingScript?: string;
|
|
134
|
+
intent: import('@totemsdk/omnia').SignRequest;
|
|
135
|
+
funding: import('@totemsdk/omnia').SignRequest;
|
|
136
|
+
expiresAt: number;
|
|
137
|
+
}
|
|
138
|
+
export interface PreparedVtxoReceiptEntry {
|
|
139
|
+
receipt: VtxoOperatorReceipt;
|
|
140
|
+
payload: Uint8Array;
|
|
141
|
+
request: SignRequest;
|
|
142
|
+
expiresAt: number;
|
|
143
|
+
}
|
|
144
|
+
export interface PreparedFactoryEntry {
|
|
145
|
+
plan: FactoryOpeningPlan;
|
|
146
|
+
remotePartyId?: string;
|
|
147
|
+
remoteFundingSignature?: Uint8Array;
|
|
148
|
+
intent: import('@totemsdk/omnia').SignRequest;
|
|
149
|
+
commitment: import('@totemsdk/omnia').SignRequest;
|
|
150
|
+
expiresAt: number;
|
|
151
|
+
}
|
|
152
|
+
export interface PreparedSpliceEntry {
|
|
153
|
+
channelId: string;
|
|
154
|
+
quiescedChannel: QuiescedChannel;
|
|
155
|
+
quiesce: {
|
|
156
|
+
unsigned: UnsignedStateUpdate;
|
|
157
|
+
intent: import('@totemsdk/omnia').SignRequest;
|
|
158
|
+
update: import('@totemsdk/omnia').SignRequest;
|
|
159
|
+
settlement: import('@totemsdk/omnia').SignRequest;
|
|
160
|
+
};
|
|
161
|
+
unsigned: UnsignedSpliceProposal;
|
|
162
|
+
acceptance: SpliceAcceptance;
|
|
163
|
+
intent: import('@totemsdk/omnia').SignRequest;
|
|
164
|
+
splice: import('@totemsdk/omnia').SignRequest;
|
|
165
|
+
expiresAt: number;
|
|
166
|
+
}
|
|
167
|
+
export interface PreparedSettleEntry {
|
|
168
|
+
channelId: string;
|
|
169
|
+
closing: OmniaChannel;
|
|
170
|
+
request: ReturnType<typeof buildSettlementSigningRequest>;
|
|
171
|
+
counterpartySignature: {
|
|
172
|
+
partyId: string;
|
|
173
|
+
signature: Uint8Array;
|
|
174
|
+
};
|
|
175
|
+
intent: import('@totemsdk/omnia').SignRequest;
|
|
176
|
+
settlement: import('@totemsdk/omnia').SignRequest;
|
|
177
|
+
expiresAt: number;
|
|
178
|
+
}
|
|
48
179
|
export declare function createHostMethods(context: HostApiContext): Map<string, JsonRpcHandler>;
|
|
180
|
+
export {};
|