@welshman/net 0.0.38 → 0.0.39

package/README.md

@@ -2,19 +2,21 @@
 
 Utilities having to do with connection management and nostr messages.
 
-- `Connection` - a wrapper for `Socket` with send and receive queues, and a `ConnectionMeta` instance.
-- `ConnectionMeta` - tracks stats for a given `Connection`.
-- `Context` - an object containing a default `Pool` and global configuration options.
+- `Connection` - the main api for dealing with relay connections
+- `ConnectionAuth` - tracks auth status for a connection
+- `ConnectionSender` - a send queue for connections
+- `ConnectionState` - tracks pending publishes and requests for a connection
+- `ConnectionStats` - tracks timing and error stats for a connection
+- `Context` - provides default values for configuring `ctx.net`
 - `Executor` - implements common nostr flows on a given `target`
-- `Pool` - a thin wrapper around `Map` which stores `Connection`s.
-- `Publish` - utilities for publishing events.
-- `Socket` - a wrapper around isomorphic-ws that handles json parsing/serialization.
-- `Subscribe` - utilities for making requests against nostr relays.
-- `Tracker` - tracks which relays a given event was seen on.
+- `Pool` - a thin wrapper around `Map` which stores `Connection`s
+- `Publish` - utilities for publishing events
+- `Socket` - a wrapper around isomorphic-ws that handles json parsing/serialization
+- `Subscribe` - utilities for making requests against nostr relays
+- `Tracker` - tracks which relays a given event was seen on
 
 Executor `target`s extend `Emitter`, and have a `send` method, a `cleanup` method, and a `connections` getter. They are intended to be passed to an `Executor` for use.
 
 - `targets/Multi` allows you to compose multiple targets together.
-- `targets/Plex` takes an array of urls and a `Connection` and sends and receives wrapped nostr messages over that connection.
 - `targets/Relay` takes a `Connection` and provides listeners for different verbs.
 - `targets/Relays` takes an array of `Connection`s and provides listeners for different verbs, merging all events into a single stream.

package/build/src/Context.cjs

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDefaultNetContext = exports.defaultOptimizeSubscriptions = void 0;
+exports.getDefaultNetContext = exports.isEventValid = exports.eventValidationScores = exports.defaultOptimizeSubscriptions = void 0;
 const lib_1 = require("@welshman/lib");
 const util_1 = require("@welshman/util");
 const Pool_1 = require("./Pool.cjs");
@@ -14,13 +14,30 @@ const defaultOptimizeSubscriptions = (subs) => (0, lib_1.uniq)(subs.flatMap(sub
     return { relays: [relay], filters };
 });
 exports.defaultOptimizeSubscriptions = defaultOptimizeSubscriptions;
