@polkadot-api/ws-provider 0.4.1 → 0.6.0

package/dist/node/esm/default-provider.mjs

@@ -0,0 +1,153 @@
+import { getSyncProvider } from '@polkadot-api/json-rpc-provider-proxy';
+import { WsEvent } from './types-common.mjs';
+import { followEnhancer } from './follow-enhancer.mjs';
+
+const timeoutError = {
+  type: WsEvent.ERROR,
+  event: { type: "timeout" }
+};
+const noop = () => {
+};
+const defaultConfig = {
+  onStatusChanged: noop,
+  innerEnhancer: (x) => x,
+  timeout: 5e3
+};
+const mapEndpoints = (endpoints) => endpoints.map((x) => typeof x === "string" ? [x] : [x.uri, x.protocol]);
+const getWsProvider = (endpoints, config) => {
+  const { onStatusChanged, innerEnhancer, timeout } = {
+    ...defaultConfig,
+    ...config
+  };
+  const actualEndpoints = mapEndpoints(
+    Array.isArray(endpoints) ? endpoints : [endpoints]
+  );
+  const WebsocketClass = config?.websocketClass ?? globalThis.WebSocket;
+  if (!WebsocketClass) throw new Error("Missing WebSocket class");
+  let idx = 0;
+  let status;
+  let switchTo = null;
+  let disconnect = noop;
+  let outerCleanup = noop;
+  const result = followEnhancer(
+    getSyncProvider(async () => {
+      const [uri, protocols] = switchTo || actualEndpoints[idx++ % endpoints.length];
+      switchTo = null;
+      const socket = new WebsocketClass(uri, protocols);
+      const forceSocketClose = () => {
+        try {
+          socket.addEventListener("error", noop, { once: true });
+          socket.close();
+        } catch {
+        }
+      };
+      onStatusChanged(
+        status = {
+          type: WsEvent.CONNECTING,
+          uri,
+          protocols
+        }
+      );
+      await new Promise((resolve, reject) => {
+        const onOpen = () => {
+          initialCleanup();
+          resolve();
+        };
+        const onError = (e) => {
+          initialCleanup();
+          if (e == null) forceSocketClose();
+          console.error(
+            `Unable to connect to ${uri}${protocols ? ", protocols: " + protocols : ""}`
+          );
+          onStatusChanged(
+            status = {
+              type: e ? WsEvent.ERROR : WsEvent.CLOSE,
+              event: e
+            }
+          );
+          setTimeout(reject, e ? 300 : 0, e);
+        };
+        const timeoutToken = timeout !== Infinity ? setTimeout(() => {
+          initialCleanup();
+          forceSocketClose();
+          onStatusChanged(status = timeoutError);
+          reject(timeoutError.event);
+        }, timeout) : void 0;
+        const initialCleanup = () => {
+          clearTimeout(timeoutToken);
+          socket.removeEventListener("error", onError);
+          socket.removeEventListener("open", onOpen);
+        };
+        socket.addEventListener("open", onOpen);
+        socket.addEventListener("error", onError);
+        disconnect = () => {
+          onError(null);
+        };
+      });
+      onStatusChanged(
+        status = {
+          type: WsEvent.CONNECTED,
+          uri,
+          protocols
+        }
+      );
+      let _onInnerMessage;
+      const inner = innerEnhancer((onInnerMessage) => {
+        _onInnerMessage = onInnerMessage;
+        return {
+          send: (m) => {
+            socket.send(m);
+          },
+          disconnect: () => {
+            disconnect();
+          }
+        };
+      });
+      return (onMessage, onHalt) => {
+        const connection = inner(onMessage);
+        const _onMessage = (e) => {
+          if (typeof e.data === "string") _onInnerMessage(e.data);
+        };
+        const innerHalt = (reason) => (e) => {
+          console.warn(`WS halt (${reason})`);
+          onStatusChanged(
+            status = {
+              type: reason,
+              event: e
+            }
+          );
+          onHalt();
+        };
+        const onError = innerHalt(WsEvent.ERROR);
+        const onClose = innerHalt(WsEvent.CLOSE);
+        socket.addEventListener("message", _onMessage);
+        socket.addEventListener("error", onError);
+        socket.addEventListener("close", onClose);
+        disconnect = (withHalt) => {
+          outerCleanup();
+          disconnect = noop;
+          socket.removeEventListener("message", _onMessage);
+          socket.removeEventListener("error", onError);
+          socket.removeEventListener("close", onClose);
+          forceSocketClose();
+          if (withHalt) onClose({});
+        };
+        return connection;
+      };
+    }),
+    () => {
+      switchFn();
+    }
+  );
+  outerCleanup = result.cleanup;
+  delete result.cleanup;
+  const switchFn = (...args) => {
+    if (status.type === WsEvent.CLOSE) return;
+    if (args.length) switchTo = args;
+    if (status.type !== WsEvent.ERROR) disconnect(true);
+  };
+  return Object.assign(result, { switch: switchFn, getStatus: () => status });
+};
+
+export { defaultConfig, getWsProvider, mapEndpoints, noop };
+//# sourceMappingURL=default-provider.mjs.map

