@ensdomains/ensjs 4.0.3-alpha.12 → 4.1.1

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

@@ -0,0 +1,475 @@
+import type { Account, Transport, WalletClient } from 'viem';
+import type { ChainWithEns } from '../../contracts/consts.js';
+import { type ClearRecordsParameters, type ClearRecordsReturnType } from '../../functions/wallet/clearRecords.js';
+import { type CommitNameParameters, type CommitNameReturnType } from '../../functions/wallet/commitName.js';
+import { type CreateSubnameParameters, type CreateSubnameReturnType } from '../../functions/wallet/createSubname.js';
+import { type DeleteSubnameParameters, type DeleteSubnameReturnType } from '../../functions/wallet/deleteSubname.js';
+import { type RegisterNameParameters, type RegisterNameReturnType } from '../../functions/wallet/registerName.js';
+import { type RenewNamesParameters, type RenewNamesReturnType } from '../../functions/wallet/renewNames.js';
+import { type SetAbiRecordParameters, type SetAbiRecordReturnType } from '../../functions/wallet/setAbiRecord.js';
+import { type SetAddressRecordParameters, type SetAddressRecordReturnType } from '../../functions/wallet/setAddressRecord.js';
+import { type SetChildFusesParameters, type SetChildFusesReturnType } from '../../functions/wallet/setChildFuses.js';
+import { type SetContentHashRecordParameters, type SetContentHashRecordReturnType } from '../../functions/wallet/setContentHashRecord.js';
+import { type SetFusesParameters, type SetFusesReturnType } from '../../functions/wallet/setFuses.js';
+import { type SetPrimaryNameParameters, type SetPrimaryNameReturnType } from '../../functions/wallet/setPrimaryName.js';
+import { type SetRecordsParameters, type SetRecordsReturnType } from '../../functions/wallet/setRecords.js';
+import { type SetResolverParameters, type SetResolverReturnType } from '../../functions/wallet/setResolver.js';
+import { type SetTextRecordParameters, type SetTextRecordReturnType } from '../../functions/wallet/setTextRecord.js';
+import { type TransferNameParameters, type TransferNameReturnType } from '../../functions/wallet/transferName.js';
+import { type UnwrapNameParameters, type UnwrapNameReturnType } from '../../functions/wallet/unwrapName.js';
+import { type WrapNameParameters, type WrapNameReturnType } from '../../functions/wallet/wrapName.js';
+export type EnsWalletActions<TChain extends ChainWithEns, TAccount extends Account | undefined> = {
+    /**
+     * Clears the records for a name on a resolver.
+     * @param parameters - {@link ClearRecordsParameters}
+     * @returns Transaction hash. {@link ClearRecordsReturnType}
+     *
+     * @example
+     * import { createWalletClient, custom } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     * import { addEnsContracts, ensWalletActions } from '@ensdomains/ensjs'
+     *
+     * const wallet = createWalletClient({
+     *   chain: addEnsContracts(mainnet),
+     *   transport: custom(window.ethereum),
+     * }).extend(ensWalletActions)
+     * const hash = await wallet.clearRecords({
+     *   name: 'ens.eth',
+     *   resolverAddress: '0x4976fb03C32e5B8cfe2b6cCB31c09Ba78EBaBa41',
+     * })
+     * // 0x...
+     */
+    clearRecords: ({ name, resolverAddress, ...txArgs }: ClearRecordsParameters<TChain, TAccount, TChain>) => Promise<ClearRecordsReturnType>;
+    /**
+     * Commits a name to be registered
+     * @param parameters - {@link CommitNameParameters}
+     * @returns Transaction hash. {@link CommitNameReturnType}
+     *
+     * @example
+     * import { createWalletClient, custom } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     * import { addEnsContracts, ensWalletActions } from '@ensdomains/ensjs'
+     * import { randomSecret } from '@ensdomains/ensjs/utils'
+     *
+     * const wallet = createWalletClient({
+     *   chain: addEnsContracts(mainnet),
+     *   transport: custom(window.ethereum),
+     * }).extend(ensWalletActions)
+     * const secret = randomSecret()
+     * const hash = await wallet.commitName({
+     *   name: 'example.eth',
+     *   owner: '0xFe89cc7aBB2C4183683ab71653C4cdc9B02D44b7',
+     *   duration: 31536000, // 1 year
+     *   secret,
+     * })
+     * // 0x...
+     */
+    commitName: ({ name, owner, duration, secret, resolverAddress, records, reverseRecord, fuses, ...txArgs }: CommitNameParameters<TChain, TAccount, TChain>) => Promise<CommitNameReturnType>;
+    /**
+     * Creates a subname
+     * @param parameters - {@link CreateSubnameParameters}
+     * @returns Transaction hash. {@link CreateSubnameReturnType}
+     *
+     * @example
+     * import { createWalletClient, custom } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     * import { addEnsContracts, ensWalletActions } from '@ensdomains/ensjs'
+     *
+     * const wallet = createWalletClient({
+     *   chain: addEnsContracts(mainnet),
+     *   transport: custom(window.ethereum),
+     * }).extend(ensWalletActions)
+     * const hash = await wallet.createSubname({
+     *   name: 'sub.ens.eth',
+     *   owner: '0xFe89cc7aBB2C4183683ab71653C4cdc9B02D44b7',
+     *   contract: 'registry',
+     * })
+     * // 0x...
+     */
+    createSubname: ({ name, contract, owner, resolverAddress, expiry, fuses, ...txArgs }: CreateSubnameParameters<TChain, TAccount, TChain>) => Promise<CreateSubnameReturnType>;
+    /**
+     * Deletes a subname
+     * @param parameters - {@link DeleteSubnameParameters}
+     * @returns Transaction hash. {@link DeleteSubnameReturnType}
+     *
+     * @example
+     * import { createWalletClient, custom } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     * import { addEnsContracts, ensWalletActions } from '@ensdomains/ensjs'
+     *
+     * const wallet = createWalletClient({
+     *   chain: addEnsContracts(mainnet),
+     *   transport: custom(window.ethereum),
+     * }).extend(ensWalletActions)
+     * const hash = await wallet.deleteSubname({
+     *   name: 'sub.ens.eth',
+     *   contract: 'registry',
+     * })
+     * // 0x...
+     */
+    deleteSubname: ({ name, contract, asOwner, ...txArgs }: DeleteSubnameParameters<TChain, TAccount, TChain>) => Promise<DeleteSubnameReturnType>;
+    /**
+     * Registers a name on ENS
+     * @param parameters - {@link RegisterNameParameters}
+     * @returns Transaction hash. {@link RegisterNameReturnType}
+     *
+     * @example
+     * import { createPublicClient, createWalletClient, http, custom } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     * import { addEnsContracts, ensPublicActions, ensWalletActions } from '@ensdomains/ensjs'
+     * import { randomSecret } from '@ensdomains/ensjs/utils'
+     *
+     * const mainnetWithEns = addEnsContracts(mainnet)
+     * const client = createPublicClient({
+     *   chain: mainnetWithEns,
+     *   transport: http(),
+     * }).extend(ensPublicActions)
+     * const wallet = createWalletClient({
+     *   chain: mainnetWithEns,
+     *   transport: custom(window.ethereum),
+     * }).extend(ensWalletActions)
+     * const secret = randomSecret()
+     * const params = {
+     *   name: 'example.eth',
+     *   owner: '0xFe89cc7aBB2C4183683ab71653C4cdc9B02D44b7',
+     *   duration: 31536000, // 1 year
+     *   secret,
+     * }
+     *
+     * const commitmentHash = await wallet.commitName(params)
+     * await client.waitForTransactionReceipt({ hash: commitmentHash }) // wait for commitment to finalise
+     * await new Promise((resolve) => setTimeout(resolve, 60 * 1_000)) // wait for commitment to be valid
+     *
+     * const { base, premium } = await client.getPrice({ nameOrNames: params.name, duration: params.duration })
+     * const value = (base + premium) * 110n / 100n // add 10% to the price for buffer
+     * const hash = await wallet.registerName({ ...params, value })
+     * // 0x...
+     */
+    registerName: ({ name, owner, duration, secret, resolverAddress, records, reverseRecord, fuses, value, ...txArgs }: RegisterNameParameters<TChain, TAccount, TChain>) => Promise<RegisterNameReturnType>;
+    /**
+     * Renews a name or names for a specified duration.
+     * @param parameters - {@link RenewNamesParameters}
+     * @returns Transaction hash. {@link RenewNamesReturnType}
+     *
+     * @example
+     * import { createPublicClient, createWalletClient, http, custom } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     * import { addEnsContracts, ensPublicActions, ensWalletActions } from '@ensdomains/ensjs'
+     *
+     * const mainnetWithEns = addEnsContracts(mainnet)
+     * const client = createPublicClient({
+     *   chain: mainnetWithEns,
+     *   transport: http(),
+     * }).extend(ensPublicActions)
+     * const wallet = createWalletClient({
+     *   chain: mainnetWithEns,
+     *   transport: custom(window.ethereum),
+     * }).extend(ensWalletActions)
+     *
+     * const duration = 31536000 // 1 year
+     * const { base, premium } = await client.getPrice({
+     *  nameOrNames: 'example.eth',
+     *  duration,
+     * })
+     * const value = (base + premium) * 110n / 100n // add 10% to the price for buffer
+     * const hash = await wallet.renewNames({
+     *   nameOrNames: 'example.eth',
+     *   duration,
+     *   value,
+     * })
+     * // 0x...
+     */
+    renewNames: ({ nameOrNames, duration, value, ...txArgs }: RenewNamesParameters<TChain, TAccount, TChain>) => Promise<RenewNamesReturnType>;
+    /**
+     * Sets the ABI for a name on a resolver.
+     * @param parameters - {@link SetAbiRecordParameters}
+     * @returns Transaction hash. {@link SetAbiRecordReturnType}
+     *
+     * @example
+     * import abi from './abi.json'
+     * import { createWalletClient, custom } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     * import { addEnsContracts, ensWalletActions } from '@ensdomains/ensjs'
+     * import { encodeAbi } from '@ensdomains/ensjs/utils'
+     *
+     * const wallet = createWalletClient({
+     *   chain: addEnsContracts(mainnet),
+     *   transport: custom(window.ethereum),
+     * }).extend(ensWalletActions)
+     *
+     * const encodedAbi = await encodeAbi({ encodeAs: 'json', abi })
+     * const hash = await wallet.setAbiRecord({
+     *   name: 'ens.eth',
+     *   encodedAbi,
+     *   resolverAddress: '0x4976fb03C32e5B8cfe2b6cCB31c09Ba78EBaBa41',
+     * })
+     * // 0x...
+     */
+    setAbiRecord: ({ name, encodedAbi, resolverAddress, ...txArgs }: SetAbiRecordParameters<TChain, TAccount, TChain>) => Promise<SetAbiRecordReturnType>;
+    /**
+     * Sets an address record for a name on a resolver.
+     * @param parameters - {@link SetAddressRecordParameters}
+     * @returns Transaction hash. {@link SetAddressRecordReturnType}
+     *
+     * @example
+     * import { createWalletClient, custom } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     * import { addEnsContracts, ensWalletActions } from '@ensdomains/ensjs'
+     *
+     * const wallet = createWalletClient({
+     *   chain: addEnsContracts(mainnet),
+     *   transport: custom(window.ethereum),
+     * }).extend(ensWalletActions)
+     * const hash = await wallet.setAddressRecord({
+     *   name: 'ens.eth',
+     *   coin: 'ETH',
+     *   value: '0xFe89cc7aBB2C4183683ab71653C4cdc9B02D44b7',
+     *   resolverAddress: '0x4976fb03C32e5B8cfe2b6cCB31c09Ba78EBaBa41',
+     * })
+     * // 0x...
+     */
+    setAddressRecord: ({ name, coin, value, resolverAddress, ...txArgs }: SetAddressRecordParameters<TChain, TAccount, TChain>) => Promise<SetAddressRecordReturnType>;
+    /**
+     * Sets the fuses for a name as the parent.
+     * @param parameters - {@link SetChildFusesParameters}
+     * @returns Transaction hash. {@link SetChildFusesReturnType}
+     *
+     * @example
+     * import { createWalletClient, custom } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     * import { addEnsContracts, ensWalletActions } from '@ensdomains/ensjs'
+     *
+     * const wallet = createWalletClient({
+     *   chain: addEnsContracts(mainnet),
+     *   transport: custom(window.ethereum),
+     * }).extend(ensWalletActions)
+     * const hash = await wallet.setChildFuses({
+     *   name: 'sub.ens.eth',
+     *   fuses: {
+     *     parent: {
+     *       named: ['PARENT_CANNOT_CONTROl'],
+     *     },
+     *   },
+     * })
+     * // 0x...
+     */
+    setChildFuses: ({ name, fuses, expiry, ...txArgs }: SetChildFusesParameters<TChain, TAccount, TChain>) => Promise<SetChildFusesReturnType>;
+    /**
+     * Sets the content hash record for a name on a resolver.
+     * @param parameters - {@link SetContentHashRecordParameters}
+     * @returns Transaction hash. {@link SetContentHashRecordReturnType}
+     *
+     * @example
+     * import { createWalletClient, custom } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     * import { addEnsContracts, ensWalletActions } from '@ensdomains/ensjs'
+     *
+     * const wallet = createWalletClient({
+     *   chain: addEnsContracts(mainnet),
+     *   transport: custom(window.ethereum),
+     * }).extend(ensWalletActions)
+     * const hash = await wallet.setContentHashRecord({
+     *   name: 'ens.eth',
+     *   value: 'ipns://k51qzi5uqu5djdczd6zw0grmo23j2vkj9uzvujencg15s5rlkq0ss4ivll8wqw',
+     *   resolverAddress: '0x4976fb03C32e5B8cfe2b6cCB31c09Ba78EBaBa41',
+     * })
+     * // 0x...
+     */
+    setContentHashRecord: ({ name, contentHash, resolverAddress, ...txArgs }: SetContentHashRecordParameters<TChain, TAccount, TChain>) => Promise<SetContentHashRecordReturnType>;
+    /**
+     * Sets the fuses for a name.
+     * @param parameters - {@link SetFusesParameters}
+     * @returns Transaction hash. {@link SetFusesReturnType}
+     *
+     * @example
+     * import { createWalletClient, custom } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     * import { addEnsContracts, ensWalletActions } from '@ensdomains/ensjs'
+     *
+     * const wallet = createWalletClient({
+     *   chain: addEnsContracts(mainnet),
+     *   transport: custom(window.ethereum),
+     * }).extend(ensWalletActions)
+     * const hash = await wallet.setFuses({
+     *   name: 'sub.ens.eth',
+     *   fuses: {
+     *     named: ['CANNOT_TRANSFER'],
+     *   },
+     * })
+     * // 0x...
+     */
+    setFuses: ({ name, fuses, ...txArgs }: SetFusesParameters<TChain, TAccount, TChain>) => Promise<SetFusesReturnType>;
+    /**
+     * Sets a primary name for an address.
+     * @param parameters - {@link SetPrimaryNameParameters}
+     * @returns Transaction hash. {@link SetPrimaryNameReturnType}
+     *
+     * @example
+     * import { createWalletClient, custom } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     * import { addEnsContracts, ensWalletActions } from '@ensdomains/ensjs'
+     *
+     * const wallet = createWalletClient({
+     *   chain: addEnsContracts(mainnet),
+     *   transport: custom(window.ethereum),
+     * }).extend(ensWalletActions)
+     * const hash = await wallet.setPrimaryName({
+     *   name: 'ens.eth',
+     * })
+     * // 0x...
+     */
+    setPrimaryName: ({ name, address, resolverAddress, ...txArgs }: SetPrimaryNameParameters<TChain, TAccount, TChain>) => Promise<SetPrimaryNameReturnType>;
+    /**
+     * Sets multiple records for a name on a resolver.
+     * @param parameters - {@link SetRecordsParameters}
+     * @returns Transaction hash. {@link SetRecordsReturnType}
+     *
+     * @example
+     * import { createWalletClient, custom } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     * import { addEnsContracts, ensWalletActions } from '@ensdomains/ensjs'
+     *
+     * const wallet = createWalletClient({
+     *   chain: addEnsContracts(mainnet),
+     *   transport: custom(window.ethereum),
+     * }).extend(ensWalletActions)
+     * const hash = await wallet.setRecords({
+     *   name: 'ens.eth',
+     *   coins: [
+     *     {
+     *       coin: 'ETH',
+     *       value: '0xFe89cc7aBB2C4183683ab71653C4cdc9B02D44b7',
+     *     },
+     *   ],
+     *   texts: [{ key: 'foo', value: 'bar' }],
+     *   resolverAddress: '0x4976fb03C32e5B8cfe2b6cCB31c09Ba78EBaBa41',
+     * })
+     * // 0x...
+     */
+    setRecords: ({ name, resolverAddress, clearRecords, contentHash, texts, coins, abi, ...txArgs }: SetRecordsParameters<TChain, TAccount, TChain>) => Promise<SetRecordsReturnType>;
+    /**
+     * Sets a resolver for a name.
+     * @param parameters - {@link SetResolverParameters}
+     * @returns Transaction hash. {@link SetResolverReturnType}
+     *
+     * @example
+     * import { createWalletClient, custom } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     * import { addEnsContracts, ensWalletActions } from '@ensdomains/ensjs'
+     *
+     * const wallet = createWalletClient({
+     *   chain: addEnsContracts(mainnet),
+     *   transport: custom(window.ethereum),
+     * }).extend(ensWalletActions)
+     * const hash = await wallet.setResolver({
+     *   name: 'ens.eth',
+     *   contract: 'registry',
+     *   resolverAddress: '0x4976fb03C32e5B8cfe2b6cCB31c09Ba78EBaBa41',
+     * })
+     * // 0x...
+     */
+    setResolver: ({ name, contract, resolverAddress, ...txArgs }: SetResolverParameters<TChain, TAccount, TChain>) => Promise<SetResolverReturnType>;
+    /**
+     * Sets a text record for a name on a resolver.
+     * @param parameters - {@link SetTextRecordParameters}
+     * @returns Transaction hash. {@link SetTextRecordReturnType}
+     *
+     * @example
+     * import { createWalletClient, custom } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     * import { addEnsContracts, ensWalletActions } from '@ensdomains/ensjs'
+     *
+     * const wallet = createWalletClient({
+     *   chain: addEnsContracts(mainnet),
+     *   transport: custom(window.ethereum),
+     * }).extend(ensWalletActions)
+     * const hash = await wallet.setTextRecord({
+     *   name: 'ens.eth',
+     *   key: 'foo',
+     *   value: 'bar',
+     *   resolverAddress: '0x4976fb03C32e5B8cfe2b6cCB31c09Ba78EBaBa41',
+     * })
+     * // 0x...
+     */
+    setTextRecord: ({ name, key, value, resolverAddress, ...txArgs }: SetTextRecordParameters<TChain, TAccount, TChain>) => Promise<SetTextRecordReturnType>;
+    /**
+     * Transfers a name to a new owner.
+     * @param parameters - {@link TransferNameParameters}
+     * @returns Transaction hash. {@link TransferNameReturnType}
+     *
+     * @example
+     * import { createWalletClient, custom } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     * import { addEnsContracts, ensWalletActions } from '@ensdomains/ensjs'
+     *
+     * const wallet = createWalletClient({
+     *   chain: addEnsContracts(mainnet),
+     *   transport: custom(window.ethereum),
+     * }).extend(ensWalletActions)
+     * const hash = await wallet.transferName({
+     *   name: 'ens.eth',
+     *   newOwnerAddress: '0xFe89cc7aBB2C4183683ab71653C4cdc9B02D44b7',
+     *   contract: 'registry',
+     * })
+     * // 0x...
+     */
+    transferName: ({ name, newOwnerAddress, contract, reclaim, asParent, ...txArgs }: TransferNameParameters<TChain, TAccount, TChain>) => Promise<TransferNameReturnType>;
+    /**
+     * Unwraps a name.
+     * @param parameters - {@link UnwrapNameParameters}
+     * @returns Transaction hash. {@link UnwrapNameReturnType}
+     *
+     * @example
+     * import { createWalletClient, custom } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     * import { addEnsContracts, ensWalletActions } from '@ensdomains/ensjs'
+     *
+     * const wallet = createWalletClient({
+     *   chain: addEnsContracts(mainnet),
+     *   transport: custom(window.ethereum),
+     * }).extend(ensWalletActions)
+     * const hash = await wallet.unwrapName({
+     *   name: 'example.eth',
+     *   newOwnerAddress: '0xFe89cc7aBB2C4183683ab71653C4cdc9B02D44b7',
+     *   newRegistrantAddress: '0xFe89cc7aBB2C4183683ab71653C4cdc9B02D44b7',
+     * })
+     * // 0x...
+     */
+    unwrapName: <TName extends string>({ name, newOwnerAddress, newRegistrantAddress, ...txArgs }: UnwrapNameParameters<TName, TChain, TAccount, TChain>) => Promise<UnwrapNameReturnType>;
+    /**
+     * Wraps a name.
+     * @param parameters - {@link WrapNameParameters}
+     * @returns Transaction hash. {@link WrapNameReturnType}
+     *
+     * @example
+     * import { createWalletClient, custom } from 'viem'
+     * import { mainnet } from 'viem/chains'
+     * import { addEnsContracts, ensWalletActions } from '@ensdomains/ensjs'
+     *
+     * const wallet = createWalletClient({
+     *   chain: addEnsContracts(mainnet),
+     *   transport: custom(window.ethereum),
+     * }).extend(ensWalletActions)
+     * const hash = await wallet.wrapName({
+     *   name: 'ens.eth',
+     *   newOwnerAddress: '0xFe89cc7aBB2C4183683ab71653C4cdc9B02D44b7',
+     * })
+     * // 0x...
+     */
+    wrapName: <TName extends string>({ name, newOwnerAddress, fuses, resolverAddress, ...txArgs }: WrapNameParameters<TName, TChain, TAccount, TChain>) => Promise<WrapNameReturnType>;
+};
+/**
+ * Extends the viem client with ENS wallet actions
+ * @param client - The viem {@link WalletClient} object to add the ENS wallet actions to
+ *
+ * @example
+ * import { createWalletClient, custom } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { addEnsContracts, ensWalletActions } from '@ensdomains/ensjs'
+ *
+ * const clientWithEns = createWalletClient({
+ *   chain: addEnsContracts(mainnet),
+ *   transport: custom(window.ethereum),
+ * }).extend(ensWalletActions)
+ */
+export declare const ensWalletActions: <TTransport extends Transport = Transport, TChain extends ChainWithEns = ChainWithEns, TAccount extends Account | undefined = Account | undefined>(client: WalletClient<TTransport, TChain, TAccount>) => EnsWalletActions<TChain, TAccount>;

