@requestnetwork/utils 0.35.1-next.1686 → 0.35.1-next.1691

package/dist/index.d.ts

@@ -16,6 +16,9 @@ declare const _default: {
         duplicates: T_4[];
     };
     notNull: <T_5>(x: T_5 | null | undefined) => x is T_5;
+    setProviderFactory: (providerFactory?: ((network: string | undefined, defaultFactory: (network: string | undefined) => string | import("@ethersproject/abstract-provider").Provider) => string | import("@ethersproject/abstract-provider").Provider) | undefined) => void;
+    initPaymentDetectionApiKeys: (defaultProviderOptions?: Record<string, string | (() => string)> | undefined) => void;
+    getDefaultProvider: (network?: string | undefined) => import("@ethersproject/abstract-provider").Provider;
     SimpleLogger: typeof SimpleLogger;
     amount: {
         add: (amount: import("types/dist/request-logic-types").Amount, delta: import("types/dist/request-logic-types").Amount) => string;
@@ -42,6 +45,9 @@ declare const _default: {
         generate32BufferKey: () => Promise<string>;
         generate8randomBytes: () => Promise<string>;
         keccak256Hash: (data: string) => string;
+        /**
+         * Collection of general purpose utility function
+         */
         last20bytesOfNormalizedKeccak256Hash: (data: unknown) => string;
         normalize: (data: unknown) => string;
         normalizeKeccak256Hash: (data: unknown) => import("types/dist/multi-format/hash-types").IHash;

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAOA,OAAO,YAAY,MAAM,iBAAiB,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAE3C;;GAEG;AACH,wBAUE"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAOA,OAAO,YAAY,MAAM,iBAAiB,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAG3C;;WAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;AAFH;;GAEG;AACH,wBAWE"}

package/dist/index.js

@@ -9,15 +9,16 @@ const retry_1 = require("./retry");
 const signature_1 = require("./signature");
 const simple_logger_1 = require("./simple-logger");
 const utils_1 = require("./utils");
+const providers_1 = require("./providers");
 /**
  * Collection of general purpose utility function
  */
-exports.default = Object.assign({ SimpleLogger: simple_logger_1.default,
+exports.default = Object.assign(Object.assign({ SimpleLogger: simple_logger_1.default,
     amount: amount_1.default,
     cachedThrottle: cached_throttle_1.default,
     crypto: crypto_1.default,
     encryption: encryption_1.default,
     identity: identity_1.default,
     retry: retry_1.default,
-    signature: signature_1.default }, utils_1.default);
+    signature: signature_1.default }, providers_1.default), utils_1.default);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;AAAA,qCAA8B;AAC9B,uDAA+C;AAC/C,qCAA8B;AAC9B,6CAAsC;AACtC,yCAAkC;AAClC,mCAA4B;AAC5B,2CAAoC;AACpC,mDAA2C;AAC3C,mCAA4B;AAC5B;;GAEG;AACH,kCACE,YAAY,EAAZ,uBAAY;IACZ,MAAM,EAAN,gBAAM;IACN,cAAc,EAAd,yBAAc;IACd,MAAM,EAAN,gBAAM;IACN,UAAU,EAAV,oBAAU;IACV,QAAQ,EAAR,kBAAQ;IACR,KAAK,EAAL,eAAK;IACL,SAAS,EAAT,mBAAS,IACN,eAAK,EACR"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;AAAA,qCAA8B;AAC9B,uDAA+C;AAC/C,qCAA8B;AAC9B,6CAAsC;AACtC,yCAAkC;AAClC,mCAA4B;AAC5B,2CAAoC;AACpC,mDAA2C;AAC3C,mCAA4B;AAC5B,2CAAoC;AACpC;;GAEG;AACH,gDACE,YAAY,EAAZ,uBAAY;IACZ,MAAM,EAAN,gBAAM;IACN,cAAc,EAAd,yBAAc;IACd,MAAM,EAAN,gBAAM;IACN,UAAU,EAAV,oBAAU;IACV,QAAQ,EAAR,kBAAQ;IACR,KAAK,EAAL,eAAK;IACL,SAAS,EAAT,mBAAS,IACN,mBAAS,GACT,eAAK,EACR"}

