@xyo-network/witness-evm-abstract 2.84.9

package/dist/node/index.js

@@ -0,0 +1,139 @@
+// src/lib/checkIpfsUrl.ts
+import { assertEx } from "@xylabs/assert";
+var allowIpfsIoRepair = true;
+var checkIpfsUrl = (urlToCheck, ipfsGateway) => {
+  try {
+    const url = new URL(urlToCheck);
+    let protocol = url.protocol;
+    let host = url.host;
+    let path = url.pathname;
+    const query = url.search;
+    if (protocol === "ipfs:") {
+      protocol = "https:";
+      host = assertEx(ipfsGateway, "No ipfsGateway provided");
+      path = url.host === "ipfs" ? `ipfs${path}` : `ipfs/${url.host}${path}`;
+      const root = `${protocol}//${host}/${path}`;
+      return (query == null ? void 0 : query.length) > 0 ? `${root}?${query}` : root;
+    } else if (allowIpfsIoRepair && protocol === "https" && host === "ipfs.io") {
+      protocol = "https:";
+      host = assertEx(ipfsGateway, "No ipfsGateway provided");
+      const pathParts = path.split("/");
+      if (pathParts[0] === "ipfs") {
+        pathParts.shift();
+      }
+      path = pathParts.join("/");
+      const root = `${protocol}//${host}/${path}`;
+      return (query == null ? void 0 : query.length) > 0 ? `${root}?${query}` : root;
+    } else {
+      return urlToCheck;
+    }
+  } catch {
+    return urlToCheck;
+  }
+};
+
+// src/lib/getProviderFromEnv.ts
+import { assertEx as assertEx2 } from "@xylabs/assert";
+import { InfuraProvider, InfuraWebSocketProvider, JsonRpcProvider, WebSocketProvider } from "ethers";
+var createInfuraRpc = (chainId) => {
+  const provider = process.env.INFURA_PROJECT_ID && process.env.INFURA_PROJECT_SECRET ? new InfuraProvider(chainId, process.env.INFURA_PROJECT_ID) : void 0;
+  return provider;
+};
+var createInfuraWss = (chainId) => {
+  const provider = process.env.INFURA_PROJECT_ID ? new InfuraWebSocketProvider(chainId, process.env.INFURA_PROJECT_ID) : void 0;
+  return provider;
+};
+var createQuicknodeWss = (chainId) => {
+  const quickNodeWSSUri = process.env.QUICKNODE_WSS_URI;
+  const provider = quickNodeWSSUri ? new WebSocketProvider(quickNodeWSSUri, chainId) : void 0;
+  return provider;
+};
+var createQuicknodeRpc = (chainId) => {
+  const quickNodeHttpsUri = process.env.QUICKNODE_HTTPS_URI;
+  const provider = quickNodeHttpsUri ? new JsonRpcProvider(quickNodeHttpsUri, chainId) : void 0;
+  return provider;
+};
+var getProviderFromEnv = (chainId = 1, { providerSource = "infura", providerType = "rpc" } = {}) => {
+  let provider = void 0;
+  switch (providerSource) {
+    case "quicknode": {
+      switch (providerType) {
+        case "rpc": {
+          provider = createQuicknodeRpc(chainId);
+          break;
+        }
+        case "wss": {
+          provider = createQuicknodeWss(chainId);
+          break;
+        }
+      }
+      break;
+    }
+    default:
+    case "infura": {
+      switch (providerType) {
+        case "wss": {
+          provider = createInfuraWss(chainId);
+          break;
+        }
+        case "rpc": {
+          provider = createInfuraRpc(chainId);
+          break;
+        }
+      }
+      break;
+    }
+  }
+  if (!provider) {
+    provider = createInfuraWss(chainId) ?? createInfuraRpc(chainId) ?? createQuicknodeRpc(chainId);
+  }
+  return assertEx2(provider, `Unable to create provider [${chainId}]: ${providerSource}|${providerType}`);
+};
+var providers = {};
+var getSharedProviderFromEnv = (chainId = 1, options) => {
+  const key = `${chainId}:${options ? JSON.stringify(options) : "default"}`;
+  providers[key] = providers[key] ?? getProviderFromEnv(chainId, options);
+  return providers[key];
+};
+var getProvidersFromEnv = (count = 1, chainId = 1, options = {}) => {
+  const result = [];
+  for (let i = 0; i < count; i++) {
+    result.push(getProviderFromEnv(chainId, options));
+  }
+  return result;
+};
+
+// src/model.ts
+var BlockchainAddressSchema = "network.xyo.blockchain.address";
+
+// src/Witness.ts
+import { AbstractWitness } from "@xyo-network/abstract-witness";
+var EvmWitnessConfigSchema = "network.xyo.evm.witness";
+var AbstractBlockchainWitness = class extends AbstractWitness {
+  _providers = void 0;
+  async getProvider(cache = false, error) {
+    const providers2 = await this.getProviders(cache);
+    if (providers2.length === 0) {
+      if (error) {
+        throw new Error(typeof error === "string" ? error : "No providers available");
+      }
+      return void 0;
+    }
+    return providers2[Date.now() % providers2.length];
+  }
+  async getProviders(cache = false) {
+    const cachedProviders = cache ? this._providers : void 0;
+    this._providers = cachedProviders ?? await this.params.providers();
+    return this._providers;
+  }
+};
+export {
+  AbstractBlockchainWitness,
+  BlockchainAddressSchema,
+  EvmWitnessConfigSchema,
+  checkIpfsUrl,
+  getProviderFromEnv,
+  getProvidersFromEnv,
+  getSharedProviderFromEnv
+};
+//# sourceMappingURL=index.js.map