package/dist/node/esm/default-provider.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"default-provider.mjs","sources":["../../../src/default-provider.ts"],"sourcesContent":["import { getSyncProvider } from \"@polkadot-api/json-rpc-provider-proxy\"\nimport { StatusChange, WsJsonRpcProvider, WsEvent } from \"./types-common\"\nimport { followEnhancer } from \"./follow-enhancer\"\nimport { JsonRpcProvider } from \"@polkadot-api/json-rpc-provider\"\nimport { WebSocketClass } from \"./types-new\"\n\nconst timeoutError: StatusChange = {\n  type: WsEvent.ERROR,\n  event: { type: \"timeout\" },\n}\n\nexport const noop = () => {}\n\nexport const defaultConfig: {\n  onStatusChanged: (status: StatusChange) => void\n  innerEnhancer: (input: JsonRpcProvider) => JsonRpcProvider\n  timeout: number\n} = {\n  onStatusChanged: noop,\n  innerEnhancer: (x: JsonRpcProvider) => x,\n  timeout: 5_000,\n}\n\nexport const mapEndpoints = (\n  endpoints: Array<string | { uri: string; protocol: string | string[] }>,\n): Array<[string, string | string[]] | [string]> =>\n  endpoints.map((x) => (typeof x === \"string\" ? [x] : [x.uri, x.protocol]))\n\nexport const getWsProvider = (\n  endpoints:\n    | string\n    | Array<string | { uri: string; protocol: string | string[] }>,\n  config?: Partial<{\n    onStatusChanged: (status: StatusChange) => void\n    innerEnhancer: (input: JsonRpcProvider) => JsonRpcProvider\n    timeout: number\n    websocketClass: WebSocketClass\n  }>,\n): WsJsonRpcProvider => {\n  const { onStatusChanged, innerEnhancer, timeout } = {\n    ...defaultConfig,\n    ...config,\n  }\n  const actualEndpoints = mapEndpoints(\n    Array.isArray(endpoints) ? endpoints : [endpoints],\n  )\n  const WebsocketClass = config?.websocketClass ?? globalThis.WebSocket\n  if (!WebsocketClass) throw new Error(\"Missing WebSocket class\")\n\n  let idx = 0\n  let status: StatusChange\n  let switchTo: [string] | [string, string | string[]] | null = null\n  let disconnect: (withHalt?: boolean) => void = noop\n\n  let outerCleanup: () => void = noop\n  const result = followEnhancer(\n    getSyncProvider(async () => {\n      const [uri, protocols] =\n        switchTo || actualEndpoints[idx++ % endpoints.length]\n      switchTo = null\n      const socket = new WebsocketClass(uri, protocols)\n      const forceSocketClose = () => {\n        try {\n          socket.addEventListener(\"error\", noop, { once: true })\n          socket.close()\n        } catch {}\n      }\n      onStatusChanged(\n        (status = {\n          type: WsEvent.CONNECTING,\n          uri,\n          protocols,\n        }),\n      )\n\n      await new Promise<void>((resolve, reject) => {\n        const onOpen = () => {\n          initialCleanup()\n          resolve()\n        }\n\n        const onError = (e: Event | null) => {\n          initialCleanup()\n          if (e == null) forceSocketClose()\n          console.error(\n            `Unable to connect to ${uri}${\n              protocols ? \", protocols: \" + protocols : \"\"\n            }`,\n          )\n          onStatusChanged(\n            (status = {\n              type: e ? WsEvent.ERROR : WsEvent.CLOSE,\n              event: e,\n            }),\n          )\n          setTimeout(reject, e ? 300 : 0, e)\n        }\n\n        const timeoutToken =\n          timeout !== Infinity\n            ? setTimeout(() => {\n                initialCleanup()\n                forceSocketClose()\n                onStatusChanged((status = timeoutError))\n                reject(timeoutError.event)\n              }, timeout)\n            : undefined\n\n        const initialCleanup = () => {\n          clearTimeout(timeoutToken)\n          socket.removeEventListener(\"error\", onError)\n          socket.removeEventListener(\"open\", onOpen)\n        }\n        socket.addEventListener(\"open\", onOpen)\n        socket.addEventListener(\"error\", onError)\n        disconnect = () => {\n          onError(null)\n        }\n      })\n\n      onStatusChanged(\n        (status = {\n          type: WsEvent.CONNECTED,\n          uri,\n          protocols,\n        }),\n      )\n\n      let _onInnerMessage: (msg: string) => void\n      const inner = innerEnhancer((onInnerMessage) => {\n        _onInnerMessage = onInnerMessage\n        return {\n          send: (m) => {\n            socket.send(m)\n          },\n          disconnect: () => {\n            disconnect()\n          },\n        }\n      })\n\n      return (onMessage, onHalt) => {\n        const connection = inner(onMessage)\n        const _onMessage = (e: MessageEvent) => {\n          if (typeof e.data === \"string\") _onInnerMessage(e.data)\n        }\n        const innerHalt =\n          (reason: WsEvent.CLOSE | WsEvent.ERROR) => (e: any) => {\n            console.warn(`WS halt (${reason})`)\n            onStatusChanged(\n              (status = {\n                type: reason,\n                event: e,\n              }),\n            )\n            onHalt()\n          }\n        const onError = innerHalt(WsEvent.ERROR)\n        const onClose = innerHalt(WsEvent.CLOSE)\n\n        socket.addEventListener(\"message\", _onMessage)\n        socket.addEventListener(\"error\", onError)\n        socket.addEventListener(\"close\", onClose)\n        disconnect = (withHalt) => {\n          outerCleanup()\n          disconnect = noop\n          socket.removeEventListener(\"message\", _onMessage)\n          socket.removeEventListener(\"error\", onError)\n          socket.removeEventListener(\"close\", onClose)\n          forceSocketClose()\n          if (withHalt) onClose({})\n        }\n\n        return connection\n      }\n    }),\n    () => {\n      switchFn()\n    },\n  )\n  outerCleanup = result.cleanup\n  delete (result as any).cleanup\n\n  const switchFn: WsJsonRpcProvider[\"switch\"] = (...args) => {\n    if (status.type === WsEvent.CLOSE) return\n    if (args.length) switchTo = args as any\n    if (status.type !== WsEvent.ERROR) disconnect(true)\n  }\n\n  return Object.assign(result, { switch: switchFn, getStatus: () => status })\n}\n"],"names":[],"mappings":";;;;AAMA,MAAM,YAAA,GAA6B;AAAA,EACjC,MAAM,OAAA,CAAQ,KAAA;AAAA,EACd,KAAA,EAAO,EAAE,IAAA,EAAM,SAAA;AACjB,CAAA;AAEO,MAAM,OAAO,MAAM;AAAC;AAEpB,MAAM,aAAA,GAIT;AAAA,EACF,eAAA,EAAiB,IAAA;AAAA,EACjB,aAAA,EAAe,CAAC,CAAA,KAAuB,CAAA;AAAA,EACvC,OAAA,EAAS;AACX;AAEO,MAAM,eAAe,CAC1B,SAAA,KAEA,UAAU,GAAA,CAAI,CAAC,MAAO,OAAO,CAAA,KAAM,QAAA,GAAW,CAAC,CAAC,CAAA,GAAI,CAAC,EAAE,GAAA,EAAK,CAAA,CAAE,QAAQ,CAAE;AAEnE,MAAM,aAAA,GAAgB,CAC3B,SAAA,EAGA,MAAA,KAMsB;AACtB,EAAA,MAAM,EAAE,eAAA,EAAiB,aAAA,EAAe,OAAA,EAAQ,GAAI;AAAA,IAClD,GAAG,aAAA;AAAA,IACH,GAAG;AAAA,GACL;AACA,EAAA,MAAM,eAAA,GAAkB,YAAA;AAAA,IACtB,MAAM,OAAA,CAAQ,SAAS,CAAA,GAAI,SAAA,GAAY,CAAC,SAAS;AAAA,GACnD;AACA,EAAA,MAAM,cAAA,GAAiB,MAAA,EAAQ,cAAA,IAAkB,UAAA,CAAW,SAAA;AAC5D,EAAA,IAAI,CAAC,cAAA,EAAgB,MAAM,IAAI,MAAM,yBAAyB,CAAA;AAE9D,EAAA,IAAI,GAAA,GAAM,CAAA;AACV,EAAA,IAAI,MAAA;AACJ,EAAA,IAAI,QAAA,GAA0D,IAAA;AAC9D,EAAA,IAAI,UAAA,GAA2C,IAAA;AAE/C,EAAA,IAAI,YAAA,GAA2B,IAAA;AAC/B,EAAA,MAAM,MAAA,GAAS,cAAA;AAAA,IACb,gBAAgB,YAAY;AAC1B,MAAA,MAAM,CAAC,KAAK,SAAS,CAAA,GACnB,YAAY,eAAA,CAAgB,GAAA,EAAA,GAAQ,UAAU,MAAM,CAAA;AACtD,MAAA,QAAA,GAAW,IAAA;AACX,MAAA,MAAM,MAAA,GAAS,IAAI,cAAA,CAAe,GAAA,EAAK,SAAS,CAAA;AAChD,MAAA,MAAM,mBAAmB,MAAM;AAC7B,QAAA,IAAI;AACF,UAAA,MAAA,CAAO,iBAAiB,OAAA,EAAS,IAAA,EAAM,EAAE,IAAA,EAAM,MAAM,CAAA;AACrD,UAAA,MAAA,CAAO,KAAA,EAAM;AAAA,QACf,CAAA,CAAA,MAAQ;AAAA,QAAC;AAAA,MACX,CAAA;AACA,MAAA,eAAA;AAAA,QACG,MAAA,GAAS;AAAA,UACR,MAAM,OAAA,CAAQ,UAAA;AAAA,UACd,GAAA;AAAA,UACA;AAAA;AACF,OACF;AAEA,MAAA,MAAM,IAAI,OAAA,CAAc,CAAC,OAAA,EAAS,MAAA,KAAW;AAC3C,QAAA,MAAM,SAAS,MAAM;AACnB,UAAA,cAAA,EAAe;AACf,UAAA,OAAA,EAAQ;AAAA,QACV,CAAA;AAEA,QAAA,MAAM,OAAA,GAAU,CAAC,CAAA,KAAoB;AACnC,UAAA,cAAA,EAAe;AACf,UAAA,IAAI,CAAA,IAAK,MAAM,gBAAA,EAAiB;AAChC,UAAA,OAAA,CAAQ,KAAA;AAAA,YACN,wBAAwB,GAAG,CAAA,EACzB,SAAA,GAAY,eAAA,GAAkB,YAAY,EAC5C,CAAA;AAAA,WACF;AACA,UAAA,eAAA;AAAA,YACG,MAAA,GAAS;AAAA,cACR,IAAA,EAAM,CAAA,GAAI,OAAA,CAAQ,KAAA,GAAQ,OAAA,CAAQ,KAAA;AAAA,cAClC,KAAA,EAAO;AAAA;AACT,WACF;AACA,UAAA,UAAA,CAAW,MAAA,EAAQ,CAAA,GAAI,GAAA,GAAM,CAAA,EAAG,CAAC,CAAA;AAAA,QACnC,CAAA;AAEA,QAAA,MAAM,YAAA,GACJ,OAAA,KAAY,QAAA,GACR,UAAA,CAAW,MAAM;AACf,UAAA,cAAA,EAAe;AACf,UAAA,gBAAA,EAAiB;AACjB,UAAA,eAAA,CAAiB,SAAS,YAAa,CAAA;AACvC,UAAA,MAAA,CAAO,aAAa,KAAK,CAAA;AAAA,QAC3B,CAAA,EAAG,OAAO,CAAA,GACV,MAAA;AAEN,QAAA,MAAM,iBAAiB,MAAM;AAC3B,UAAA,YAAA,CAAa,YAAY,CAAA;AACzB,UAAA,MAAA,CAAO,mBAAA,CAAoB,SAAS,OAAO,CAAA;AAC3C,UAAA,MAAA,CAAO,mBAAA,CAAoB,QAAQ,MAAM,CAAA;AAAA,QAC3C,CAAA;AACA,QAAA,MAAA,CAAO,gBAAA,CAAiB,QAAQ,MAAM,CAAA;AACtC,QAAA,MAAA,CAAO,gBAAA,CAAiB,SAAS,OAAO,CAAA;AACxC,QAAA,UAAA,GAAa,MAAM;AACjB,UAAA,OAAA,CAAQ,IAAI,CAAA;AAAA,QACd,CAAA;AAAA,MACF,CAAC,CAAA;AAED,MAAA,eAAA;AAAA,QACG,MAAA,GAAS;AAAA,UACR,MAAM,OAAA,CAAQ,SAAA;AAAA,UACd,GAAA;AAAA,UACA;AAAA;AACF,OACF;AAEA,MAAA,IAAI,eAAA;AACJ,MAAA,MAAM,KAAA,GAAQ,aAAA,CAAc,CAAC,cAAA,KAAmB;AAC9C,QAAA,eAAA,GAAkB,cAAA;AAClB,QAAA,OAAO;AAAA,UACL,IAAA,EAAM,CAAC,CAAA,KAAM;AACX,YAAA,MAAA,CAAO,KAAK,CAAC,CAAA;AAAA,UACf,CAAA;AAAA,UACA,YAAY,MAAM;AAChB,YAAA,UAAA,EAAW;AAAA,UACb;AAAA,SACF;AAAA,MACF,CAAC,CAAA;AAED,MAAA,OAAO,CAAC,WAAW,MAAA,KAAW;AAC5B,QAAA,MAAM,UAAA,GAAa,MAAM,SAAS,CAAA;AAClC,QAAA,MAAM,UAAA,GAAa,CAAC,CAAA,KAAoB;AACtC,UAAA,IAAI,OAAO,CAAA,CAAE,IAAA,KAAS,QAAA,EAAU,eAAA,CAAgB,EAAE,IAAI,CAAA;AAAA,QACxD,CAAA;AACA,QAAA,MAAM,SAAA,GACJ,CAAC,MAAA,KAA0C,CAAC,CAAA,KAAW;AACrD,UAAA,OAAA,CAAQ,IAAA,CAAK,CAAA,SAAA,EAAY,MAAM,CAAA,CAAA,CAAG,CAAA;AAClC,UAAA,eAAA;AAAA,YACG,MAAA,GAAS;AAAA,cACR,IAAA,EAAM,MAAA;AAAA,cACN,KAAA,EAAO;AAAA;AACT,WACF;AACA,UAAA,MAAA,EAAO;AAAA,QACT,CAAA;AACF,QAAA,MAAM,OAAA,GAAU,SAAA,CAAU,OAAA,CAAQ,KAAK,CAAA;AACvC,QAAA,MAAM,OAAA,GAAU,SAAA,CAAU,OAAA,CAAQ,KAAK,CAAA;AAEvC,QAAA,MAAA,CAAO,gBAAA,CAAiB,WAAW,UAAU,CAAA;AAC7C,QAAA,MAAA,CAAO,gBAAA,CAAiB,SAAS,OAAO,CAAA;AACxC,QAAA,MAAA,CAAO,gBAAA,CAAiB,SAAS,OAAO,CAAA;AACxC,QAAA,UAAA,GAAa,CAAC,QAAA,KAAa;AACzB,UAAA,YAAA,EAAa;AACb,UAAA,UAAA,GAAa,IAAA;AACb,UAAA,MAAA,CAAO,mBAAA,CAAoB,WAAW,UAAU,CAAA;AAChD,UAAA,MAAA,CAAO,mBAAA,CAAoB,SAAS,OAAO,CAAA;AAC3C,UAAA,MAAA,CAAO,mBAAA,CAAoB,SAAS,OAAO,CAAA;AAC3C,UAAA,gBAAA,EAAiB;AACjB,UAAA,IAAI,QAAA,EAAU,OAAA,CAAQ,EAAE,CAAA;AAAA,QAC1B,CAAA;AAEA,QAAA,OAAO,UAAA;AAAA,MACT,CAAA;AAAA,IACF,CAAC,CAAA;AAAA,IACD,MAAM;AACJ,MAAA,QAAA,EAAS;AAAA,IACX;AAAA,GACF;AACA,EAAA,YAAA,GAAe,MAAA,CAAO,OAAA;AACtB,EAAA,OAAQ,MAAA,CAAe,OAAA;AAEvB,EAAA,MAAM,QAAA,GAAwC,IAAI,IAAA,KAAS;AACzD,IAAA,IAAI,MAAA,CAAO,IAAA,KAAS,OAAA,CAAQ,KAAA,EAAO;AACnC,IAAA,IAAI,IAAA,CAAK,QAAQ,QAAA,GAAW,IAAA;AAC5B,IAAA,IAAI,MAAA,CAAO,IAAA,KAAS,OAAA,CAAQ,KAAA,aAAkB,IAAI,CAAA;AAAA,EACpD,CAAA;AAEA,EAAA,OAAO,MAAA,CAAO,OAAO,MAAA,EAAQ,EAAE,QAAQ,QAAA,EAAU,SAAA,EAAW,MAAM,MAAA,EAAQ,CAAA;AAC5E;;;;"}