package/dist/providers.d.ts

@@ -0,0 +1,14 @@
+import { providers } from 'ethers';
+declare type ProviderFactory = (network: string | undefined) => providers.Provider | string;
+/**
+ * @param network the network to connect to
+ * @param defaultFactory the defaultFactory to use as fallback if needed
+ */
+declare type CurrentProviderFactory = (network: string | undefined, defaultFactory: ProviderFactory) => providers.Provider | string;
+declare const _default: {
+    setProviderFactory: (providerFactory?: CurrentProviderFactory | undefined) => void;
+    initPaymentDetectionApiKeys: (defaultProviderOptions?: Record<string, string | (() => string)> | undefined) => void;
+    getDefaultProvider: (network?: string | undefined) => providers.Provider;
+};
+export default _default;
+//# sourceMappingURL=providers.d.ts.map

package/dist/providers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"providers.d.ts","sourceRoot":"","sources":["../src/providers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AAEnC,aAAK,eAAe,GAAG,CAAC,OAAO,EAAE,MAAM,GAAG,SAAS,KAAK,SAAS,CAAC,QAAQ,GAAG,MAAM,CAAC;AAGpF;;;GAGG;AACH,aAAK,sBAAsB,GAAG,CAC5B,OAAO,EAAE,MAAM,GAAG,SAAS,EAC3B,cAAc,EAAE,eAAe,KAC5B,SAAS,CAAC,QAAQ,GAAG,MAAM,CAAC;;;;;;AAuHjC,wBAIE"}

package/dist/providers.js

