@ensdomains/ensjs 4.0.3-alpha.12 → 4.1.1

package/dist/functions/public/getName.d.ts

@@ -0,0 +1,60 @@
+import { type Address, type BaseError, type Hex } from 'viem';
+import type { ClientWithEns } from '../../contracts/consts.js';
+import type { GenericPassthrough, TransactionRequestWithPassthrough } from '../../types.js';
+import { type GeneratedFunction } from '../../utils/generateFunction.js';
+type GetNameCoinTypeParameters = {
+    coinType: number;
+    chainId?: never;
+};
+type GetNameChainIdParameters = {
+    chainId: number;
+    coinType?: never;
+};
+export type GetNameParameters = {
+    /** Address to get name for */
+    address: Address;
+    /** Coin type to use for reverse resolution */
+    coinType?: GetNameCoinTypeParameters['coinType'];
+    /** Chain ID to use for reverse resolution */
+    chainId?: GetNameChainIdParameters['chainId'];
+    /** Whether or not to allow mismatched forward resolution */
+    allowMismatch?: boolean;
+    /** Whether or not to throw decoding errors */
+    strict?: boolean;
+    /** Batch gateway URLs to use for resolving CCIP-read requests. */
+    gatewayUrls?: string[];
+} & (GetNameCoinTypeParameters | GetNameChainIdParameters | {});
+export type GetNameReturnType = {
+    /** Primary name for address */
+    name: string;
+    /** Indicates if forward resolution for name matches address */
+    match: boolean;
+    /** Resolver address for reverse node */
+    reverseResolverAddress: Address;
+    /** Resolver address for resolved name */
+    resolverAddress: Address;
+};
+declare const encode: (client: ClientWithEns, { address, coinType, chainId, gatewayUrls, }: Omit<GetNameParameters, "allowMismatch" | "strict">) => TransactionRequestWithPassthrough;
+declare const decode: (_client: ClientWithEns, data: Hex | BaseError, passthrough: GenericPassthrough, { allowMismatch, strict, gatewayUrls }: GetNameParameters) => Promise<GetNameReturnType | null>;
+type BatchableFunctionObject = GeneratedFunction<typeof encode, typeof decode>;
+/**
+ * Gets the primary name for an address
+ * @param client - {@link ClientWithEns}
+ * @param parameters - {@link GetNameParameters}
+ * @returns Name data object, or `null` if no primary name is set. {@link GetNameReturnType}
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { getName } from '@ensdomains/ensjs/public'
+ *
+ * const client = createPublicClient({
+ *   chain: addEnsContracts(mainnet),
+ *   transport: http(),
+ * })
+ * const result = await getName(client, { address: '0xb8c2C29ee19D8307cb7255e1Cd9CbDE883A267d5' })
+ * // { name: 'nick.eth', match: true, reverseResolverAddress: '0xa2c122be93b0074270ebee7f6b7292c7deb45047', resolverAddress: '0x4976fb03c32e5b8cfe2b6ccb31c09ba78ebaba41' }
+ */
+declare const getName: ((client: ClientWithEns, { address, allowMismatch, strict }: GetNameParameters) => Promise<GetNameReturnType>) & BatchableFunctionObject;
+export default getName;

package/dist/functions/public/getName.js

