eteres 0.0.1-security → 6.7.1

package/lib.commonjs/providers/default-provider.js

@@ -0,0 +1,138 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDefaultProvider = void 0;
+const index_js_1 = require("../utils/index.js");
+const provider_ankr_js_1 = require("./provider-ankr.js");
+const provider_alchemy_js_1 = require("./provider-alchemy.js");
+const provider_cloudflare_js_1 = require("./provider-cloudflare.js");
+const provider_etherscan_js_1 = require("./provider-etherscan.js");
+const provider_infura_js_1 = require("./provider-infura.js");
+//import { PocketProvider } from "./provider-pocket.js";
+const provider_quicknode_js_1 = require("./provider-quicknode.js");
+const provider_fallback_js_1 = require("./provider-fallback.js");
+const provider_jsonrpc_js_1 = require("./provider-jsonrpc.js");
+const network_js_1 = require("./network.js");
+const provider_websocket_js_1 = require("./provider-websocket.js");
+function isWebSocketLike(value) {
+    return (value && typeof (value.send) === "function" &&
+        typeof (value.close) === "function");
+}
+const Testnets = "goerli kovan sepolia classicKotti optimism-goerli arbitrum-goerli matic-mumbai bnbt".split(" ");
+function getDefaultProvider(network, options) {
+    if (options == null) {
+        options = {};
+    }
+    const allowService = (name) => {
+        if (options[name] === "-") {
+            return false;
+        }
+        if (typeof (options.exclusive) === "string") {
+            return (name === options.exclusive);
+        }
+        if (Array.isArray(options.exclusive)) {
+            return (options.exclusive.indexOf(name) !== -1);
+        }
+        return true;
+    };
+    if (typeof (network) === "string" && network.match(/^https?:/)) {
+        return new provider_jsonrpc_js_1.JsonRpcProvider(network);
+    }
+    if (typeof (network) === "string" && network.match(/^wss?:/) || isWebSocketLike(network)) {
+        return new provider_websocket_js_1.WebSocketProvider(network);
+    }
+    // Get the network and name, if possible
+    let staticNetwork = null;
+    try {
+        staticNetwork = network_js_1.Network.from(network);
+    }
+    catch (error) { }
+    const providers = [];
+    if (allowService("publicPolygon") && staticNetwork) {
+        if (staticNetwork.name === "matic") {
+            providers.push(new provider_jsonrpc_js_1.JsonRpcProvider("https:/\/polygon-rpc.com/", staticNetwork, { staticNetwork }));
+        }
+    }
+    if (allowService("alchemy")) {
+        try {
+            providers.push(new provider_alchemy_js_1.AlchemyProvider(network, options.alchemy));
+        }
+        catch (error) { }
+    }
+    if (allowService("ankr") && options.ankr != null) {
+        try {
+            providers.push(new provider_ankr_js_1.AnkrProvider(network, options.ankr));
+        }
+        catch (error) { }
+    }
+    if (allowService("cloudflare")) {
+        try {
+            providers.push(new provider_cloudflare_js_1.CloudflareProvider(network));
+        }
+        catch (error) { }
+    }
+    if (allowService("etherscan")) {
+        try {
+            providers.push(new provider_etherscan_js_1.EtherscanProvider(network, options.etherscan));
+        }
+        catch (error) { }
+    }
+    if (allowService("infura")) {
+        try {
+            let projectId = options.infura;
+            let projectSecret = undefined;
+            if (typeof (projectId) === "object") {
+                projectSecret = projectId.projectSecret;
+                projectId = projectId.projectId;
+            }
+            providers.push(new provider_infura_js_1.InfuraProvider(network, projectId, projectSecret));
+        }
+        catch (error) { }
+    }
+    /*
+        if (options.pocket !== "-") {
+            try {
+                let appId = options.pocket;
+                let secretKey: undefined | string = undefined;
+                let loadBalancer: undefined | boolean = undefined;
+                if (typeof(appId) === "object") {
+                    loadBalancer = !!appId.loadBalancer;
+                    secretKey = appId.secretKey;
+                    appId = appId.appId;
+                }
+                providers.push(new PocketProvider(network, appId, secretKey, loadBalancer));
+            } catch (error) { console.log(error); }
+        }
+    */
+    if (allowService("quicknode")) {
+        try {
+            let token = options.quicknode;
+            providers.push(new provider_quicknode_js_1.QuickNodeProvider(network, token));
+        }
+        catch (error) { }
+    }
+    (0, index_js_1.assert)(providers.length, "unsupported default network", "UNSUPPORTED_OPERATION", {
+        operation: "getDefaultProvider"
+    });
+    // No need for a FallbackProvider
+    if (providers.length === 1) {
+        return providers[0];
+    }
+    // We use the floor because public third-party providers can be unreliable,
+    // so a low number of providers with a large quorum will fail too often
+    let quorum = Math.floor(providers.length / 2);
+    if (quorum > 2) {
+        quorum = 2;
+    }
+    // Testnets don't need as strong a security gaurantee and speed is
+    // more useful during testing
+    if (staticNetwork && Testnets.indexOf(staticNetwork.name) !== -1) {
+        quorum = 1;
+    }
+    // Provided override qorum takes priority
+    if (options && options.quorum) {
+        quorum = options.quorum;
+    }
+    return new provider_fallback_js_1.FallbackProvider(providers, undefined, { quorum });
+}
+exports.getDefaultProvider = getDefaultProvider;
+//# sourceMappingURL=default-provider.js.map