package/dist/node/esm/legacy-provider.mjs

@@ -0,0 +1,42 @@
+import { mapEndpoints, noop, defaultConfig, getWsProvider } from './default-provider.mjs';
+
+const getLegacyWsProvider = (websocketClass) => {
+  return (...args) => {
+    let endpoints = [];
+    let { timeout, innerEnhancer, onStatusChanged } = defaultConfig;
+    const [firstArg] = args;
+    if (args.length === 1 && typeof firstArg === "object" && !Array.isArray(firstArg)) {
+      endpoints = mapEndpoints(firstArg.endpoints);
+      onStatusChanged = firstArg.onStatusChanged ?? noop;
+      timeout = firstArg.timeout ?? timeout;
+      innerEnhancer = firstArg.innerEnhancer ?? ((x) => x);
+    } else {
+      if (typeof args[1] === "function")
+        onStatusChanged = args[1];
+      if (Array.isArray(firstArg)) endpoints = mapEndpoints(firstArg);
+      else {
+        endpoints = [[firstArg]];
+        if (args[1] && args[1] !== onStatusChanged)
+          endpoints[0][1] = args[1];
+        if (args[2]) onStatusChanged = args[2];
+      }
+    }
+    return getWsProvider(
+      endpoints.map(
+        (x) => x.length === 1 ? x[0] : {
+          uri: x[0],
+          protocol: x[1]
+        }
+      ),
+      {
+        websocketClass,
+        onStatusChanged,
+        timeout,
+        innerEnhancer
+      }
+    );
+  };
+};
+
+export { getLegacyWsProvider };
+//# sourceMappingURL=legacy-provider.mjs.map