@@ -0,0 +1,122 @@
+import { evmChainIdToCoinType } from '@ensdomains/address-encoder/utils';
+import { decodeErrorResult, decodeFunctionResult, encodeFunctionData, zeroAddress, } from 'viem';
+import { getChainContractAddress } from '../../contracts/getChainContractAddress.js';
+import { universalResolverReverseSnippet, universalResolverReverseWithGatewaysSnippet, } from '../../contracts/universalResolver.js';
+import { checkSafeUniversalResolverData } from '../../utils/checkSafeUniversalResolverData.js';
+import { generateFunction, } from '../../utils/generateFunction.js';
+import { getRevertErrorData } from '../../utils/getRevertErrorData.js';
+import { normalise } from '../../utils/normalise.js';
+const encode = (client, { address, coinType, chainId, gatewayUrls, }) => {
+    const to = getChainContractAddress({
+        client,
+        contract: 'ensUniversalResolver',
+    });
+    const args = [
+        address,
+        chainId ? evmChainIdToCoinType(chainId) : coinType || 60n,
+    ];
+    return {
+        to,
+        ...(gatewayUrls?.length
+            ? {
+                data: encodeFunctionData({
+                    abi: universalResolverReverseWithGatewaysSnippet,
+                    functionName: 'reverseWithGateways',
+                    args: [...args, gatewayUrls],
+                }),
+                passthrough: {
+                    args: [...args, gatewayUrls],
+                    address: to,
+                },
+            }
+            : {
+                data: encodeFunctionData({
+                    abi: universalResolverReverseSnippet,
+                    functionName: 'reverse',
+                    args,
+                }),
+                passthrough: {
+                    args,
+                    address: to,
+                },
+            }),
+    };
+};
+const decode = async (_client, data, passthrough, { allowMismatch, strict, gatewayUrls }) => {
+    const isSafe = checkSafeUniversalResolverData(data, {
+        strict,
+        abi: gatewayUrls
+            ? universalResolverReverseWithGatewaysSnippet
+            : universalResolverReverseSnippet,
+        args: passthrough.args,
+        functionName: 'reverse',
+        address: passthrough.address,
+    });
+    if (!isSafe) {
+        if (!allowMismatch)
+            return null;
+        const errorData = getRevertErrorData(data);
+        if (!errorData)
+            return null;
+        try {
+            const decodedError = decodeErrorResult({
+                abi: universalResolverReverseSnippet,
+                data: errorData,
+            });
+            if (decodedError.errorName !== 'ReverseAddressMismatch')
+                return null;
+            return {
+                name: decodedError.args[0],
+                match: false,
+                reverseResolverAddress: zeroAddress,
+                resolverAddress: zeroAddress,
+            };
+        }
+        catch {
+            return null;
+        }
+    }
+    try {
+        const [unnormalisedName, resolverAddress, reverseResolverAddress] = decodeFunctionResult({
+            abi: universalResolverReverseSnippet,
+            functionName: 'reverse',
+            data,
+        });
+        if (!unnormalisedName)
+            return null;
+        const normalisedName = normalise(unnormalisedName);
+        return {
+            name: normalisedName,
+            match: true,
+            reverseResolverAddress,
+            resolverAddress,
+        };
+    }
+    catch (error) {
+        if (strict)
+            throw error;
+        return null;
+    }
+};
+/**
+ * Gets the primary name for an address
+ * @param client - {@link ClientWithEns}
+ * @param parameters - {@link GetNameParameters}
+ * @returns Name data object, or `null` if no primary name is set. {@link GetNameReturnType}
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { getName } from '@ensdomains/ensjs/public'
+ *
+ * const client = createPublicClient({
+ *   chain: addEnsContracts(mainnet),
+ *   transport: http(),
+ * })
+ * const result = await getName(client, { address: '0xb8c2C29ee19D8307cb7255e1Cd9CbDE883A267d5' })
+ * // { name: 'nick.eth', match: true, reverseResolverAddress: '0xa2c122be93b0074270ebee7f6b7292c7deb45047', resolverAddress: '0x4976fb03c32e5b8cfe2b6ccb31c09ba78ebaba41' }
+ */
+const getName = generateFunction({ encode, decode });
+export default getName;
+//# sourceMappingURL=getName.js.map

