@aionis/substrate 0.1.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/CHANGELOG.md +29 -0
- package/LICENSE +201 -0
- package/README.md +222 -0
- package/dist/backup.d.ts +38 -0
- package/dist/backup.d.ts.map +1 -0
- package/dist/backup.js +203 -0
- package/dist/backup.js.map +1 -0
- package/dist/event-log.d.ts +18 -0
- package/dist/event-log.d.ts.map +1 -0
- package/dist/event-log.js +157 -0
- package/dist/event-log.js.map +1 -0
- package/dist/file-substrate.d.ts +7 -0
- package/dist/file-substrate.d.ts.map +1 -0
- package/dist/file-substrate.js +409 -0
- package/dist/file-substrate.js.map +1 -0
- package/dist/index.d.ts +9 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +9 -0
- package/dist/index.js.map +1 -0
- package/dist/runtime-reference-corpus.d.ts +76 -0
- package/dist/runtime-reference-corpus.d.ts.map +1 -0
- package/dist/runtime-reference-corpus.js +308 -0
- package/dist/runtime-reference-corpus.js.map +1 -0
- package/dist/runtime-snapshot-corpus.d.ts +53 -0
- package/dist/runtime-snapshot-corpus.d.ts.map +1 -0
- package/dist/runtime-snapshot-corpus.js +176 -0
- package/dist/runtime-snapshot-corpus.js.map +1 -0
- package/dist/runtime-snapshot-importer.d.ts +27 -0
- package/dist/runtime-snapshot-importer.d.ts.map +1 -0
- package/dist/runtime-snapshot-importer.js +571 -0
- package/dist/runtime-snapshot-importer.js.map +1 -0
- package/dist/runtime-snapshot-parity.d.ts +40 -0
- package/dist/runtime-snapshot-parity.d.ts.map +1 -0
- package/dist/runtime-snapshot-parity.js +217 -0
- package/dist/runtime-snapshot-parity.js.map +1 -0
- package/dist/search.d.ts +3 -0
- package/dist/search.d.ts.map +1 -0
- package/dist/search.js +157 -0
- package/dist/search.js.map +1 -0
- package/dist/sqlite-substrate.d.ts +7 -0
- package/dist/sqlite-substrate.d.ts.map +1 -0
- package/dist/sqlite-substrate.js +666 -0
- package/dist/sqlite-substrate.js.map +1 -0
- package/dist/types.d.ts +253 -0
- package/dist/types.d.ts.map +1 -0
- package/dist/types.js +2 -0
- package/dist/types.js.map +1 -0
- package/docs/ADAPTER_CONTRACT.md +155 -0
- package/docs/API_USAGE.md +225 -0
- package/docs/BACKUP_RESTORE.md +108 -0
- package/docs/CHECKPOINT_COMPACTION.md +75 -0
- package/docs/EXTERNAL_ADMISSION_PARITY.md +98 -0
- package/docs/RUNTIME_DUAL_WRITE_EXPERIMENT.md +132 -0
- package/docs/RUNTIME_MAPPING.md +69 -0
- package/docs/RUNTIME_REFERENCE_CORPUS.md +129 -0
- package/docs/RUNTIME_SNAPSHOT_CORPUS.md +81 -0
- package/docs/RUNTIME_SNAPSHOT_IMPORT.md +120 -0
- package/docs/STORE_CONTRACT.md +181 -0
- package/examples/basic/README.md +19 -0
- package/examples/basic/index.mjs +112 -0
- package/package.json +65 -0
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes to Aionis Substrate are documented here.
|
|
4
|
+
|
|
5
|
+
## 0.1.0 - 2026-06-26
|
|
6
|
+
|
|
7
|
+
### Added
|
|
8
|
+
|
|
9
|
+
- Independent `@aionis/substrate` package with file and SQLite adapters.
|
|
10
|
+
- Append-only memory event log with deterministic replay.
|
|
11
|
+
- Memory nodes with lifecycle, authority, confidence, owner, target-file, metadata, and payload references.
|
|
12
|
+
- Relation graph for `supports`, `supersedes`, `contradicts`, `invalidates`, and `requires_payload`.
|
|
13
|
+
- Outcome feedback records tied to concrete memory ids.
|
|
14
|
+
- Governed context surfaces: `use_now`, `inspect_before_use`, `do_not_use`, and `rehydrate`.
|
|
15
|
+
- `compileContext()` for auditable context compilation with `memory.decision.recorded` receipts.
|
|
16
|
+
- `previewContext()` for side-effect-free admission previews.
|
|
17
|
+
- Deterministic scoped `searchNodes()` over lexical and structured fields.
|
|
18
|
+
- Backup export, integrity verification, and restore to file or SQLite stores.
|
|
19
|
+
- Checkpoint compaction that preserves governed state while collapsing event history.
|
|
20
|
+
- Runtime Lite snapshot import and parity tooling for isolated validation against Aionis Runtime data.
|
|
21
|
+
- External admission parity and dual-write sidecar experiments.
|
|
22
|
+
- Package, install, contract, and scale release checks.
|
|
23
|
+
- Basic example covering file + SQLite stores, preview, compile, feedback, search, and backup.
|
|
24
|
+
|
|
25
|
+
### Boundaries
|
|
26
|
+
|
|
27
|
+
- The package is a substrate contract, not the full Aionis Runtime policy engine.
|
|
28
|
+
- `searchNodes()` is deterministic lexical/structured search, not vector search, ANN, or semantic recall.
|
|
29
|
+
- SQLite uses Node's built-in `node:sqlite`, which may emit an experimental warning on Node 24.
|
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
https://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright 2026 Aionis contributors
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
https://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,222 @@
|
|
|
1
|
+
# Aionis Substrate
|
|
2
|
+
|
|
3
|
+
Aionis Substrate is an independent storage-contract project for Aionis memory and execution state.
|
|
4
|
+
|
|
5
|
+
It defines the durable substrate Aionis needs for governed working memory: append-only evidence, lifecycle state, relations, feedback, decision receipts, and context admission buckets.
|
|
6
|
+
|
|
7
|
+
It is not Aionis Runtime core, not an Agent framework, and not a vector database replacement.
|
|
8
|
+
|
|
9
|
+
## Status
|
|
10
|
+
|
|
11
|
+
- Package: `@aionis/substrate`
|
|
12
|
+
- Version: `0.1.0`
|
|
13
|
+
- Runtime: Node 24+
|
|
14
|
+
- License: Apache-2.0
|
|
15
|
+
- Current adapters: file store and SQLite
|
|
16
|
+
- Runtime integration status: read-only snapshot import, reference-corpus parity, external admission parity, and isolated dual-write sidecar experiments
|
|
17
|
+
|
|
18
|
+
The project is intentionally independent from `AionisRuntime-focused`. It can import real Runtime Lite SQLite snapshots for validation and run isolated sidecar dual-write experiments, but it does not mutate Runtime source code or replace Runtime storage.
|
|
19
|
+
|
|
20
|
+
## Goal
|
|
21
|
+
|
|
22
|
+
Define the storage semantics Aionis needs before choosing or building a storage engine:
|
|
23
|
+
|
|
24
|
+
- append-only evidence events
|
|
25
|
+
- memory nodes with lifecycle and authority state
|
|
26
|
+
- relation graph for support, supersession, contradiction, invalidation, and payload requirements
|
|
27
|
+
- admission buckets: `use_now`, `inspect_before_use`, `do_not_use`, `rehydrate`
|
|
28
|
+
- decision traces that explain why memory was admitted, downgraded, blocked, or deferred
|
|
29
|
+
- controlled forgetting as state transitions, not silent deletion
|
|
30
|
+
|
|
31
|
+
## What It Is Not
|
|
32
|
+
|
|
33
|
+
- not a RAG library;
|
|
34
|
+
- not a vector index;
|
|
35
|
+
- not a chat memory store;
|
|
36
|
+
- not a benchmark harness;
|
|
37
|
+
- not the full Aionis Runtime policy engine.
|
|
38
|
+
|
|
39
|
+
The admission logic here is a substrate-level minimum contract. Full Aionis Runtime policy remains above this layer.
|
|
40
|
+
|
|
41
|
+
## Current Scope
|
|
42
|
+
|
|
43
|
+
This first version ships two embedded adapters:
|
|
44
|
+
|
|
45
|
+
- `events.jsonl` is the append-only evidence log.
|
|
46
|
+
- `snapshot.json` is a derived read model.
|
|
47
|
+
- `openSqliteAionisSubstrate` stores the same event log and read model in SQLite tables.
|
|
48
|
+
- SQLite uses Node's built-in `node:sqlite`; Node may print an experimental warning depending on the installed Node 24 build.
|
|
49
|
+
- every write is serialized and persisted.
|
|
50
|
+
- reopening the store rebuilds the same state from disk.
|
|
51
|
+
- every store reports its substrate schema version through `getStoreInfo`.
|
|
52
|
+
- the SQLite adapter persists schema metadata and rejects stores created by a newer unsupported schema.
|
|
53
|
+
- event-log backups can be exported, checksum-verified, and restored to either file or SQLite stores.
|
|
54
|
+
- checkpoint compaction can rewrite a store event log to one checksum-covered checkpoint event without changing governed state.
|
|
55
|
+
- `searchNodes` provides scoped deterministic lexical/structured search over memory nodes without mutating events or admission state. It is not ANN, vector recall, semantic retrieval, or a Recall Engine.
|
|
56
|
+
- `importRuntimeLiteSnapshot` can import an existing Runtime Lite SQLite database into an isolated Substrate store through a read-only source connection.
|
|
57
|
+
|
|
58
|
+
This is intentionally small. It proves the substrate contract without changing the existing Aionis Runtime.
|
|
59
|
+
|
|
60
|
+
## Contract
|
|
61
|
+
|
|
62
|
+
See [docs/STORE_CONTRACT.md](docs/STORE_CONTRACT.md).
|
|
63
|
+
|
|
64
|
+
API usage is documented in [docs/API_USAGE.md](docs/API_USAGE.md).
|
|
65
|
+
|
|
66
|
+
Adapter consistency requirements are documented in [docs/ADAPTER_CONTRACT.md](docs/ADAPTER_CONTRACT.md).
|
|
67
|
+
|
|
68
|
+
Backup and restore are documented in [docs/BACKUP_RESTORE.md](docs/BACKUP_RESTORE.md).
|
|
69
|
+
|
|
70
|
+
Checkpoint compaction is documented in [docs/CHECKPOINT_COMPACTION.md](docs/CHECKPOINT_COMPACTION.md).
|
|
71
|
+
|
|
72
|
+
Runtime snapshot import is documented in [docs/RUNTIME_SNAPSHOT_IMPORT.md](docs/RUNTIME_SNAPSHOT_IMPORT.md).
|
|
73
|
+
|
|
74
|
+
Runtime reference corpus parity is documented in [docs/RUNTIME_REFERENCE_CORPUS.md](docs/RUNTIME_REFERENCE_CORPUS.md).
|
|
75
|
+
|
|
76
|
+
External admission parity is documented in [docs/EXTERNAL_ADMISSION_PARITY.md](docs/EXTERNAL_ADMISSION_PARITY.md).
|
|
77
|
+
|
|
78
|
+
Runtime dual-write experimentation is documented in [docs/RUNTIME_DUAL_WRITE_EXPERIMENT.md](docs/RUNTIME_DUAL_WRITE_EXPERIMENT.md).
|
|
79
|
+
|
|
80
|
+
Release steps are documented in [RELEASE.md](RELEASE.md).
|
|
81
|
+
|
|
82
|
+
Changes are tracked in [CHANGELOG.md](CHANGELOG.md).
|
|
83
|
+
|
|
84
|
+
The basic package example is in [examples/basic](examples/basic).
|
|
85
|
+
|
|
86
|
+
## Quick Test
|
|
87
|
+
|
|
88
|
+
```bash
|
|
89
|
+
cd /Volumes/ziel/AionisSubstrate
|
|
90
|
+
npm install
|
|
91
|
+
npm run typecheck
|
|
92
|
+
npm test
|
|
93
|
+
npm run example:basic
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
Node 24+ is required because the project runs TypeScript directly.
|
|
97
|
+
|
|
98
|
+
## Contract Benchmark
|
|
99
|
+
|
|
100
|
+
```bash
|
|
101
|
+
npm run bench:contract
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
The benchmark runs the same governed memory scenarios against both embedded adapters and writes a report under `reports/substrate-contract-*`.
|
|
105
|
+
|
|
106
|
+
## Runtime Snapshot Import
|
|
107
|
+
|
|
108
|
+
```bash
|
|
109
|
+
node scripts/import-runtime-snapshot.ts \
|
|
110
|
+
--source /path/to/aionis-runtime-lite.sqlite \
|
|
111
|
+
--target /tmp/aionis-substrate.sqlite \
|
|
112
|
+
--adapter sqlite \
|
|
113
|
+
--scope repo-a
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
The source Runtime database is opened read-only. The command writes a separate Substrate store and prints imported/skipped counts.
|
|
117
|
+
|
|
118
|
+
Runtime snapshot smoke/parity:
|
|
119
|
+
|
|
120
|
+
```bash
|
|
121
|
+
npm run check:runtime-snapshot -- \
|
|
122
|
+
--source /path/to/aionis-runtime-lite.sqlite \
|
|
123
|
+
--scope repo-a \
|
|
124
|
+
--output /tmp/aionis-runtime-snapshot-report.json
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
Add `--reference /path/to/runtime-guide-or-measure.json` to compare Substrate buckets against Runtime `agent_context` / `memory_decision_trace` bucket ids.
|
|
128
|
+
|
|
129
|
+
Runtime snapshot corpus smoke:
|
|
130
|
+
|
|
131
|
+
```bash
|
|
132
|
+
npm run check:runtime-corpus -- \
|
|
133
|
+
--root /path/to/AionisRuntime-focused/.tmp \
|
|
134
|
+
--max-files 20 \
|
|
135
|
+
--max-scopes 20 \
|
|
136
|
+
--max-scopes-per-file 3
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
This scans Runtime Lite SQLite files read-only, imports selected scopes into temporary Substrate stores, and writes an aggregate report under `reports/runtime-snapshot-corpus-*`.
|
|
140
|
+
|
|
141
|
+
Runtime reference corpus parity:
|
|
142
|
+
|
|
143
|
+
```bash
|
|
144
|
+
npm run check:runtime-reference-corpus -- \
|
|
145
|
+
--source-root /path/to/AionisRuntime-focused/.tmp \
|
|
146
|
+
--reference-root /path/to/AionisRuntime-focused/docs/examples \
|
|
147
|
+
--max-source-files all \
|
|
148
|
+
--max-scopes 100 \
|
|
149
|
+
--max-scopes-per-file 20 \
|
|
150
|
+
--max-references all
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
This scans Runtime `agent_context` / `memory_decision_trace` JSON and only counts a reference when its memory ids overlap a real Runtime SQLite scope. Unmatched demo/export files are reported separately.
|
|
154
|
+
|
|
155
|
+
External admission parity against focused Runtime:
|
|
156
|
+
|
|
157
|
+
```bash
|
|
158
|
+
npm run check:external-admission-parity -- \
|
|
159
|
+
--runtime-root /path/to/AionisRuntime-focused
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
This starts focused Runtime with isolated Lite SQLite paths, calls the real external memory governance route, projects the same candidate memories into Substrate, and compares `use_now`, `inspect_before_use`, `do_not_use`, and `rehydrate`. The runner includes fixed contract scenarios plus deterministic generated variants; pass `--generated-count` and `--seed` to control the batch.
|
|
163
|
+
|
|
164
|
+
Runtime dual-write sidecar experiment:
|
|
165
|
+
|
|
166
|
+
```bash
|
|
167
|
+
npm run check:runtime-dual-write -- \
|
|
168
|
+
--runtime-root /path/to/AionisRuntime-focused \
|
|
169
|
+
--generated-count 8 \
|
|
170
|
+
--chain-probe-count 4 \
|
|
171
|
+
--concurrency 4
|
|
172
|
+
```
|
|
173
|
+
|
|
174
|
+
This starts focused Runtime with isolated Lite SQLite paths, calls real `observe -> guide -> feedback -> measure`, writes the same observed memory ids and outcomes into a separate Substrate SQLite store, compares guide buckets, closes and reopens Substrate, and compares again. It can add deterministic generated scenarios with `--generated-count`, run independent scopes concurrently with `--concurrency`, and record sidecar write-integrity plus lifecycle/relation chain probes. It does not mutate focused Runtime source code or replace Runtime storage.
|
|
175
|
+
|
|
176
|
+
Sustained sidecar soak:
|
|
177
|
+
|
|
178
|
+
```bash
|
|
179
|
+
npm run check:runtime-dual-write -- \
|
|
180
|
+
--runtime-root /path/to/AionisRuntime-focused \
|
|
181
|
+
--generated-count 96 \
|
|
182
|
+
--chain-probe-count 16 \
|
|
183
|
+
--concurrency 8
|
|
184
|
+
```
|
|
185
|
+
|
|
186
|
+
The soak report includes per-scenario latency summaries, chain-probe latency, reopen latency, event-sequence continuity, and SQLite file sizes.
|
|
187
|
+
|
|
188
|
+
## Development Checks
|
|
189
|
+
|
|
190
|
+
```bash
|
|
191
|
+
npm run typecheck
|
|
192
|
+
npm run build
|
|
193
|
+
npm test
|
|
194
|
+
npm run bench:contract
|
|
195
|
+
npm run check:pack
|
|
196
|
+
npm run check:install-smoke
|
|
197
|
+
npm run example:basic
|
|
198
|
+
```
|
|
199
|
+
|
|
200
|
+
The CI workflow runs the same checks on every push and pull request.
|
|
201
|
+
|
|
202
|
+
For a full local release gate:
|
|
203
|
+
|
|
204
|
+
```bash
|
|
205
|
+
npm run check:release
|
|
206
|
+
```
|
|
207
|
+
|
|
208
|
+
`check:pack` runs `npm pack --dry-run` and rejects package contents that would leak tests, reports, CI metadata, `node_modules`, or other non-runtime artifacts into the published tarball.
|
|
209
|
+
|
|
210
|
+
`check:install-smoke` packs the built package, installs that tarball into a fresh temporary project, imports `@aionis/substrate`, and runs real file/SQLite store operations from the installed package.
|
|
211
|
+
|
|
212
|
+
## Scale Smoke
|
|
213
|
+
|
|
214
|
+
```bash
|
|
215
|
+
npm run check:scale -- \
|
|
216
|
+
--nodes 10000 \
|
|
217
|
+
--scopes 10 \
|
|
218
|
+
--relations 2000 \
|
|
219
|
+
--feedback 1000
|
|
220
|
+
```
|
|
221
|
+
|
|
222
|
+
The scale smoke writes a temporary SQLite substrate, verifies event sequence continuity, runs scoped search, compiles context, compacts the store, reopens it, and writes a report under `reports/scale-*`.
|
package/dist/backup.d.ts
ADDED
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
import { type AionisEvent, type AionisSubstrate, type AionisSubstrateSnapshot, type AionisSubstrateStoreInfo } from "./types.ts";
|
|
2
|
+
export declare const AIONIS_SUBSTRATE_BACKUP_FORMAT = "aionis_substrate_backup";
|
|
3
|
+
export declare const AIONIS_SUBSTRATE_BACKUP_VERSION = 1;
|
|
4
|
+
export type AionisSubstrateBackup = {
|
|
5
|
+
format: typeof AIONIS_SUBSTRATE_BACKUP_FORMAT;
|
|
6
|
+
backupVersion: typeof AIONIS_SUBSTRATE_BACKUP_VERSION;
|
|
7
|
+
schemaVersion: number;
|
|
8
|
+
createdAt: string;
|
|
9
|
+
source: AionisSubstrateStoreInfo;
|
|
10
|
+
eventCount: number;
|
|
11
|
+
lastSequence: number;
|
|
12
|
+
checksum: {
|
|
13
|
+
algorithm: "sha256";
|
|
14
|
+
eventsSha256: string;
|
|
15
|
+
};
|
|
16
|
+
events: AionisEvent[];
|
|
17
|
+
};
|
|
18
|
+
export type AionisSubstrateBackupIntegrityReport = {
|
|
19
|
+
ok: boolean;
|
|
20
|
+
errors: string[];
|
|
21
|
+
schemaVersion: number | null;
|
|
22
|
+
eventCount: number;
|
|
23
|
+
lastSequence: number;
|
|
24
|
+
eventsSha256: string | null;
|
|
25
|
+
snapshot: AionisSubstrateSnapshot | null;
|
|
26
|
+
};
|
|
27
|
+
export type RestoreAionisSubstrateBackupOptions = {
|
|
28
|
+
overwrite?: boolean;
|
|
29
|
+
};
|
|
30
|
+
export declare function exportAionisSubstrateBackup(store: AionisSubstrate, options?: {
|
|
31
|
+
createdAt?: string;
|
|
32
|
+
}): Promise<AionisSubstrateBackup>;
|
|
33
|
+
export declare function verifyAionisSubstrateBackup(backup: AionisSubstrateBackup): AionisSubstrateBackupIntegrityReport;
|
|
34
|
+
export declare function writeAionisSubstrateBackupFile(path: string, backup: AionisSubstrateBackup): Promise<void>;
|
|
35
|
+
export declare function readAionisSubstrateBackupFile(path: string): Promise<AionisSubstrateBackup>;
|
|
36
|
+
export declare function restoreAionisSubstrateBackupToFile(backup: AionisSubstrateBackup, dir: string, options?: RestoreAionisSubstrateBackupOptions): Promise<AionisSubstrateSnapshot>;
|
|
37
|
+
export declare function restoreAionisSubstrateBackupToSqlite(backup: AionisSubstrateBackup, path: string, options?: RestoreAionisSubstrateBackupOptions): Promise<AionisSubstrateSnapshot>;
|
|
38
|
+
//# sourceMappingURL=backup.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"backup.d.ts","sourceRoot":"","sources":["../src/backup.ts"],"names":[],"mappings":"AASA,OAAO,EAGL,KAAK,WAAW,EAIhB,KAAK,eAAe,EACpB,KAAK,uBAAuB,EAC5B,KAAK,wBAAwB,EAC9B,MAAM,YAAY,CAAC;AAEpB,eAAO,MAAM,8BAA8B,4BAA4B,CAAC;AACxE,eAAO,MAAM,+BAA+B,IAAI,CAAC;AAEjD,MAAM,MAAM,qBAAqB,GAAG;IAClC,MAAM,EAAE,OAAO,8BAA8B,CAAC;IAC9C,aAAa,EAAE,OAAO,+BAA+B,CAAC;IACtD,aAAa,EAAE,MAAM,CAAC;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,wBAAwB,CAAC;IACjC,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE;QACR,SAAS,EAAE,QAAQ,CAAC;QACpB,YAAY,EAAE,MAAM,CAAC;KACtB,CAAC;IACF,MAAM,EAAE,WAAW,EAAE,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,oCAAoC,GAAG;IACjD,EAAE,EAAE,OAAO,CAAC;IACZ,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,QAAQ,EAAE,uBAAuB,GAAG,IAAI,CAAC;CAC1C,CAAC;AAEF,MAAM,MAAM,mCAAmC,GAAG;IAChD,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,CAAC;AAQF,wBAAsB,2BAA2B,CAC/C,KAAK,EAAE,eAAe,EACtB,OAAO,GAAE;IAAE,SAAS,CAAC,EAAE,MAAM,CAAA;CAAO,GACnC,OAAO,CAAC,qBAAqB,CAAC,CAkBhC;AAED,wBAAgB,2BAA2B,CAAC,MAAM,EAAE,qBAAqB,GAAG,oCAAoC,CA6C/G;AAED,wBAAsB,8BAA8B,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,qBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC,CAI/G;AAED,wBAAsB,6BAA6B,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAEhG;AAED,wBAAsB,kCAAkC,CACtD,MAAM,EAAE,qBAAqB,EAC7B,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,mCAAwC,GAChD,OAAO,CAAC,uBAAuB,CAAC,CAalC;AAED,wBAAsB,oCAAoC,CACxD,MAAM,EAAE,qBAAqB,EAC7B,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,mCAAwC,GAChD,OAAO,CAAC,uBAAuB,CAAC,CAgDlC"}
|