package/dist/node/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/lib/checkIpfsUrl.ts","../../src/lib/getProviderFromEnv.ts","../../src/model.ts","../../src/Witness.ts"],"sourcesContent":["import { assertEx } from '@xylabs/assert'\n\nconst allowIpfsIoRepair = true\n\n/**\n * Returns the equivalent IPFS gateway URL for the supplied URL.\n * @param urlToCheck The URL to check\n * @returns If the supplied URL is an IPFS URL, it converts the URL to the\n * equivalent IPFS gateway URL. Otherwise, returns the original URL.\n */\nexport const checkIpfsUrl = (urlToCheck: string, ipfsGateway?: string): string => {\n  try {\n    const url = new URL(urlToCheck)\n    let protocol = url.protocol\n    let host = url.host\n    let path = url.pathname\n    const query = url.search\n    if (protocol === 'ipfs:') {\n      protocol = 'https:'\n      host = assertEx(ipfsGateway, 'No ipfsGateway provided')\n      path = url.host === 'ipfs' ? `ipfs${path}` : `ipfs/${url.host}${path}`\n      const root = `${protocol}//${host}/${path}`\n      return query?.length > 0 ? `${root}?${query}` : root\n    } else if (allowIpfsIoRepair && protocol === 'https' && host === 'ipfs.io') {\n      protocol = 'https:'\n      host = assertEx(ipfsGateway, 'No ipfsGateway provided')\n      const pathParts = path.split('/')\n      if (pathParts[0] === 'ipfs') {\n        pathParts.shift()\n      }\n      path = pathParts.join('/')\n      const root = `${protocol}//${host}/${path}`\n      return query?.length > 0 ? `${root}?${query}` : root\n    } else {\n      return urlToCheck\n    }\n  } catch {\n    //const error = ex as Error\n    //console.error(`${error.name}:${error.message} [${urlToCheck}]`)\n    //console.log(error.stack)\n    return urlToCheck\n  }\n}\n","import { assertEx } from '@xylabs/assert'\nimport { InfuraProvider, InfuraWebSocketProvider, JsonRpcProvider, Provider, WebSocketProvider } from 'ethers'\n\nexport type ProviderSource = 'infura' | 'quicknode'\nexport type ProviderType = 'rpc' | 'wss'\n\nexport interface GetProvidersFromEnvOptions {\n  providerSource?: ProviderSource\n  providerType?: ProviderType\n}\n\nconst createInfuraRpc = (chainId: number) => {\n  const provider =\n    process.env.INFURA_PROJECT_ID && process.env.INFURA_PROJECT_SECRET ? new InfuraProvider(chainId, process.env.INFURA_PROJECT_ID) : undefined\n  return provider\n}\n\nconst createInfuraWss = (chainId: number) => {\n  const provider = process.env.INFURA_PROJECT_ID ? new InfuraWebSocketProvider(chainId, process.env.INFURA_PROJECT_ID) : undefined\n  return provider\n}\n\nconst createQuicknodeWss = (chainId: number) => {\n  const quickNodeWSSUri = process.env.QUICKNODE_WSS_URI\n  const provider = quickNodeWSSUri ? new WebSocketProvider(quickNodeWSSUri, chainId) : undefined\n\n  return provider\n}\n\nconst createQuicknodeRpc = (chainId: number) => {\n  const quickNodeHttpsUri = process.env.QUICKNODE_HTTPS_URI\n  const provider = quickNodeHttpsUri ? new JsonRpcProvider(quickNodeHttpsUri, chainId) : undefined\n  return provider\n}\n\nexport const getProviderFromEnv = (\n  chainId: number = 0x01,\n  { providerSource = 'infura', providerType = 'rpc' }: GetProvidersFromEnvOptions = {},\n): Provider => {\n  let provider: Provider | undefined = undefined\n  switch (providerSource) {\n    case 'quicknode': {\n      switch (providerType) {\n        case 'rpc': {\n          provider = createQuicknodeRpc(chainId)\n          break\n        }\n        case 'wss': {\n          provider = createQuicknodeWss(chainId)\n          break\n        }\n      }\n      break\n    }\n    default:\n    case 'infura': {\n      switch (providerType) {\n        case 'wss': {\n          provider = createInfuraWss(chainId)\n          break\n        }\n        case 'rpc': {\n          provider = createInfuraRpc(chainId)\n          break\n        }\n      }\n      break\n    }\n  }\n  if (!provider) {\n    provider = createInfuraWss(chainId) ?? createInfuraRpc(chainId) ?? createQuicknodeRpc(chainId)\n  }\n  return assertEx(provider, `Unable to create provider [${chainId}]: ${providerSource}|${providerType}`)\n}\n\nconst providers: Record<string, Provider> = {}\n\nexport const getSharedProviderFromEnv = (\n  chainId: number = 0x01,\n  options?: { providerSource?: ProviderSource; providerType?: ProviderType },\n): Provider => {\n  const key = `${chainId}:${options ? JSON.stringify(options) : 'default'}`\n  providers[key] = providers[key] ?? getProviderFromEnv(chainId, options)\n  return providers[key]\n}\n\nexport const getProvidersFromEnv = (count: number = 1, chainId: number = 0x01, options: GetProvidersFromEnvOptions = {}): Provider[] => {\n  const result: Provider[] = []\n  for (let i = 0; i < count; i++) {\n    result.push(getProviderFromEnv(chainId, options))\n  }\n  return result\n}\n","import { Payload } from '@xyo-network/payload-model'\n\nexport const BlockchainAddressSchema = 'network.xyo.blockchain.address'\nexport type BlockchainAddressSchema = typeof BlockchainAddressSchema\n\nexport type BlockchainAddress = Payload<\n  {\n    address?: string\n    blockTag?: string | number\n    chainId?: number\n  },\n  BlockchainAddressSchema\n>\n","import { Promisable } from '@xylabs/promise'\nimport { AbstractWitness } from '@xyo-network/abstract-witness'\nimport { AnyConfigSchema } from '@xyo-network/module-model'\nimport { EmptyObject, WithAdditional } from '@xyo-network/object'\nimport { Payload } from '@xyo-network/payload-model'\nimport { WitnessConfig, WitnessInstance, WitnessModuleEventData, WitnessParams } from '@xyo-network/witness-model'\nimport { Provider } from 'ethers'\n\nexport const EvmWitnessConfigSchema = 'network.xyo.evm.witness'\nexport type BlockchainWitnessConfigSchema = typeof EvmWitnessConfigSchema\n\nexport type BlockchainWitnessConfig<TAdditional extends EmptyObject | Payload | void = void, TSchema extends string | void = void> = WitnessConfig<\n  TAdditional,\n  TSchema extends void ? (TAdditional extends Payload ? TAdditional['schema'] : BlockchainWitnessConfigSchema) : TSchema\n>\n\nexport type AdditionalBlockchainWitnessParams = {\n  providers: Provider[]\n}\n\nexport type BlockchainWitnessParams<\n  TConfig extends AnyConfigSchema<BlockchainWitnessConfig> = BlockchainWitnessConfig,\n  TAdditionalParams extends EmptyObject | void = void,\n> = WitnessParams<\n  TConfig,\n  WithAdditional<\n    {\n      providers: () => Promisable<Provider[]>\n    },\n    TAdditionalParams\n  >\n>\n\nexport abstract class AbstractBlockchainWitness<\n  TParams extends BlockchainWitnessParams<AnyConfigSchema<BlockchainWitnessConfig>> = BlockchainWitnessParams,\n  TIn extends Payload = Payload,\n  TOut extends Payload = Payload,\n  TEventData extends WitnessModuleEventData<WitnessInstance<TParams, TIn, TOut>, TIn, TOut> = WitnessModuleEventData<\n    WitnessInstance<TParams, TIn, TOut>,\n    TIn,\n    TOut\n  >,\n> extends AbstractWitness<TParams, TIn, TOut, TEventData> {\n  private _providers: Provider[] | undefined = undefined\n\n  async getProvider(cache?: boolean): Promise<Provider | undefined>\n  async getProvider(cache: boolean, error: string | true): Promise<Provider>\n  async getProvider(cache = false, error?: string | boolean): Promise<Provider | undefined> {\n    const providers = await this.getProviders(cache)\n    if (providers.length === 0) {\n      if (error) {\n        throw new Error(typeof error === 'string' ? error : 'No providers available')\n      }\n      return undefined\n    }\n    return providers[Date.now() % providers.length] //pick a random provider\n  }\n\n  async getProviders(cache = false): Promise<Provider[]> {\n    const cachedProviders = cache ? this._providers : undefined\n    this._providers = cachedProviders ?? (await this.params.providers())\n    return this._providers\n  }\n}\n"],"mappings":";AAAA,SAAS,gBAAgB;AAEzB,IAAM,oBAAoB;AAQnB,IAAM,eAAe,CAAC,YAAoB,gBAAiC;AAChF,MAAI;AACF,UAAM,MAAM,IAAI,IAAI,UAAU;AAC9B,QAAI,WAAW,IAAI;AACnB,QAAI,OAAO,IAAI;AACf,QAAI,OAAO,IAAI;AACf,UAAM,QAAQ,IAAI;AAClB,QAAI,aAAa,SAAS;AACxB,iBAAW;AACX,aAAO,SAAS,aAAa,yBAAyB;AACtD,aAAO,IAAI,SAAS,SAAS,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,GAAG,IAAI;AACpE,YAAM,OAAO,GAAG,QAAQ,KAAK,IAAI,IAAI,IAAI;AACzC,cAAO,+BAAO,UAAS,IAAI,GAAG,IAAI,IAAI,KAAK,KAAK;AAAA,IAClD,WAAW,qBAAqB,aAAa,WAAW,SAAS,WAAW;AAC1E,iBAAW;AACX,aAAO,SAAS,aAAa,yBAAyB;AACtD,YAAM,YAAY,KAAK,MAAM,GAAG;AAChC,UAAI,UAAU,CAAC,MAAM,QAAQ;AAC3B,kBAAU,MAAM;AAAA,MAClB;AACA,aAAO,UAAU,KAAK,GAAG;AACzB,YAAM,OAAO,GAAG,QAAQ,KAAK,IAAI,IAAI,IAAI;AACzC,cAAO,+BAAO,UAAS,IAAI,GAAG,IAAI,IAAI,KAAK,KAAK;AAAA,IAClD,OAAO;AACL,aAAO;AAAA,IACT;AAAA,EACF,QAAQ;AAIN,WAAO;AAAA,EACT;AACF;;;AC1CA,SAAS,YAAAA,iBAAgB;AACzB,SAAS,gBAAgB,yBAAyB,iBAA2B,yBAAyB;AAUtG,IAAM,kBAAkB,CAAC,YAAoB;AAC3C,QAAM,WACJ,QAAQ,IAAI,qBAAqB,QAAQ,IAAI,wBAAwB,IAAI,eAAe,SAAS,QAAQ,IAAI,iBAAiB,IAAI;AACpI,SAAO;AACT;AAEA,IAAM,kBAAkB,CAAC,YAAoB;AAC3C,QAAM,WAAW,QAAQ,IAAI,oBAAoB,IAAI,wBAAwB,SAAS,QAAQ,IAAI,iBAAiB,IAAI;AACvH,SAAO;AACT;AAEA,IAAM,qBAAqB,CAAC,YAAoB;AAC9C,QAAM,kBAAkB,QAAQ,IAAI;AACpC,QAAM,WAAW,kBAAkB,IAAI,kBAAkB,iBAAiB,OAAO,IAAI;AAErF,SAAO;AACT;AAEA,IAAM,qBAAqB,CAAC,YAAoB;AAC9C,QAAM,oBAAoB,QAAQ,IAAI;AACtC,QAAM,WAAW,oBAAoB,IAAI,gBAAgB,mBAAmB,OAAO,IAAI;AACvF,SAAO;AACT;AAEO,IAAM,qBAAqB,CAChC,UAAkB,GAClB,EAAE,iBAAiB,UAAU,eAAe,MAAM,IAAgC,CAAC,MACtE;AACb,MAAI,WAAiC;AACrC,UAAQ,gBAAgB;AAAA,IACtB,KAAK,aAAa;AAChB,cAAQ,cAAc;AAAA,QACpB,KAAK,OAAO;AACV,qBAAW,mBAAmB,OAAO;AACrC;AAAA,QACF;AAAA,QACA,KAAK,OAAO;AACV,qBAAW,mBAAmB,OAAO;AACrC;AAAA,QACF;AAAA,MACF;AACA;AAAA,IACF;AAAA,IACA;AAAA,IACA,KAAK,UAAU;AACb,cAAQ,cAAc;AAAA,QACpB,KAAK,OAAO;AACV,qBAAW,gBAAgB,OAAO;AAClC;AAAA,QACF;AAAA,QACA,KAAK,OAAO;AACV,qBAAW,gBAAgB,OAAO;AAClC;AAAA,QACF;AAAA,MACF;AACA;AAAA,IACF;AAAA,EACF;AACA,MAAI,CAAC,UAAU;AACb,eAAW,gBAAgB,OAAO,KAAK,gBAAgB,OAAO,KAAK,mBAAmB,OAAO;AAAA,EAC/F;AACA,SAAOA,UAAS,UAAU,8BAA8B,OAAO,MAAM,cAAc,IAAI,YAAY,EAAE;AACvG;AAEA,IAAM,YAAsC,CAAC;AAEtC,IAAM,2BAA2B,CACtC,UAAkB,GAClB,YACa;AACb,QAAM,MAAM,GAAG,OAAO,IAAI,UAAU,KAAK,UAAU,OAAO,IAAI,SAAS;AACvE,YAAU,GAAG,IAAI,UAAU,GAAG,KAAK,mBAAmB,SAAS,OAAO;AACtE,SAAO,UAAU,GAAG;AACtB;AAEO,IAAM,sBAAsB,CAAC,QAAgB,GAAG,UAAkB,GAAM,UAAsC,CAAC,MAAkB;AACtI,QAAM,SAAqB,CAAC;AAC5B,WAAS,IAAI,GAAG,IAAI,OAAO,KAAK;AAC9B,WAAO,KAAK,mBAAmB,SAAS,OAAO,CAAC;AAAA,EAClD;AACA,SAAO;AACT;;;AC1FO,IAAM,0BAA0B;;;ACDvC,SAAS,uBAAuB;AAOzB,IAAM,yBAAyB;AAyB/B,IAAe,4BAAf,cASG,gBAAgD;AAAA,EAChD,aAAqC;AAAA,EAI7C,MAAM,YAAY,QAAQ,OAAO,OAAyD;AACxF,UAAMC,aAAY,MAAM,KAAK,aAAa,KAAK;AAC/C,QAAIA,WAAU,WAAW,GAAG;AAC1B,UAAI,OAAO;AACT,cAAM,IAAI,MAAM,OAAO,UAAU,WAAW,QAAQ,wBAAwB;AAAA,MAC9E;AACA,aAAO;AAAA,IACT;AACA,WAAOA,WAAU,KAAK,IAAI,IAAIA,WAAU,MAAM;AAAA,EAChD;AAAA,EAEA,MAAM,aAAa,QAAQ,OAA4B;AACrD,UAAM,kBAAkB,QAAQ,KAAK,aAAa;AAClD,SAAK,aAAa,mBAAoB,MAAM,KAAK,OAAO,UAAU;AAClE,WAAO,KAAK;AAAA,EACd;AACF;","names":["assertEx","providers"]}

package/dist/node/lib/checkIpfsUrl.d.cts

@@ -0,0 +1,8 @@
+/**
+ * Returns the equivalent IPFS gateway URL for the supplied URL.
+ * @param urlToCheck The URL to check
+ * @returns If the supplied URL is an IPFS URL, it converts the URL to the
+ * equivalent IPFS gateway URL. Otherwise, returns the original URL.
+ */
+export declare const checkIpfsUrl: (urlToCheck: string, ipfsGateway?: string) => string;
+//# sourceMappingURL=checkIpfsUrl.d.ts.map

package/dist/node/lib/checkIpfsUrl.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"checkIpfsUrl.d.ts","sourceRoot":"","sources":["../../../src/lib/checkIpfsUrl.ts"],"names":[],"mappings":"AAIA;;;;;GAKG;AACH,eAAO,MAAM,YAAY,eAAgB,MAAM,gBAAgB,MAAM,KAAG,MAgCvE,CAAA"}

package/dist/node/lib/checkIpfsUrl.d.mts

@@ -0,0 +1,8 @@
+/**
+ * Returns the equivalent IPFS gateway URL for the supplied URL.
+ * @param urlToCheck The URL to check
+ * @returns If the supplied URL is an IPFS URL, it converts the URL to the
+ * equivalent IPFS gateway URL. Otherwise, returns the original URL.
+ */
+export declare const checkIpfsUrl: (urlToCheck: string, ipfsGateway?: string) => string;
+//# sourceMappingURL=checkIpfsUrl.d.ts.map

package/dist/node/lib/checkIpfsUrl.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"checkIpfsUrl.d.ts","sourceRoot":"","sources":["../../../src/lib/checkIpfsUrl.ts"],"names":[],"mappings":"AAIA;;;;;GAKG;AACH,eAAO,MAAM,YAAY,eAAgB,MAAM,gBAAgB,MAAM,KAAG,MAgCvE,CAAA"}