package/dist/functions/public/getName.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getName.js","sourceRoot":"","sources":["../../../src/functions/public/getName.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAA;AACxE,OAAO,EAIL,iBAAiB,EACjB,oBAAoB,EACpB,kBAAkB,EAClB,WAAW,GACZ,MAAM,MAAM,CAAA;AAEb,OAAO,EAAE,uBAAuB,EAAE,MAAM,4CAA4C,CAAA;AACpF,OAAO,EACL,+BAA+B,EAC/B,2CAA2C,GAC5C,MAAM,sCAAsC,CAAA;AAK7C,OAAO,EAAE,8BAA8B,EAAE,MAAM,+CAA+C,CAAA;AAC9F,OAAO,EAEL,gBAAgB,GACjB,MAAM,iCAAiC,CAAA;AACxC,OAAO,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAA;AACtE,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAA;AAsCpD,MAAM,MAAM,GAAG,CACb,MAAqB,EACrB,EACE,OAAO,EACP,QAAQ,EACR,OAAO,EACP,WAAW,GACyC,EACnB,EAAE;IACrC,MAAM,EAAE,GAAG,uBAAuB,CAAC;QACjC,MAAM;QACN,QAAQ,EAAE,sBAAsB;KACjC,CAAC,CAAA;IACF,MAAM,IAAI,GAAG;QACX,OAAO;QACP,OAAO,CAAC,CAAC,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,QAAQ,IAAI,GAAG;KACjD,CAAA;IAEV,OAAO;QACL,EAAE;QACF,GAAG,CAAC,WAAW,EAAE,MAAM;YACrB,CAAC,CAAC;gBACE,IAAI,EAAE,kBAAkB,CAAC;oBACvB,GAAG,EAAE,2CAA2C;oBAChD,YAAY,EAAE,qBAAqB;oBACnC,IAAI,EAAE,CAAC,GAAG,IAAI,EAAE,WAAW,CAAU;iBACtC,CAAC;gBACF,WAAW,EAAE;oBACX,IAAI,EAAE,CAAC,GAAG,IAAI,EAAE,WAAW,CAAC;oBAC5B,OAAO,EAAE,EAAE;iBACZ;aACF;YACH,CAAC,CAAC;gBACE,IAAI,EAAE,kBAAkB,CAAC;oBACvB,GAAG,EAAE,+BAA+B;oBACpC,YAAY,EAAE,SAAS;oBACvB,IAAI;iBACL,CAAC;gBACF,WAAW,EAAE;oBACX,IAAI;oBACJ,OAAO,EAAE,EAAE;iBACZ;aACF,CAAC;KACP,CAAA;AACH,CAAC,CAAA;AAED,MAAM,MAAM,GAAG,KAAK,EAClB,OAAsB,EACtB,IAAqB,EACrB,WAA+B,EAC/B,EAAE,aAAa,EAAE,MAAM,EAAE,WAAW,EAAqB,EACtB,EAAE;IACrC,MAAM,MAAM,GAAG,8BAA8B,CAAC,IAAI,EAAE;QAClD,MAAM;QACN,GAAG,EAAE,WAAW;YACd,CAAC,CAAC,2CAA2C;YAC7C,CAAC,CAAC,+BAA+B;QACnC,IAAI,EAAE,WAAW,CAAC,IAAI;QACtB,YAAY,EAAE,SAAS;QACvB,OAAO,EAAE,WAAW,CAAC,OAAO;KAC7B,CAAC,CAAA;IACF,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,IAAI,CAAC,aAAa;YAAE,OAAO,IAAI,CAAA;QAC/B,MAAM,SAAS,GAAG,kBAAkB,CAAC,IAAI,CAAC,CAAA;QAC1C,IAAI,CAAC,SAAS;YAAE,OAAO,IAAI,CAAA;QAC3B,IAAI,CAAC;YACH,MAAM,YAAY,GAAG,iBAAiB,CAAC;gBACrC,GAAG,EAAE,+BAA+B;gBACpC,IAAI,EAAE,SAAS;aAChB,CAAC,CAAA;YACF,IAAI,YAAY,CAAC,SAAS,KAAK,wBAAwB;gBAAE,OAAO,IAAI,CAAA;YACpE,OAAO;gBACL,IAAI,EAAE,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC;gBAC1B,KAAK,EAAE,KAAK;gBACZ,sBAAsB,EAAE,WAAW;gBACnC,eAAe,EAAE,WAAW;aAC7B,CAAA;QACH,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,IAAI,CAAA;QACb,CAAC;IACH,CAAC;IAED,IAAI,CAAC;QACH,MAAM,CAAC,gBAAgB,EAAE,eAAe,EAAE,sBAAsB,CAAC,GAC/D,oBAAoB,CAAC;YACnB,GAAG,EAAE,+BAA+B;YACpC,YAAY,EAAE,SAAS;YACvB,IAAI;SACL,CAAC,CAAA;QAEJ,IAAI,CAAC,gBAAgB;YAAE,OAAO,IAAI,CAAA;QAElC,MAAM,cAAc,GAAG,SAAS,CAAC,gBAAgB,CAAC,CAAA;QAClD,OAAO;YACL,IAAI,EAAE,cAAc;YACpB,KAAK,EAAE,IAAI;YACX,sBAAsB;YACtB,eAAe;SAChB,CAAA;IACH,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,MAAM;YAAE,MAAM,KAAK,CAAA;QACvB,OAAO,IAAI,CAAA;IACb,CAAC;AACH,CAAC,CAAA;AAID;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,OAAO,GAAG,gBAAgB,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,CAI1B,CAAA;AAEzB,eAAe,OAAO,CAAA"}

package/dist/functions/public/getOwner.d.ts

@@ -0,0 +1,73 @@
+import { type Address, type BaseError, type Hex } from 'viem';
+import type { ClientWithEns } from '../../contracts/consts.js';
+import type { SimpleTransactionRequest } from '../../types.js';
+import { type OwnerContract } from '../../utils/ownerFromContract.js';
+export type GetOwnerParameters<TContract extends OwnerContract | undefined = undefined> = {
+    /** Name to get owner for */
+    name: string;
+    /** Optional specific contract to get ownership value from */
+    contract?: TContract;
+};
+type BaseGetOwnerReturnType = {
+    /** Owner of the name */
+    owner?: Address | null;
+    /** Registrant of the name (registrar owner) */
+    registrant?: Address | null;
+    /** The contract level that the ownership is on */
+    ownershipLevel: 'registry' | 'registrar' | 'nameWrapper';
+};
+type RegistrarOnlyOwnership = {
+    owner?: never;
+    registrant: Address;
+    ownershipLevel: 'registrar';
+};
+type WrappedOwnership = {
+    owner: Address;
+    registrant?: never;
+    ownershipLevel: 'nameWrapper';
+};
+type UnwrappedEth2ldOwnership = {
+    registrant: Address | null;
+    owner: Address;
+    ownershipLevel: 'registrar';
+};
+type UnwrappedOwnership = {
+    owner: Address;
+    registrant?: never;
+    ownershipLevel: 'registry';
+};
+export type GetOwnerReturnType<TContract extends OwnerContract | undefined = undefined> = (BaseGetOwnerReturnType & (TContract extends 'registrar' ? RegistrarOnlyOwnership : TContract extends 'nameWrapper' ? WrappedOwnership : TContract extends 'registry' ? UnwrappedOwnership : WrappedOwnership | UnwrappedEth2ldOwnership | UnwrappedOwnership)) | null;
+declare const encode: <TContract extends OwnerContract | undefined = undefined>(client: ClientWithEns, { name, contract }: GetOwnerParameters<TContract>) => SimpleTransactionRequest;
+declare const decode: <TContract extends OwnerContract | undefined = undefined>(client: ClientWithEns, data: Hex | BaseError, { name, contract }: GetOwnerParameters<TContract>) => Promise<GetOwnerReturnType<TContract>>;
+type EncoderFunction = typeof encode;
+type DecoderFunction = typeof decode;
+type BatchableFunctionObject = {
+    encode: EncoderFunction;
+    decode: DecoderFunction;
+    batch: <TContract extends OwnerContract | undefined = undefined, TParams extends GetOwnerParameters<TContract> = GetOwnerParameters<TContract>>(args: TParams) => {
+        args: [TParams];
+        encode: EncoderFunction;
+        decode: typeof decode<TContract>;
+    };
+};
+/**
+ * Gets the owner(s) of a name.
+ * @param client - {@link ClientWithEns}
+ * @param parameters - {@link GetOwnerParameters}
+ * @returns Owner data object, or `null` if no owners exist. {@link GetOwnerReturnType}
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { getOwner } from '@ensdomains/ensjs/public'
+ *
+ * const client = createPublicClient({
+ *   chain: addEnsContracts(mainnet),
+ *   transport: http(),
+ * })
+ * const result = await getOwner(client, { name: 'ens.eth' })
+ * // { owner: '0xb6E040C9ECAaE172a89bD561c5F73e1C48d28cd9', registrant: '0xb6E040C9ECAaE172a89bD561c5F73e1C48d28cd9', ownershipLevel: 'registrar }
+ */
+declare const getOwner: (<TContract extends OwnerContract | undefined = undefined>(client: ClientWithEns, { name, contract }: GetOwnerParameters<TContract>) => Promise<GetOwnerReturnType<TContract>>) & BatchableFunctionObject;
+export default getOwner;