package/dist/clients/decorators/wallet.js

@@ -0,0 +1,53 @@
+import clearRecords from '../../functions/wallet/clearRecords.js';
+import commitName from '../../functions/wallet/commitName.js';
+import createSubname from '../../functions/wallet/createSubname.js';
+import deleteSubname from '../../functions/wallet/deleteSubname.js';
+import registerName from '../../functions/wallet/registerName.js';
+import renewNames from '../../functions/wallet/renewNames.js';
+import setAbiRecord from '../../functions/wallet/setAbiRecord.js';
+import setAddressRecord from '../../functions/wallet/setAddressRecord.js';
+import setChildFuses from '../../functions/wallet/setChildFuses.js';
+import setContentHashRecord from '../../functions/wallet/setContentHashRecord.js';
+import setFuses from '../../functions/wallet/setFuses.js';
+import setPrimaryName from '../../functions/wallet/setPrimaryName.js';
+import setRecords from '../../functions/wallet/setRecords.js';
+import setResolver from '../../functions/wallet/setResolver.js';
+import setTextRecord from '../../functions/wallet/setTextRecord.js';
+import transferName from '../../functions/wallet/transferName.js';
+import unwrapName from '../../functions/wallet/unwrapName.js';
+import wrapName from '../../functions/wallet/wrapName.js';
+/**
+ * Extends the viem client with ENS wallet actions
+ * @param client - The viem {@link WalletClient} object to add the ENS wallet actions to
+ *
+ * @example
+ * import { createWalletClient, custom } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { addEnsContracts, ensWalletActions } from '@ensdomains/ensjs'
+ *
+ * const clientWithEns = createWalletClient({
+ *   chain: addEnsContracts(mainnet),
+ *   transport: custom(window.ethereum),
+ * }).extend(ensWalletActions)
+ */
+export const ensWalletActions = (client) => ({
+    clearRecords: (parameters) => clearRecords(client, parameters),
+    commitName: (parameters) => commitName(client, parameters),
+    createSubname: (parameters) => createSubname(client, parameters),
+    deleteSubname: (parameters) => deleteSubname(client, parameters),
+    registerName: (parameters) => registerName(client, parameters),
+    renewNames: (parameters) => renewNames(client, parameters),
+    setAbiRecord: (parameters) => setAbiRecord(client, parameters),
+    setAddressRecord: (parameters) => setAddressRecord(client, parameters),
+    setChildFuses: (parameters) => setChildFuses(client, parameters),
+    setContentHashRecord: (parameters) => setContentHashRecord(client, parameters),
+    setFuses: (parameters) => setFuses(client, parameters),
+    setPrimaryName: (parameters) => setPrimaryName(client, parameters),
+    setRecords: (parameters) => setRecords(client, parameters),
+    setResolver: (parameters) => setResolver(client, parameters),
+    setTextRecord: (parameters) => setTextRecord(client, parameters),
+    transferName: (parameters) => transferName(client, parameters),
+    unwrapName: (parameters) => unwrapName(client, parameters),
+    wrapName: (parameters) => wrapName(client, parameters),
+});
+//# sourceMappingURL=wallet.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"wallet.js","sourceRoot":"","sources":["../../../src/clients/decorators/wallet.ts"],"names":[],"mappings":"AAEA,OAAO,YAGN,MAAM,wCAAwC,CAAA;AAC/C,OAAO,UAGN,MAAM,sCAAsC,CAAA;AAC7C,OAAO,aAGN,MAAM,yCAAyC,CAAA;AAChD,OAAO,aAGN,MAAM,yCAAyC,CAAA;AAChD,OAAO,YAGN,MAAM,wCAAwC,CAAA;AAC/C,OAAO,UAGN,MAAM,sCAAsC,CAAA;AAC7C,OAAO,YAGN,MAAM,wCAAwC,CAAA;AAC/C,OAAO,gBAGN,MAAM,4CAA4C,CAAA;AACnD,OAAO,aAGN,MAAM,yCAAyC,CAAA;AAChD,OAAO,oBAGN,MAAM,gDAAgD,CAAA;AACvD,OAAO,QAGN,MAAM,oCAAoC,CAAA;AAC3C,OAAO,cAGN,MAAM,0CAA0C,CAAA;AACjD,OAAO,UAGN,MAAM,sCAAsC,CAAA;AAC7C,OAAO,WAGN,MAAM,uCAAuC,CAAA;AAC9C,OAAO,aAGN,MAAM,yCAAyC,CAAA;AAChD,OAAO,YAGN,MAAM,wCAAwC,CAAA;AAC/C,OAAO,UAGN,MAAM,sCAAsC,CAAA;AAC7C,OAAO,QAGN,MAAM,oCAAoC,CAAA;AAwnB3C;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAK9B,MAAkD,EACd,EAAE,CAAC,CAAC;IACxC,YAAY,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC,YAAY,CAAC,MAAM,EAAE,UAAU,CAAC;IAC9D,UAAU,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,MAAM,EAAE,UAAU,CAAC;IAC1D,aAAa,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC,aAAa,CAAC,MAAM,EAAE,UAAU,CAAC;IAChE,aAAa,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC,aAAa,CAAC,MAAM,EAAE,UAAU,CAAC;IAChE,YAAY,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC,YAAY,CAAC,MAAM,EAAE,UAAU,CAAC;IAC9D,UAAU,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,MAAM,EAAE,UAAU,CAAC;IAC1D,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,aAAa,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC,aAAa,CAAC,MAAM,EAAE,UAAU,CAAC;IAChE,oBAAoB,EAAE,CAAC,UAAU,EAAE,EAAE,CACnC,oBAAoB,CAAC,MAAM,EAAE,UAAU,CAAC;IAC1C,QAAQ,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC;IACtD,cAAc,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC,cAAc,CAAC,MAAM,EAAE,UAAU,CAAC;IAClE,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,YAAY,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC,YAAY,CAAC,MAAM,EAAE,UAAU,CAAC;IAC9D,UAAU,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,MAAM,EAAE,UAAU,CAAC;IAC1D,QAAQ,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC;CACvD,CAAC,CAAA"}

