Initial import of verae-archive-worm from zapier monorepo
This commit is contained in:
commit
778491ee34
6 changed files with 145 additions and 0 deletions
9
NATS.md
Normal file
9
NATS.md
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
# NATS — verae-archive-worm
|
||||
|
||||
| Direction | Address | From / to | Body |
|
||||
|-----------|---------|-----------|------|
|
||||
| IN | `verae.archive.put` | splitter | `{ sha256, tenantId, kind, record, traceId }` |
|
||||
| IN | `verae.archive.query` | aggregator (broadcast) | `{ correlationId, sha256, tenantId, kinds[], traceId }` |
|
||||
| OUT | `verae.archive.reply.<correlationId>` | aggregator | `{ archiveId, sha256, records[], traceId }` **only if bloom.mightHave(sha256)** |
|
||||
|
||||
Subscribe to query **without** a shared queue group so every archive sees every query.
|
||||
14
SUMMARY.md
Normal file
14
SUMMARY.md
Normal file
|
|
@ -0,0 +1,14 @@
|
|||
# verae-archive-worm
|
||||
|
||||
**Job:** Append-only WORM store of metadata and files. Bloom filter: miss → stay silent on NATS.
|
||||
|
||||
**Expects:**
|
||||
- `verae.archive.put` — append record, add sha256 to bloom
|
||||
- `verae.archive.query` — `{ correlationId, sha256, tenantId, kinds[] }` (every node sees this; **not** a shared queue group)
|
||||
|
||||
**Sends:**
|
||||
- `verae.archive.reply.<correlationId>` **only on bloom hit** — `{ archiveId, sha256, records[] }`
|
||||
|
||||
**Does not** write to the blockchain.
|
||||
|
||||
**Test:** `npm test` — miss is `null`; put then query returns records.
|
||||
8
package.json
Normal file
8
package.json
Normal file
|
|
@ -0,0 +1,8 @@
|
|||
{
|
||||
"name": "verae-archive-worm",
|
||||
"version": "0.1.0",
|
||||
"type": "module",
|
||||
"description": "Bloom-filtered WORM archive node for off-chain metadata and files",
|
||||
"scripts": { "test": "node --test test/*.test.js" },
|
||||
"engines": { "node": ">=20" }
|
||||
}
|
||||
40
src/archive.js
Normal file
40
src/archive.js
Normal file
|
|
@ -0,0 +1,40 @@
|
|||
/**
|
||||
* In-process WORM archive: append-only records + bloom.
|
||||
* @module archive
|
||||
*/
|
||||
|
||||
import { Bloom } from './bloom.js';
|
||||
|
||||
export class WormArchive {
|
||||
/**
|
||||
* @param {string} archiveId
|
||||
*/
|
||||
constructor(archiveId) {
|
||||
this.archiveId = archiveId;
|
||||
this.bloom = new Bloom();
|
||||
/** @type {Map<string, object[]>} */
|
||||
this.byHash = new Map();
|
||||
}
|
||||
|
||||
/**
|
||||
* @param {{ sha256: string, kind: string, record: object }} put
|
||||
*/
|
||||
put(put) {
|
||||
const key = String(put.sha256).toLowerCase();
|
||||
const list = this.byHash.get(key) ?? [];
|
||||
list.push({ kind: put.kind, record: put.record, archiveId: this.archiveId, storedAt: new Date().toISOString() });
|
||||
this.byHash.set(key, list);
|
||||
this.bloom.add(key);
|
||||
}
|
||||
|
||||
/**
|
||||
* Bloom miss → null (caller must stay silent). Hit → records (may be empty if false positive).
|
||||
* @param {string} sha256
|
||||
* @returns {object[]|null}
|
||||
*/
|
||||
query(sha256) {
|
||||
const key = String(sha256).toLowerCase();
|
||||
if (!this.bloom.mightHave(key)) return null;
|
||||
return this.byHash.get(key) ?? [];
|
||||
}
|
||||
}
|
||||
46
src/bloom.js
Normal file
46
src/bloom.js
Normal file
|
|
@ -0,0 +1,46 @@
|
|||
/**
|
||||
* Tiny Bloom filter for SHA256 membership (false positives ok).
|
||||
* @module bloom
|
||||
*/
|
||||
|
||||
import { createHash } from 'node:crypto';
|
||||
|
||||
export class Bloom {
|
||||
/**
|
||||
* @param {number} [m=16384] bit count
|
||||
* @param {number} [k=4] hash rounds
|
||||
*/
|
||||
constructor(m = 16384, k = 4) {
|
||||
this.m = m;
|
||||
this.k = k;
|
||||
this.bits = Buffer.alloc(Math.ceil(m / 8));
|
||||
}
|
||||
|
||||
/**
|
||||
* @param {string} s
|
||||
* @returns {number[]}
|
||||
*/
|
||||
hashes(s) {
|
||||
const digest = createHash('sha256').update(String(s)).digest();
|
||||
const out = [];
|
||||
for (let i = 0; i < this.k; i += 1) {
|
||||
const n = digest.readUInt32BE((i * 4) % 28);
|
||||
out.push(n % this.m);
|
||||
}
|
||||
return out;
|
||||
}
|
||||
|
||||
add(s) {
|
||||
for (const i of this.hashes(s)) {
|
||||
this.bits[i >> 3] |= 1 << (i & 7);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @param {string} s
|
||||
* @returns {boolean} maybe (never a guaranteed yes)
|
||||
*/
|
||||
mightHave(s) {
|
||||
return this.hashes(s).every((i) => (this.bits[i >> 3] & (1 << (i & 7))) !== 0);
|
||||
}
|
||||
}
|
||||
28
test/archive.test.js
Normal file
28
test/archive.test.js
Normal file
|
|
@ -0,0 +1,28 @@
|
|||
import { describe, it } from 'node:test';
|
||||
import assert from 'node:assert/strict';
|
||||
import { WormArchive } from '../src/archive.js';
|
||||
import { Bloom } from '../src/bloom.js';
|
||||
|
||||
describe('WormArchive + Bloom', () => {
|
||||
it('miss stays silent (null)', () => {
|
||||
const a = new WormArchive('archive-a');
|
||||
assert.equal(a.query('a'.repeat(64)), null);
|
||||
});
|
||||
|
||||
it('put then query returns records', () => {
|
||||
const a = new WormArchive('archive-b');
|
||||
const sha = 'b'.repeat(64);
|
||||
a.put({ sha256: sha, kind: 'publicMeta', record: { publicMetadata: { t: 1 } } });
|
||||
const hit = a.query(sha);
|
||||
assert.ok(Array.isArray(hit));
|
||||
assert.equal(hit[0].kind, 'publicMeta');
|
||||
assert.equal(hit[0].archiveId, 'archive-b');
|
||||
});
|
||||
|
||||
it('bloom reports maybe after add', () => {
|
||||
const b = new Bloom();
|
||||
assert.equal(b.mightHave('hello'), false);
|
||||
b.add('hello');
|
||||
assert.equal(b.mightHave('hello'), true);
|
||||
});
|
||||
});
|
||||
Loading…
Add table
Add a link
Reference in a new issue