package/dist/functions/public/getOwner.js

@@ -0,0 +1,156 @@
+import { decodeAbiParameters, } from 'viem';
+import { getChainContractAddress } from '../../contracts/getChainContractAddress.js';
+import { EMPTY_ADDRESS } from '../../utils/consts.js';
+import { generateFunction } from '../../utils/generateFunction.js';
+import { namehash as makeNamehash } from '../../utils/normalise.js';
+import { ownerFromContract, } from '../../utils/ownerFromContract.js';
+import { checkIsDotEth } from '../../utils/validation.js';
+import multicallWrapper from './multicallWrapper.js';
+const encode = (client, { name, contract }) => {
+    const namehash = makeNamehash(name);
+    const labels = name.split('.');
+    if (contract || labels.length === 1) {
+        return ownerFromContract({
+            client,
+            contract: contract || 'registry',
+            namehash,
+            labels,
+        });
+    }
+    const registryData = ownerFromContract({
+        client,
+        contract: 'registry',
+        namehash,
+    });
+    const nameWrapperData = ownerFromContract({
+        client,
+        contract: 'nameWrapper',
+        namehash,
+    });
+    const data = [registryData, nameWrapperData];
+    if (checkIsDotEth(labels)) {
+        data.push(ownerFromContract({ client, contract: 'registrar', labels }));
+    }
+    return multicallWrapper.encode(client, { transactions: data });
+};
+const addressDecode = (data) => decodeAbiParameters([{ type: 'address' }], data)[0];
+const decode = async (client, data, { name, contract }) => {
+    if (typeof data === 'object')
+        throw data;
+    const labels = name.split('.');
+    if (contract || labels.length === 1) {
+        const singleOwner = addressDecode(data);
+        if (contract === 'registrar') {
+            return {
+                ownershipLevel: 'registrar',
+                registrant: singleOwner,
+            };
+        }
+        return {
+            ownershipLevel: contract || 'registry',
+            owner: singleOwner,
+        };
+    }
+    const result = await multicallWrapper.decode(client, data, []);
+    const [registryOwner, nameWrapperOwner, registrarOwner] = [
+        result[0].returnData,
+        result[1].returnData,
+        result[2]?.returnData,
+    ].map((ret) => (ret && ret !== '0x' ? addressDecode(ret) : undefined));
+    const nameWrapperAddress = getChainContractAddress({
+        client,
+        contract: 'ensNameWrapper',
+    });
+    // check for only .eth names
+    if (labels[labels.length - 1] === 'eth') {
+        // if the owner on the registrar is the namewrapper, then the namewrapper owner is the owner
+        // there is no "registrant" for wrapped names
+        if (registrarOwner === nameWrapperAddress) {
+            return {
+                owner: nameWrapperOwner,
+                ownershipLevel: 'nameWrapper',
+            };
+        }
+        // if there is a registrar owner, then it's not a subdomain but we have also passed the namewrapper clause
+        // this means that it's an unwrapped second-level name
+        // the registrant is the owner of the NFT
+        // the owner is the controller of the records
+        if (registrarOwner) {
+            return {
+                registrant: registrarOwner,
+                owner: registryOwner,
+                ownershipLevel: 'registrar',
+            };
+        }
+        if (registryOwner !== EMPTY_ADDRESS) {
+            // if there is no registrar owner, but the label length is two, then the domain is an expired 2LD .eth
+            // so we still want to return the ownership values
+            if (labels.length === 2) {
+                return {
+                    registrant: null,
+                    owner: registryOwner,
+                    ownershipLevel: 'registrar',
+                };
+            }
+            // this means that the subname is wrapped
+            if (registryOwner === nameWrapperAddress &&
+                nameWrapperOwner &&
+                nameWrapperOwner !== EMPTY_ADDRESS) {
+                return {
+                    owner: nameWrapperOwner,
+                    ownershipLevel: 'nameWrapper',
+                };
+            }
+            // unwrapped subnames do not have NFTs associated, so do not have a registrant
+            return {
+                owner: registryOwner,
+                ownershipLevel: 'registry',
+            };
+        }
+        // .eth names with no registrar owner are either unregistered or expired
+        return null;
+    }
+    // non .eth names inherit the owner from the registry
+    // there will only ever be an owner for non .eth names, not a registrant
+    // this is because for unwrapped names, there is no associated NFT
+    // and for wrapped names, owner and registrant are the same thing
+    if (registryOwner === nameWrapperAddress &&
+        nameWrapperOwner &&
+        nameWrapperOwner !== EMPTY_ADDRESS) {
+        return {
+            owner: nameWrapperOwner,
+            ownershipLevel: 'nameWrapper',
+        };
+    }
+    // for unwrapped non .eth names, the owner is the registry owner
+    if (registryOwner && registryOwner !== EMPTY_ADDRESS) {
+        return {
+            owner: registryOwner,
+            ownershipLevel: 'registry',
+        };
+    }
+    // for anything else, return
+    return null;
+};
+/**
+ * Gets the owner(s) of a name.
+ * @param client - {@link ClientWithEns}
+ * @param parameters - {@link GetOwnerParameters}
+ * @returns Owner data object, or `null` if no owners exist. {@link GetOwnerReturnType}
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { getOwner } from '@ensdomains/ensjs/public'
+ *
+ * const client = createPublicClient({
+ *   chain: addEnsContracts(mainnet),
+ *   transport: http(),
+ * })
+ * const result = await getOwner(client, { name: 'ens.eth' })
+ * // { owner: '0xb6E040C9ECAaE172a89bD561c5F73e1C48d28cd9', registrant: '0xb6E040C9ECAaE172a89bD561c5F73e1C48d28cd9', ownershipLevel: 'registrar }
+ */
+const getOwner = generateFunction({ encode, decode });
+export default getOwner;
+//# sourceMappingURL=getOwner.js.map