package/dist/clients/public.d.ts

@@ -0,0 +1,26 @@
+import { type Client, type ClientConfig, type PublicRpcSchema, type Transport } from 'viem';
+import type { ChainWithBaseContracts, ChainWithEns } from '../contracts/consts.js';
+import type { Prettify } from '../types.js';
+import { type EnsPublicActions } from './decorators/public.js';
+import { type EnsSubgraphActions } from './decorators/subgraph.js';
+export type EnsPublicClientConfig<TTransport extends Transport = Transport, TChain extends ChainWithBaseContracts = ChainWithBaseContracts> = Pick<ClientConfig<TTransport, TChain>, 'batch' | 'key' | 'name' | 'pollingInterval' | 'transport'> & {
+    chain: TChain;
+};
+export type EnsPublicClient<TTransport extends Transport = Transport, TChain extends ChainWithEns = ChainWithEns> = Prettify<Client<TTransport, TChain, undefined, PublicRpcSchema, EnsPublicActions & EnsSubgraphActions>>;
+/**
+ * Creates a ENS Public Client with a given [Transport](https://viem.sh/docs/clients/intro.html) configured for a [Chain](https://viem.sh/docs/clients/chains.html).
+ *
+ * @param config - {@link EnsPublicClientConfig}
+ * @returns An ENS Public Client. {@link EnsPublicClient}
+ *
+ * @example
+ * import { http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { createEnsPublicClient } from '@ensdomains/ensjs'
+ *
+ * const client = createEnsPublicClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ */
+export declare const createEnsPublicClient: <TTransport extends Transport, TChain extends ChainWithBaseContracts>({ batch, chain, key, name, transport, pollingInterval, }: EnsPublicClientConfig<TTransport, TChain>) => EnsPublicClient<TTransport, ChainWithEns<TChain>>;