@@ -0,0 +1,113 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const ethers_1 = require("ethers");
+let warned = false;
+/**
+ * Default API_KEYS configuration, can be overriden using initPaymentDetectionApiKeys
+ */
+let providersApiKeys = {
+    // fallback to Ethers v4 default projectId
+    infura: () => process.env.RN_INFURA_KEY || '7d0d81d0919f4f05b9ab6634be01ee73',
+};
+/**
+ * @param defaultProviderOptions Default Provider Options as specified in https://docs.ethers.io/v5/api/providers/#providers-getDefaultProvider  */
+const initPaymentDetectionApiKeys = (defaultProviderOptions) => {
+    providersApiKeys = Object.assign(Object.assign({}, providersApiKeys), defaultProviderOptions);
+};
+/**
+ * Define default URLs for networks supported by Request payment detection but not by ethers' Infura Provider
+ */
+const networkRpcs = {
+    private: ethers_1.providers.JsonRpcProvider.defaultUrl(),
+    matic: 'https://polygon-rpc.com/',
+    fantom: 'https://rpc.ftm.tools',
+    fuse: 'https://rpc.fuse.io',
+    bsctest: 'https://data-seed-prebsc-1-s1.binance.org:8545',
+    bsc: 'https://bsc-dataseed1.binance.org/',
+    xdai: 'https://rpc.xdaichain.com/',
+    'arbitrum-rinkeby': 'https://rinkeby.arbitrum.io/rpc',
+    'arbitrum-one': 'https://arb1.arbitrum.io/rpc',
+    avalanche: 'https://api.avax.network/ext/bc/C/rpc',
+};
+/**
+ * @see getDefaultProvider
+ * @param network
+ */
+const defaultProviderFactory = (network) => {
+    if (!network) {
+        network = 'homestead';
+    }
+    // Returns environment variable override
+    const envVar = (process === null || process === void 0 ? void 0 : process.env) ? process.env[`RN_WEB3_RPC_URL_${network.toUpperCase()}`] : null;
+    if (envVar) {
+        return envVar;
+    }
+    // check default RPCs
+    if (networkRpcs[network]) {
+        return networkRpcs[network];
+    }
+    // use infura, if supported
+    try {
+        // try getting the URL for the given network. Will throw if not supported.
+        ethers_1.providers.InfuraProvider.getUrl(ethers_1.providers.getNetwork(network), {});
+        const apiKey = typeof providersApiKeys.infura === 'function'
+            ? providersApiKeys.infura()
+            : providersApiKeys.infura;
+        if (!apiKey && !warned) {
+            console.warn(`No API Key specified for Infura, using ethers default API key.
+      This is not recommended for Production environments.
+      To override Infura's default api key, use RN_INFURA_KEY environment variable, or call
+      initPaymentDetectionApiKeys({ infura: () => "myApiKey" });
+      `);
+            warned = true;
+        }
+        return new ethers_1.providers.InfuraProvider(network, apiKey);
+    }
+    catch (e) {
+        // suppress errors
+    }
+    if (!warned) {
+        console.warn(`No provider is specified for network ${network}, using ethers default provider. 
+      This is not recommended for Production environments.
+      Use setProviderFactory to override the default provider`);
+        warned = true;
+    }
+    // use getDefaultProvider to keep the original behaviour
+    return ethers_1.providers.getDefaultProvider(network, providersApiKeys);
+};
+/**
+ * Defines the behaviour to obtain a Provider for a given Network.
+ * May be overriden using setProviderFactory
+ */
+let currentProviderFactory = defaultProviderFactory;
+/**
+ * Override the default providerFactory, which relies mainly on Infura.
+ * @param providerFactory if not specify, will reset to the default factory
+ */
+const setProviderFactory = (providerFactory) => {
+    currentProviderFactory = providerFactory || defaultProviderFactory;
+};
+/**
+ * Returns a Web3 Provider for the given `network`.
+ *
+ * Configuration options:
+ * - Specify `RN_WEB3_RPC_URL_[NETWORK]` environment variable to override the default behaviour
+ * - Specify `RN_INFURA_KEY` to override the default Infura API KEY (recommended)
+ * - Use `initPaymentDetectionApiKeys` to override Infura API KEY when `RN_INFURA_KEY` is not usable
+ * - Use `setProviderFactory` for more complex configurations with multiple networks
+ *
+ * @param network the blockchain network. See https://chainid.network/chains.json `network` field for reference
+ */
+const getDefaultProvider = (network) => {
+    const provider = currentProviderFactory(network, defaultProviderFactory);
+    if (typeof provider === 'string') {
+        return new ethers_1.providers.StaticJsonRpcProvider(provider);
+    }
+    return provider;
+};
+exports.default = {
+    setProviderFactory,
+    initPaymentDetectionApiKeys,
+    getDefaultProvider,
+};
+//# sourceMappingURL=providers.js.map