package/dist/node/esm/legacy-provider.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"legacy-provider.mjs","sources":["../../../src/legacy-provider.ts"],"sourcesContent":["import type { StatusChange, WsJsonRpcProvider } from \"./types-common\"\nimport type { GetWsProviderInput } from \"./types-legacy\"\nimport {\n  getWsProvider,\n  mapEndpoints,\n  defaultConfig,\n  noop,\n} from \"./default-provider\"\nimport { type WebSocketClass } from \"./types-new\"\n\nexport const getLegacyWsProvider = (\n  websocketClass: WebSocketClass,\n): GetWsProviderInput => {\n  return (...args): WsJsonRpcProvider => {\n    let endpoints: Array<[string, string | string[]] | [string]> = []\n    let { timeout, innerEnhancer, onStatusChanged } = defaultConfig\n\n    const [firstArg] = args\n    if (\n      args.length === 1 &&\n      typeof firstArg === \"object\" &&\n      !Array.isArray(firstArg)\n    ) {\n      endpoints = mapEndpoints(firstArg.endpoints)\n      onStatusChanged = firstArg.onStatusChanged ?? noop\n      timeout = firstArg.timeout ?? timeout\n      innerEnhancer = firstArg.innerEnhancer ?? ((x) => x)\n    } else {\n      if (typeof args[1] === \"function\")\n        onStatusChanged = args[1] as (status: StatusChange) => void\n      if (Array.isArray(firstArg)) endpoints = mapEndpoints(firstArg)\n      else {\n        endpoints = [[firstArg as string]]\n        if (args[1] && args[1] !== onStatusChanged)\n          endpoints[0][1] = args[1] as any\n        if (args[2]) onStatusChanged = args[2] as any\n      }\n    }\n\n    return getWsProvider(\n      endpoints.map((x) =>\n        x.length === 1\n          ? x[0]\n          : {\n              uri: x[0],\n              protocol: x[1],\n            },\n      ),\n      {\n        websocketClass,\n        onStatusChanged,\n        timeout,\n        innerEnhancer,\n      },\n    )\n  }\n}\n"],"names":[],"mappings":";;AAUO,MAAM,mBAAA,GAAsB,CACjC,cAAA,KACuB;AACvB,EAAA,OAAO,IAAI,IAAA,KAA4B;AACrC,IAAA,IAAI,YAA2D,EAAC;AAChE,IAAA,IAAI,EAAE,OAAA,EAAS,aAAA,EAAe,eAAA,EAAgB,GAAI,aAAA;AAElD,IAAA,MAAM,CAAC,QAAQ,CAAA,GAAI,IAAA;AACnB,IAAA,IACE,IAAA,CAAK,MAAA,KAAW,CAAA,IAChB,OAAO,QAAA,KAAa,YACpB,CAAC,KAAA,CAAM,OAAA,CAAQ,QAAQ,CAAA,EACvB;AACA,MAAA,SAAA,GAAY,YAAA,CAAa,SAAS,SAAS,CAAA;AAC3C,MAAA,eAAA,GAAkB,SAAS,eAAA,IAAmB,IAAA;AAC9C,MAAA,OAAA,GAAU,SAAS,OAAA,IAAW,OAAA;AAC9B,MAAA,aAAA,GAAgB,QAAA,CAAS,aAAA,KAAkB,CAAC,CAAA,KAAM,CAAA,CAAA;AAAA,IACpD,CAAA,MAAO;AACL,MAAA,IAAI,OAAO,IAAA,CAAK,CAAC,CAAA,KAAM,UAAA;AACrB,QAAA,eAAA,GAAkB,KAAK,CAAC,CAAA;AAC1B,MAAA,IAAI,MAAM,OAAA,CAAQ,QAAQ,CAAA,EAAG,SAAA,GAAY,aAAa,QAAQ,CAAA;AAAA,WACzD;AACH,QAAA,SAAA,GAAY,CAAC,CAAC,QAAkB,CAAC,CAAA;AACjC,QAAA,IAAI,IAAA,CAAK,CAAC,CAAA,IAAK,IAAA,CAAK,CAAC,CAAA,KAAM,eAAA;AACzB,UAAA,SAAA,CAAU,CAAC,CAAA,CAAE,CAAC,CAAA,GAAI,KAAK,CAAC,CAAA;AAC1B,QAAA,IAAI,IAAA,CAAK,CAAC,CAAA,EAAG,eAAA,GAAkB,KAAK,CAAC,CAAA;AAAA,MACvC;AAAA,IACF;AAEA,IAAA,OAAO,aAAA;AAAA,MACL,SAAA,CAAU,GAAA;AAAA,QAAI,CAAC,CAAA,KACb,CAAA,CAAE,WAAW,CAAA,GACT,CAAA,CAAE,CAAC,CAAA,GACH;AAAA,UACE,GAAA,EAAK,EAAE,CAAC,CAAA;AAAA,UACR,QAAA,EAAU,EAAE,CAAC;AAAA;AACf,OACN;AAAA,MACA;AAAA,QACE,cAAA;AAAA,QACA,eAAA;AAAA,QACA,OAAA;AAAA,QACA;AAAA;AACF,KACF;AAAA,EACF,CAAA;AACF;;;;"}