package/dist/node/lib/checkIpfsUrl.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Returns the equivalent IPFS gateway URL for the supplied URL.
+ * @param urlToCheck The URL to check
+ * @returns If the supplied URL is an IPFS URL, it converts the URL to the
+ * equivalent IPFS gateway URL. Otherwise, returns the original URL.
+ */
+export declare const checkIpfsUrl: (urlToCheck: string, ipfsGateway?: string) => string;
+//# sourceMappingURL=checkIpfsUrl.d.ts.map

package/dist/node/lib/checkIpfsUrl.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"checkIpfsUrl.d.ts","sourceRoot":"","sources":["../../../src/lib/checkIpfsUrl.ts"],"names":[],"mappings":"AAIA;;;;;GAKG;AACH,eAAO,MAAM,YAAY,eAAgB,MAAM,gBAAgB,MAAM,KAAG,MAgCvE,CAAA"}

package/dist/node/lib/getProviderFromEnv.d.cts

@@ -0,0 +1,14 @@
+import { Provider } from 'ethers';
+export type ProviderSource = 'infura' | 'quicknode';
+export type ProviderType = 'rpc' | 'wss';
+export interface GetProvidersFromEnvOptions {
+    providerSource?: ProviderSource;
+    providerType?: ProviderType;
+}
+export declare const getProviderFromEnv: (chainId?: number, { providerSource, providerType }?: GetProvidersFromEnvOptions) => Provider;
+export declare const getSharedProviderFromEnv: (chainId?: number, options?: {
+    providerSource?: ProviderSource;
+    providerType?: ProviderType;
+}) => Provider;
+export declare const getProvidersFromEnv: (count?: number, chainId?: number, options?: GetProvidersFromEnvOptions) => Provider[];
+//# sourceMappingURL=getProviderFromEnv.d.ts.map