package/dist/clients/public.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"public.js","sourceRoot":"","sources":["../../src/clients/public.ts"],"names":[],"mappings":"AAAA,OAAO,EAKL,YAAY,GACb,MAAM,MAAM,CAAA;AACb,OAAO,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAA;AAMjE,OAAO,EAAyB,gBAAgB,EAAE,MAAM,wBAAwB,CAAA;AAChF,OAAO,EAEL,kBAAkB,GACnB,MAAM,0BAA0B,CAAA;AAyBjC;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAGnC,EACA,KAAK,EACL,KAAK,EACL,GAAG,GAAG,WAAW,EACjB,IAAI,GAAG,mBAAmB,EAC1B,SAAS,EACT,eAAe,GAC2B,EAG1C,EAAE;IACF,OAAO,YAAY,CAAC;QAClB,KAAK;QACL,KAAK,EAAE,eAAe,CAAC,KAAK,CAAC;QAC7B,GAAG;QACH,IAAI;QACJ,eAAe;QACf,SAAS;QACT,IAAI,EAAE,iBAAiB;KACxB,CAAC;SACC,MAAM,CAAC,gBAAgB,CAAC;SACxB,MAAM,CAAC,kBAAkB,CAAC,CAAA;AAC/B,CAAC,CAAA"}