package/dist/functions/public/getOwner.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getOwner.js","sourceRoot":"","sources":["../../../src/functions/public/getOwner.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,mBAAmB,GACpB,MAAM,MAAM,CAAA;AAEb,OAAO,EAAE,uBAAuB,EAAE,MAAM,4CAA4C,CAAA;AAEpF,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAA;AACrD,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAA;AAClE,OAAO,EAAE,QAAQ,IAAI,YAAY,EAAE,MAAM,0BAA0B,CAAA;AACnE,OAAO,EAEL,iBAAiB,GAClB,MAAM,kCAAkC,CAAA;AACzC,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAA;AACzD,OAAO,gBAAgB,MAAM,uBAAuB,CAAA;AAyDpD,MAAM,MAAM,GAAG,CACb,MAAqB,EACrB,EAAE,IAAI,EAAE,QAAQ,EAAiC,EACvB,EAAE;IAC5B,MAAM,QAAQ,GAAG,YAAY,CAAC,IAAI,CAAC,CAAA;IACnC,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IAE9B,IAAI,QAAQ,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACpC,OAAO,iBAAiB,CAAC;YACvB,MAAM;YACN,QAAQ,EAAE,QAAQ,IAAI,UAAU;YAChC,QAAQ;YACR,MAAM;SACP,CAAC,CAAA;IACJ,CAAC;IAED,MAAM,YAAY,GAAG,iBAAiB,CAAC;QACrC,MAAM;QACN,QAAQ,EAAE,UAAU;QACpB,QAAQ;KACT,CAAC,CAAA;IACF,MAAM,eAAe,GAAG,iBAAiB,CAAC;QACxC,MAAM;QACN,QAAQ,EAAE,aAAa;QACvB,QAAQ;KACT,CAAC,CAAA;IAEF,MAAM,IAAI,GAAiC,CAAC,YAAY,EAAE,eAAe,CAAC,CAAA;IAE1E,IAAI,aAAa,CAAC,MAAM,CAAC,EAAE,CAAC;QAC1B,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,EAAE,CAAC,CAAC,CAAA;IACzE,CAAC;IAED,OAAO,gBAAgB,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC,CAAA;AAChE,CAAC,CAAA;AAED,MAAM,aAAa,GAAG,CAAC,IAAS,EAAE,EAAE,CAClC,mBAAmB,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAY,CAAA;AAEhE,MAAM,MAAM,GAAG,KAAK,EAClB,MAAqB,EACrB,IAAqB,EACrB,EAAE,IAAI,EAAE,QAAQ,EAAiC,EACT,EAAE;IAC1C,IAAI,OAAO,IAAI,KAAK,QAAQ;QAAE,MAAM,IAAI,CAAA;IACxC,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IAC9B,IAAI,QAAQ,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACpC,MAAM,WAAW,GAAG,aAAa,CAAC,IAAI,CAAC,CAAA;QACvC,IAAI,QAAQ,KAAK,WAAW,EAAE,CAAC;YAC7B,OAAO;gBACL,cAAc,EAAE,WAAW;gBAC3B,UAAU,EAAE,WAAW;aACS,CAAA;QACpC,CAAC;QACD,OAAO;YACL,cAAc,EAAE,QAAQ,IAAI,UAAU;YACtC,KAAK,EAAE,WAAW;SACc,CAAA;IACpC,CAAC;IAED,MAAM,MAAM,GAAG,MAAM,gBAAgB,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,EAAE,EAAE,CAAC,CAAA;IAE9D,MAAM,CAAC,aAAa,EAAE,gBAAgB,EAAE,cAAc,CAAC,GAAG;QACxD,MAAM,CAAC,CAAC,CAAC,CAAC,UAAU;QACpB,MAAM,CAAC,CAAC,CAAC,CAAC,UAAU;QACpB,MAAM,CAAC,CAAC,CAAC,EAAE,UAAU;KACtB,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,IAAI,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAIpE,CAAA;IAED,MAAM,kBAAkB,GAAG,uBAAuB,CAAC;QACjD,MAAM;QACN,QAAQ,EAAE,gBAAgB;KAC3B,CAAC,CAAA;IAEF,4BAA4B;IAC5B,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,KAAK,EAAE,CAAC;QACxC,4FAA4F;QAC5F,6CAA6C;QAC7C,IAAI,cAAc,KAAK,kBAAkB,EAAE,CAAC;YAC1C,OAAO;gBACL,KAAK,EAAE,gBAAgB;gBACvB,cAAc,EAAE,aAAa;aACG,CAAA;QACpC,CAAC;QACD,0GAA0G;QAC1G,sDAAsD;QACtD,yCAAyC;QACzC,6CAA6C;QAC7C,IAAI,cAAc,EAAE,CAAC;YACnB,OAAO;gBACL,UAAU,EAAE,cAAe;gBAC3B,KAAK,EAAE,aAAc;gBACrB,cAAc,EAAE,WAAW;aACK,CAAA;QACpC,CAAC;QACD,IAAI,aAAa,KAAK,aAAa,EAAE,CAAC;YACpC,sGAAsG;YACtG,kDAAkD;YAClD,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACxB,OAAO;oBACL,UAAU,EAAE,IAAI;oBAChB,KAAK,EAAE,aAAa;oBACpB,cAAc,EAAE,WAAW;iBACK,CAAA;YACpC,CAAC;YACD,yCAAyC;YACzC,IACE,aAAa,KAAK,kBAAkB;gBACpC,gBAAgB;gBAChB,gBAAgB,KAAK,aAAa,EAClC,CAAC;gBACD,OAAO;oBACL,KAAK,EAAE,gBAAgB;oBACvB,cAAc,EAAE,aAAa;iBACG,CAAA;YACpC,CAAC;YACD,8EAA8E;YAC9E,OAAO;gBACL,KAAK,EAAE,aAAa;gBACpB,cAAc,EAAE,UAAU;aACM,CAAA;QACpC,CAAC;QACD,wEAAwE;QACxE,OAAO,IAAI,CAAA;IACb,CAAC;IAED,qDAAqD;IACrD,wEAAwE;IACxE,kEAAkE;IAClE,iEAAiE;IACjE,IACE,aAAa,KAAK,kBAAkB;QACpC,gBAAgB;QAChB,gBAAgB,KAAK,aAAa,EAClC,CAAC;QACD,OAAO;YACL,KAAK,EAAE,gBAAgB;YACvB,cAAc,EAAE,aAAa;SACG,CAAA;IACpC,CAAC;IAED,gEAAgE;IAChE,IAAI,aAAa,IAAI,aAAa,KAAK,aAAa,EAAE,CAAC;QACrD,OAAO;YACL,KAAK,EAAE,aAAa;YACpB,cAAc,EAAE,UAAU;SACM,CAAA;IACpC,CAAC;IAED,4BAA4B;IAC5B,OAAO,IAAI,CAAA;AACb,CAAC,CAAA;AAqBD;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,QAAQ,GAAG,gBAAgB,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,CAM3B,CAAA;AAEzB,eAAe,QAAQ,CAAA"}