package/dist/node/lib/getProviderFromEnv.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getProviderFromEnv.d.ts","sourceRoot":"","sources":["../../../src/lib/getProviderFromEnv.ts"],"names":[],"mappings":"AACA,OAAO,EAA4D,QAAQ,EAAqB,MAAM,QAAQ,CAAA;AAE9G,MAAM,MAAM,cAAc,GAAG,QAAQ,GAAG,WAAW,CAAA;AACnD,MAAM,MAAM,YAAY,GAAG,KAAK,GAAG,KAAK,CAAA;AAExC,MAAM,WAAW,0BAA0B;IACzC,cAAc,CAAC,EAAE,cAAc,CAAA;IAC/B,YAAY,CAAC,EAAE,YAAY,CAAA;CAC5B;AA0BD,eAAO,MAAM,kBAAkB,aACpB,MAAM,qCACsC,0BAA0B,KAC9E,QAmCF,CAAA;AAID,eAAO,MAAM,wBAAwB,aAC1B,MAAM,YACL;IAAE,cAAc,CAAC,EAAE,cAAc,CAAC;IAAC,YAAY,CAAC,EAAE,YAAY,CAAA;CAAE,KACzE,QAIF,CAAA;AAED,eAAO,MAAM,mBAAmB,WAAW,MAAM,YAAe,MAAM,YAAkB,0BAA0B,KAAQ,QAAQ,EAMjI,CAAA"}

