@xyo-network/event-kit-node 0.1.1 → 0.1.2

package/README.md

@@ -1,6 +1,6 @@
 # `@xyo-network/event-kit-node`
 
-Node.js durability adapters for Event Kit:
+Node.js 24+ durability adapters for Event Kit (verified on Node 24.14.1):
 
 - `createFilesystemCursorStore` — publisher cursor for the wake publisher actor
 - `createFilesystemPublisherOutbox` — durable pending-wake slot for retry stability
@@ -38,8 +38,28 @@ publication.
 
 The handshake subpath deliberately does not load the wake queues, inbox,
 outbox, or `node:sqlite`. A clean packed consumer typechecks and executes it
-without SQLite coupling. The resident `publisher run` process that combines
-these clients with finalized scanning and webhook delivery remains Phase 4.
+without SQLite coupling. There is one unversioned source-aware contract.
+Service publication requires `sources` and `maxPositionsPerWake`; subscription
+publication requires `source` and `fromPosition`. Authorization remains pinned
+to the XL1 session independently of source positions. Removed schema suffixes,
+block-range fields, and profile selectors have no compatibility aliases.
+
+## Resident publisher
+
+`@xyo-network/event-kit-node/publisher-runtime` exports the SQLite publisher
+authority/stores, persistent runtime, real D-005 discovery, bounded transports,
+native REST gateway/datalake composition, and XL1/Ethereum/UTC source readers.
+It uses the shared periodic actor lifecycle; the CLI owns process interrupts,
+provider cleanup, and probes. Importing the module does not open a database;
+opening publisher state loads `node:sqlite` explicitly.
+
+Logical wake creation and pending outbox persistence co-commit. Durable admission
+receipt, contiguous publisher cursor, and outbox clear co-commit independently
+for each subscriber. Process death and ambiguous responses resend the same body
+with a fresh real wallet JWT. Publisher progress is admission progress, not
+completed receiver compute. See the [runbook](../../docs/RESIDENT_PUBLISHER.md)
+for ownership, crypto custody, retry/cancellation rules, transport limits, and
+the remaining hosted/Sequence gates.
 
 ## Durability model