package/dist/clients/subgraph.d.ts

@@ -0,0 +1,25 @@
+import { type Client, type ClientConfig, type PublicRpcSchema, type Transport } from 'viem';
+import type { ChainWithBaseContracts, ChainWithEns } from '../contracts/consts.js';
+import type { Prettify } from '../types.js';
+import { type EnsSubgraphActions } from './decorators/subgraph.js';
+export type EnsSubgraphClientConfig<TTransport extends Transport = Transport, TChain extends ChainWithBaseContracts = ChainWithBaseContracts> = Pick<ClientConfig<TTransport, TChain>, 'batch' | 'key' | 'name' | 'pollingInterval' | 'transport'> & {
+    chain: TChain;
+};
+export type EnsSubgraphClient<TTransport extends Transport = Transport, TChain extends ChainWithEns = ChainWithEns> = Prettify<Client<TTransport, TChain, undefined, PublicRpcSchema, EnsSubgraphActions>>;
+/**
+ * Creates a ENS Subgraph Client with a given [Transport](https://viem.sh/docs/clients/intro.html) configured for a [Chain](https://viem.sh/docs/clients/chains.html).
+ *
+ * @param config - {@link EnsSubgraphClientConfig}
+ * @returns An ENS Subgraph Client. {@link EnsSubgraphClient}
+ *
+ * @example
+ * import { http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { createEnsSubgraphClient } from '@ensdomains/ensjs'
+ *
+ * const client = createEnsSubgraphClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ */
+export declare const createEnsSubgraphClient: <TTransport extends Transport, TChain extends ChainWithBaseContracts>({ batch, chain, key, name, transport, pollingInterval, }: EnsSubgraphClientConfig<TTransport, TChain>) => EnsSubgraphClient<TTransport, ChainWithEns<TChain>>;