package/lib.commonjs/providers/default-provider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"default-provider.js","sourceRoot":"","sources":["../../src.ts/providers/default-provider.ts"],"names":[],"mappings":";;;AACA,gDAA2C;AAE3C,yDAAkD;AAClD,+DAAwD;AACxD,qEAA8D;AAC9D,mEAA4D;AAC5D,6DAAsD;AACtD,wDAAwD;AACxD,mEAA4D;AAE5D,iEAA0D;AAC1D,+DAAwD;AACxD,6CAAuC;AACvC,mEAA4D;AAM5D,SAAS,eAAe,CAAC,KAAU;IAC/B,OAAO,CAAC,KAAK,IAAI,OAAM,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,UAAU;QAC9C,OAAM,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,UAAU,CAAC,CAAC;AAC5C,CAAC;AAED,MAAM,QAAQ,GAAG,qFAAqF,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;AAElH,SAAgB,kBAAkB,CAAC,OAA4C,EAAE,OAAa;IAC1F,IAAI,OAAO,IAAI,IAAI,EAAE;QAAE,OAAO,GAAG,EAAG,CAAC;KAAE;IAEvC,MAAM,YAAY,GAAG,CAAC,IAAY,EAAE,EAAE;QAClC,IAAI,OAAO,CAAC,IAAI,CAAC,KAAK,GAAG,EAAE;YAAE,OAAO,KAAK,CAAC;SAAE;QAC5C,IAAI,OAAM,CAAC,OAAO,CAAC,SAAS,CAAC,KAAK,QAAQ,EAAE;YACxC,OAAO,CAAC,IAAI,KAAK,OAAO,CAAC,SAAS,CAAC,CAAC;SACvC;QACD,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE;YAClC,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;SACnD;QACD,OAAO,IAAI,CAAC;IAChB,CAAC,CAAC;IAEF,IAAI,OAAM,CAAC,OAAO,CAAC,KAAK,QAAQ,IAAI,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE;QAC3D,OAAO,IAAI,qCAAe,CAAC,OAAO,CAAC,CAAC;KACvC;IAED,IAAI,OAAM,CAAC,OAAO,CAAC,KAAK,QAAQ,IAAI,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,eAAe,CAAC,OAAO,CAAC,EAAE;QACrF,OAAO,IAAI,yCAAiB,CAAC,OAAO,CAAC,CAAC;KACzC;IAED,wCAAwC;IACxC,IAAI,aAAa,GAAmB,IAAI,CAAC;IACzC,IAAI;QACA,aAAa,GAAG,oBAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;KACzC;IAAC,OAAO,KAAK,EAAE,GAAG;IAGnB,MAAM,SAAS,GAA4B,EAAG,CAAC;IAE/C,IAAI,YAAY,CAAC,eAAe,CAAC,IAAI,aAAa,EAAE;QAChD,IAAI,aAAa,CAAC,IAAI,KAAK,OAAO,EAAE;YAChC,SAAS,CAAC,IAAI,CAAC,IAAI,qCAAe,CAAC,2BAA2B,EAAE,aAAa,EAAE,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC;SACtG;KACJ;IAED,IAAI,YAAY,CAAC,SAAS,CAAC,EAAE;QACzB,IAAI;YACA,SAAS,CAAC,IAAI,CAAC,IAAI,qCAAe,CAAC,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;SACjE;QAAC,OAAO,KAAK,EAAE,GAAG;KACtB;IAED,IAAI,YAAY,CAAC,MAAM,CAAC,IAAI,OAAO,CAAC,IAAI,IAAI,IAAI,EAAE;QAC9C,IAAI;YACA,SAAS,CAAC,IAAI,CAAC,IAAI,+BAAY,CAAC,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;SAC3D;QAAC,OAAO,KAAK,EAAE,GAAG;KACtB;IAED,IAAI,YAAY,CAAC,YAAY,CAAC,EAAE;QAC5B,IAAI;YACA,SAAS,CAAC,IAAI,CAAC,IAAI,2CAAkB,CAAC,OAAO,CAAC,CAAC,CAAC;SACnD;QAAC,OAAO,KAAK,EAAE,GAAG;KACtB;IAED,IAAI,YAAY,CAAC,WAAW,CAAC,EAAE;QAC3B,IAAI;YACA,SAAS,CAAC,IAAI,CAAC,IAAI,yCAAiB,CAAC,OAAO,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC;SACrE;QAAC,OAAO,KAAK,EAAE,GAAG;KACtB;IAED,IAAI,YAAY,CAAC,QAAQ,CAAC,EAAE;QACxB,IAAI;YACA,IAAI,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC;YAC/B,IAAI,aAAa,GAAuB,SAAS,CAAC;YAClD,IAAI,OAAM,CAAC,SAAS,CAAC,KAAK,QAAQ,EAAE;gBAChC,aAAa,GAAG,SAAS,CAAC,aAAa,CAAC;gBACxC,SAAS,GAAG,SAAS,CAAC,SAAS,CAAC;aACnC;YACD,SAAS,CAAC,IAAI,CAAC,IAAI,mCAAc,CAAC,OAAO,EAAE,SAAS,EAAE,aAAa,CAAC,CAAC,CAAC;SACzE;QAAC,OAAO,KAAK,EAAE,GAAG;KACtB;IACL;;;;;;;;;;;;;;MAcE;IACE,IAAI,YAAY,CAAC,WAAW,CAAC,EAAE;QAC3B,IAAI;YACA,IAAI,KAAK,GAAG,OAAO,CAAC,SAAS,CAAC;YAC9B,SAAS,CAAC,IAAI,CAAC,IAAI,yCAAiB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;SACzD;QAAC,OAAO,KAAK,EAAE,GAAG;KACtB;IAED,IAAA,iBAAM,EAAC,SAAS,CAAC,MAAM,EAAE,6BAA6B,EAAE,uBAAuB,EAAE;QAC7E,SAAS,EAAE,oBAAoB;KAClC,CAAC,CAAC;IAEH,iCAAiC;IACjC,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE;QAAE,OAAO,SAAS,CAAC,CAAC,CAAC,CAAC;KAAE;IAEpD,2EAA2E;IAC3E,uEAAuE;IACvE,IAAI,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAC9C,IAAI,MAAM,GAAG,CAAC,EAAE;QAAE,MAAM,GAAG,CAAC,CAAC;KAAE;IAE/B,kEAAkE;IAClE,6BAA6B;IAC7B,IAAI,aAAa,IAAI,QAAQ,CAAC,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE;QAAE,MAAM,GAAG,CAAC,CAAC;KAAE;IAEjF,yCAAyC;IACzC,IAAI,OAAO,IAAI,OAAO,CAAC,MAAM,EAAE;QAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;KAAE;IAE3D,OAAO,IAAI,uCAAgB,CAAC,SAAS,EAAE,SAAS,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;AAClE,CAAC;AAlHD,gDAkHC"}