package/dist/node/esm/node.mjs

@@ -1,13 +1,13 @@
 import { WebSocket } from 'ws';
-import { getInternalWsProvider } from './ws-provider.mjs';
-export { WsEvent } from './types.mjs';
+import { getLegacyWsProvider } from './legacy-provider.mjs';
+export { WsEvent } from './types-common.mjs';
 
 class WS extends WebSocket {
   close() {
     this.terminate();
   }
 }
-const getWsProvider = getInternalWsProvider(
+const getWsProvider = getLegacyWsProvider(
   WS
 );
 

package/dist/node/esm/node.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"node.mjs","sources":["../../../src/node.ts"],"sourcesContent":["import { WebSocket } from \"ws\"\nimport { getInternalWsProvider } from \"./ws-provider\"\nexport type { JsonRpcProvider } from \"@polkadot-api/json-rpc-provider\"\n\nexport * from \"./types\"\n\nclass WS extends WebSocket {\n  close() {\n    this.terminate()\n  }\n}\n\nexport const getWsProvider = getInternalWsProvider(\n  WS as unknown as typeof globalThis.WebSocket,\n)\n"],"names":[],"mappings":";;;;AAMA,MAAM,WAAW,SAAA,CAAU;AAAA,EACzB,KAAA,GAAQ;AACN,IAAA,IAAA,CAAK,SAAA,EAAU;AAAA,EACjB;AACF;AAEO,MAAM,aAAA,GAAgB,qBAAA;AAAA,EAC3B;AACF;;;;"}
+{"version":3,"file":"node.mjs","sources":["../../../src/node.ts"],"sourcesContent":["import { WebSocket } from \"ws\"\nimport { getLegacyWsProvider } from \"./legacy-provider\"\nexport type { JsonRpcProvider } from \"@polkadot-api/json-rpc-provider\"\n\nexport * from \"./types-common\"\nexport * from \"./types-legacy\"\n\nclass WS extends WebSocket {\n  close() {\n    this.terminate()\n  }\n}\n\n/**\n * @deprecated This export will be removed in PAPI v2. Migrate as follows:\n *             `import { getWsProvider } from \"polkadot-api/ws-provider\"\n */\nexport const getWsProvider = getLegacyWsProvider(\n  WS as unknown as typeof globalThis.WebSocket,\n)\n"],"names":[],"mappings":";;;;AAOA,MAAM,WAAW,SAAA,CAAU;AAAA,EACzB,KAAA,GAAQ;AACN,IAAA,IAAA,CAAK,SAAA,EAAU;AAAA,EACjB;AACF;AAMO,MAAM,aAAA,GAAgB,mBAAA;AAAA,EAC3B;AACF;;;;"}