package/dist/clients/subgraph.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"subgraph.js","sourceRoot":"","sources":["../../src/clients/subgraph.ts"],"names":[],"mappings":"AAAA,OAAO,EAKL,YAAY,GACb,MAAM,MAAM,CAAA;AACb,OAAO,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAA;AAMjE,OAAO,EAEL,kBAAkB,GACnB,MAAM,0BAA0B,CAAA;AAmBjC;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAGrC,EACA,KAAK,EACL,KAAK,EACL,GAAG,GAAG,aAAa,EACnB,IAAI,GAAG,qBAAqB,EAC5B,SAAS,EACT,eAAe,GAC6B,EAG5C,EAAE;IACF,OAAO,YAAY,CAAC;QAClB,KAAK;QACL,KAAK,EAAE,eAAe,CAAC,KAAK,CAAC;QAC7B,GAAG;QACH,IAAI;QACJ,eAAe;QACf,SAAS;QACT,IAAI,EAAE,mBAAmB;KAC1B,CAAC,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAA;AAC/B,CAAC,CAAA"}

package/dist/clients/wallet.d.ts

@@ -0,0 +1,25 @@
+import { type Account, type Address, type Client, type ClientConfig, type ParseAccount, type Transport, type WalletActions, type WalletRpcSchema } from 'viem';
+import type { ChainWithBaseContracts, ChainWithEns, CheckedChainWithEns } from '../contracts/consts.js';
+import type { Assign, Prettify } from '../types.js';
+import { type EnsWalletActions } from './decorators/wallet.js';
+export type EnsWalletClientConfig<TTransport extends Transport, TChain extends ChainWithBaseContracts, TAccountOrAddress extends Account | Address | undefined = Account | Address | undefined> = Assign<Pick<ClientConfig<TTransport, TChain, TAccountOrAddress>, 'account' | 'chain' | 'key' | 'name' | 'pollingInterval' | 'transport'>, {
+    chain: TChain;
+}>;
+export type EnsWalletClient<TTransport extends Transport = Transport, TChain extends ChainWithEns = ChainWithEns, TAccount extends Account | undefined = Account | undefined> = Prettify<Client<TTransport, TChain, TAccount, WalletRpcSchema, WalletActions<TChain, TAccount> & EnsWalletActions<TChain, TAccount>>>;
+/**
+ * Creates an ENS Wallet Client with a given [Transport](https://viem.sh/docs/clients/intro.html) configured for a [Chain](https://viem.sh/docs/clients/chains.html).
+ *
+ * @param config - {@link EnsWalletClientConfig}
+ * @returns An ENS Wallet Client. {@link EnsWalletClient}
+ *
+ * @example
+ * import { custom } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { createEnsWalletClient } from '@ensdomains/ensjs'
+ *
+ * const client = createEnsWalletClient({
+ *   chain: mainnet,
+ *   transport: custom(window.ethereum),
+ * })
+ */
+export declare const createEnsWalletClient: <TTransport extends Transport, TChain extends ChainWithBaseContracts, TAccountOrAddress extends Account | Address | undefined = undefined>({ account, chain, key, name, transport, pollingInterval, }: EnsWalletClientConfig<TTransport, TChain, TAccountOrAddress>) => EnsWalletClient<TTransport, CheckedChainWithEns<TChain>, ParseAccount<TAccountOrAddress>>;