package/lib.commonjs/providers/ens-resolver.d.ts

@@ -0,0 +1,147 @@
+/**
+ *  ENS is a service which allows easy-to-remember names to map to
+ *  network addresses.
+ *
+ *  @_section: api/providers/ens-resolver:ENS Resolver  [about-ens-rsolver]
+ */
+import type { BytesLike } from "../utils/index.js";
+import type { AbstractProvider, AbstractProviderPlugin } from "./abstract-provider.js";
+import type { Provider } from "./provider.js";
+/**
+ *  The type of data found during a steip during avatar resolution.
+ */
+export type AvatarLinkageType = "name" | "avatar" | "!avatar" | "url" | "data" | "ipfs" | "erc721" | "erc1155" | "!erc721-caip" | "!erc1155-caip" | "!owner" | "owner" | "!balance" | "balance" | "metadata-url-base" | "metadata-url-expanded" | "metadata-url" | "!metadata-url" | "!metadata" | "metadata" | "!imageUrl" | "imageUrl-ipfs" | "imageUrl" | "!imageUrl-ipfs";
+/**
+ *  An individual record for each step during avatar resolution.
+ */
+export interface AvatarLinkage {
+    /**
+     *  The type of linkage.
+     */
+    type: AvatarLinkageType;
+    /**
+     *  The linkage value.
+     */
+    value: string;
+}
+/**
+ *  When resolving an avatar for an ENS name, there are many
+ *  steps involved, fetching metadata, validating results, et cetera.
+ *
+ *  Some applications may wish to analyse this data, or use this data
+ *  to diagnose promblems, so an **AvatarResult** provides details of
+ *  each completed step during avatar resolution.
+ */
+export interface AvatarResult {
+    /**
+     *  How the [[url]] was arrived at, resolving the many steps required
+     *  for an avatar URL.
+     */
+    linkage: Array<AvatarLinkage>;
+    /**
+     *  The avatar URL or null if the avatar was not set, or there was
+     *  an issue during validation (such as the address not owning the
+     *  avatar or a metadata error).
+     */
+    url: null | string;
+}
+/**
+ *  A provider plugin super-class for processing multicoin address types.
+ */
+export declare abstract class MulticoinProviderPlugin implements AbstractProviderPlugin {
+    /**
+     *  The name.
+     */
+    readonly name: string;
+    /**
+     *  Creates a new **MulticoinProviderPluing** for %%name%%.
+     */
+    constructor(name: string);
+    connect(proivder: Provider): MulticoinProviderPlugin;
+    /**
+     *  Returns ``true`` if %%coinType%% is supported by this plugin.
+     */
+    supportsCoinType(coinType: number): boolean;
+    /**
+     *  Resovles to the encoded %%address%% for %%coinType%%.
+     */
+    encodeAddress(coinType: number, address: string): Promise<string>;
+    /**
+     *  Resovles to the decoded %%data%% for %%coinType%%.
+     */
+    decodeAddress(coinType: number, data: BytesLike): Promise<string>;
+}
+/**
+ *  A **BasicMulticoinProviderPlugin** provides service for common
+ *  coin types, which do not require additional libraries to encode or
+ *  decode.
+ */
+export declare class BasicMulticoinProviderPlugin extends MulticoinProviderPlugin {
+    /**
+     *  Creates a new **BasicMulticoinProviderPlugin**.
+     */
+    constructor();
+}
+/**
+ *  A connected object to a resolved ENS name resolver, which can be
+ *  used to query additional details.
+ */
+export declare class EnsResolver {
+    #private;
+    /**
+     *  The connected provider.
+     */
+    provider: AbstractProvider;
+    /**
+     *  The address of the resolver.
+     */
+    address: string;
+    /**
+     *  The name this resolver was resolved against.
+     */
+    name: string;
+    constructor(provider: AbstractProvider, address: string, name: string);
+    /**
+     *  Resolves to true if the resolver supports wildcard resolution.
+     */
+    supportsWildcard(): Promise<boolean>;
+    /**
+     *  Resolves to the address for %%coinType%% or null if the
+     *  provided %%coinType%% has not been configured.
+     */
+    getAddress(coinType?: number): Promise<null | string>;
+    /**
+     *  Resolves to the EIP-634 text record for %%key%%, or ``null``
+     *  if unconfigured.
+     */
+    getText(key: string): Promise<null | string>;
+    /**
+     *  Rsolves to the content-hash or ``null`` if unconfigured.
+     */
+    getContentHash(): Promise<null | string>;
+    /**
+     *  Resolves to the avatar url or ``null`` if the avatar is either
+     *  unconfigured or incorrectly configured (e.g. references an NFT
+     *  not owned by the address).
+     *
+     *  If diagnosing issues with configurations, the [[_getAvatar]]
+     *  method may be useful.
+     */
+    getAvatar(): Promise<null | string>;
+    /**
+     *  When resolving an avatar, there are many steps involved, such
+     *  fetching metadata and possibly validating ownership of an
+     *  NFT.
+     *
+     *  This method can be used to examine each step and the value it
+     *  was working from.
+     */
+    _getAvatar(): Promise<AvatarResult>;
+    static getEnsAddress(provider: Provider): Promise<string>;
+    /**
+     *  Resolve to the ENS resolver for %%name%% using %%provider%% or
+     *  ``null`` if unconfigured.
+     */
+    static fromName(provider: AbstractProvider, name: string): Promise<null | EnsResolver>;
+}
+//# sourceMappingURL=ens-resolver.d.ts.map

