@ensdomains/ensjs 2.1.0 → 3.0.0-alpha.11

package/dist/cjs/index.d.ts

@@ -0,0 +1,478 @@
+import { JsonRpcSigner } from '@ethersproject/providers';
+import { ContractTransaction, ethers, PopulatedTransaction } from 'ethers';
+import ContractManager from './contracts';
+import { getContractAddress as _getContractAddress } from './contracts/getContractAddress';
+import { SupportedNetworkId } from './contracts/types';
+import type burnFuses from './functions/burnFuses';
+import type createSubname from './functions/createSubname';
+import type deleteSubname from './functions/deleteSubname';
+import type setName from './functions/setName';
+import type setRecord from './functions/setRecord';
+import type setRecords from './functions/setRecords';
+import type setResolver from './functions/setResolver';
+import type transferName from './functions/transferName';
+import type transferSubname from './functions/transferSubname';
+import type unwrapName from './functions/unwrapName';
+import type wrapName from './functions/wrapName';
+import GqlManager from './GqlManager';
+declare type ENSOptions = {
+    graphURI?: string | null;
+    getContractAddress?: typeof _getContractAddress;
+};
+export declare type InternalENS = {
+    options?: ENSOptions;
+    provider?: ethers.providers.Provider;
+    signer: JsonRpcSigner;
+    graphURI?: string | null;
+} & ENS;
+export declare type ENSArgs<K extends keyof InternalENS> = {
+    [P in K]: InternalENS[P];
+};
+declare type OmitFirstArg<F> = F extends (x: any, ...args: infer P) => infer R ? (...args: P) => R : never;
+declare type OmitFirstTwoArgs<F> = F extends (x: any, y: any, ...args: infer P) => infer R ? (...args: P) => R : never;
+declare type WriteOptions = {
+    addressOrIndex?: string | number;
+    signer?: JsonRpcSigner;
+};
+declare type OptionalWriteOptions<F> = F extends (x: any, arg_0: infer Z, options?: infer P) => infer R ? (name: Z, options?: P & WriteOptions) => R : F extends (x: any, arg_0: infer Z, options: infer P) => infer R ? (name: Z, options: P & WriteOptions) => R : never;
+interface WriteFunction<F extends (...args: any) => any> extends Function {
+    (...args: Parameters<OptionalWriteOptions<F>>): Promise<ContractTransaction>;
+    populateTransaction: (...args: Parameters<OptionalWriteOptions<F>>) => Promise<PopulatedTransaction>;
+}
+export declare type RawFunction = {
+    raw: (...args: any[]) => Promise<{
+        to: string;
+        data: string;
+    }>;
+    decode: (...args: any[]) => Promise<any>;
+};
+export declare type BatchFunctionResult<F extends RawFunction> = {
+    args: Parameters<OmitFirstArg<F['raw']>>;
+    raw: F['raw'];
+    decode: F['decode'];
+};
+declare type BatchFunction<F extends RawFunction> = (...args: Parameters<OmitFirstArg<F['raw']>>) => BatchFunctionResult<F>;
+export declare type RawFunctionWithBatch = {
+    batch: BatchFunction<any>;
+} & RawFunction;
+interface GeneratedRawFunction<F extends RawFunction> extends Function, RawFunction {
+    (...args: Parameters<OmitFirstArg<F['raw']>>): ReturnType<OmitFirstTwoArgs<F['decode']>>;
+    batch: BatchFunction<F>;
+}
+export interface GenericGeneratedRawFunction extends Function, RawFunctionWithBatch {
+}
+export declare class ENS {
+    [x: string]: any;
+    protected options?: ENSOptions;
+    protected provider?: ethers.providers.JsonRpcProvider;
+    protected graphURI?: string | null;
+    protected initialProvider?: ethers.providers.JsonRpcProvider;
+    contracts?: ContractManager;
+    getContractAddress: (networkId: SupportedNetworkId) => import("./contracts/getContractAddress").ContractAddressFetch;
+    gqlInstance: GqlManager;
+    constructor(options?: ENSOptions);
+    /**
+     * Checks for an initial provider and if it exists, sets it as the provider
+     * @returns {Promise<void>} - A promise that resolves when the provider is checked, and set if needed
+     */
+    private checkInitialProvider;
+    /**
+     * Creates an object of ENS properties from an array
+     * @param {FunctionDeps} dependencies - An array of ENS properties
+     * @returns {Object} - An object of ENS properties
+     */
+    private forwardDependenciesFromArray;
+    /**
+     * Creates a wrapper for a function to be dynamically imported, with the correct dependencies passed in
+     * @param {string} path - The path of the exported function
+     * @param {FunctionDeps} dependencies - An array of ENS properties
+     * @param {string} exportName - The export name of the target function
+     * @param {string} subFunc - The type of function being imported
+     * @returns {Function} - The generated wrapped function
+     */
+    private importGenerator;
+    /**
+     * Generates a normal wrapped function
+     * @param {string} path - The path of the exported function
+     * @param {FunctionDeps} dependencies - An array of ENS properties
+     * @param {string} exportName - The export name of the target function
+     * @returns {OmitFirstArg} - The generated wrapped function
+     */
+    private generateFunction;
+    /**
+     * Generates a write wrapped function
+     * @param {string} path - The path of the exported function
+     * @param {FunctionDeps} dependencies - An array of ENS properties
+     * @param {string} exportName - The export name of the target function
+     * @returns {OmitFirstArg} - The generated wrapped function
+     */
+    private generateWriteFunction;
+    /**
+     * Generates a wrapped function from raw and decode exports
+     * @param {string} path - The path of the exported function
+     * @param {FunctionDeps} dependencies - An array of ENS properties
+     * @param {string} exportName - The export name of the target function
+     * @returns {GeneratedRawFunction} - The generated wrapped function
+     */
+    private generateRawFunction;
+    /**
+     * Sets the provider for the ENS class
+     * @param {ethers.providers.JsonRpcProvider} provider - The provider to set
+     * @returns {Promise<void>} - A promise that resolves when the provider is set
+     */
+    setProvider: (provider: ethers.providers.JsonRpcProvider) => Promise<void>;
+    /**
+     * Creates a new ENS instance with a different provider, ideally should be used individually with any given function
+     * @param {ethers.providers.JsonRpcProvider} provider - The provider to use
+     * @returns {ENS} - A new ENS instance with the given provider
+     */
+    withProvider: (provider: ethers.providers.JsonRpcProvider) => ENS;
+    batch: GeneratedRawFunction<{
+        raw: ({ multicallWrapper }: ENSArgs<"multicallWrapper">, ...items: BatchFunctionResult<RawFunction>[]) => Promise<{
+            to: string;
+            data: string;
+        }>;
+        decode: ({ multicallWrapper }: ENSArgs<"multicallWrapper">, data: string, ...items: BatchFunctionResult<RawFunction>[]) => Promise<any[] | undefined>;
+    }>;
+    getProfile: (nameOrAddress: string, options?: ({
+        contentHash?: boolean | undefined;
+        texts?: boolean | string[] | undefined;
+        coinTypes?: boolean | string[] | undefined;
+    } & {
+        resolverAddress?: string | undefined;
+    }) | undefined) => Promise<{
+        isMigrated: boolean | null;
+        createdAt: string | null;
+        address?: string | undefined;
+        name?: string | null | undefined;
+        match?: boolean | undefined;
+        message?: string | undefined;
+        records?: {
+            contentHash?: string | import("./utils/contentHash").DecodedContentHash | null | undefined;
+            texts?: {
+                key: string | number;
+                type: "addr" | "text" | "contentHash";
+                coin?: string | undefined;
+                value: string;
+            }[] | undefined;
+            coinTypes?: {
+                key: string | number;
+                type: "addr" | "text" | "contentHash";
+                coin?: string | undefined;
+                value: string;
+            }[] | undefined;
+        } | undefined;
+        resolverAddress?: string | undefined;
+        reverseResolverAddress?: string | undefined;
+    } | undefined>;
+    getRecords: (name: string, options?: {
+        contentHash?: boolean | undefined;
+        texts?: boolean | string[] | undefined;
+        coinTypes?: boolean | string[] | undefined;
+        resolverAddress?: string | undefined;
+    } | undefined) => Promise<{
+        isMigrated: boolean | null;
+        createdAt: string | null;
+        address?: string | undefined;
+        name?: string | null | undefined;
+        match?: boolean | undefined;
+        message?: string | undefined;
+        records?: {
+            contentHash?: string | import("./utils/contentHash").DecodedContentHash | null | undefined;
+            texts?: {
+                key: string | number;
+                type: "addr" | "text" | "contentHash";
+                coin?: string | undefined;
+                value: string;
+            }[] | undefined;
+            coinTypes?: {
+                key: string | number;
+                type: "addr" | "text" | "contentHash";
+                coin?: string | undefined;
+                value: string;
+            }[] | undefined;
+        } | undefined;
+        resolverAddress?: string | undefined;
+        reverseResolverAddress?: string | undefined;
+    } | undefined>;
+    getName: GeneratedRawFunction<{
+        raw: ({ contracts }: ENSArgs<"contracts">, address: string) => Promise<{
+            to: string;
+            data: string;
+        }>;
+        decode: ({ contracts }: ENSArgs<"contracts">, data: string, address: string) => Promise<{
+            name: any;
+            match: boolean;
+            reverseResolverAddress: any;
+            resolverAddress: any;
+        } | {
+            name: null;
+            match: boolean;
+            reverseResolverAddress?: undefined;
+            resolverAddress?: undefined;
+        } | undefined>;
+    }>;
+    getResolver: GeneratedRawFunction<{
+        raw: ({ contracts }: ENSArgs<"contracts">, name: string) => Promise<{
+            to: string;
+            data: string;
+        }>;
+        decode: ({ contracts }: ENSArgs<"contracts">, data: string) => Promise<any>;
+    }>;
+    getFuses: GeneratedRawFunction<{
+        raw: ({ contracts }: ENSArgs<"contracts">, name: string) => Promise<{
+            to: string;
+            data: string;
+        }>;
+        decode: ({ contracts }: ENSArgs<"contracts">, data: string, name: string) => Promise<{
+            fuseObj: {
+                [k: string]: boolean;
+            };
+            expiryDate: Date;
+            rawFuses: ethers.BigNumber;
+        } | undefined>;
+    }>;
+    getHistory: (name: string) => Promise<{
+        domain: {
+            type: any;
+            blockNumber: any;
+            transactionHash: any;
+            id: any;
+            data: Record<string, any>;
+        }[];
+        registration: {
+            type: any;
+            blockNumber: any;
+            transactionHash: any;
+            id: any;
+            data: Record<string, any>;
+        }[];
+        resolver: {
+            type: any;
+            blockNumber: any;
+            transactionHash: any;
+            id: any;
+            data: Record<string, any>;
+        }[];
+    } | undefined>;
+    getHistoryWithDetail: (name: string) => Promise<{
+        domain: {
+            type: any;
+            blockNumber: any;
+            transactionHash: any;
+            id: any;
+            data: Record<string, any>;
+        }[];
+        registration: {
+            type: any;
+            blockNumber: any;
+            transactionHash: any;
+            id: any;
+            data: Record<string, any>;
+        }[];
+        resolver: {
+            type: any;
+            blockNumber: any;
+            transactionHash: any;
+            id: any;
+            data: Record<string, any>;
+        }[];
+    } | undefined>;
+    getHistoryDetailForTransactionHash: (hash: string, indexInTransaction?: number | undefined) => Promise<({
+        key: any;
+        value: any;
+    } | undefined)[] | {
+        key: any;
+        value: any;
+    } | undefined>;
+    getContentHash: GeneratedRawFunction<{
+        raw: ({ contracts, universalWrapper }: ENSArgs<"contracts" | "universalWrapper">, name: string) => Promise<{
+            to: string;
+            data: string;
+        }>;
+        decode: ({ contracts, universalWrapper }: ENSArgs<"contracts" | "universalWrapper">, data: string) => Promise<{
+            protocolType?: undefined;
+            decoded?: undefined;
+            error?: undefined;
+        } | {
+            protocolType: null;
+            decoded: any;
+            error?: undefined;
+        } | {
+            protocolType: string | undefined;
+            decoded: any;
+            error: any;
+        } | undefined>;
+    }>;
+    _getContentHash: GeneratedRawFunction<{
+        raw: ({ contracts }: ENSArgs<"contracts">, name: string) => Promise<{
+            to: string;
+            data: string;
+        }>;
+        decode: ({ contracts }: ENSArgs<"contracts">, data: string) => Promise<{
+            protocolType?: undefined;
+            decoded?: undefined;
+            error?: undefined;
+        } | {
+            protocolType: null;
+            decoded: any;
+            error?: undefined;
+        } | {
+            protocolType: string | undefined;
+            decoded: any;
+            error: any;
+        } | undefined>;
+    }>;
+    getAddr: GeneratedRawFunction<{
+        raw: ({ contracts, universalWrapper }: ENSArgs<"contracts" | "universalWrapper">, name: string, coinType?: string | number | undefined) => Promise<{
+            to: string;
+            data: string;
+        }>;
+        decode: ({ contracts, universalWrapper }: ENSArgs<"contracts" | "universalWrapper">, data: string, _name: string, coinType?: string | number | undefined) => Promise<string | {
+            coin: string;
+            addr: string;
+        } | undefined>;
+    }>;
+    _getAddr: GeneratedRawFunction<{
+        raw: ({ contracts }: ENSArgs<"contracts">, name: string, coinType?: string | number | undefined, bypassFormat?: boolean | undefined) => Promise<{
+            to: string;
+            data: string;
+        }>;
+        decode: ({ contracts }: ENSArgs<"contracts">, data: string, _name: string, coinType?: string | number | undefined) => Promise<string | {
+            coin: string;
+            addr: string;
+        } | undefined>;
+    }>;
+    getText: GeneratedRawFunction<{
+        raw: ({ contracts, universalWrapper }: ENSArgs<"contracts" | "universalWrapper">, name: string, key: string) => Promise<{
+            to: string;
+            data: string;
+        }>;
+        decode: ({ contracts, universalWrapper }: ENSArgs<"contracts" | "universalWrapper">, data: string) => Promise<any>;
+    }>;
+    _getText: GeneratedRawFunction<{
+        raw: ({ contracts }: ENSArgs<"contracts">, name: string, key: string) => Promise<{
+            to: string;
+            data: string;
+        }>;
+        decode: ({ contracts }: ENSArgs<"contracts">, data: string) => Promise<any>;
+    }>;
+    getOwner: GeneratedRawFunction<{
+        raw: ({ contracts, multicallWrapper }: ENSArgs<"contracts" | "multicallWrapper">, name: string, contract?: "nameWrapper" | "registrar" | "registry" | undefined) => Promise<{
+            to: string;
+            data: string;
+        }>;
+        decode: ({ contracts, multicallWrapper }: ENSArgs<"contracts" | "multicallWrapper">, data: string, name: string, contract?: "nameWrapper" | "registrar" | "registry" | undefined) => Promise<{
+            registrant?: string | undefined;
+            owner?: string | undefined;
+            ownershipLevel: "nameWrapper" | "registrar" | "registry";
+        } | undefined>;
+    }>;
+    getExpiry: GeneratedRawFunction<{
+        raw: (ensArgs: ENSArgs<"contracts" | "multicallWrapper">, name: string, { contract }?: {
+            contract?: ("nameWrapper" | "registrar") | undefined;
+        }) => Promise<{
+            to: string;
+            data: string;
+        }>;
+        decode: (ensArgs: ENSArgs<"contracts" | "multicallWrapper">, data: string, name: string, { contract }?: {
+            contract?: ("nameWrapper" | "registrar") | undefined;
+        }) => Promise<{
+            expiry: Date;
+            gracePeriod: null;
+        } | {
+            expiry: Date | null;
+            gracePeriod: number;
+        } | undefined>;
+    }>;
+    getSubnames: (functionArgs: {
+        name: string;
+        page?: number | undefined;
+        pageSize?: number | undefined;
+        orderDirection?: "asc" | "desc" | undefined;
+        orderBy?: "labelName" | "createdAt" | undefined;
+        lastSubnames?: any[] | undefined;
+        isLargeQuery?: boolean | undefined;
+    }) => Promise<{
+        subnames: {
+            id: string;
+            labelName: string | null;
+            truncatedName?: string | undefined;
+            labelhash: string;
+            isMigrated: boolean;
+            name: string;
+            owner: {
+                id: string;
+            };
+        }[];
+        subnameCount: number;
+    }>;
+    getNames: (args_0: {
+        address: string;
+        type: "owner" | "registrant" | "all";
+        page?: number | undefined;
+        pageSize?: number | undefined;
+        orderDirection?: "asc" | "desc" | undefined;
+    } & ({
+        type: "registrant";
+        orderBy?: "expiryDate" | "registrationDate" | "labelName" | undefined;
+    } | {
+        type: "owner";
+        orderBy?: "labelName" | "createdAt" | undefined;
+    } | {
+        type: "all";
+        orderBy?: "labelName" | "creationDate" | undefined;
+        page?: undefined;
+        pageSize?: undefined;
+    })) => Promise<import("./functions/getNames").Name[]>;
+    getPrice: GeneratedRawFunction<{
+        raw: ({ contracts, multicallWrapper }: ENSArgs<"contracts" | "multicallWrapper">, name: string, duration: number, legacy?: boolean | undefined) => Promise<{
+            to: string;
+            data: string;
+        }>;
+        decode: ({ contracts, multicallWrapper }: ENSArgs<"contracts" | "multicallWrapper">, data: string, _name: string, _number: number, legacy?: boolean | undefined) => Promise<{
+            base: ethers.BigNumber;
+            premium: ethers.BigNumber;
+        } | undefined>;
+    }>;
+    universalWrapper: GeneratedRawFunction<{
+        raw: ({ contracts }: ENSArgs<"contracts">, name: string, data: string) => Promise<{
+            to: string;
+            data: string;
+        }>;
+        decode: ({ contracts }: ENSArgs<"contracts">, data: string) => Promise<{
+            data: any;
+            resolver: any;
+        } | undefined>;
+    }>;
+    resolverMulticallWrapper: GeneratedRawFunction<{
+        raw: ({ contracts }: ENSArgs<"contracts">, data: {
+            to: string;
+            data: string;
+        }[]) => Promise<{
+            to: string;
+            data: string;
+        }>;
+        decode: ({ contracts }: ENSArgs<"contracts">, data: string) => Promise<ethers.utils.Result | undefined>;
+    }>;
+    multicallWrapper: GeneratedRawFunction<{
+        raw: ({ contracts }: ENSArgs<"contracts">, transactions: ethers.providers.TransactionRequest[], requireSuccess?: boolean) => Promise<{
+            to: string;
+            data: string;
+        }>;
+        decode: ({ contracts }: ENSArgs<"contracts">, data: string) => Promise<any>;
+    }>;
+    setName: WriteFunction<typeof setName>;
+    setRecords: WriteFunction<typeof setRecords>;
+    setRecord: WriteFunction<typeof setRecord>;
+    setResolver: WriteFunction<typeof setResolver>;
+    transferName: WriteFunction<typeof transferName>;
+    wrapName: WriteFunction<typeof wrapName>;
+    unwrapName: WriteFunction<typeof unwrapName>;
+    burnFuses: WriteFunction<typeof burnFuses>;
+    createSubname: WriteFunction<typeof createSubname>;
+    deleteSubname: WriteFunction<typeof deleteSubname>;
+    transferSubname: WriteFunction<typeof transferSubname>;
+    getDNSOwner: (dnsName: string) => Promise<any>;
+}
+export {};