+exports.eventValidationScores = new Map();
+const isEventValid = (url, event) => {
+    if (url === util_1.LOCAL_RELAY_URL)
+        return true;
+    const validCount = exports.eventValidationScores.get(url) || 0;
+    // The more events we've actually validated from this relay, the more we can trust it.
+    if (validCount > (0, lib_1.randomInt)(100, 1000))
+        true;
+    const isValid = (0, util_1.isSignedEvent)(event) && (0, util_1.hasValidSignature)(event);
+    // If the event was valid, increase the relay's score. If not, reset it
+    // Never validate less than 10% to make sure we're never totally checking out
+    if (!isValid || validCount < 900) {
+        exports.eventValidationScores.set(url, isValid ? validCount + 1 : 0);
+    }
+    return isValid;
+};
+exports.isEventValid = isEventValid;
 const getDefaultNetContext = (overrides = {}) => ({
     pool: new Pool_1.Pool(),
     authMode: ConnectionAuth_1.AuthMode.Implicit,
     onEvent: lib_1.noop,
     signEvent: lib_1.noop,
     isDeleted: (0, lib_1.always)(false),
-    isValid: (url, event) => (0, util_1.isSignedEvent)(event) && (0, util_1.hasValidSignature)(event),
+    isValid: exports.isEventValid,
     getExecutor: (relays) => new Executor_1.Executor(new Relays_1.Relays(relays.map((relay) => lib_1.ctx.net.pool.get(relay)))),
     matchFilters: (url, filters, event) => (0, util_1.matchFilters)(filters, event),
     optimizeSubscriptions: exports.defaultOptimizeSubscriptions,

package/build/src/Context.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"Context.cjs","sourceRoot":"","sources":["../../src/Context.ts"],"names":[],"mappings":";;;AAAA,uCAAqD;AACrD,yCAA2F;AAE3F,qCAA2B;AAC3B,6CAAmC;AACnC,yDAAyC;AACzC,gDAAsC;AAe/B,MAAM,4BAA4B,GAAG,CAAC,IAAoB,EAAE,EAAE,CACnE,IAAA,UAAI,EAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC;KAChD,GAAG,CAAC,KAAK,CAAC,EAAE;IACX,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAA;IACxE,MAAM,OAAO,GAAG,IAAA,mBAAY,EAAC,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAA;IAE3E,OAAO,EAAC,MAAM,EAAE,CAAC,KAAK,CAAC,EAAE,OAAO,EAAC,CAAA;AACnC,CAAC,CAAC,CAAA;AAPO,QAAA,4BAA4B,gCAOnC;AAEC,MAAM,oBAAoB,GAAG,CAAC,YAAiC,EAAE,EAAE,EAAE,CAAC,CAAC;IAC5E,IAAI,EAAE,IAAI,WAAI,EAAE;IAChB,QAAQ,EAAE,yBAAQ,CAAC,QAAQ;IAC3B,OAAO,EAAE,UAAI;IACb,SAAS,EAAE,UAAI;IACf,SAAS,EAAE,IAAA,YAAM,EAAC,KAAK,CAAC;IACxB,OAAO,EAAE,CAAC,GAAW,EAAE,KAAmB,EAAE,EAAE,CAAC,IAAA,oBAAa,EAAC,KAAK,CAAC,IAAI,IAAA,wBAAiB,EAAC,KAAK,CAAC;IAC/F,WAAW,EAAE,CAAC,MAAgB,EAAE,EAAE,CAAC,IAAI,mBAAQ,CAAC,IAAI,eAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAa,EAAE,EAAE,CAAC,SAAG,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACnH,YAAY,EAAE,CAAC,GAAW,EAAE,OAAiB,EAAE,KAAmB,EAAE,EAAE,CAAC,IAAA,mBAAY,EAAC,OAAO,EAAE,KAAK,CAAC;IACnG,qBAAqB,EAAE,oCAA4B;IACnD,GAAG,SAAS;CACb,CAAC,CAAA;AAXW,QAAA,oBAAoB,wBAW/B"}
+{"version":3,"file":"Context.cjs","sourceRoot":"","sources":["../../src/Context.ts"],"names":[],"mappings":";;;AAAA,uCAAgE;AAChE,yCAA4G;AAE5G,qCAA2B;AAC3B,6CAAmC;AACnC,yDAAyC;AACzC,gDAAsC;AAe/B,MAAM,4BAA4B,GAAG,CAAC,IAAoB,EAAE,EAAE,CACnE,IAAA,UAAI,EAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC;KAChD,GAAG,CAAC,KAAK,CAAC,EAAE;IACX,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAA;IACxE,MAAM,OAAO,GAAG,IAAA,mBAAY,EAAC,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAA;IAE3E,OAAO,EAAC,MAAM,EAAE,CAAC,KAAK,CAAC,EAAE,OAAO,EAAC,CAAA;AACnC,CAAC,CAAC,CAAA;AAPO,QAAA,4BAA4B,gCAOnC;AAEO,QAAA,qBAAqB,GAAG,IAAI,GAAG,EAAkB,CAAA;AAEvD,MAAM,YAAY,GAAG,CAAC,GAAW,EAAE,KAAmB,EAAE,EAAE;IAC/D,IAAI,GAAG,KAAK,sBAAe;QAAE,OAAO,IAAI,CAAA;IAExC,MAAM,UAAU,GAAG,6BAAqB,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;IAEtD,sFAAsF;IACtF,IAAI,UAAU,GAAG,IAAA,eAAS,EAAC,GAAG,EAAE,IAAI,CAAC;QAAE,IAAI,CAAA;IAE3C,MAAM,OAAO,GAAG,IAAA,oBAAa,EAAC,KAAK,CAAC,IAAI,IAAA,wBAAiB,EAAC,KAAK,CAAC,CAAA;IAEhE,uEAAuE;IACvE,6EAA6E;IAC7E,IAAI,CAAC,OAAO,IAAI,UAAU,GAAG,GAAG,EAAE;QAChC,6BAAqB,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;KAC7D;IAED,OAAO,OAAO,CAAA;AAChB,CAAC,CAAA;AAjBY,QAAA,YAAY,gBAiBxB;AAEM,MAAM,oBAAoB,GAAG,CAAC,YAAiC,EAAE,EAAE,EAAE,CAAC,CAAC;IAC5E,IAAI,EAAE,IAAI,WAAI,EAAE;IAChB,QAAQ,EAAE,yBAAQ,CAAC,QAAQ;IAC3B,OAAO,EAAE,UAAI;IACb,SAAS,EAAE,UAAI;IACf,SAAS,EAAE,IAAA,YAAM,EAAC,KAAK,CAAC;IACxB,OAAO,EAAE,oBAAY;IACrB,WAAW,EAAE,CAAC,MAAgB,EAAE,EAAE,CAAC,IAAI,mBAAQ,CAAC,IAAI,eAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAa,EAAE,EAAE,CAAC,SAAG,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACnH,YAAY,EAAE,CAAC,GAAW,EAAE,OAAiB,EAAE,KAAmB,EAAE,EAAE,CAAC,IAAA,mBAAY,EAAC,OAAO,EAAE,KAAK,CAAC;IACnG,qBAAqB,EAAE,oCAA4B;IACnD,GAAG,SAAS;CACb,CAAC,CAAA;AAXW,QAAA,oBAAoB,wBAW/B"}

package/build/src/Context.d.ts

@@ -18,6 +18,8 @@ export declare const defaultOptimizeSubscriptions: (subs: Subscription[]) => {
     relays: string[];
     filters: Filter[];
 }[];
+export declare const eventValidationScores: Map<string, number>;
+export declare const isEventValid: (url: string, event: TrustedEvent) => boolean;
 export declare const getDefaultNetContext: (overrides?: Partial<NetContext>) => {
     pool: Pool;
     authMode: AuthMode;

package/build/src/Context.mjs

@@ -1,5 +1,5 @@
-import { ctx, uniq, noop, always } from '@welshman/lib';
-import { matchFilters, unionFilters, isSignedEvent, hasValidSignature } from '@welshman/util';
+import { ctx, randomInt, uniq, noop, always } from '@welshman/lib';
+import { LOCAL_RELAY_URL, matchFilters, unionFilters, isSignedEvent, hasValidSignature } from '@welshman/util';
 import { Pool } from "./Pool.mjs";
 import { Executor } from "./Executor.mjs";
 import { AuthMode } from "./ConnectionAuth.mjs";
@@ -10,13 +10,29 @@ export const defaultOptimizeSubscriptions = (subs) => uniq(subs.flatMap(sub => s
     const filters = unionFilters(relaySubs.flatMap(sub => sub.request.filters));
     return { relays: [relay], filters };
 });
+export const eventValidationScores = new Map();
+export const isEventValid = (url, event) => {
+    if (url === LOCAL_RELAY_URL)
+        return true;
+    const validCount = eventValidationScores.get(url) || 0;
+    // The more events we've actually validated from this relay, the more we can trust it.
+    if (validCount > randomInt(100, 1000))
+        true;
+    const isValid = isSignedEvent(event) && hasValidSignature(event);
+    // If the event was valid, increase the relay's score. If not, reset it
+    // Never validate less than 10% to make sure we're never totally checking out
+    if (!isValid || validCount < 900) {
+        eventValidationScores.set(url, isValid ? validCount + 1 : 0);
+    }
+    return isValid;
+};
 export const getDefaultNetContext = (overrides = {}) => ({
     pool: new Pool(),
     authMode: AuthMode.Implicit,
     onEvent: noop,
     signEvent: noop,
     isDeleted: always(false),
-    isValid: (url, event) => isSignedEvent(event) && hasValidSignature(event),
+    isValid: isEventValid,
     getExecutor: (relays) => new Executor(new Relays(relays.map((relay) => ctx.net.pool.get(relay)))),
     matchFilters: (url, filters, event) => matchFilters(filters, event),
     optimizeSubscriptions: defaultOptimizeSubscriptions,

package/build/src/Context.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"Context.mjs","sourceRoot":"","sources":["../../src/Context.ts"],"names":[],"mappings":"OAAO,EAAC,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAC,MAAM,eAAe;OAC9C,EAAC,YAAY,EAAE,YAAY,EAAE,aAAa,EAAE,iBAAiB,EAAC,MAAM,gBAAgB;OAEpF,EAAC,IAAI,EAAC;OACN,EAAC,QAAQ,EAAC;OACV,EAAC,QAAQ,EAAC;OACV,EAAC,MAAM,EAAC;AAef,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,IAAoB,EAAE,EAAE,CACnE,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC;KAChD,GAAG,CAAC,KAAK,CAAC,EAAE;IACX,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAA;IACxE,MAAM,OAAO,GAAG,YAAY,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAA;IAE3E,OAAO,EAAC,MAAM,EAAE,CAAC,KAAK,CAAC,EAAE,OAAO,EAAC,CAAA;AACnC,CAAC,CAAC,CAAA;AAEN,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,YAAiC,EAAE,EAAE,EAAE,CAAC,CAAC;IAC5E,IAAI,EAAE,IAAI,IAAI,EAAE;IAChB,QAAQ,EAAE,QAAQ,CAAC,QAAQ;IAC3B,OAAO,EAAE,IAAI;IACb,SAAS,EAAE,IAAI;IACf,SAAS,EAAE,MAAM,CAAC,KAAK,CAAC;IACxB,OAAO,EAAE,CAAC,GAAW,EAAE,KAAmB,EAAE,EAAE,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,iBAAiB,CAAC,KAAK,CAAC;IAC/F,WAAW,EAAE,CAAC,MAAgB,EAAE,EAAE,CAAC,IAAI,QAAQ,CAAC,IAAI,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAa,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACnH,YAAY,EAAE,CAAC,GAAW,EAAE,OAAiB,EAAE,KAAmB,EAAE,EAAE,CAAC,YAAY,CAAC,OAAO,EAAE,KAAK,CAAC;IACnG,qBAAqB,EAAE,4BAA4B;IACnD,GAAG,SAAS;CACb,CAAC,CAAA"}
+{"version":3,"file":"Context.mjs","sourceRoot":"","sources":["../../src/Context.ts"],"names":[],"mappings":"OAAO,EAAC,GAAG,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAC,MAAM,eAAe;OACzD,EAAC,eAAe,EAAE,YAAY,EAAE,YAAY,EAAE,aAAa,EAAE,iBAAiB,EAAC,MAAM,gBAAgB;OAErG,EAAC,IAAI,EAAC;OACN,EAAC,QAAQ,EAAC;OACV,EAAC,QAAQ,EAAC;OACV,EAAC,MAAM,EAAC;AAef,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,IAAoB,EAAE,EAAE,CACnE,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC;KAChD,GAAG,CAAC,KAAK,CAAC,EAAE;IACX,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAA;IACxE,MAAM,OAAO,GAAG,YAAY,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAA;IAE3E,OAAO,EAAC,MAAM,EAAE,CAAC,KAAK,CAAC,EAAE,OAAO,EAAC,CAAA;AACnC,CAAC,CAAC,CAAA;AAEN,MAAM,CAAC,MAAM,qBAAqB,GAAG,IAAI,GAAG,EAAkB,CAAA;AAE9D,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,GAAW,EAAE,KAAmB,EAAE,EAAE;IAC/D,IAAI,GAAG,KAAK,eAAe;QAAE,OAAO,IAAI,CAAA;IAExC,MAAM,UAAU,GAAG,qBAAqB,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;IAEtD,sFAAsF;IACtF,IAAI,UAAU,GAAG,SAAS,CAAC,GAAG,EAAE,IAAI,CAAC;QAAE,IAAI,CAAA;IAE3C,MAAM,OAAO,GAAG,aAAa,CAAC,KAAK,CAAC,IAAI,iBAAiB,CAAC,KAAK,CAAC,CAAA;IAEhE,uEAAuE;IACvE,6EAA6E;IAC7E,IAAI,CAAC,OAAO,IAAI,UAAU,GAAG,GAAG,EAAE;QAChC,qBAAqB,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;KAC7D;IAED,OAAO,OAAO,CAAA;AAChB,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,YAAiC,EAAE,EAAE,EAAE,CAAC,CAAC;IAC5E,IAAI,EAAE,IAAI,IAAI,EAAE;IAChB,QAAQ,EAAE,QAAQ,CAAC,QAAQ;IAC3B,OAAO,EAAE,IAAI;IACb,SAAS,EAAE,IAAI;IACf,SAAS,EAAE,MAAM,CAAC,KAAK,CAAC;IACxB,OAAO,EAAE,YAAY;IACrB,WAAW,EAAE,CAAC,MAAgB,EAAE,EAAE,CAAC,IAAI,QAAQ,CAAC,IAAI,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAa,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACnH,YAAY,EAAE,CAAC,GAAW,EAAE,OAAiB,EAAE,KAAmB,EAAE,EAAE,CAAC,YAAY,CAAC,OAAO,EAAE,KAAK,CAAC;IACnG,qBAAqB,EAAE,4BAA4B;IACnD,GAAG,SAAS;CACb,CAAC,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@welshman/net",
-  "version": "0.0.38",
+  "version": "0.0.39",
   "author": "hodlbod",
   "license": "MIT",
   "description": "Utilities for connecting with nostr relays.",
@@ -33,8 +33,8 @@
     "typescript": "~5.1.6"
   },
   "dependencies": {
-    "@welshman/lib": "~0.0.25",
-    "@welshman/util": "~0.0.45",
+    "@welshman/lib": "~0.0.27",
+    "@welshman/util": "~0.0.46",
     "isomorphic-ws": "^5.0.0",
     "ws": "^8.16.0"
   }