package/lib.commonjs/providers/ens-resolver.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ens-resolver.d.ts","sourceRoot":"","sources":["../../src.ts/providers/ens-resolver.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAeH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAEnD,OAAO,KAAK,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,MAAM,wBAAwB,CAAC;AAEvF,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAgB9C;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,QAAQ,GAAG,SAAS,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM,GACnF,QAAQ,GAAG,SAAS,GAAG,cAAc,GAAG,eAAe,GACvD,QAAQ,GAAG,OAAO,GAAG,UAAU,GAAG,SAAS,GAC3C,mBAAmB,GAAG,uBAAuB,GAAG,cAAc,GAAG,eAAe,GAChF,WAAW,GAAG,UAAU,GACxB,WAAW,GAAG,eAAe,GAAG,UAAU,GAAG,gBAAgB,CAAC;AAElE;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B;;OAEG;IACH,IAAI,EAAE,iBAAiB,CAAC;IAExB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,YAAY;IACzB;;;OAGG;IACH,OAAO,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;IAE9B;;;;OAIG;IACH,GAAG,EAAE,IAAI,GAAG,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,8BAAsB,uBAAwB,YAAW,sBAAsB;IAC3E;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAG,MAAM,CAAC;IAEvB;;OAEG;gBACS,IAAI,EAAE,MAAM;IAIxB,OAAO,CAAC,QAAQ,EAAE,QAAQ,GAAG,uBAAuB;IAIpD;;OAEG;IACH,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;IAI3C;;OAEG;IACG,aAAa,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAIvE;;OAEG;IACG,aAAa,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC;CAG1E;AAID;;;;GAIG;AACH,qBAAa,4BAA6B,SAAQ,uBAAuB;IACrE;;OAEG;;CAIN;AAUD;;;GAGG;AACH,qBAAa,WAAW;;IACpB;;OAEG;IACH,QAAQ,EAAG,gBAAgB,CAAC;IAE5B;;OAEG;IACH,OAAO,EAAG,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAG,MAAM,CAAC;gBAOF,QAAQ,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;IAerE;;OAEG;IACG,gBAAgB,IAAI,OAAO,CAAC,OAAO,CAAC;IA8D1C;;;OAGG;IACG,UAAU,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,GAAG,MAAM,CAAC;IAoD3D;;;OAGG;IACG,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,GAAG,MAAM,CAAC;IAMlD;;OAEG;IACG,cAAc,IAAI,OAAO,CAAC,IAAI,GAAG,MAAM,CAAC;IA6B9C;;;;;;;OAOG;IACG,SAAS,IAAI,OAAO,CAAC,IAAI,GAAG,MAAM,CAAC;IAKzC;;;;;;;OAOG;IACG,UAAU,IAAI,OAAO,CAAC,YAAY,CAAC;WAgK5B,aAAa,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC;IAoC/D;;;OAGG;WACU,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,GAAG,WAAW,CAAC;CA2B/F"}