@ensdomains/ensjs 3.0.0-alpha.9 → 3.0.0-beta.10

package/dist/esm/utils/validation.js

@@ -1,67 +1,60 @@
-import { isAddress } from 'ethers/lib/utils';
-import { isEncodedLabelhash, saveName } from './labels';
-import { normalise } from './normalise';
+import { NameWithEmptyLabelsError, RootNameIncludesOtherLabelsError, } from '../errors/utils.js';
+import { MINIMUM_DOT_ETH_CHARS } from './consts.js';
+import { checkLabel, isEncodedLabelhash, saveName } from './labels.js';
+import { normalise, split } from './normalise.js';
 export const validateName = (name) => {
     const nameArray = name.split('.');
-    const hasEmptyLabels = nameArray.some((label) => label.length == 0);
-    if (hasEmptyLabels)
-        throw new Error('Name cannot have empty labels');
-    const normalizedArray = nameArray.map((label) => {
+    const normalisedArray = nameArray.map((label) => {
+        if (label.length === 0)
+            throw new NameWithEmptyLabelsError({ name });
         if (label === '[root]') {
+            if (name !== label)
+                throw new RootNameIncludesOtherLabelsError({ name });
             return label;
         }
-        else {
-            return isEncodedLabelhash(label) ? label : normalise(label);
-        }
+        return isEncodedLabelhash(label)
+            ? checkLabel(label) || label
+            : normalise(label);
     });
-    const normalizedName = normalizedArray.join('.');
-    saveName(normalizedName);
-    return normalizedName;
-};
-export const validateTLD = (name) => {
-    const labels = name.split('.');
-    return validateName(labels[labels.length - 1]);
+    const normalisedName = normalisedArray.join('.');
+    saveName(normalisedName);
+    return normalisedName;
 };
-export const parseInputType = (input) => {
-    const validTLD = validateTLD(input);
-    let regex = /[^.]+$/;
+export const parseInput = (input) => {
+    let nameReference = input;
+    let isValid = false;
     try {
-        validateName(input);
-    }
-    catch (e) {
-        return {
-            type: 'unknown',
-        };
-    }
-    if (input.indexOf('.') !== -1) {
-        const termArray = input.split('.');
-        const tld = input.match(regex) ? input.match(regex)[0] : '';
-        if (validTLD) {
-            if (tld === 'eth' && [...termArray[termArray.length - 2]].length < 3) {
-                // code-point length
-                return {
-                    type: 'name',
-                    info: 'short',
-                };
-            }
-            return {
-                type: 'name',
-                info: 'supported',
-            };
-        }
-        return {
-            type: 'name',
-            info: 'unsupported',
-        };
-    }
-    else if (isAddress(input)) {
-        return {
-            type: 'address',
-        };
+        nameReference = validateName(input);
+        isValid = true;
     }
-    else {
+    catch { }
+    const normalisedName = isValid ? nameReference : undefined;
+    const labels = nameReference.split('.');
+    const tld = labels[labels.length - 1];
+    const isETH = tld === 'eth';
+    const labelDataArray = split(nameReference);
+    const isShort = (labelDataArray[0].output?.length || 0) < MINIMUM_DOT_ETH_CHARS;
+    if (labels.length === 1) {
         return {
             type: 'label',
+            normalised: normalisedName,
+            isShort,
+            isValid,
+            is2LD: false,
+            isETH,
+            labelDataArray,
         };
     }
+    const is2LD = labels.length === 2;
+    return {
+        type: 'name',
+        normalised: normalisedName,
+        isShort: isETH && is2LD ? isShort : false,
+        isValid,
+        is2LD,
+        isETH,
+        labelDataArray,
+    };
 };
+export const checkIsDotEth = (labels) => labels.length === 2 && labels[1] === 'eth';
+//# sourceMappingURL=validation.js.map

package/dist/esm/utils/validation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.js","sourceRoot":"","sources":["../../../src/utils/validation.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,wBAAwB,EACxB,gCAAgC,GACjC,MAAM,oBAAoB,CAAA;AAC3B,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AACnD,OAAO,EAAE,UAAU,EAAE,kBAAkB,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AACtE,OAAO,EAAE,SAAS,EAAE,KAAK,EAAc,MAAM,gBAAgB,CAAA;AAE7D,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,IAAY,EAAE,EAAE;IAC3C,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IACjC,MAAM,eAAe,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;QAC9C,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;YAAE,MAAM,IAAI,wBAAwB,CAAC,EAAE,IAAI,EAAE,CAAC,CAAA;QACpE,IAAI,KAAK,KAAK,QAAQ,EAAE;YACtB,IAAI,IAAI,KAAK,KAAK;gBAAE,MAAM,IAAI,gCAAgC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAA;YACxE,OAAO,KAAK,CAAA;SACb;QACD,OAAO,kBAAkB,CAAC,KAAK,CAAC;YAC9B,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,KAAK;YAC5B,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;IACtB,CAAC,CAAC,CAAA;IACF,MAAM,cAAc,GAAG,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IAChD,QAAQ,CAAC,cAAc,CAAC,CAAA;IACxB,OAAO,cAAc,CAAA;AACvB,CAAC,CAAA;AAYD,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,KAAa,EAAqB,EAAE;IAC7D,IAAI,aAAa,GAAG,KAAK,CAAA;IACzB,IAAI,OAAO,GAAG,KAAK,CAAA;IAEnB,IAAI;QACF,aAAa,GAAG,YAAY,CAAC,KAAK,CAAC,CAAA;QACnC,OAAO,GAAG,IAAI,CAAA;KACf;IAAC,MAAM,GAAE;IAEV,MAAM,cAAc,GAAG,OAAO,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAA;IAE1D,MAAM,MAAM,GAAG,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IACvC,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;IACrC,MAAM,KAAK,GAAG,GAAG,KAAK,KAAK,CAAA;IAC3B,MAAM,cAAc,GAAG,KAAK,CAAC,aAAa,CAAC,CAAA;IAC3C,MAAM,OAAO,GACX,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,MAAM,IAAI,CAAC,CAAC,GAAG,qBAAqB,CAAA;IAEjE,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE;QACvB,OAAO;YACL,IAAI,EAAE,OAAO;YACb,UAAU,EAAE,cAAc;YAC1B,OAAO;YACP,OAAO;YACP,KAAK,EAAE,KAAK;YACZ,KAAK;YACL,cAAc;SACf,CAAA;KACF;IAED,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,KAAK,CAAC,CAAA;IACjC,OAAO;QACL,IAAI,EAAE,MAAM;QACZ,UAAU,EAAE,cAAc;QAC1B,OAAO,EAAE,KAAK,IAAI,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK;QACzC,OAAO;QACP,KAAK;QACL,KAAK;QACL,cAAc;KACf,CAAA;AACH,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,MAAgB,EAAE,EAAE,CAChD,MAAM,CAAC,MAAM,KAAK,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,KAAK,KAAK,CAAA"}

package/dist/esm/utils/wrapper.js

@@ -0,0 +1,20 @@
+import { stringToBytes } from 'viem';
+import { WrappedLabelTooLargeError } from '../errors/utils.js';
+export const MAX_EXPIRY = 2n ** 64n - 1n;
+export const expiryToBigInt = (expiry, defaultValue = 0n) => {
+    if (!expiry)
+        return defaultValue;
+    if (typeof expiry === 'bigint')
+        return expiry;
+    if (typeof expiry === 'string' || typeof expiry === 'number')
+        return BigInt(expiry);
+    if (expiry instanceof Date)
+        return BigInt(Math.floor(expiry.getTime() / 1000));
+    throw new TypeError('Expiry must be a bigint, string, number or Date');
+};
+export const wrappedLabelLengthCheck = (label) => {
+    const bytes = stringToBytes(label);
+    if (bytes.byteLength > 255)
+        throw new WrappedLabelTooLargeError({ label, byteLength: bytes.byteLength });
+};
+//# sourceMappingURL=wrapper.js.map

package/dist/esm/utils/wrapper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"wrapper.js","sourceRoot":"","sources":["../../../src/utils/wrapper.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,MAAM,CAAA;AACpC,OAAO,EAAE,yBAAyB,EAAE,MAAM,oBAAoB,CAAA;AAG9D,MAAM,CAAC,MAAM,UAAU,GAAG,EAAE,IAAI,GAAG,GAAG,EAAE,CAAA;AAExC,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,MAAgB,EAAE,YAAY,GAAG,EAAE,EAAU,EAAE;IAC5E,IAAI,CAAC,MAAM;QAAE,OAAO,YAAY,CAAA;IAChC,IAAI,OAAO,MAAM,KAAK,QAAQ;QAAE,OAAO,MAAM,CAAA;IAC7C,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,OAAO,MAAM,KAAK,QAAQ;QAC1D,OAAO,MAAM,CAAC,MAAM,CAAC,CAAA;IACvB,IAAI,MAAM,YAAY,IAAI;QAAE,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC,CAAA;IAC9E,MAAM,IAAI,SAAS,CAAC,iDAAiD,CAAC,CAAA;AACxE,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,KAAa,EAAE,EAAE;IACvD,MAAM,KAAK,GAAG,aAAa,CAAC,KAAK,CAAC,CAAA;IAClC,IAAI,KAAK,CAAC,UAAU,GAAG,GAAG;QACxB,MAAM,IAAI,yBAAyB,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,KAAK,CAAC,UAAU,EAAE,CAAC,CAAA;AAChF,CAAC,CAAA"}

package/dist/esm/wallet.js

@@ -0,0 +1,19 @@
+export { default as clearRecords, } from './functions/wallet/clearRecords.js';
+export { default as commitName, } from './functions/wallet/commitName.js';
+export { default as createSubname, } from './functions/wallet/createSubname.js';
+export { default as deleteSubname, } from './functions/wallet/deleteSubname.js';
+export { default as registerName, } from './functions/wallet/registerName.js';
+export { default as renewNames, } from './functions/wallet/renewNames.js';
+export { default as setAbiRecord, } from './functions/wallet/setAbiRecord.js';
+export { default as setAddressRecord, } from './functions/wallet/setAddressRecord.js';
+export { default as setChildFuses, } from './functions/wallet/setChildFuses.js';
+export { default as setContentHashRecord, } from './functions/wallet/setContentHashRecord.js';
+export { default as setFuses, } from './functions/wallet/setFuses.js';
+export { default as setPrimaryName, } from './functions/wallet/setPrimaryName.js';
+export { default as setRecords, } from './functions/wallet/setRecords.js';
+export { default as setResolver, } from './functions/wallet/setResolver.js';
+export { default as setTextRecord, } from './functions/wallet/setTextRecord.js';
+export { default as transferName, } from './functions/wallet/transferName.js';
+export { default as unwrapName, } from './functions/wallet/unwrapName.js';
+export { default as wrapName, } from './functions/wallet/wrapName.js';
+//# sourceMappingURL=wallet.js.map

package/dist/esm/wallet.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"wallet.js","sourceRoot":"","sources":["../../src/wallet.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,IAAI,YAAY,GAKxB,MAAM,oCAAoC,CAAA;AAC3C,OAAO,EACL,OAAO,IAAI,UAAU,GAKtB,MAAM,kCAAkC,CAAA;AACzC,OAAO,EACL,OAAO,IAAI,aAAa,GAKzB,MAAM,qCAAqC,CAAA;AAC5C,OAAO,EACL,OAAO,IAAI,aAAa,GAKzB,MAAM,qCAAqC,CAAA;AAC5C,OAAO,EACL,OAAO,IAAI,YAAY,GAKxB,MAAM,oCAAoC,CAAA;AAC3C,OAAO,EACL,OAAO,IAAI,UAAU,GAKtB,MAAM,kCAAkC,CAAA;AACzC,OAAO,EACL,OAAO,IAAI,YAAY,GAKxB,MAAM,oCAAoC,CAAA;AAC3C,OAAO,EACL,OAAO,IAAI,gBAAgB,GAK5B,MAAM,wCAAwC,CAAA;AAC/C,OAAO,EACL,OAAO,IAAI,aAAa,GAKzB,MAAM,qCAAqC,CAAA;AAC5C,OAAO,EACL,OAAO,IAAI,oBAAoB,GAKhC,MAAM,4CAA4C,CAAA;AACnD,OAAO,EACL,OAAO,IAAI,QAAQ,GAKpB,MAAM,gCAAgC,CAAA;AACvC,OAAO,EACL,OAAO,IAAI,cAAc,GAK1B,MAAM,sCAAsC,CAAA;AAC7C,OAAO,EACL,OAAO,IAAI,UAAU,GAKtB,MAAM,kCAAkC,CAAA;AACzC,OAAO,EACL,OAAO,IAAI,WAAW,GAKvB,MAAM,mCAAmC,CAAA;AAC1C,OAAO,EACL,OAAO,IAAI,aAAa,GAKzB,MAAM,qCAAqC,CAAA;AAC5C,OAAO,EACL,OAAO,IAAI,YAAY,GAKxB,MAAM,oCAAoC,CAAA;AAC3C,OAAO,EACL,OAAO,IAAI,UAAU,GAKtB,MAAM,kCAAkC,CAAA;AACzC,OAAO,EACL,OAAO,IAAI,QAAQ,GAKpB,MAAM,gCAAgC,CAAA"}

package/dist/types/clients/decorators/public.d.ts

@@ -0,0 +1,295 @@
+import type { Account, Client, Transport } from 'viem';
+import type { ChainWithEns } from '../../contracts/consts.js';
+import { type BatchParameters, type BatchReturnType } from '../../functions/public/batch.js';
+import { type GetAbiRecordParameters, type GetAbiRecordReturnType } from '../../functions/public/getAbiRecord.js';
+import { type GetAddressRecordParameters, type GetAddressRecordReturnType } from '../../functions/public/getAddressRecord.js';
+import { type GetAvailableParameters, type GetAvailableReturnType } from '../../functions/public/getAvailable.js';
+import { type GetContentHashRecordParameters, type GetContentHashRecordReturnType } from '../../functions/public/getContentHashRecord.js';
+import { type GetExpiryParameters, type GetExpiryReturnType } from '../../functions/public/getExpiry.js';
+import { type GetNameParameters, type GetNameReturnType } from '../../functions/public/getName.js';
+import { type GetOwnerParameters, type GetOwnerReturnType } from '../../functions/public/getOwner.js';
+import { type GetPriceParameters, type GetPriceReturnType } from '../../functions/public/getPrice.js';
+import { type GetRecordsParameters, type GetRecordsReturnType } from '../../functions/public/getRecords.js';
+import { type GetResolverParameters, type GetResolverReturnType } from '../../functions/public/getResolver.js';
+import { type GetTextRecordParameters, type GetTextRecordReturnType } from '../../functions/public/getTextRecord.js';
+import { type GetWrapperDataParameters, type GetWrapperDataReturnType } from '../../functions/public/getWrapperData.js';
+import { type GetWrapperNameParameters, type GetWrapperNameReturnType } from '../../functions/public/getWrapperName.js';
+export type EnsPublicActions = {
+    /**
+     * Batches multiple read functions into a single call.
+     * @param ...parameters - Array of {@link BatchFunctionResult} objects
+     * @returns Array of return values from each function
+     *
+     * @example
+     * import { createPublicClient, http } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     * import { addEnsContracts, ensPublicActions, getTextRecord, getAddressRecord } from '@ensdomains/ensjs'
+     *
+     * const client = createPublicClient({
+     *   chain: addEnsContracts(mainnet),
+     *   transport: http(),
+     * }).extend(ensPublicActions)
+     * const result = await client.ensBatch(
+     *   getTextRecord.batch({ name: 'ens.eth', key: 'com.twitter' }),
+     *   getAddressRecord.batch({ name: 'ens.eth', coin: 'ETH' }),
+     * )
+     * // ['ensdomains', { id: 60, name: 'ETH', value: '0xFe89cc7aBB2C4183683ab71653C4cdc9B02D44b7 }]
+     */
+    ensBatch: <TBatchFunctions extends BatchParameters>(...parameters: TBatchFunctions) => Promise<BatchReturnType<TBatchFunctions>>;
+    /**
+     * Gets the ABI record for a name
+     * @param parameters - {@link GetAbiRecordParameters}
+     * @returns ABI record for the name, or `null` if not found. {@link GetAbiRecordReturnType}
+     *
+     * @example
+     * import { createPublicClient, http } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     * import { addEnsContracts, ensPublicActions } from '@ensdomains/ensjs'
+     *
+     * const client = createPublicClient({
+     *   chain: addEnsContracts(mainnet),
+     *   transport: http(),
+     * }).extend(ensPublicActions)
+     * const result = await client.getAbiRecord({ name: 'ens.eth' })
+     * // TODO: real example
+     */
+    getAbiRecord: ({ name, }: GetAbiRecordParameters) => Promise<GetAbiRecordReturnType>;
+    /**
+     * Gets an address record for a name and specified coin
+     * @param parameters - {@link GetAddressRecordParameters}
+     * @returns Coin value object, or `null` if not found. {@link GetAddressRecordReturnType}
+     *
+     * @example
+     * import { createPublicClient, http } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     * import { addEnsContracts, ensPublicActions } from '@ensdomains/ensjs'
+     *
+     * const client = createPublicClient({
+     *   chain: addEnsContracts(mainnet),
+     *   transport: http(),
+     * }).extend(ensPublicActions)
+     * const result = await client.getAddressRecord({ name: 'ens.eth', coin: 'ETH' })
+     * // { id: 60, name: 'ETH , value: '0xFe89cc7aBB2C4183683ab71653C4cdc9B02D44b7' }
+     */
+    getAddressRecord: ({ name, coin, bypassFormat, }: GetAddressRecordParameters) => Promise<GetAddressRecordReturnType>;
+    /**
+     * Gets the availability of a name to register
+     * @param parameters - {@link GetAvailableParameters}
+     * @returns Availability as boolean. {@link GetAvailableReturnType}
+     *
+     * @example
+     * import { createPublicClient, http } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     * import { addEnsContracts, ensPublicActions } from '@ensdomains/ensjs'
+     *
+     * const client = createPublicClient({
+     *   chain: addEnsContracts(mainnet),
+     *   transport: http(),
+     * }).extend(ensPublicActions)
+     * const result = await client.getAvailable({ name: 'ens.eth' })
+     * // false
+     */
+    getAvailable: ({ name, }: GetAvailableParameters) => Promise<GetAvailableReturnType>;
+    /**
+     * Gets the content hash record for a name
+     * @param parameters - {@link GetContentHashRecordParameters}
+     * @returns Content hash object, or `null` if not found. {@link GetContentHashRecordReturnType}
+     *
+     * @example
+     * import { createPublicClient, http } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     * import { addEnsContracts, ensPublicActions } from '@ensdomains/ensjs'
+     *
+     * const client = createPublicClient({
+     *   chain: addEnsContracts(mainnet),
+     *   transport: http(),
+     * }).extend(ensPublicActions)
+     * const result = await client.getContentHashRecord({ name: 'ens.eth' })
+     * // { protocolType: 'ipfs', decoded: 'k51qzi5uqu5djdczd6zw0grmo23j2vkj9uzvujencg15s5rlkq0ss4ivll8wqw' }
+     */
+    getContentHashRecord: ({ name, }: GetContentHashRecordParameters) => Promise<GetContentHashRecordReturnType>;
+    /**
+     * Gets the expiry for a name
+     * @param parameters - {@link GetExpiryParameters}
+     * @returns Expiry object, or `null` if no expiry. {@link GetExpiryReturnType}
+     *
+     * @example
+     * import { createPublicClient, http } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     * import { addEnsContracts, ensPublicActions } from '@ensdomains/ensjs'
+     *
+     * const client = createPublicClient({
+     *   chain: addEnsContracts(mainnet),
+     *   transport: http(),
+     * }).extend(ensPublicActions)
+     * const result = await client.getExpiry({ name: 'ens.eth' })
+     * // { expiry: { date: Date, value: 1913933217n }, gracePeriod: 7776000, status: 'active' }
+     */
+    getExpiry: ({ name, contract, }: GetExpiryParameters) => Promise<GetExpiryReturnType>;
+    /**
+     * Gets the primary name for an address
+     * @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, ensPublicActions } from '@ensdomains/ensjs'
+     *
+     * const client = createPublicClient({
+     *   chain: addEnsContracts(mainnet),
+     *   transport: http(),
+     * }).extend(ensPublicActions)
+     * const result = await client.getName({ address: '0xb8c2C29ee19D8307cb7255e1Cd9CbDE883A267d5' })
+     * // { name: 'nick.eth', match: true, reverseResolverAddress: '0xa2c122be93b0074270ebee7f6b7292c7deb45047', resolverAddress: '0x4976fb03c32e5b8cfe2b6ccb31c09ba78ebaba41' }
+     */
+    getName: ({ address }: GetNameParameters) => Promise<GetNameReturnType>;
+    /**
+     * Gets the owner(s) of a name.
+     * @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, ensPublicActions } from '@ensdomains/ensjs'
+     *
+     * const client = createPublicClient({
+     *   chain: addEnsContracts(mainnet),
+     *   transport: http(),
+     * }).extend(ensPublicActions)
+     * const result = await client.getOwner({ name: 'ens.eth' })
+     * // { owner: '0xb6E040C9ECAaE172a89bD561c5F73e1C48d28cd9', registrant: '0xb6E040C9ECAaE172a89bD561c5F73e1C48d28cd9', ownershipLevel: 'registrar }
+     */
+    getOwner: ({ name, contract, }: GetOwnerParameters) => Promise<GetOwnerReturnType>;
+    /**
+     * Gets the price of a name, or array of names, for a given duration.
+     * @param parameters - {@link GetPriceParameters}
+     * @returns Price data object. {@link GetPriceReturnType}
+     *
+     * @example
+     * import { createPublicClient, http } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     * import { addEnsContracts, ensPublicActions } from '@ensdomains/ensjs'
+     *
+     * const client = createPublicClient({
+     *   chain: addEnsContracts(mainnet),
+     *   transport: http(),
+     * }).extend(ensPublicActions)
+     * const result = await client.getPrice({ nameOrNames: 'ens.eth' })
+     * // { base: 352828971668930335n, premium: 0n }
+     */
+    getPrice: ({ nameOrNames, duration, }: GetPriceParameters) => Promise<GetPriceReturnType>;
+    /**
+     * Gets arbitrary records for a name
+     * @param parameters - {@link GetRecordsParameters}
+     * @returns Records data object. {@link GetRecordsReturnType}
+     *
+     * @example
+     * import { createPublicClient, http } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     * import { addEnsContracts, ensPublicActions } from '@ensdomains/ensjs'
+     *
+     * const client = createPublicClient({
+     *   chain: addEnsContracts(mainnet),
+     *   transport: http(),
+     * }).extend(ensPublicActions)
+     * const result = await client.getRecords({
+     *   name: 'ens.eth',
+     *   records: {
+     *     texts: ['com.twitter', 'com.github'],
+     *     coins: ['ETH'],
+     *     contentHash: true,
+     *   },
+     * })
+     * // { texts: [{ key: 'com.twitter', value: 'ensdomains' }, { key: 'com.github', value: 'ensdomains' }], coins: [{ id: 60, name: 'ETH', value: '0xFe89cc7aBB2C4183683ab71653C4cdc9B02D44b7' }], contentHash: { protocolType: 'ipns', decoded: 'k51qzi5uqu5djdczd6zw0grmo23j2vkj9uzvujencg15s5rlkq0ss4ivll8wqw' } }
+     */
+    getRecords: ({ name, records, resolver, }: GetRecordsParameters) => Promise<GetRecordsReturnType>;
+    /**
+     * Gets the resolver address for a name.
+     * @param parameters - {@link GetResolverParameters}
+     * @returns Resolver address, or null if none is found. {@link GetResolverReturnType}
+     *
+     * @example
+     * import { createPublicClient, http } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     * import { addEnsContracts, ensPublicActions } from '@ensdomains/ensjs'
+     *
+     * const client = createPublicClient({
+     *   chain: addEnsContracts(mainnet),
+     *   transport: http(),
+     * }).extend(ensPublicActions)
+     * const result = await client.getResolver({ name: 'ens.eth' })
+     * // 0x4976fb03C32e5B8cfe2b6cCB31c09Ba78EBaBa41
+     */
+    getResolver: ({ name, }: GetResolverParameters) => Promise<GetResolverReturnType>;
+    /**
+     * Gets a text record for a name.
+     * @param parameters - {@link GetTextRecordParameters}
+     * @returns Text record string, or null if none is found. {@link GetTextRecordReturnType}
+     *
+     * @example
+     * import { createPublicClient, http } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     * import { addEnsContracts, ensPublicActions } from '@ensdomains/ensjs'
+     *
+     * const client = createPublicClient({
+     *   chain: addEnsContracts(mainnet),
+     *   transport: http(),
+     * }).extend(ensPublicActions)
+     * const result = await client.getTextRecord({ name: 'ens.eth', key: 'com.twitter' })
+     * // ensdomains
+     */
+    getTextRecord: ({ name, key, }: GetTextRecordParameters) => Promise<GetTextRecordReturnType>;
+    /**
+     * Gets the wrapper data for a name.
+     * @param parameters - {@link GetWrapperDataParameters}
+     * @returns Wrapper data object, or null if name is not wrapped. {@link GetWrapperDataReturnType}
+     *
+     * @example
+     * import { createPublicClient, http } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     * import { addEnsContracts, ensPublicActions } from '@ensdomains/ensjs'
+     *
+     * const client = createPublicClient({
+     *   chain: addEnsContracts(mainnet),
+     *   transport: http(),
+     * }).extend(ensPublicActions)
+     * const result = await client.getWrapperData({ name: 'ilikelasagna.eth' })
+     */
+    getWrapperData: ({ name, }: GetWrapperDataParameters) => Promise<GetWrapperDataReturnType>;
+    /**
+     * Gets the full name for a name with unknown labels from the NameWrapper.
+     * @param parameters - {@link GetWrapperNameParameters}
+     * @returns Full name, or null if name was not found. {@link GetWrapperNameReturnType}
+     *
+     * @example
+     * import { createPublicClient, http } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     * import { addEnsContracts, ensPublicActions } from '@ensdomains/ensjs'
+     *
+     * const client = createPublicClient({
+     *   chain: addEnsContracts(mainnet),
+     *   transport: http(),
+     * }).extend(ensPublicActions)
+     * const result = await client.getWrapperName({ name: '[4ca938ec1b323ca71c4fb47a712abb68cce1cabf39ea4d6789e42fbc1f95459b].eth' })
+     * // wrapped.eth
+     */
+    getWrapperName: ({ name, }: GetWrapperNameParameters) => Promise<GetWrapperNameReturnType>;
+};
+/**
+ * Extends the viem client with ENS public actions
+ * @param client - The viem {@link Client} object to add the ENS public actions to
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { addEnsContracts, ensPublicActions } from '@ensdomains/ensjs'
+ *
+ * const clientWithEns = createPublicClient({
+ *   chain: addEnsContracts(mainnet),
+ *   transport: http(),
+ * }).extend(ensPublicActions)
+ */
+export declare const ensPublicActions: <TTransport extends Transport = Transport, TChain extends ChainWithEns = ChainWithEns, TAccount extends Account | undefined = Account | undefined>(client: Client<TTransport, TChain, TAccount>) => EnsPublicActions;
+//# sourceMappingURL=public.d.ts.map

package/dist/types/clients/decorators/public.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"public.d.ts","sourceRoot":"","sources":["../../../../src/clients/decorators/public.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,MAAM,CAAA;AACtD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAC7D,OAAc,EACZ,KAAK,eAAe,EACpB,KAAK,eAAe,EACrB,MAAM,iCAAiC,CAAA;AACxC,OAAqB,EACnB,KAAK,sBAAsB,EAC3B,KAAK,sBAAsB,EAC5B,MAAM,wCAAwC,CAAA;AAC/C,OAAyB,EACvB,KAAK,0BAA0B,EAC/B,KAAK,0BAA0B,EAChC,MAAM,4CAA4C,CAAA;AACnD,OAAqB,EACnB,KAAK,sBAAsB,EAC3B,KAAK,sBAAsB,EAC5B,MAAM,wCAAwC,CAAA;AAC/C,OAA6B,EAC3B,KAAK,8BAA8B,EACnC,KAAK,8BAA8B,EACpC,MAAM,gDAAgD,CAAA;AACvD,OAAkB,EAChB,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,EACzB,MAAM,qCAAqC,CAAA;AAC5C,OAAgB,EACd,KAAK,iBAAiB,EACtB,KAAK,iBAAiB,EACvB,MAAM,mCAAmC,CAAA;AAC1C,OAAiB,EACf,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,EACxB,MAAM,oCAAoC,CAAA;AAC3C,OAAiB,EACf,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,EACxB,MAAM,oCAAoC,CAAA;AAC3C,OAAmB,EACjB,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EAC1B,MAAM,sCAAsC,CAAA;AAC7C,OAAoB,EAClB,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,EAC3B,MAAM,uCAAuC,CAAA;AAC9C,OAAsB,EACpB,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC7B,MAAM,yCAAyC,CAAA;AAChD,OAAuB,EACrB,KAAK,wBAAwB,EAC7B,KAAK,wBAAwB,EAC9B,MAAM,0CAA0C,CAAA;AACjD,OAAuB,EACrB,KAAK,wBAAwB,EAC7B,KAAK,wBAAwB,EAC9B,MAAM,0CAA0C,CAAA;AAEjD,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;;;;;;;;;;;;;;;;;;OAmBG;IACH,QAAQ,EAAE,CAAC,eAAe,SAAS,eAAe,EAChD,GAAG,UAAU,EAAE,eAAe,KAC3B,OAAO,CAAC,eAAe,CAAC,eAAe,CAAC,CAAC,CAAA;IAC9C;;;;;;;;;;;;;;;;OAgBG;IACH,YAAY,EAAE,CAAC,EACb,IAAI,GACL,EAAE,sBAAsB,KAAK,OAAO,CAAC,sBAAsB,CAAC,CAAA;IAC7D;;;;;;;;;;;;;;;;OAgBG;IACH,gBAAgB,EAAE,CAAC,EACjB,IAAI,EACJ,IAAI,EACJ,YAAY,GACb,EAAE,0BAA0B,KAAK,OAAO,CAAC,0BAA0B,CAAC,CAAA;IACrE;;;;;;;;;;;;;;;;OAgBG;IACH,YAAY,EAAE,CAAC,EACb,IAAI,GACL,EAAE,sBAAsB,KAAK,OAAO,CAAC,sBAAsB,CAAC,CAAA;IAC7D;;;;;;;;;;;;;;;;OAgBG;IACH,oBAAoB,EAAE,CAAC,EACrB,IAAI,GACL,EAAE,8BAA8B,KAAK,OAAO,CAAC,8BAA8B,CAAC,CAAA;IAC7E;;;;;;;;;;;;;;;;OAgBG;IACH,SAAS,EAAE,CAAC,EACV,IAAI,EACJ,QAAQ,GACT,EAAE,mBAAmB,KAAK,OAAO,CAAC,mBAAmB,CAAC,CAAA;IACvD;;;;;;;;;;;;;;;;OAgBG;IACH,OAAO,EAAE,CAAC,EAAE,OAAO,EAAE,EAAE,iBAAiB,KAAK,OAAO,CAAC,iBAAiB,CAAC,CAAA;IACvE;;;;;;;;;;;;;;;;OAgBG;IACH,QAAQ,EAAE,CAAC,EACT,IAAI,EACJ,QAAQ,GACT,EAAE,kBAAkB,KAAK,OAAO,CAAC,kBAAkB,CAAC,CAAA;IACrD;;;;;;;;;;;;;;;;OAgBG;IACH,QAAQ,EAAE,CAAC,EACT,WAAW,EACX,QAAQ,GACT,EAAE,kBAAkB,KAAK,OAAO,CAAC,kBAAkB,CAAC,CAAA;IACrD;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,UAAU,EAAE,CAAC,EACX,IAAI,EACJ,OAAO,EACP,QAAQ,GACT,EAAE,oBAAoB,KAAK,OAAO,CAAC,oBAAoB,CAAC,CAAA;IACzD;;;;;;;;;;;;;;;;OAgBG;IACH,WAAW,EAAE,CAAC,EACZ,IAAI,GACL,EAAE,qBAAqB,KAAK,OAAO,CAAC,qBAAqB,CAAC,CAAA;IAC3D;;;;;;;;;;;;;;;;OAgBG;IACH,aAAa,EAAE,CAAC,EACd,IAAI,EACJ,GAAG,GACJ,EAAE,uBAAuB,KAAK,OAAO,CAAC,uBAAuB,CAAC,CAAA;IAC/D;;;;;;;;;;;;;;;OAeG;IACH,cAAc,EAAE,CAAC,EACf,IAAI,GACL,EAAE,wBAAwB,KAAK,OAAO,CAAC,wBAAwB,CAAC,CAAA;IACjE;;;;;;;;;;;;;;;;OAgBG;IACH,cAAc,EAAE,CAAC,EACf,IAAI,GACL,EAAE,wBAAwB,KAAK,OAAO,CAAC,wBAAwB,CAAC,CAAA;CAClE,CAAA;AAED;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,gBAAgB,sMAM1B,gBAgBD,CAAA"}

package/dist/types/clients/decorators/subgraph.d.ts

@@ -0,0 +1,136 @@
+import type { Account, Client, Transport } from 'viem';
+import type { ChainWithEns } from '../../contracts/consts.js';
+import { type GetDecodedNameParameters, type GetDecodedNameReturnType } from '../../functions/subgraph/getDecodedName.js';
+import { type GetNameHistoryParameters, type GetNameHistoryReturnType } from '../../functions/subgraph/getNameHistory.js';
+import { type GetNamesForAddressParameters, type GetNamesForAddressReturnType } from '../../functions/subgraph/getNamesForAddress.js';
+import { type GetSubgraphRecordsParameters, type GetSubgraphRecordsReturnType } from '../../functions/subgraph/getSubgraphRecords.js';
+import { type GetSubgraphRegistrantParameters, type GetSubgraphRegistrantReturnType } from '../../functions/subgraph/getSubgraphRegistrant.js';
+import { type GetSubnamesParameters, type GetSubnamesReturnType } from '../../functions/subgraph/getSubnames.js';
+export type EnsSubgraphActions = {
+    /**
+     * Gets the full name for a name with unknown labels from the subgraph.
+     * @param parameters - {@link GetDecodedNameParameters}
+     * @returns Full name, or null if name was could not be filled. {@link GetDecodedNameReturnType}
+     *
+     * @example
+     * import { createPublicClient, http } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     * import { addEnsContracts, ensSubgraphActions } from '@ensdomains/ensjs'
+     *
+     * const client = createPublicClient({
+     *   chain: addEnsContracts(mainnet),
+     *   transport: http(),
+     * }).extend(ensSubgraphActions)
+     * const result = await client.getDecodedName({ name: '[5cee339e13375638553bdf5a6e36ba80fb9f6a4f0783680884d92b558aa471da].eth' })
+     * // ens.eth
+     */
+    getDecodedName: ({ name, allowIncomplete, }: GetDecodedNameParameters) => Promise<GetDecodedNameReturnType>;
+    /**
+     * Gets the history of a name from the subgraph.
+     * @param parameters - {@link GetNameHistoryParameters}
+     * @returns History object, or null if name could not be found. {@link GetNameHistoryReturnType}
+     *
+     * @example
+     * import { createPublicClient, http } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     * import { addEnsContracts, ensSubgraphActions } from '@ensdomains/ensjs'
+     *
+     * const client = createPublicClient({
+     *   chain: addEnsContracts(mainnet),
+     *   transport: http(),
+     * }).extend(ensSubgraphActions)
+     * const result = await client.getNameHistory({ name: 'ens.eth' })
+     */
+    getNameHistory: ({ name, }: GetNameHistoryParameters) => Promise<GetNameHistoryReturnType>;
+    /**
+     * Gets the names for an address from the subgraph.
+     * @param parameters - {@link GetNamesForAddressParameters}
+     * @returns Name array. {@link GetNamesForAddressReturnType}
+     *
+     * @example
+     * import { createPublicClient, http } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     * import { addEnsContracts, ensSubgraphActions } from '@ensdomains/ensjs'
+     *
+     * const client = createPublicClient({
+     *   chain: addEnsContracts(mainnet),
+     *   transport: http(),
+     * }).extend(ensSubgraphActions)
+     * const result = await client.getNamesForAddress({ address: '0xFe89cc7aBB2C4183683ab71653C4cdc9B02D44b7' })
+     */
+    getNamesForAddress: ({ address, filter, orderBy, orderDirection, pageSize, previousPage, }: GetNamesForAddressParameters) => Promise<GetNamesForAddressReturnType>;
+    /**
+     * Gets the records for a name from the subgraph
+     * @param parameters - {@link GetSubgraphRecordsParameters}
+     * @returns Record object, or null if name was not found. {@link GetSubgraphRecordsReturnType}
+     *
+     * @example
+     * import { createPublicClient, http } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     * import { addEnsContracts, ensSubgraphActions } from '@ensdomains/ensjs'
+     *
+     * const client = createPublicClient({
+     *   chain: addEnsContracts(mainnet),
+     *   transport: http(),
+     * }).extend(ensSubgraphActions)
+     * const result = await client.getSubgraphRecords({ name: 'ens.eth' })
+     * // {
+     * //   isMigrated: true,
+     * //   createdAt: { date: 2019-08-26T05:09:01.000Z, value: 1566796141000 },
+     * //   texts: [ 'snapshot', 'url', 'avatar', 'com.twitter', 'com.github' ],
+     * //   coins: [ '60' ]
+     * // }
+     */
+    getSubgraphRecords: ({ name, resolverAddress, }: GetSubgraphRecordsParameters) => Promise<GetSubgraphRecordsReturnType>;
+    /**
+     * Gets the name registrant from the subgraph.
+     * @param parameters - {@link GetSubgraphRegistrantParameters}
+     * @returns Registrant address, or null if name was not found. {@link GetSubgraphRegistrantReturnType}
+     *
+     * @example
+     * import { createPublicClient, http } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     * import { addEnsContracts, ensSubgraphActions } from '@ensdomains/ensjs'
+     *
+     * const client = createPublicClient({
+     *   chain: addEnsContracts(mainnet),
+     *   transport: http(),
+     * }).extend(ensSubgraphActions)
+     * const result = await client.getSubgraphRegistrant({ name: 'ens.eth' })
+     * // 0xb6E040C9ECAaE172a89bD561c5F73e1C48d28cd9
+     */
+    getSubgraphRegistrant: ({ name, }: GetSubgraphRegistrantParameters) => Promise<GetSubgraphRegistrantReturnType>;
+    /**
+     * Gets the subnames for a name from the subgraph.
+     * @param parameters - {@link GetSubnamesParameters}
+     * @returns Subname array. {@link GetSubnamesReturnType}
+     *
+     * @example
+     * import { createPublicClient, http } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     * import { addEnsContracts, ensSubgraphActions } from '@ensdomains/ensjs'
+     *
+     * const client = createPublicClient({
+     *   chain: addEnsContracts(mainnet),
+     *   transport: http(),
+     * }).extend(ensSubgraphActions)
+     * const result = await client.getSubnames({ name: 'ens.eth' })
+     */
+    getSubnames: ({ name, searchString, allowExpired, allowDeleted, orderBy, orderDirection, pageSize, previousPage, }: GetSubnamesParameters) => Promise<GetSubnamesReturnType>;
+};
+/**
+ * Extends the viem client with ENS subgraph actions
+ * @param client - The viem {@link Client} object to add the ENS subgraph actions to
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { addEnsContracts, ensSubgraphActions } from '@ensdomains/ensjs'
+ *
+ * const clientWithEns = createPublicClient({
+ *   chain: addEnsContracts(mainnet),
+ *   transport: http(),
+ * }).extend(ensSubgraphActions)
+ */
+export declare const ensSubgraphActions: <TTransport extends Transport = Transport, TChain extends ChainWithEns = ChainWithEns, TAccount extends Account | undefined = Account | undefined>(client: Client<TTransport, TChain, TAccount>) => EnsSubgraphActions;
+//# sourceMappingURL=subgraph.d.ts.map

package/dist/types/clients/decorators/subgraph.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"subgraph.d.ts","sourceRoot":"","sources":["../../../../src/clients/decorators/subgraph.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,MAAM,CAAA;AACtD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAC7D,OAAuB,EACrB,KAAK,wBAAwB,EAC7B,KAAK,wBAAwB,EAC9B,MAAM,4CAA4C,CAAA;AACnD,OAAuB,EACrB,KAAK,wBAAwB,EAC7B,KAAK,wBAAwB,EAC9B,MAAM,4CAA4C,CAAA;AACnD,OAA2B,EACzB,KAAK,4BAA4B,EACjC,KAAK,4BAA4B,EAClC,MAAM,gDAAgD,CAAA;AACvD,OAA2B,EACzB,KAAK,4BAA4B,EACjC,KAAK,4BAA4B,EAClC,MAAM,gDAAgD,CAAA;AACvD,OAA8B,EAC5B,KAAK,+BAA+B,EACpC,KAAK,+BAA+B,EACrC,MAAM,mDAAmD,CAAA;AAC1D,OAAoB,EAClB,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,EAC3B,MAAM,yCAAyC,CAAA;AAEhD,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;;;;;;;;;;;;;;;OAgBG;IACH,cAAc,EAAE,CAAC,EACf,IAAI,EACJ,eAAe,GAChB,EAAE,wBAAwB,KAAK,OAAO,CAAC,wBAAwB,CAAC,CAAA;IACjE;;;;;;;;;;;;;;;OAeG;IACH,cAAc,EAAE,CAAC,EACf,IAAI,GACL,EAAE,wBAAwB,KAAK,OAAO,CAAC,wBAAwB,CAAC,CAAA;IACjE;;;;;;;;;;;;;;;OAeG;IACH,kBAAkB,EAAE,CAAC,EACnB,OAAO,EACP,MAAM,EACN,OAAO,EACP,cAAc,EACd,QAAQ,EACR,YAAY,GACb,EAAE,4BAA4B,KAAK,OAAO,CAAC,4BAA4B,CAAC,CAAA;IACzE;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,kBAAkB,EAAE,CAAC,EACnB,IAAI,EACJ,eAAe,GAChB,EAAE,4BAA4B,KAAK,OAAO,CAAC,4BAA4B,CAAC,CAAA;IACzE;;;;;;;;;;;;;;;;OAgBG;IACH,qBAAqB,EAAE,CAAC,EACtB,IAAI,GACL,EAAE,+BAA+B,KAAK,OAAO,CAAC,+BAA+B,CAAC,CAAA;IAC/E;;;;;;;;;;;;;;;OAeG;IACH,WAAW,EAAE,CAAC,EACZ,IAAI,EACJ,YAAY,EACZ,YAAY,EACZ,YAAY,EACZ,OAAO,EACP,cAAc,EACd,QAAQ,EACR,YAAY,GACb,EAAE,qBAAqB,KAAK,OAAO,CAAC,qBAAqB,CAAC,CAAA;CAC5D,CAAA;AAED;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,kBAAkB,sMAM5B,kBAQD,CAAA"}