package/dist/clients/wallet.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"wallet.js","sourceRoot":"","sources":["../../src/clients/wallet.ts"],"names":[],"mappings":"AAAA,OAAO,EASL,kBAAkB,GACnB,MAAM,MAAM,CAAA;AACb,OAAO,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAA;AAOjE,OAAO,EAAyB,gBAAgB,EAAE,MAAM,wBAAwB,CAAA;AAiChF;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAInC,EACA,OAAO,EACP,KAAK,EACL,GAAG,GAAG,WAAW,EACjB,IAAI,GAAG,mBAAmB,EAC1B,SAAS,EACT,eAAe,GAKhB,EAIC,EAAE;IACF,OAAO,kBAAkB,CAAC;QACxB,OAAO;QACP,KAAK,EAAE,eAAe,CAAC,KAAK,CAAC;QAC7B,GAAG;QACH,IAAI;QACJ,eAAe;QACf,SAAS;KACV,CAAC,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAA;AAC7B,CAAC,CAAA"}

package/dist/contracts/addEnsContracts.d.ts

@@ -0,0 +1,17 @@
+import type { Chain } from 'viem';
+import { type CheckedChainWithEns } from './consts.js';
+/**
+ * Adds ENS contract addresses to the viem chain
+ * @param chain - The viem {@link Chain} object to add the ENS contracts to
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ *
+ * const clientWithEns = createPublicClient({
+ *   chain: addEnsContracts(mainnet),
+ *   transport: http(),
+ * })
+ */
+export declare const addEnsContracts: <const TChain extends Chain>(chain: TChain) => CheckedChainWithEns<TChain>;

package/dist/contracts/addEnsContracts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"addEnsContracts.js","sourceRoot":"","sources":["../../src/contracts/addEnsContracts.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAA;AAC5E,OAAO,EAGL,SAAS,EACT,SAAS,EACT,eAAe,GAChB,MAAM,aAAa,CAAA;AAEpB;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAA6B,KAAa,EAAE,EAAE;IAC3E,IAAI,CAAC,KAAK;QAAE,MAAM,IAAI,YAAY,EAAE,CAAA;IACpC,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAoB,CAAC;QACvD,MAAM,IAAI,qBAAqB,CAAC;YAC9B,OAAO,EAAE,KAAK,CAAC,EAAE;YACjB,eAAe;SAChB,CAAC,CAAA;IACJ,OAAO;QACL,GAAG,KAAK;QACR,SAAS,EAAE;YACT,GAAG,KAAK,CAAC,SAAS;YAClB,GAAG,SAAS,CAAC,KAAK,CAAC,EAAoB,CAAC;SACzC;QACD,SAAS,EAAE;YACT,GAAG,SAAS,CAAC,KAAK,CAAC,EAAoB,CAAC;SACzC;KACwC,CAAA;AAC7C,CAAC,CAAA"}