@bitsocial/pubsub-voting 0.1.2 → 0.1.4

package/README.md

@@ -18,7 +18,7 @@ The same engine generalizes to the original use case in [pkc-js issue #25](https
 - The engine is reusable across clients and contests.
 - The core (`schema/`, `verify/`, `crdt/`, `tally/`) is transport-agnostic and unit-testable without a network. libp2p only appears in `transport/`.
 
-This library does not start its own node. It consumes the host's running Helia node directly — no adapter — and drives that node's gossipsub service and blockstore itself. The node must carry a pubsub service at `libp2p.services.pubsub` (a plain Helia node does not — register e.g. `@libp2p/gossipsub`), a usable `blockstore`, and a libp2p fetch service at `libp2p.services.fetch` (register `@libp2p/fetch` — the checkpoint root-record pull rides it); construction throws `MissingPubsubError` / `MissingBlockstoreError` / `MissingFetchError` otherwise. With pkc-js today that node is reached at `pkc.clients.libp2pJsClients[key]._helia`; a version-stable accessor on pkc-js is a planned follow-up (see [DESIGN.md, Deferred pkc-js work](./DESIGN.md#deferred-pkc-js-work)).
+This library does not start its own node. It consumes the host's running Helia node directly — no adapter — and drives that node's gossipsub service and blockstore itself. The node must carry a pubsub service at `libp2p.services.pubsub` (a plain Helia node does not — register e.g. `@libp2p/gossipsub`), a usable `blockstore`, and a libp2p fetch service at `libp2p.services.fetch` (register `@libp2p/fetch` — the checkpoint root-record pull rides it); construction throws `MissingPubsubError` / `MissingBlockstoreError` / `MissingFetchError` otherwise. With pkc-js that node is reached at `pkc.clients.libp2pJsClients[key].heliaNode` — the documented, semver-covered accessor since pkc-js `0.0.72` (see [DESIGN.md, Deferred pkc-js work](./DESIGN.md#deferred-pkc-js-work)).
 
 ## Design at a glance
 

package/dist/client/voter.d.ts

@@ -182,7 +182,7 @@ export interface VoteClient {
 export interface PubsubVoterOptions {
     /**
      * The host's running Helia node (the value `createHelia` returns; for pkc-js it is
-     * `pkc.clients.libp2pJsClients[key]._helia`). The only host-node seam, passed
+     * `pkc.clients.libp2pJsClients[key].heliaNode`). The only host-node seam, passed
      * directly with no adapter. It MUST carry a gossipsub service at
      * `libp2p.services.pubsub`, a usable `blockstore`, and a libp2p fetch service at
      * `libp2p.services.fetch`; the constructor throws `MissingPubsubError` /

package/dist/transport/integration/harness.d.ts

@@ -54,6 +54,24 @@ export interface VoteNode {
     admitBundle(bundle: VotesBundle): Promise<void>;
     stop(): Promise<void>;
 }
+/**
+ * One real loopback libp2p + Helia node carrying gossipsub (topic-scoped score params) and
+ * `@libp2p/fetch` — the raw host node with nothing else wired. {@link makeVoteNode} builds the
+ * harness transport on top of it; the three-node relay test instead hands it straight to the
+ * REAL `PubsubVoter` as the injected host node (the `PubsubVoterOptions.helia` seam).
+ */
+export declare function makeBareNode(topic: string): Promise<{
+    libp2p: Libp2p<{
+        identify: import("@libp2p/identify").Identify;
+        fetch: import("@libp2p/fetch").Fetch;
+        pubsub: import("@libp2p/gossipsub").GossipSub;
+    }>;
+    helia: Helia<Libp2p<{
+        identify: import("@libp2p/identify").Identify;
+        fetch: import("@libp2p/fetch").Fetch;
+        pubsub: import("@libp2p/gossipsub").GossipSub;
+    }>>;
+}>;
 /** Build one real node with the full forward-gate wired to real gossipsub. */
 export declare function makeVoteNode(topic: string, options?: VoteNodeOptions): Promise<VoteNode>;
 /**

package/dist/transport/integration/harness.js

@@ -38,9 +38,13 @@ const BLOCKS_PER_BUCKET = 43_200;
 const VOTE_EXPIRY_BUCKETS = 30;
 /** A permissive default verifier; individual tests swap it via {@link VoteNode.setVerifier}. */
 const okVerifier = () => ({ valid: true, ruleScore: 1n, resolvedNames: {} });
-/** Build one real node with the full forward-gate wired to real gossipsub. */
-export async function makeVoteNode(topic, options = {}) {
-    const timeoutMs = options.timeoutMs ?? 10_000;
+/**
+ * One real loopback libp2p + Helia node carrying gossipsub (topic-scoped score params) and
+ * `@libp2p/fetch` — the raw host node with nothing else wired. {@link makeVoteNode} builds the
+ * harness transport on top of it; the three-node relay test instead hands it straight to the
+ * REAL `PubsubVoter` as the injected host node (the `PubsubVoterOptions.helia` seam).
+ */
+export async function makeBareNode(topic) {
     const libp2p = await createLibp2p({
         addresses: { listen: ["/ip4/127.0.0.1/tcp/0"] },
         transports: [tcp()],
@@ -87,6 +91,12 @@ export async function makeVoteNode(topic, options = {}) {
         }
     });
     const helia = await createHelia({ libp2p });
+    return { libp2p, helia };
+}
+/** Build one real node with the full forward-gate wired to real gossipsub. */
+export async function makeVoteNode(topic, options = {}) {
+    const timeoutMs = options.timeoutMs ?? 10_000;
+    const { libp2p, helia } = await makeBareNode(topic);
     const pubsub = libp2p.services.pubsub;
     // Adapt Helia's async-generator `get` to the library's Promise-returning BlockstoreLike, the
     // same bridge `requireHeliaServices` applies to an injected host node.

package/dist/transport/types.d.ts

@@ -18,7 +18,7 @@ import type { RootRecord } from "./messages.js";
  *
  * The library does not start a node and does not take a host SDK. It receives the
  * host's already-running **Helia node** directly (e.g. the value `createHelia` returns,
- * which for a pkc-js host is `pkc.clients.libp2pJsClients[key]._helia`) and drives its
+ * which for a pkc-js host is `pkc.clients.libp2pJsClients[key].heliaNode`) and drives its
  * libp2p pubsub + blockstore itself — there is no host-written adapter. The node must
  * carry a gossipsub service at `libp2p.services.pubsub` and a usable `blockstore`;
  * construction enforces both (see `requireHeliaServices` / `MissingPubsubError` /

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bitsocial/pubsub-voting",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "description": "Trustless pubsub voting over a shared libp2p/Helia node.",
   "type": "module",
   "license": "GPL-3.0-or-later",
@@ -26,6 +26,7 @@
     "typecheck": "tsc -p tsconfig.json --noEmit",
     "typecheck:examples": "tsc -p tsconfig.examples.json --noEmit",
     "test": "vitest run",
+    "test:coverage": "vitest run --coverage",
     "test:watch": "vitest",
     "test:integration": "vitest run -c vitest.integration.config.ts",
     "build:bench": "tsc -p benchmark/tsconfig.json",
@@ -64,9 +65,10 @@
     "@libp2p/identify": "4.1.8",
     "@libp2p/tcp": "11.0.22",
     "@multiformats/multiaddr": "13.0.3",
-    "@pkcprotocol/pkc-js": "0.0.63",
+    "@pkcprotocol/pkc-js": "0.0.72",
     "@release-it/conventional-changelog": "10.0.6",
     "@types/better-sqlite3": "7.6.13",
+    "@vitest/coverage-v8": "4.1.9",
     "commitizen": "4.3.1",
     "cz-conventional-changelog": "3.3.0",
     "husky": "9.1.7",