package/dist/providers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"providers.js","sourceRoot":"","sources":["../src/providers.ts"],"names":[],"mappings":";;AAAA,mCAAmC;AAInC,IAAI,MAAM,GAAG,KAAK,CAAC;AAUnB;;GAEG;AACH,IAAI,gBAAgB,GAA4C;IAC9D,0CAA0C;IAC1C,MAAM,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,IAAI,kCAAkC;CAC9E,CAAC;AAEF;mJACmJ;AACnJ,MAAM,2BAA2B,GAAG,CAAC,sBAAgD,EAAQ,EAAE;IAC7F,gBAAgB,mCAAQ,gBAAgB,GAAK,sBAAsB,CAAE,CAAC;AACxE,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,GAA2B;IAC1C,OAAO,EAAE,kBAAS,CAAC,eAAe,CAAC,UAAU,EAAE;IAC/C,KAAK,EAAE,0BAA0B;IACjC,MAAM,EAAE,uBAAuB;IAC/B,IAAI,EAAE,qBAAqB;IAC3B,OAAO,EAAE,gDAAgD;IACzD,GAAG,EAAE,oCAAoC;IACzC,IAAI,EAAE,4BAA4B;IAClC,kBAAkB,EAAE,iCAAiC;IACrD,cAAc,EAAE,8BAA8B;IAC9C,SAAS,EAAE,uCAAuC;CACnD,CAAC;AAEF;;;GAGG;AACH,MAAM,sBAAsB,GAAoB,CAAC,OAA2B,EAAE,EAAE;IAC9E,IAAI,CAAC,OAAO,EAAE;QACZ,OAAO,GAAG,WAAW,CAAC;KACvB;IAED,wCAAwC;IACxC,MAAM,MAAM,GAAG,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,GAAG,EAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAC7F,IAAI,MAAM,EAAE;QACV,OAAO,MAAM,CAAC;KACf;IAED,qBAAqB;IACrB,IAAI,WAAW,CAAC,OAAO,CAAC,EAAE;QACxB,OAAO,WAAW,CAAC,OAAO,CAAC,CAAC;KAC7B;IAED,2BAA2B;IAC3B,IAAI;QACF,0EAA0E;QAC1E,kBAAS,CAAC,cAAc,CAAC,MAAM,CAAC,kBAAS,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC,CAAC;QACnE,MAAM,MAAM,GACV,OAAO,gBAAgB,CAAC,MAAM,KAAK,UAAU;YAC3C,CAAC,CAAC,gBAAgB,CAAC,MAAM,EAAE;YAC3B,CAAC,CAAC,gBAAgB,CAAC,MAAM,CAAC;QAE9B,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,EAAE;YACtB,OAAO,CAAC,IAAI,CAAC;;;;OAIZ,CAAC,CAAC;YACH,MAAM,GAAG,IAAI,CAAC;SACf;QACD,OAAO,IAAI,kBAAS,CAAC,cAAc,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;KACtD;IAAC,OAAO,CAAC,EAAE;QACV,kBAAkB;KACnB;IAED,IAAI,CAAC,MAAM,EAAE;QACX,OAAO,CAAC,IAAI,CACV,wCAAwC,OAAO;;8DAES,CACzD,CAAC;QACF,MAAM,GAAG,IAAI,CAAC;KACf;IACD,wDAAwD;IACxD,OAAO,kBAAS,CAAC,kBAAkB,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC;AACjE,CAAC,CAAC;AAEF;;;GAGG;AACH,IAAI,sBAAsB,GAA2B,sBAAsB,CAAC;AAE5E;;;GAGG;AACH,MAAM,kBAAkB,GAAG,CAAC,eAAwC,EAAQ,EAAE;IAC5E,sBAAsB,GAAG,eAAe,IAAI,sBAAsB,CAAC;AACrE,CAAC,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,kBAAkB,GAAG,CAAC,OAAgB,EAAsB,EAAE;IAClE,MAAM,QAAQ,GAAG,sBAAsB,CAAC,OAAO,EAAE,sBAAsB,CAAC,CAAC;IACzE,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE;QAChC,OAAO,IAAI,kBAAS,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;KACtD;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC;AAEF,kBAAe;IACb,kBAAkB;IAClB,2BAA2B;IAC3B,kBAAkB;CACnB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@requestnetwork/utils",
-  "version": "0.35.1-next.1686+b2792f0b",
+  "version": "0.35.1-next.1691+4a3c46af",
   "publishConfig": {
     "access": "public"
   },
@@ -40,7 +40,7 @@
     "test:watch": "yarn test --watch"
   },
   "dependencies": {
-    "@requestnetwork/types": "0.35.1-next.1686+b2792f0b",
+    "@requestnetwork/types": "0.35.1-next.1691+4a3c46af",
     "eccrypto": "1.1.6",
     "ethers": "5.5.1",
     "secp256k1": "4.0.2",
@@ -57,5 +57,5 @@
     "ts-node": "9.0.0",
     "typescript": "4.4.4"
   },
-  "gitHead": "b2792f0bee97ededbd0b400e7bcd0bd775315b1c"
+  "gitHead": "4a3c46af555c011a6bebf4d3fc556769f45df4bd"
 }