package/dist/node/lib/getProviderFromEnv.d.mts

@@ -0,0 +1,14 @@
+import { Provider } from 'ethers';
+export type ProviderSource = 'infura' | 'quicknode';
+export type ProviderType = 'rpc' | 'wss';
+export interface GetProvidersFromEnvOptions {
+    providerSource?: ProviderSource;
+    providerType?: ProviderType;
+}
+export declare const getProviderFromEnv: (chainId?: number, { providerSource, providerType }?: GetProvidersFromEnvOptions) => Provider;
+export declare const getSharedProviderFromEnv: (chainId?: number, options?: {
+    providerSource?: ProviderSource;
+    providerType?: ProviderType;
+}) => Provider;
+export declare const getProvidersFromEnv: (count?: number, chainId?: number, options?: GetProvidersFromEnvOptions) => Provider[];
+//# sourceMappingURL=getProviderFromEnv.d.ts.map

package/dist/node/lib/getProviderFromEnv.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getProviderFromEnv.d.ts","sourceRoot":"","sources":["../../../src/lib/getProviderFromEnv.ts"],"names":[],"mappings":"AACA,OAAO,EAA4D,QAAQ,EAAqB,MAAM,QAAQ,CAAA;AAE9G,MAAM,MAAM,cAAc,GAAG,QAAQ,GAAG,WAAW,CAAA;AACnD,MAAM,MAAM,YAAY,GAAG,KAAK,GAAG,KAAK,CAAA;AAExC,MAAM,WAAW,0BAA0B;IACzC,cAAc,CAAC,EAAE,cAAc,CAAA;IAC/B,YAAY,CAAC,EAAE,YAAY,CAAA;CAC5B;AA0BD,eAAO,MAAM,kBAAkB,aACpB,MAAM,qCACsC,0BAA0B,KAC9E,QAmCF,CAAA;AAID,eAAO,MAAM,wBAAwB,aAC1B,MAAM,YACL;IAAE,cAAc,CAAC,EAAE,cAAc,CAAC;IAAC,YAAY,CAAC,EAAE,YAAY,CAAA;CAAE,KACzE,QAIF,CAAA;AAED,eAAO,MAAM,mBAAmB,WAAW,MAAM,YAAe,MAAM,YAAkB,0BAA0B,KAAQ,QAAQ,EAMjI,CAAA"}

package/dist/node/lib/getProviderFromEnv.d.ts

