@ensdomains/ensjs 4.0.3-alpha.12 → 4.1.0

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

@@ -0,0 +1,292 @@
+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, gatewayUrls, strict, supportedContentTypes, }: 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, gatewayUrls, strict, }: 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, gatewayUrls, strict, }: 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, allowMismatch, gatewayUrls, strict, }: 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',
+     *   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: <const TTexts extends readonly string[] = readonly string[], const TCoins extends readonly (string | number)[] = readonly (string | number)[], const TContentHash extends boolean = true, const TAbi extends boolean = true>({ name, texts, coins, contentHash, abi, resolver, gatewayUrls, }: GetRecordsParameters<TTexts, TCoins, TContentHash, TAbi>) => Promise<GetRecordsReturnType<TTexts, TCoins, TContentHash, TAbi>>;
+    /**
+     * 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, gatewayUrls, strict, }: 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;

package/dist/clients/decorators/public.js

@@ -0,0 +1,45 @@
+import batch from '../../functions/public/batch.js';
+import getAbiRecord from '../../functions/public/getAbiRecord.js';
+import getAddressRecord from '../../functions/public/getAddressRecord.js';
+import getAvailable from '../../functions/public/getAvailable.js';
+import getContentHashRecord from '../../functions/public/getContentHashRecord.js';
+import getExpiry from '../../functions/public/getExpiry.js';
+import getName from '../../functions/public/getName.js';
+import getOwner from '../../functions/public/getOwner.js';
+import getPrice from '../../functions/public/getPrice.js';
+import getRecords from '../../functions/public/getRecords.js';
+import getResolver from '../../functions/public/getResolver.js';
+import getTextRecord from '../../functions/public/getTextRecord.js';
+import getWrapperData from '../../functions/public/getWrapperData.js';
+import getWrapperName from '../../functions/public/getWrapperName.js';
+/**
+ * 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 const ensPublicActions = (client) => ({
+    ensBatch: (...parameters) => batch(client, ...parameters),
+    getAbiRecord: (parameters) => getAbiRecord(client, parameters),
+    getAddressRecord: (parameters) => getAddressRecord(client, parameters),
+    getAvailable: (parameters) => getAvailable(client, parameters),
+    getContentHashRecord: (parameters) => getContentHashRecord(client, parameters),
+    getExpiry: (parameters) => getExpiry(client, parameters),
+    getName: (parameters) => getName(client, parameters),
+    getOwner: (parameters) => getOwner(client, parameters),
+    getPrice: (parameters) => getPrice(client, parameters),
+    getRecords: (parameters) => getRecords(client, parameters),
+    getResolver: (parameters) => getResolver(client, parameters),
+    getTextRecord: (parameters) => getTextRecord(client, parameters),
+    getWrapperData: (parameters) => getWrapperData(client, parameters),
+    getWrapperName: (parameters) => getWrapperName(client, parameters),
+});
+//# sourceMappingURL=public.js.map

package/dist/clients/decorators/public.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"public.js","sourceRoot":"","sources":["../../../src/clients/decorators/public.ts"],"names":[],"mappings":"AAEA,OAAO,KAGN,MAAM,iCAAiC,CAAA;AACxC,OAAO,YAGN,MAAM,wCAAwC,CAAA;AAC/C,OAAO,gBAGN,MAAM,4CAA4C,CAAA;AACnD,OAAO,YAGN,MAAM,wCAAwC,CAAA;AAC/C,OAAO,oBAGN,MAAM,gDAAgD,CAAA;AACvD,OAAO,SAGN,MAAM,qCAAqC,CAAA;AAC5C,OAAO,OAGN,MAAM,mCAAmC,CAAA;AAC1C,OAAO,QAGN,MAAM,oCAAoC,CAAA;AAC3C,OAAO,QAGN,MAAM,oCAAoC,CAAA;AAC3C,OAAO,UAGN,MAAM,sCAAsC,CAAA;AAC7C,OAAO,WAGN,MAAM,uCAAuC,CAAA;AAC9C,OAAO,aAGN,MAAM,yCAAyC,CAAA;AAChD,OAAO,cAGN,MAAM,0CAA0C,CAAA;AACjD,OAAO,cAGN,MAAM,0CAA0C,CAAA;AAsUjD;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAK9B,MAA4C,EAC1B,EAAE,CAAC,CAAC;IACtB,QAAQ,EAAE,CAAC,GAAG,UAAU,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,GAAG,UAAU,CAAC;IACzD,YAAY,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC,YAAY,CAAC,MAAM,EAAE,UAAU,CAAC;IAC9D,gBAAgB,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC,gBAAgB,CAAC,MAAM,EAAE,UAAU,CAAC;IACtE,YAAY,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC,YAAY,CAAC,MAAM,EAAE,UAAU,CAAC;IAC9D,oBAAoB,EAAE,CAAC,UAAU,EAAE,EAAE,CACnC,oBAAoB,CAAC,MAAM,EAAE,UAAU,CAAC;IAC1C,SAAS,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,EAAE,UAAU,CAAC;IACxD,OAAO,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,UAAU,CAAC;IACpD,QAAQ,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC;IACtD,QAAQ,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC;IACtD,UAAU,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,MAAM,EAAE,UAAU,CAAC;IAC1D,WAAW,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC,WAAW,CAAC,MAAM,EAAE,UAAU,CAAC;IAC5D,aAAa,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC,aAAa,CAAC,MAAM,EAAE,UAAU,CAAC;IAChE,cAAc,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC,cAAc,CAAC,MAAM,EAAE,UAAU,CAAC;IAClE,cAAc,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC,cAAc,CAAC,MAAM,EAAE,UAAU,CAAC;CACnE,CAAC,CAAA"}

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

@@ -0,0 +1,135 @@
+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;

package/dist/clients/decorators/subgraph.js

@@ -0,0 +1,29 @@
+import getDecodedName from '../../functions/subgraph/getDecodedName.js';
+import getNameHistory from '../../functions/subgraph/getNameHistory.js';
+import getNamesForAddress from '../../functions/subgraph/getNamesForAddress.js';
+import getSubgraphRecords from '../../functions/subgraph/getSubgraphRecords.js';
+import getSubgraphRegistrant from '../../functions/subgraph/getSubgraphRegistrant.js';
+import getSubnames from '../../functions/subgraph/getSubnames.js';
+/**
+ * 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 const ensSubgraphActions = (client) => ({
+    getDecodedName: (parameters) => getDecodedName(client, parameters),
+    getNameHistory: (parameters) => getNameHistory(client, parameters),
+    getNamesForAddress: (parameters) => getNamesForAddress(client, parameters),
+    getSubgraphRecords: (parameters) => getSubgraphRecords(client, parameters),
+    getSubgraphRegistrant: (parameters) => getSubgraphRegistrant(client, parameters),
+    getSubnames: (parameters) => getSubnames(client, parameters),
+});
+//# sourceMappingURL=subgraph.js.map

package/dist/clients/decorators/subgraph.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"subgraph.js","sourceRoot":"","sources":["../../../src/clients/decorators/subgraph.ts"],"names":[],"mappings":"AAEA,OAAO,cAGN,MAAM,4CAA4C,CAAA;AACnD,OAAO,cAGN,MAAM,4CAA4C,CAAA;AACnD,OAAO,kBAGN,MAAM,gDAAgD,CAAA;AACvD,OAAO,kBAGN,MAAM,gDAAgD,CAAA;AACvD,OAAO,qBAGN,MAAM,mDAAmD,CAAA;AAC1D,OAAO,WAGN,MAAM,yCAAyC,CAAA;AA6IhD;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAKhC,MAA4C,EACxB,EAAE,CAAC,CAAC;IACxB,cAAc,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC,cAAc,CAAC,MAAM,EAAE,UAAU,CAAC;IAClE,cAAc,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC,cAAc,CAAC,MAAM,EAAE,UAAU,CAAC;IAClE,kBAAkB,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC,kBAAkB,CAAC,MAAM,EAAE,UAAU,CAAC;IAC1E,kBAAkB,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC,kBAAkB,CAAC,MAAM,EAAE,UAAU,CAAC;IAC1E,qBAAqB,EAAE,CAAC,UAAU,EAAE,EAAE,CACpC,qBAAqB,CAAC,MAAM,EAAE,UAAU,CAAC;IAC3C,WAAW,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC,WAAW,CAAC,MAAM,EAAE,UAAU,CAAC;CAC7D,CAAC,CAAA"}