package/dist/{web/esm/types.mjs → node/esm/types-common.mjs}

@@ -7,4 +7,4 @@ var WsEvent = /* @__PURE__ */ ((WsEvent2) => {
 })(WsEvent || {});
 
 export { WsEvent };
-//# sourceMappingURL=types.mjs.map
+//# sourceMappingURL=types-common.mjs.map

package/dist/node/esm/types-common.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"types-common.mjs","sources":["../../../src/types-common.ts"],"sourcesContent":["import { JsonRpcProvider } from \"@polkadot-api/json-rpc-provider\"\n\nexport enum WsEvent {\n  CONNECTING,\n  CONNECTED,\n  ERROR,\n  CLOSE,\n}\n\nexport type WsConnecting = {\n  type: WsEvent.CONNECTING\n  uri: string\n  protocols?: string | string[]\n}\nexport type WsConnected = {\n  type: WsEvent.CONNECTED\n  uri: string\n  protocols?: string | string[]\n}\nexport type WsError = {\n  type: WsEvent.ERROR\n  event: any\n}\nexport type WsClose = {\n  type: WsEvent.CLOSE\n  event: any\n}\nexport type StatusChange = WsConnecting | WsConnected | WsError | WsClose\nexport type WsJsonRpcProvider = JsonRpcProvider & {\n  switch: (uri?: string, protocol?: string[]) => void\n  getStatus: () => StatusChange\n}\nexport { type JsonRpcProvider }\n"],"names":["WsEvent"],"mappings":"AAEO,IAAK,OAAA,qBAAAA,QAAAA,KAAL;AACL,EAAAA,QAAAA,CAAAA,QAAAA,CAAA,YAAA,CAAA,GAAA,CAAA,CAAA,GAAA,YAAA;AACA,EAAAA,QAAAA,CAAAA,QAAAA,CAAA,WAAA,CAAA,GAAA,CAAA,CAAA,GAAA,WAAA;AACA,EAAAA,QAAAA,CAAAA,QAAAA,CAAA,OAAA,CAAA,GAAA,CAAA,CAAA,GAAA,OAAA;AACA,EAAAA,QAAAA,CAAAA,QAAAA,CAAA,OAAA,CAAA,GAAA,CAAA,CAAA,GAAA,OAAA;AAJU,EAAA,OAAAA,QAAAA;AAAA,CAAA,EAAA,OAAA,IAAA,EAAA;;;;"}