package/dist/functions/public/getPrice.d.ts

@@ -0,0 +1,40 @@
+import { type BaseError, type Hex } from 'viem';
+import type { ClientWithEns } from '../../contracts/consts.js';
+import type { SimpleTransactionRequest } from '../../types.js';
+import { type GeneratedFunction } from '../../utils/generateFunction.js';
+export type GetPriceParameters = {
+    /** Name, or array of names, to get price for */
+    nameOrNames: string | string[];
+    /** Duration in seconds to get price for */
+    duration: bigint | number;
+};
+export type GetPriceReturnType = {
+    /** Price base value */
+    base: bigint;
+    /** Price premium */
+    premium: bigint;
+};
+declare const encode: (client: ClientWithEns, { nameOrNames, duration }: GetPriceParameters) => SimpleTransactionRequest;
+declare const decode: (client: ClientWithEns, data: Hex | BaseError, { nameOrNames }: GetPriceParameters) => Promise<GetPriceReturnType>;
+type BatchableFunctionObject = GeneratedFunction<typeof encode, typeof decode>;
+/**
+ * Gets the price of a name, or array of names, for a given duration.
+ * @param client - {@link ClientWithEns}
+ * @param parameters - {@link GetPriceParameters}
+ * @returns Price data object. {@link GetPriceReturnType}
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { getPrice } from '@ensdomains/ensjs/public'
+ *
+ * const client = createPublicClient({
+ *   chain: addEnsContracts(mainnet),
+ *   transport: http(),
+ * })
+ * const result = await getPrice(client, { nameOrNames: 'ens.eth', duration: 31536000 })
+ * // { base: 352828971668930335n, premium: 0n }
+ */
+declare const getPrice: ((client: ClientWithEns, { nameOrNames, duration }: GetPriceParameters) => Promise<GetPriceReturnType>) & BatchableFunctionObject;
+export default getPrice;