@@ -0,0 +1,14 @@
+import { Provider } from 'ethers';
+export type ProviderSource = 'infura' | 'quicknode';
+export type ProviderType = 'rpc' | 'wss';
+export interface GetProvidersFromEnvOptions {
+    providerSource?: ProviderSource;
+    providerType?: ProviderType;
+}
+export declare const getProviderFromEnv: (chainId?: number, { providerSource, providerType }?: GetProvidersFromEnvOptions) => Provider;
+export declare const getSharedProviderFromEnv: (chainId?: number, options?: {
+    providerSource?: ProviderSource;
+    providerType?: ProviderType;
+}) => Provider;
+export declare const getProvidersFromEnv: (count?: number, chainId?: number, options?: GetProvidersFromEnvOptions) => Provider[];
+//# sourceMappingURL=getProviderFromEnv.d.ts.map

package/dist/node/lib/getProviderFromEnv.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getProviderFromEnv.d.ts","sourceRoot":"","sources":["../../../src/lib/getProviderFromEnv.ts"],"names":[],"mappings":"AACA,OAAO,EAA4D,QAAQ,EAAqB,MAAM,QAAQ,CAAA;AAE9G,MAAM,MAAM,cAAc,GAAG,QAAQ,GAAG,WAAW,CAAA;AACnD,MAAM,MAAM,YAAY,GAAG,KAAK,GAAG,KAAK,CAAA;AAExC,MAAM,WAAW,0BAA0B;IACzC,cAAc,CAAC,EAAE,cAAc,CAAA;IAC/B,YAAY,CAAC,EAAE,YAAY,CAAA;CAC5B;AA0BD,eAAO,MAAM,kBAAkB,aACpB,MAAM,qCACsC,0BAA0B,KAC9E,QAmCF,CAAA;AAID,eAAO,MAAM,wBAAwB,aAC1B,MAAM,YACL;IAAE,cAAc,CAAC,EAAE,cAAc,CAAC;IAAC,YAAY,CAAC,EAAE,YAAY,CAAA;CAAE,KACzE,QAIF,CAAA;AAED,eAAO,MAAM,mBAAmB,WAAW,MAAM,YAAe,MAAM,YAAkB,0BAA0B,KAAQ,QAAQ,EAMjI,CAAA"}

package/dist/node/lib/index.d.cts

@@ -0,0 +1,3 @@
+export * from './checkIpfsUrl';
+export * from './getProviderFromEnv';
+//# sourceMappingURL=index.d.ts.map

package/dist/node/lib/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/lib/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAA;AAC9B,cAAc,sBAAsB,CAAA"}

package/dist/node/lib/index.d.mts

@@ -0,0 +1,3 @@
+export * from './checkIpfsUrl';
+export * from './getProviderFromEnv';
+//# sourceMappingURL=index.d.ts.map

package/dist/node/lib/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/lib/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAA;AAC9B,cAAc,sBAAsB,CAAA"}

package/dist/node/lib/index.d.ts

@@ -0,0 +1,3 @@
+export * from './checkIpfsUrl';
+export * from './getProviderFromEnv';
+//# sourceMappingURL=index.d.ts.map

package/dist/node/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/lib/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAA;AAC9B,cAAc,sBAAsB,CAAA"}

package/dist/node/model.d.cts

@@ -0,0 +1,9 @@
+import { Payload } from '@xyo-network/payload-model';
+export declare const BlockchainAddressSchema = "network.xyo.blockchain.address";
+export type BlockchainAddressSchema = typeof BlockchainAddressSchema;
+export type BlockchainAddress = Payload<{
+    address?: string;
+    blockTag?: string | number;
+    chainId?: number;
+}, BlockchainAddressSchema>;
+//# sourceMappingURL=model.d.ts.map

package/dist/node/model.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"model.d.ts","sourceRoot":"","sources":["../../src/model.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAEpD,eAAO,MAAM,uBAAuB,mCAAmC,CAAA;AACvE,MAAM,MAAM,uBAAuB,GAAG,OAAO,uBAAuB,CAAA;AAEpE,MAAM,MAAM,iBAAiB,GAAG,OAAO,CACrC;IACE,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,EACD,uBAAuB,CACxB,CAAA"}

package/dist/node/model.d.mts

@@ -0,0 +1,9 @@
+import { Payload } from '@xyo-network/payload-model';
+export declare const BlockchainAddressSchema = "network.xyo.blockchain.address";
+export type BlockchainAddressSchema = typeof BlockchainAddressSchema;
+export type BlockchainAddress = Payload<{
+    address?: string;
+    blockTag?: string | number;
+    chainId?: number;
+}, BlockchainAddressSchema>;
+//# sourceMappingURL=model.d.ts.map

package/dist/node/model.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"model.d.ts","sourceRoot":"","sources":["../../src/model.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAEpD,eAAO,MAAM,uBAAuB,mCAAmC,CAAA;AACvE,MAAM,MAAM,uBAAuB,GAAG,OAAO,uBAAuB,CAAA;AAEpE,MAAM,MAAM,iBAAiB,GAAG,OAAO,CACrC;IACE,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,EACD,uBAAuB,CACxB,CAAA"}

package/dist/node/model.d.ts

@@ -0,0 +1,9 @@
+import { Payload } from '@xyo-network/payload-model';
+export declare const BlockchainAddressSchema = "network.xyo.blockchain.address";
+export type BlockchainAddressSchema = typeof BlockchainAddressSchema;
+export type BlockchainAddress = Payload<{
+    address?: string;
+    blockTag?: string | number;
+    chainId?: number;
+}, BlockchainAddressSchema>;
+//# sourceMappingURL=model.d.ts.map

package/dist/node/model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"model.d.ts","sourceRoot":"","sources":["../../src/model.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAEpD,eAAO,MAAM,uBAAuB,mCAAmC,CAAA;AACvE,MAAM,MAAM,uBAAuB,GAAG,OAAO,uBAAuB,CAAA;AAEpE,MAAM,MAAM,iBAAiB,GAAG,OAAO,CACrC;IACE,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,EACD,uBAAuB,CACxB,CAAA"}