package/dist/node/node.d.ts

@@ -30,6 +30,7 @@ type WsJsonRpcProvider = JsonRpcProvider & {
     switch: (uri?: string, protocol?: string[]) => void;
     getStatus: () => StatusChange;
 };
+
 interface WsProviderConfig {
     endpoints: Array<string | {
         uri: string;
@@ -37,6 +38,7 @@ interface WsProviderConfig {
     }>;
     onStatusChanged?: (status: StatusChange) => void;
     timeout?: number;
+    innerEnhancer?: (input: JsonRpcProvider) => JsonRpcProvider;
 }
 interface GetWsProviderInput {
     (uri: string, protocols?: string | string[], onStatusChanged?: (status: StatusChange) => void): WsJsonRpcProvider;
@@ -48,6 +50,10 @@ interface GetWsProviderInput {
     (wsProviderConfig: WsProviderConfig): WsJsonRpcProvider;
 }
 
+/**
+ * @deprecated This export will be removed in PAPI v2. Migrate as follows:
+ *             `import { getWsProvider } from "polkadot-api/ws-provider"
+ */
 declare const getWsProvider: GetWsProviderInput;
 
 export { WsEvent, getWsProvider };

package/dist/node/node.js

@@ -97,17 +97,157 @@ const timeoutError = {
 };
 const noop = () => {
 };
+const defaultConfig = {
+  onStatusChanged: noop,
+  innerEnhancer: (x) => x,
+  timeout: 5e3
+};
 const mapEndpoints = (endpoints) => endpoints.map((x) => typeof x === "string" ? [x] : [x.uri, x.protocol]);
-const getInternalWsProvider = (WebsocketClass) => {
+const getWsProvider$1 = (endpoints, config) => {
+  const { onStatusChanged, innerEnhancer, timeout } = {
+    ...defaultConfig,
+    ...config
+  };
+  const actualEndpoints = mapEndpoints(
+    Array.isArray(endpoints) ? endpoints : [endpoints]
+  );
+  const WebsocketClass = config?.websocketClass ?? globalThis.WebSocket;
+  if (!WebsocketClass) throw new Error("Missing WebSocket class");
+  let idx = 0;
+  let status;
+  let switchTo = null;
+  let disconnect = noop;
+  let outerCleanup = noop;
+  const result = followEnhancer(
+    jsonRpcProviderProxy.getSyncProvider(async () => {
+      const [uri, protocols] = switchTo || actualEndpoints[idx++ % endpoints.length];
+      switchTo = null;
+      const socket = new WebsocketClass(uri, protocols);
+      const forceSocketClose = () => {
+        try {
+          socket.addEventListener("error", noop, { once: true });
+          socket.close();
+        } catch {
+        }
+      };
+      onStatusChanged(
+        status = {
+          type: WsEvent.CONNECTING,
+          uri,
+          protocols
+        }
+      );
+      await new Promise((resolve, reject) => {
+        const onOpen = () => {
+          initialCleanup();
+          resolve();
+        };
+        const onError = (e) => {
+          initialCleanup();
+          if (e == null) forceSocketClose();
+          console.error(
+            `Unable to connect to ${uri}${protocols ? ", protocols: " + protocols : ""}`
+          );
+          onStatusChanged(
+            status = {
+              type: e ? WsEvent.ERROR : WsEvent.CLOSE,
+              event: e
+            }
+          );
+          setTimeout(reject, e ? 300 : 0, e);
+        };
+        const timeoutToken = timeout !== Infinity ? setTimeout(() => {
+          initialCleanup();
+          forceSocketClose();
+          onStatusChanged(status = timeoutError);
+          reject(timeoutError.event);
+        }, timeout) : void 0;
+        const initialCleanup = () => {
+          clearTimeout(timeoutToken);
+          socket.removeEventListener("error", onError);
+          socket.removeEventListener("open", onOpen);
+        };
+        socket.addEventListener("open", onOpen);
+        socket.addEventListener("error", onError);
+        disconnect = () => {
+          onError(null);
+        };
+      });
+      onStatusChanged(
+        status = {
+          type: WsEvent.CONNECTED,
+          uri,
+          protocols
+        }
+      );
+      let _onInnerMessage;
+      const inner = innerEnhancer((onInnerMessage) => {
+        _onInnerMessage = onInnerMessage;
+        return {
+          send: (m) => {
+            socket.send(m);
+          },
+          disconnect: () => {
+            disconnect();
+          }
+        };
+      });
+      return (onMessage, onHalt) => {
+        const connection = inner(onMessage);
+        const _onMessage = (e) => {
+          if (typeof e.data === "string") _onInnerMessage(e.data);
+        };
+        const innerHalt = (reason) => (e) => {
+          console.warn(`WS halt (${reason})`);
+          onStatusChanged(
+            status = {
+              type: reason,
+              event: e
+            }
+          );
+          onHalt();
+        };
+        const onError = innerHalt(WsEvent.ERROR);
+        const onClose = innerHalt(WsEvent.CLOSE);
+        socket.addEventListener("message", _onMessage);
+        socket.addEventListener("error", onError);
+        socket.addEventListener("close", onClose);
+        disconnect = (withHalt) => {
+          outerCleanup();
+          disconnect = noop;
+          socket.removeEventListener("message", _onMessage);
+          socket.removeEventListener("error", onError);
+          socket.removeEventListener("close", onClose);
+          forceSocketClose();
+          if (withHalt) onClose({});
+        };
+        return connection;
+      };
+    }),
+    () => {
+      switchFn();
+    }
+  );
+  outerCleanup = result.cleanup;
+  delete result.cleanup;
+  const switchFn = (...args) => {
+    if (status.type === WsEvent.CLOSE) return;
+    if (args.length) switchTo = args;
+    if (status.type !== WsEvent.ERROR) disconnect(true);
+  };
+  return Object.assign(result, { switch: switchFn, getStatus: () => status });
+};
+
+const getLegacyWsProvider = (websocketClass) => {
   return (...args) => {
     let endpoints = [];
-    let onStatusChanged = noop;
-    let timeout = 3500;
+    let { timeout, innerEnhancer, onStatusChanged } = defaultConfig;
     const [firstArg] = args;
     if (args.length === 1 && typeof firstArg === "object" && !Array.isArray(firstArg)) {
       endpoints = mapEndpoints(firstArg.endpoints);
       onStatusChanged = firstArg.onStatusChanged ?? noop;
       timeout = firstArg.timeout ?? timeout;
+      innerEnhancer = firstArg.innerEnhancer ?? ((x) => x);
     } else {
       if (typeof args[1] === "function")
         onStatusChanged = args[1];
@@ -119,121 +259,20 @@ const getInternalWsProvider = (WebsocketClass) => {
         if (args[2]) onStatusChanged = args[2];
       }
     }
-    let idx = 0;
-    let status;
-    let switchTo = null;
-    let disconnect = noop;
-    let outerCleanup = noop;
-    const result = followEnhancer(
-      jsonRpcProviderProxy.getSyncProvider(async () => {
-        const [uri, protocols] = switchTo || endpoints[idx++ % endpoints.length];
-        switchTo = null;
-        const socket = new WebsocketClass(uri, protocols);
-        const forceSocketClose = () => {
-          try {
-            socket.addEventListener("error", noop, { once: true });
-            socket.close();
-          } catch {
-          }
-        };
-        onStatusChanged(
-          status = {
-            type: WsEvent.CONNECTING,
-            uri,
-            protocols
-          }
-        );
-        await new Promise((resolve, reject) => {
-          const onOpen = () => {
-            initialCleanup();
-            resolve();
-          };
-          const onError = (e) => {
-            initialCleanup();
-            if (e == null) forceSocketClose();
-            console.error(
-              `Unable to connect to ${uri}${protocols ? ", protocols: " + protocols : ""}`
-            );
-            onStatusChanged(
-              status = {
-                type: e ? WsEvent.ERROR : WsEvent.CLOSE,
-                event: e
-              }
-            );
-            setTimeout(reject, e ? 300 : 0, e);
-          };
-          const timeoutToken = timeout !== Infinity ? setTimeout(() => {
-            initialCleanup();
-            forceSocketClose();
-            onStatusChanged(status = timeoutError);
-            reject(timeoutError.event);
-          }, timeout) : void 0;
-          const initialCleanup = () => {
-            clearTimeout(timeoutToken);
-            socket.removeEventListener("error", onError);
-            socket.removeEventListener("open", onOpen);
-          };
-          socket.addEventListener("open", onOpen);
-          socket.addEventListener("error", onError);
-          disconnect = () => {
-            onError(null);
-          };
-        });
-        onStatusChanged(
-          status = {
-            type: WsEvent.CONNECTED,
-            uri,
-            protocols
-          }
-        );
-        return (onMessage, onHalt) => {
-          const _onMessage = (e) => {
-            if (typeof e.data === "string") onMessage(e.data);
-          };
-          const innerHalt = (reason) => (e) => {
-            console.warn(`WS halt (${reason})`);
-            onStatusChanged(
-              status = {
-                type: reason,
-                event: e
-              }
-            );
-            onHalt();
-          };
-          const onError = innerHalt(WsEvent.ERROR);
-          const onClose = innerHalt(WsEvent.CLOSE);
-          socket.addEventListener("message", _onMessage);
-          socket.addEventListener("error", onError);
-          socket.addEventListener("close", onClose);
-          disconnect = (withHalt) => {
-            outerCleanup();
-            disconnect = noop;
-            socket.removeEventListener("message", _onMessage);
-            socket.removeEventListener("error", onError);
-            socket.removeEventListener("close", onClose);
-            forceSocketClose();
-            if (withHalt) onClose({});
-          };
-          return {
-            send: (msg) => {
-              socket.send(msg);
-            },
-            disconnect
-          };
-        };
-      }),
-      () => {
-        switchFn();
+    return getWsProvider$1(
+      endpoints.map(
+        (x) => x.length === 1 ? x[0] : {
+          uri: x[0],
+          protocol: x[1]
+        }
+      ),
+      {
+        websocketClass,
+        onStatusChanged,
+        timeout,
+        innerEnhancer
       }
     );
-    outerCleanup = result.cleanup;
-    delete result.cleanup;
-    const switchFn = (...args2) => {
-      if (status.type === WsEvent.CLOSE) return;
-      if (args2.length) switchTo = args2;
-      if (status.type !== WsEvent.ERROR) disconnect(true);
-    };
-    return Object.assign(result, { switch: switchFn, getStatus: () => status });
   };
 };
 
@@ -242,7 +281,7 @@ class WS extends ws.WebSocket {
     this.terminate();
   }
 }
-const getWsProvider = getInternalWsProvider(
+const getWsProvider = getLegacyWsProvider(
   WS
 );