package/dist/functions/public/getPrice.js

@@ -0,0 +1,105 @@
+import { decodeFunctionResult, encodeFunctionData, } from 'viem';
+import { bulkRenewalRentPriceSnippet } from '../../contracts/bulkRenewal.js';
+import { ethRegistrarControllerRentPriceSnippet } from '../../contracts/ethRegistrarController.js';
+import { getChainContractAddress } from '../../contracts/getChainContractAddress.js';
+import { UnsupportedNameTypeError } from '../../errors/general.js';
+import { generateFunction, } from '../../utils/generateFunction.js';
+import { getNameType } from '../../utils/getNameType.js';
+import multicallWrapper from './multicallWrapper.js';
+const encode = (client, { nameOrNames, duration }) => {
+    const names = (Array.isArray(nameOrNames) ? nameOrNames : [nameOrNames]).map((name) => {
+        const labels = name.split('.');
+        const nameType = getNameType(name);
+        if (nameType !== 'eth-2ld' && nameType !== 'tld')
+            throw new UnsupportedNameTypeError({
+                nameType,
+                supportedNameTypes: ['eth-2ld', 'tld'],
+                details: 'Currently only the price of eth-2ld names can be fetched',
+            });
+        return labels[0];
+    });
+    if (names.length > 1) {
+        const bulkRenewalAddress = getChainContractAddress({
+            client,
+            contract: 'ensBulkRenewal',
+        });
+        return multicallWrapper.encode(client, {
+            transactions: [
+                {
+                    to: bulkRenewalAddress,
+                    data: encodeFunctionData({
+                        abi: bulkRenewalRentPriceSnippet,
+                        functionName: 'rentPrice',
+                        args: [names, BigInt(duration)],
+                    }),
+                },
+                {
+                    to: bulkRenewalAddress,
+                    data: encodeFunctionData({
+                        abi: bulkRenewalRentPriceSnippet,
+                        functionName: 'rentPrice',
+                        args: [names, 0n],
+                    }),
+                },
+            ],
+        });
+    }
+    return {
+        to: getChainContractAddress({
+            client,
+            contract: 'ensEthRegistrarController',
+        }),
+        data: encodeFunctionData({
+            abi: ethRegistrarControllerRentPriceSnippet,
+            functionName: 'rentPrice',
+            args: [names[0], BigInt(duration)],
+        }),
+    };
+};
+const decode = async (client, data, { nameOrNames }) => {
+    if (typeof data === 'object')
+        throw data;
+    const isBulkRenewal = Array.isArray(nameOrNames) && nameOrNames.length > 1;
+    if (isBulkRenewal) {
+        const result = await multicallWrapper.decode(client, data, []);
+        const price = decodeFunctionResult({
+            abi: bulkRenewalRentPriceSnippet,
+            functionName: 'rentPrice',
+            data: result[0].returnData,
+        });
+        const premium = decodeFunctionResult({
+            abi: bulkRenewalRentPriceSnippet,
+            functionName: 'rentPrice',
+            data: result[1].returnData,
+        });
+        const base = price - premium;
+        return { base, premium };
+    }
+    return decodeFunctionResult({
+        abi: ethRegistrarControllerRentPriceSnippet,
+        functionName: 'rentPrice',
+        data,
+    });
+};
+/**
+ * Gets the price of a name, or array of names, for a given duration.
+ * @param client - {@link ClientWithEns}
+ * @param parameters - {@link GetPriceParameters}
+ * @returns Price data object. {@link GetPriceReturnType}
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { getPrice } from '@ensdomains/ensjs/public'
+ *
+ * const client = createPublicClient({
+ *   chain: addEnsContracts(mainnet),
+ *   transport: http(),
+ * })
+ * const result = await getPrice(client, { nameOrNames: 'ens.eth', duration: 31536000 })
+ * // { base: 352828971668930335n, premium: 0n }
+ */
+const getPrice = generateFunction({ encode, decode });
+export default getPrice;
+//# sourceMappingURL=getPrice.js.map