package/package.json

@@ -0,0 +1,71 @@
+{
+  "name": "@xyo-network/witness-evm-abstract",
+  "author": {
+    "email": "support@xyo.network",
+    "name": "XYO Development Team",
+    "url": "https://xyo.network"
+  },
+  "bugs": {
+    "email": "support@xyo.network",
+    "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
+  },
+  "dependencies": {
+    "@xylabs/assert": "^2.13.20",
+    "@xylabs/promise": "^2.13.20",
+    "@xyo-network/abstract-witness": "~2.84.9",
+    "@xyo-network/module-model": "~2.84.9",
+    "@xyo-network/object": "~2.84.9",
+    "@xyo-network/payload-model": "~2.84.9",
+    "@xyo-network/witness-model": "~2.84.9",
+    "ethers": "^6.9.1"
+  },
+  "devDependencies": {
+    "@xylabs/jest-helpers": "^2.13.20",
+    "@xylabs/ts-scripts-yarn3": "^3.2.25",
+    "@xylabs/tsconfig": "^3.2.25",
+    "ethers": "^6.9.1",
+    "jest": "^29.7.0",
+    "typescript": "^5.3.3"
+  },
+  "description": "Primary SDK for using XYO Protocol 2.0",
+  "types": "dist/node/index.d.mts",
+  "exports": {
+    ".": {
+      "browser": {
+        "require": {
+          "types": "./dist/browser/index.d.cts",
+          "default": "./dist/browser/index.cjs"
+        },
+        "import": {
+          "types": "./dist/browser/index.d.mts",
+          "default": "./dist/browser/index.js"
+        }
+      },
+      "node": {
+        "require": {
+          "types": "./dist/node/index.d.mts",
+          "default": "./dist/node/index.cjs"
+        },
+        "import": {
+          "types": "./dist/node/index.d.mts",
+          "default": "./dist/node/index.js"
+        }
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "dist/node/index.cjs",
+  "module": "dist/node/index.js",
+  "homepage": "https://xyo.network",
+  "license": "LGPL-3.0-only",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js.git"
+  },
+  "sideEffects": false,
+  "version": "2.84.9",
+  "type": "module"
+}

package/src/Witness.ts

@@ -0,0 +1,64 @@
+import { Promisable } from '@xylabs/promise'
+import { AbstractWitness } from '@xyo-network/abstract-witness'
+import { AnyConfigSchema } from '@xyo-network/module-model'
+import { EmptyObject, WithAdditional } from '@xyo-network/object'
+import { Payload } from '@xyo-network/payload-model'
+import { WitnessConfig, WitnessInstance, WitnessModuleEventData, WitnessParams } from '@xyo-network/witness-model'
+import { Provider } from 'ethers'
+
+export const EvmWitnessConfigSchema = 'network.xyo.evm.witness'
+export type BlockchainWitnessConfigSchema = typeof EvmWitnessConfigSchema
+
+export type BlockchainWitnessConfig<TAdditional extends EmptyObject | Payload | void = void, TSchema extends string | void = void> = WitnessConfig<
+  TAdditional,
+  TSchema extends void ? (TAdditional extends Payload ? TAdditional['schema'] : BlockchainWitnessConfigSchema) : TSchema
+>
+
+export type AdditionalBlockchainWitnessParams = {
+  providers: Provider[]
+}
+
+export type BlockchainWitnessParams<
+  TConfig extends AnyConfigSchema<BlockchainWitnessConfig> = BlockchainWitnessConfig,
+  TAdditionalParams extends EmptyObject | void = void,
+> = WitnessParams<
+  TConfig,
+  WithAdditional<
+    {
+      providers: () => Promisable<Provider[]>
+    },
+    TAdditionalParams
+  >
+>
+
+export abstract class AbstractBlockchainWitness<
+  TParams extends BlockchainWitnessParams<AnyConfigSchema<BlockchainWitnessConfig>> = BlockchainWitnessParams,
+  TIn extends Payload = Payload,
+  TOut extends Payload = Payload,
+  TEventData extends WitnessModuleEventData<WitnessInstance<TParams, TIn, TOut>, TIn, TOut> = WitnessModuleEventData<
+    WitnessInstance<TParams, TIn, TOut>,
+    TIn,
+    TOut
+  >,
+> extends AbstractWitness<TParams, TIn, TOut, TEventData> {
+  private _providers: Provider[] | undefined = undefined
+
+  async getProvider(cache?: boolean): Promise<Provider | undefined>
+  async getProvider(cache: boolean, error: string | true): Promise<Provider>
+  async getProvider(cache = false, error?: string | boolean): Promise<Provider | undefined> {
+    const providers = await this.getProviders(cache)
+    if (providers.length === 0) {
+      if (error) {
+        throw new Error(typeof error === 'string' ? error : 'No providers available')
+      }
+      return undefined
+    }
+    return providers[Date.now() % providers.length] //pick a random provider
+  }
+
+  async getProviders(cache = false): Promise<Provider[]> {
+    const cachedProviders = cache ? this._providers : undefined
+    this._providers = cachedProviders ?? (await this.params.providers())
+    return this._providers
+  }
+}

package/src/index.ts

@@ -0,0 +1,3 @@
+export * from './lib'
+export * from './model'
+export * from './Witness'

package/src/lib/checkIpfsUrl.ts

@@ -0,0 +1,43 @@
+import { assertEx } from '@xylabs/assert'
+
+const allowIpfsIoRepair = true
+
+/**
+ * Returns the equivalent IPFS gateway URL for the supplied URL.
+ * @param urlToCheck The URL to check
+ * @returns If the supplied URL is an IPFS URL, it converts the URL to the
+ * equivalent IPFS gateway URL. Otherwise, returns the original URL.
+ */
+export const checkIpfsUrl = (urlToCheck: string, ipfsGateway?: string): string => {
+  try {
+    const url = new URL(urlToCheck)
+    let protocol = url.protocol
+    let host = url.host
+    let path = url.pathname
+    const query = url.search
+    if (protocol === 'ipfs:') {
+      protocol = 'https:'
+      host = assertEx(ipfsGateway, 'No ipfsGateway provided')
+      path = url.host === 'ipfs' ? `ipfs${path}` : `ipfs/${url.host}${path}`
+      const root = `${protocol}//${host}/${path}`
+      return query?.length > 0 ? `${root}?${query}` : root
+    } else if (allowIpfsIoRepair && protocol === 'https' && host === 'ipfs.io') {
+      protocol = 'https:'
+      host = assertEx(ipfsGateway, 'No ipfsGateway provided')
+      const pathParts = path.split('/')
+      if (pathParts[0] === 'ipfs') {
+        pathParts.shift()
+      }
+      path = pathParts.join('/')
+      const root = `${protocol}//${host}/${path}`
+      return query?.length > 0 ? `${root}?${query}` : root
+    } else {
+      return urlToCheck
+    }
+  } catch {
+    //const error = ex as Error
+    //console.error(`${error.name}:${error.message} [${urlToCheck}]`)
+    //console.log(error.stack)
+    return urlToCheck
+  }
+}

package/src/lib/getProviderFromEnv.ts

@@ -0,0 +1,93 @@
+import { assertEx } from '@xylabs/assert'
+import { InfuraProvider, InfuraWebSocketProvider, JsonRpcProvider, Provider, WebSocketProvider } from 'ethers'
+
+export type ProviderSource = 'infura' | 'quicknode'
+export type ProviderType = 'rpc' | 'wss'
+
+export interface GetProvidersFromEnvOptions {
+  providerSource?: ProviderSource
+  providerType?: ProviderType
+}
+
+const createInfuraRpc = (chainId: number) => {
+  const provider =
+    process.env.INFURA_PROJECT_ID && process.env.INFURA_PROJECT_SECRET ? new InfuraProvider(chainId, process.env.INFURA_PROJECT_ID) : undefined
+  return provider
+}
+
+const createInfuraWss = (chainId: number) => {
+  const provider = process.env.INFURA_PROJECT_ID ? new InfuraWebSocketProvider(chainId, process.env.INFURA_PROJECT_ID) : undefined
+  return provider
+}
+
+const createQuicknodeWss = (chainId: number) => {
+  const quickNodeWSSUri = process.env.QUICKNODE_WSS_URI
+  const provider = quickNodeWSSUri ? new WebSocketProvider(quickNodeWSSUri, chainId) : undefined
+
+  return provider
+}
+
+const createQuicknodeRpc = (chainId: number) => {
+  const quickNodeHttpsUri = process.env.QUICKNODE_HTTPS_URI
+  const provider = quickNodeHttpsUri ? new JsonRpcProvider(quickNodeHttpsUri, chainId) : undefined
+  return provider
+}
+
+export const getProviderFromEnv = (
+  chainId: number = 0x01,
+  { providerSource = 'infura', providerType = 'rpc' }: GetProvidersFromEnvOptions = {},
+): Provider => {
+  let provider: Provider | undefined = undefined
+  switch (providerSource) {
+    case 'quicknode': {
+      switch (providerType) {
+        case 'rpc': {
+          provider = createQuicknodeRpc(chainId)
+          break
+        }
+        case 'wss': {
+          provider = createQuicknodeWss(chainId)
+          break
+        }
+      }
+      break
+    }
+    default:
+    case 'infura': {
+      switch (providerType) {
+        case 'wss': {
+          provider = createInfuraWss(chainId)
+          break
+        }
+        case 'rpc': {
+          provider = createInfuraRpc(chainId)
+          break
+        }
+      }
+      break
+    }
+  }
+  if (!provider) {
+    provider = createInfuraWss(chainId) ?? createInfuraRpc(chainId) ?? createQuicknodeRpc(chainId)
+  }
+  return assertEx(provider, `Unable to create provider [${chainId}]: ${providerSource}|${providerType}`)
+}
+
+const providers: Record<string, Provider> = {}
+
+export const getSharedProviderFromEnv = (
+  chainId: number = 0x01,
+  options?: { providerSource?: ProviderSource; providerType?: ProviderType },
+): Provider => {
+  const key = `${chainId}:${options ? JSON.stringify(options) : 'default'}`
+  providers[key] = providers[key] ?? getProviderFromEnv(chainId, options)
+  return providers[key]
+}
+
+export const getProvidersFromEnv = (count: number = 1, chainId: number = 0x01, options: GetProvidersFromEnvOptions = {}): Provider[] => {
+  const result: Provider[] = []
+  for (let i = 0; i < count; i++) {
+    result.push(getProviderFromEnv(chainId, options))
+  }
+  return result
+}

package/src/lib/index.ts

@@ -0,0 +1,2 @@
+export * from './checkIpfsUrl'
+export * from './getProviderFromEnv'

package/src/model.ts

@@ -0,0 +1,13 @@
+import { Payload } from '@xyo-network/payload-model'
+
+export const BlockchainAddressSchema = 'network.xyo.blockchain.address'
+export type BlockchainAddressSchema = typeof BlockchainAddressSchema
+
+export type BlockchainAddress = Payload<
+  {
+    address?: string
+    blockTag?: string | number
+    chainId?: number
+  },
+  BlockchainAddressSchema
+>

package/typedoc.json

@@ -0,0 +1,5 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "entryPoints": ["./src/index.ts"],
+  "tsconfig": "./tsconfig.typedoc.json"
+}