package/dist/functions/public/getPrice.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getPrice.js","sourceRoot":"","sources":["../../../src/functions/public/getPrice.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,oBAAoB,EACpB,kBAAkB,GACnB,MAAM,MAAM,CAAA;AACb,OAAO,EAAE,2BAA2B,EAAE,MAAM,gCAAgC,CAAA;AAE5E,OAAO,EAAE,sCAAsC,EAAE,MAAM,2CAA2C,CAAA;AAClG,OAAO,EAAE,uBAAuB,EAAE,MAAM,4CAA4C,CAAA;AACpF,OAAO,EAAE,wBAAwB,EAAE,MAAM,yBAAyB,CAAA;AAElE,OAAO,EAEL,gBAAgB,GACjB,MAAM,iCAAiC,CAAA;AACxC,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAA;AACxD,OAAO,gBAAgB,MAAM,uBAAuB,CAAA;AAgBpD,MAAM,MAAM,GAAG,CACb,MAAqB,EACrB,EAAE,WAAW,EAAE,QAAQ,EAAsB,EACnB,EAAE;IAC5B,MAAM,KAAK,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,CAC1E,CAAC,IAAI,EAAE,EAAE;QACP,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QAC9B,MAAM,QAAQ,GAAG,WAAW,CAAC,IAAI,CAAC,CAAA;QAClC,IAAI,QAAQ,KAAK,SAAS,IAAI,QAAQ,KAAK,KAAK;YAC9C,MAAM,IAAI,wBAAwB,CAAC;gBACjC,QAAQ;gBACR,kBAAkB,EAAE,CAAC,SAAS,EAAE,KAAK,CAAC;gBACtC,OAAO,EAAE,0DAA0D;aACpE,CAAC,CAAA;QACJ,OAAO,MAAM,CAAC,CAAC,CAAC,CAAA;IAClB,CAAC,CACF,CAAA;IAED,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACrB,MAAM,kBAAkB,GAAG,uBAAuB,CAAC;YACjD,MAAM;YACN,QAAQ,EAAE,gBAAgB;SAC3B,CAAC,CAAA;QACF,OAAO,gBAAgB,CAAC,MAAM,CAAC,MAAM,EAAE;YACrC,YAAY,EAAE;gBACZ;oBACE,EAAE,EAAE,kBAAkB;oBACtB,IAAI,EAAE,kBAAkB,CAAC;wBACvB,GAAG,EAAE,2BAA2B;wBAChC,YAAY,EAAE,WAAW;wBACzB,IAAI,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC;qBAChC,CAAC;iBACH;gBACD;oBACE,EAAE,EAAE,kBAAkB;oBACtB,IAAI,EAAE,kBAAkB,CAAC;wBACvB,GAAG,EAAE,2BAA2B;wBAChC,YAAY,EAAE,WAAW;wBACzB,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC;qBAClB,CAAC;iBACH;aACF;SACF,CAAC,CAAA;IACJ,CAAC;IACD,OAAO;QACL,EAAE,EAAE,uBAAuB,CAAC;YAC1B,MAAM;YACN,QAAQ,EAAE,2BAA2B;SACtC,CAAC;QACF,IAAI,EAAE,kBAAkB,CAAC;YACvB,GAAG,EAAE,sCAAsC;YAC3C,YAAY,EAAE,WAAW;YACzB,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC;SACnC,CAAC;KACH,CAAA;AACH,CAAC,CAAA;AAED,MAAM,MAAM,GAAG,KAAK,EAClB,MAAqB,EACrB,IAAqB,EACrB,EAAE,WAAW,EAAsB,EACN,EAAE;IAC/B,IAAI,OAAO,IAAI,KAAK,QAAQ;QAAE,MAAM,IAAI,CAAA;IACxC,MAAM,aAAa,GAAG,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,CAAA;IAC1E,IAAI,aAAa,EAAE,CAAC;QAClB,MAAM,MAAM,GAAG,MAAM,gBAAgB,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,EAAE,EAAE,CAAC,CAAA;QAC9D,MAAM,KAAK,GAAG,oBAAoB,CAAC;YACjC,GAAG,EAAE,2BAA2B;YAChC,YAAY,EAAE,WAAW;YACzB,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,UAAU;SAC3B,CAAC,CAAA;QACF,MAAM,OAAO,GAAG,oBAAoB,CAAC;YACnC,GAAG,EAAE,2BAA2B;YAChC,YAAY,EAAE,WAAW;YACzB,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,UAAU;SAC3B,CAAC,CAAA;QACF,MAAM,IAAI,GAAG,KAAK,GAAG,OAAO,CAAA;QAC5B,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,CAAA;IAC1B,CAAC;IAED,OAAO,oBAAoB,CAAC;QAC1B,GAAG,EAAE,sCAAsC;QAC3C,YAAY,EAAE,WAAW;QACzB,IAAI;KACL,CAAC,CAAA;AACJ,CAAC,CAAA;AAID;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,QAAQ,GAAG,gBAAgB,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,CAI3B,CAAA;AAEzB,eAAe,QAAQ,CAAA"}