@ensdomains/ensjs 4.1.1 → 5.0.0-alpha.0

package/dist/actions/wallet/transferName.js

@@ -0,0 +1,161 @@
+import { labelhash, namehash, } from 'viem';
+import { writeContract } from 'viem/actions';
+import { getAction } from 'viem/utils';
+import { getChainContractAddress, } from '../../clients/chain.js';
+import { baseRegistrarReclaimSnippet, baseRegistrarSafeTransferFromSnippet, } from '../../contracts/baseRegistrar.js';
+import { nameWrapperSafeTransferFromSnippet, nameWrapperSetSubnodeOwnerSnippet, } from '../../contracts/nameWrapper.js';
+import { registrySetOwnerSnippet, registrySetSubnodeOwnerSnippet, } from '../../contracts/registry.js';
+import { AdditionalParameterSpecifiedError, InvalidContractTypeError, UnsupportedNameTypeError, } from '../../errors/general.js';
+import { ASSERT_NO_TYPE_ERROR } from '../../types/internal.js';
+import { clientWithOverrides, } from '../../utils/clientWithOverrides.js';
+import { getNameType } from '../../utils/name/getNameType.js';
+import { makeLabelNodeAndParent, } from '../../utils/name/makeLabelNodeAndParent.js';
+export const transferNameWriteParameters = (client, { name, newOwnerAddress, contract, reclaim, asParent, }) => {
+    ASSERT_NO_TYPE_ERROR(client);
+    if (reclaim && contract !== 'registrar')
+        throw new AdditionalParameterSpecifiedError({
+            parameter: 'reclaim',
+            allowedParameters: ['name', 'newOwnerAddress', 'contract'],
+            details: "Can't reclaim a name from any contract other than the registrar",
+        });
+    switch (contract) {
+        case 'registry': {
+            const baseParams = {
+                address: getChainContractAddress({
+                    chain: client.chain,
+                    contract: 'ensRegistry',
+                }),
+                chain: client.chain,
+                account: client.account,
+            };
+            if (asParent) {
+                const { labelhash: labelhashId, parentNode } = makeLabelNodeAndParent(name);
+                return {
+                    ...baseParams,
+                    abi: registrySetSubnodeOwnerSnippet,
+                    functionName: 'setSubnodeOwner',
+                    args: [parentNode, labelhashId, newOwnerAddress],
+                };
+            }
+            return {
+                ...baseParams,
+                abi: registrySetOwnerSnippet,
+                functionName: 'setOwner',
+                args: [namehash(name), newOwnerAddress],
+            };
+        }
+        case 'registrar': {
+            if (asParent)
+                throw new AdditionalParameterSpecifiedError({
+                    parameter: 'asParent',
+                    allowedParameters: ['name', 'newOwnerAddress', 'contract', 'reclaim'],
+                    details: "Can't transfer a name as the parent owner on the registrar",
+                });
+            const nameType = getNameType(name);
+            if (nameType !== 'eth-2ld')
+                throw new UnsupportedNameTypeError({
+                    nameType,
+                    supportedNameTypes: ['eth-2ld'],
+                    details: 'Only eth-2ld names can be transferred on the registrar contract',
+                });
+            const labels = name.split('.');
+            const tokenId = BigInt(labelhash(labels[0]));
+            const baseParams = {
+                address: getChainContractAddress({
+                    chain: client.chain,
+                    contract: 'ensBaseRegistrarImplementation',
+                }),
+                chain: client.chain,
+                account: client.account,
+            };
+            if (reclaim)
+                return {
+                    ...baseParams,
+                    abi: baseRegistrarReclaimSnippet,
+                    functionName: 'reclaim',
+                    args: [tokenId, newOwnerAddress],
+                };
+            return {
+                ...baseParams,
+                abi: baseRegistrarSafeTransferFromSnippet,
+                functionName: 'safeTransferFrom',
+                args: [client.account.address, newOwnerAddress, tokenId],
+            };
+        }
+        case 'nameWrapper': {
+            const baseParams = {
+                address: getChainContractAddress({
+                    chain: client.chain,
+                    contract: 'ensNameWrapper',
+                }),
+                chain: client.chain,
+                account: client.account,
+            };
+            if (asParent) {
+                const { label, parentNode } = makeLabelNodeAndParent(name);
+                return {
+                    ...baseParams,
+                    abi: nameWrapperSetSubnodeOwnerSnippet,
+                    functionName: 'setSubnodeOwner',
+                    args: [parentNode, label, newOwnerAddress, 0, BigInt(0)],
+                };
+            }
+            return {
+                ...baseParams,
+                abi: nameWrapperSafeTransferFromSnippet,
+                functionName: 'safeTransferFrom',
+                args: [
+                    client.account.address,
+                    newOwnerAddress,
+                    BigInt(namehash(name)),
+                    BigInt(1),
+                    '0x',
+                ],
+            };
+        }
+        default:
+            throw new InvalidContractTypeError({
+                contractType: contract,
+                supportedContractTypes: ['registry', 'registrar', 'nameWrapper'],
+            });
+    }
+};
+/**
+ * Transfers a name to a new owner.
+ * @param client - {@link Client}
+ * @param options - {@link TransferNameOptions}
+ * @returns Transaction hash. {@link TransferNameReturnType}
+ *
+ * @example
+ * import { createWalletClient, custom } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { transferName } from '@ensdomains/ensjs/wallet'
+ *
+ * const wallet = createWalletClient({
+ *   chain: addEnsContracts(mainnet),
+ *   transport: custom(window.ethereum),
+ * })
+ * const hash = await transferName(wallet, {
+ *   name: 'ens.eth',
+ *   newOwnerAddress: '0xFe89cc7aBB2C4183683ab71653C4cdc9B02D44b7',
+ *   contract: 'registry',
+ * })
+ * // 0x...
+ */
+export async function transferName(client, { name, newOwnerAddress, contract, reclaim, asParent, ...txArgs }) {
+    ASSERT_NO_TYPE_ERROR(client);
+    const writeParameters = transferNameWriteParameters(clientWithOverrides(client, txArgs), {
+        name,
+        newOwnerAddress,
+        contract,
+        reclaim,
+        asParent,
+    });
+    const writeContractAction = getAction(client, writeContract, 'writeContract');
+    return writeContractAction({
+        ...writeParameters,
+        ...txArgs,
+    });
+}
+//# sourceMappingURL=transferName.js.map

package/dist/actions/wallet/transferName.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transferName.js","sourceRoot":"","sources":["../../../src/actions/wallet/transferName.ts"],"names":[],"mappings":"AAAA,OAAO,EAML,SAAS,EAET,QAAQ,GAIT,MAAM,MAAM,CAAA;AACb,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAA;AAC5C,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AACtC,OAAO,EAEL,uBAAuB,GAExB,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EACL,2BAA2B,EAC3B,oCAAoC,GACrC,MAAM,kCAAkC,CAAA;AACzC,OAAO,EACL,kCAAkC,EAClC,iCAAiC,GAClC,MAAM,gCAAgC,CAAA;AACvC,OAAO,EACL,uBAAuB,EACvB,8BAA8B,GAC/B,MAAM,6BAA6B,CAAA;AACpC,OAAO,EACL,iCAAiC,EACjC,wBAAwB,EACxB,wBAAwB,GACzB,MAAM,yBAAyB,CAAA;AAGhC,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAA;AAC9D,OAAO,EAEL,mBAAmB,GACpB,MAAM,oCAAoC,CAAA;AAC3C,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAA;AAC7D,OAAO,EAEL,sBAAsB,GACvB,MAAM,4CAA4C,CAAA;AAgCnD,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAKzC,MAIC,EACD,EACE,IAAI,EACJ,eAAe,EACf,QAAQ,EACR,OAAO,EACP,QAAQ,GACwC,EAClD,EAAE;IACF,oBAAoB,CAAC,MAAM,CAAC,CAAA;IAE5B,IAAI,OAAO,IAAI,QAAQ,KAAK,WAAW;QACrC,MAAM,IAAI,iCAAiC,CAAC;YAC1C,SAAS,EAAE,SAAS;YACpB,iBAAiB,EAAE,CAAC,MAAM,EAAE,iBAAiB,EAAE,UAAU,CAAC;YAC1D,OAAO,EACL,iEAAiE;SACpE,CAAC,CAAA;IACJ,QAAQ,QAAQ,EAAE,CAAC;QACjB,KAAK,UAAU,CAAC,CAAC,CAAC;YAChB,MAAM,UAAU,GAAG;gBACjB,OAAO,EAAE,uBAAuB,CAAC;oBAC/B,KAAK,EAAE,MAAM,CAAC,KAAK;oBACnB,QAAQ,EAAE,aAAa;iBACxB,CAAC;gBACF,KAAK,EAAE,MAAM,CAAC,KAAK;gBACnB,OAAO,EAAE,MAAM,CAAC,OAAO;aACf,CAAA;YACV,IAAI,QAAQ,EAAE,CAAC;gBACb,MAAM,EAAE,SAAS,EAAE,WAAW,EAAE,UAAU,EAAE,GAC1C,sBAAsB,CAAC,IAAI,CAAC,CAAA;gBAC9B,OAAO;oBACL,GAAG,UAAU;oBACb,GAAG,EAAE,8BAA8B;oBACnC,YAAY,EAAE,iBAAiB;oBAC/B,IAAI,EAAE,CAAC,UAAU,EAAE,WAAW,EAAE,eAAe,CAAC;iBAGjD,CAAA;YACH,CAAC;YAED,OAAO;gBACL,GAAG,UAAU;gBACb,GAAG,EAAE,uBAAuB;gBAC5B,YAAY,EAAE,UAAU;gBACxB,IAAI,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,eAAe,CAAC;aAGxC,CAAA;QACH,CAAC;QACD,KAAK,WAAW,CAAC,CAAC,CAAC;YACjB,IAAI,QAAQ;gBACV,MAAM,IAAI,iCAAiC,CAAC;oBAC1C,SAAS,EAAE,UAAU;oBACrB,iBAAiB,EAAE,CAAC,MAAM,EAAE,iBAAiB,EAAE,UAAU,EAAE,SAAS,CAAC;oBACrE,OAAO,EAAE,4DAA4D;iBACtE,CAAC,CAAA;YACJ,MAAM,QAAQ,GAAG,WAAW,CAAC,IAAI,CAAC,CAAA;YAClC,IAAI,QAAQ,KAAK,SAAS;gBACxB,MAAM,IAAI,wBAAwB,CAAC;oBACjC,QAAQ;oBACR,kBAAkB,EAAE,CAAC,SAAS,CAAC;oBAC/B,OAAO,EACL,iEAAiE;iBACpE,CAAC,CAAA;YACJ,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;YAC9B,MAAM,OAAO,GAAG,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;YAC5C,MAAM,UAAU,GAAG;gBACjB,OAAO,EAAE,uBAAuB,CAAC;oBAC/B,KAAK,EAAE,MAAM,CAAC,KAAK;oBACnB,QAAQ,EAAE,gCAAgC;iBAC3C,CAAC;gBACF,KAAK,EAAE,MAAM,CAAC,KAAK;gBACnB,OAAO,EAAE,MAAM,CAAC,OAAO;aACxB,CAAA;YACD,IAAI,OAAO;gBACT,OAAO;oBACL,GAAG,UAAU;oBACb,GAAG,EAAE,2BAA2B;oBAChC,YAAY,EAAE,SAAS;oBACvB,IAAI,EAAE,CAAC,OAAO,EAAE,eAAe,CAAC;iBAGjC,CAAA;YAEH,OAAO;gBACL,GAAG,UAAU;gBACb,GAAG,EAAE,oCAAoC;gBACzC,YAAY,EAAE,kBAAkB;gBAChC,IAAI,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,eAAe,EAAE,OAAO,CAAC;aAGzD,CAAA;QACH,CAAC;QACD,KAAK,aAAa,CAAC,CAAC,CAAC;YACnB,MAAM,UAAU,GAAG;gBACjB,OAAO,EAAE,uBAAuB,CAAC;oBAC/B,KAAK,EAAE,MAAM,CAAC,KAAK;oBACnB,QAAQ,EAAE,gBAAgB;iBAC3B,CAAC;gBACF,KAAK,EAAE,MAAM,CAAC,KAAK;gBACnB,OAAO,EAAE,MAAM,CAAC,OAAO;aACf,CAAA;YACV,IAAI,QAAQ,EAAE,CAAC;gBACb,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,GAAG,sBAAsB,CAAC,IAAI,CAAC,CAAA;gBAC1D,OAAO;oBACL,GAAG,UAAU;oBACb,GAAG,EAAE,iCAAiC;oBACtC,YAAY,EAAE,iBAAiB;oBAC/B,IAAI,EAAE,CAAC,UAAU,EAAE,KAAK,EAAE,eAAe,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;iBAGzD,CAAA;YACH,CAAC;YAED,OAAO;gBACL,GAAG,UAAU;gBACb,GAAG,EAAE,kCAAkC;gBACvC,YAAY,EAAE,kBAAkB;gBAChC,IAAI,EAAE;oBACJ,MAAM,CAAC,OAAO,CAAC,OAAO;oBACtB,eAAe;oBACf,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;oBACtB,MAAM,CAAC,CAAC,CAAC;oBACT,IAAI;iBACL;aAGF,CAAA;QACH,CAAC;QACD;YACE,MAAM,IAAI,wBAAwB,CAAC;gBACjC,YAAY,EAAE,QAAQ;gBACtB,sBAAsB,EAAE,CAAC,UAAU,EAAE,WAAW,EAAE,aAAa,CAAC;aACjE,CAAC,CAAA;IACN,CAAC;AACH,CAAC,CAAA;AAyBD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAQhC,MAIC,EACD,EACE,IAAI,EACJ,eAAe,EACf,QAAQ,EACR,OAAO,EACP,QAAQ,EACR,GAAG,MAAM,EACuD;IAElE,oBAAoB,CAAC,MAAM,CAAC,CAAA;IAE5B,MAAM,eAAe,GAAG,2BAA2B,CACjD,mBAAmB,CAAC,MAAM,EAAE,MAAM,CAAC,EACnC;QACE,IAAI;QACJ,eAAe;QACf,QAAQ;QACR,OAAO;QACP,QAAQ;KAC0C,CACrD,CAAA;IAED,MAAM,mBAAmB,GAAG,SAAS,CAAC,MAAM,EAAE,aAAa,EAAE,eAAe,CAAC,CAAA;IAC7E,OAAO,mBAAmB,CAAC;QACzB,GAAG,eAAe;QAClB,GAAG,MAAM;KACiB,CAAC,CAAA;AAC/B,CAAC"}

package/dist/actions/wallet/unwrapName.d.ts

@@ -0,0 +1,313 @@
+import type { Account, Address, Chain, GetChainContractAddressErrorType, Hash, WriteContractErrorType } from 'viem';
+import { type ChainWithContracts, type RequireClientContracts } from '../../clients/chain.js';
+import { AdditionalParameterSpecifiedError, RequiredParameterNotSpecifiedError } from '../../errors/general.js';
+import type { ErrorType } from '../../errors/utils.js';
+import type { Eth2ldNameSpecifier, GetNameType, WriteTransactionParameters } from '../../types/index.js';
+import { type ClientWithOverridesErrorType } from '../../utils/clientWithOverrides.js';
+import { type MakeLabelNodeAndParentErrorType } from '../../utils/name/makeLabelNodeAndParent.js';
+export type UnwrapNameWriteParametersParameters<name extends string> = {
+    /** The name to unwrap */
+    name: name;
+    /** The recipient of the unwrapped name */
+    newOwnerAddress: Address;
+    /** The registrant of the unwrapped name (eth-2ld only) */
+    newRegistrantAddress?: Address;
+} & (GetNameType<name> extends Eth2ldNameSpecifier ? {
+    newRegistrantAddress: Address;
+} : {
+    newRegistrantAddress?: never;
+});
+export type UnwrapNameWriteParametersErrorType = MakeLabelNodeAndParentErrorType | AdditionalParameterSpecifiedError | RequiredParameterNotSpecifiedError | GetChainContractAddressErrorType | ErrorType;
+export declare const unwrapNameWriteParameters: <name extends string, chain extends Chain, account extends Account>(client: RequireClientContracts<chain, "ensNameWrapper", account>, { name, newOwnerAddress, newRegistrantAddress, }: UnwrapNameWriteParametersParameters<name>) => {
+    readonly address: `0x${string}`;
+    readonly abi: readonly [{
+        readonly inputs: readonly [];
+        readonly name: "CannotUpgrade";
+        readonly type: "error";
+    }, {
+        readonly inputs: readonly [];
+        readonly name: "IncompatibleParent";
+        readonly type: "error";
+    }, {
+        readonly inputs: readonly [{
+            readonly name: "owner";
+            readonly type: "address";
+        }];
+        readonly name: "IncorrectTargetOwner";
+        readonly type: "error";
+    }, {
+        readonly inputs: readonly [];
+        readonly name: "IncorrectTokenType";
+        readonly type: "error";
+    }, {
+        readonly inputs: readonly [{
+            readonly name: "labelHash";
+            readonly type: "bytes32";
+        }, {
+            readonly name: "expectedLabelhash";
+            readonly type: "bytes32";
+        }];
+        readonly name: "LabelMismatch";
+        readonly type: "error";
+    }, {
+        readonly inputs: readonly [{
+            readonly name: "label";
+            readonly type: "string";
+        }];
+        readonly name: "LabelTooLong";
+        readonly type: "error";
+    }, {
+        readonly inputs: readonly [];
+        readonly name: "LabelTooShort";
+        readonly type: "error";
+    }, {
+        readonly inputs: readonly [];
+        readonly name: "NameIsNotWrapped";
+        readonly type: "error";
+    }, {
+        readonly inputs: readonly [{
+            readonly name: "node";
+            readonly type: "bytes32";
+        }];
+        readonly name: "OperationProhibited";
+        readonly type: "error";
+    }, {
+        readonly inputs: readonly [{
+            readonly name: "node";
+            readonly type: "bytes32";
+        }, {
+            readonly name: "addr";
+            readonly type: "address";
+        }];
+        readonly name: "Unauthorised";
+        readonly type: "error";
+    }, {
+        readonly inputs: readonly [{
+            readonly name: "labelhash";
+            readonly type: "bytes32";
+        }, {
+            readonly name: "registrant";
+            readonly type: "address";
+        }, {
+            readonly name: "controller";
+            readonly type: "address";
+        }];
+        readonly name: "unwrapETH2LD";
+        readonly outputs: readonly [];
+        readonly stateMutability: "nonpayable";
+        readonly type: "function";
+    }];
+    readonly functionName: "unwrapETH2LD";
+    readonly args: readonly [`0x${string}`, `0x${string}`, `0x${string}`];
+    readonly chain: Omit<Chain, "contracts"> & {
+        contracts: {
+            ensNameWrapper: import("viem").ChainContract;
+        };
+    } & {
+        blockExplorers?: {
+            [key: string]: {
+                name: string;
+                url: string;
+                apiUrl?: string | undefined;
+            };
+            default: {
+                name: string;
+                url: string;
+                apiUrl?: string | undefined;
+            };
+        } | undefined;
+        blockTime?: number | undefined;
+        contracts?: import("viem").Prettify<{
+            [key: string]: import("viem").ChainContract | {
+                [sourceId: number]: import("viem").ChainContract | undefined;
+            } | undefined;
+        } & {
+            ensRegistry?: import("viem").ChainContract | undefined;
+            ensUniversalResolver?: import("viem").ChainContract | undefined;
+            multicall3?: import("viem").ChainContract | undefined;
+            erc6492Verifier?: import("viem").ChainContract | undefined;
+        }> | undefined;
+        ensTlds?: readonly string[] | undefined;
+        id: number;
+        name: string;
+        nativeCurrency: {
+            name: string;
+            symbol: string;
+            decimals: number;
+        };
+        experimental_preconfirmationTime?: number | undefined;
+        rpcUrls: {
+            [key: string]: {
+                http: readonly string[];
+                webSocket?: readonly string[] | undefined;
+            };
+            default: {
+                http: readonly string[];
+                webSocket?: readonly string[] | undefined;
+            };
+        };
+        sourceId?: number | undefined;
+        testnet?: boolean | undefined;
+    } & import("viem").ChainConfig<import("viem").ChainFormatters | undefined, Record<string, unknown> | undefined>;
+    readonly account: Account;
+} | {
+    readonly address: `0x${string}`;
+    readonly abi: readonly [{
+        readonly inputs: readonly [];
+        readonly name: "CannotUpgrade";
+        readonly type: "error";
+    }, {
+        readonly inputs: readonly [];
+        readonly name: "IncompatibleParent";
+        readonly type: "error";
+    }, {
+        readonly inputs: readonly [{
+            readonly name: "owner";
+            readonly type: "address";
+        }];
+        readonly name: "IncorrectTargetOwner";
+        readonly type: "error";
+    }, {
+        readonly inputs: readonly [];
+        readonly name: "IncorrectTokenType";
+        readonly type: "error";
+    }, {
+        readonly inputs: readonly [{
+            readonly name: "labelHash";
+            readonly type: "bytes32";
+        }, {
+            readonly name: "expectedLabelhash";
+            readonly type: "bytes32";
+        }];
+        readonly name: "LabelMismatch";
+        readonly type: "error";
+    }, {
+        readonly inputs: readonly [{
+            readonly name: "label";
+            readonly type: "string";
+        }];
+        readonly name: "LabelTooLong";
+        readonly type: "error";
+    }, {
+        readonly inputs: readonly [];
+        readonly name: "LabelTooShort";
+        readonly type: "error";
+    }, {
+        readonly inputs: readonly [];
+        readonly name: "NameIsNotWrapped";
+        readonly type: "error";
+    }, {
+        readonly inputs: readonly [{
+            readonly name: "node";
+            readonly type: "bytes32";
+        }];
+        readonly name: "OperationProhibited";
+        readonly type: "error";
+    }, {
+        readonly inputs: readonly [{
+            readonly name: "node";
+            readonly type: "bytes32";
+        }, {
+            readonly name: "addr";
+            readonly type: "address";
+        }];
+        readonly name: "Unauthorised";
+        readonly type: "error";
+    }, {
+        readonly inputs: readonly [{
+            readonly name: "parentNode";
+            readonly type: "bytes32";
+        }, {
+            readonly name: "labelhash";
+            readonly type: "bytes32";
+        }, {
+            readonly name: "controller";
+            readonly type: "address";
+        }];
+        readonly name: "unwrap";
+        readonly outputs: readonly [];
+        readonly stateMutability: "nonpayable";
+        readonly type: "function";
+    }];
+    readonly functionName: "unwrap";
+    readonly args: readonly [`0x${string}`, `0x${string}`, `0x${string}`];
+    readonly chain: Omit<Chain, "contracts"> & {
+        contracts: {
+            ensNameWrapper: import("viem").ChainContract;
+        };
+    } & {
+        blockExplorers?: {
+            [key: string]: {
+                name: string;
+                url: string;
+                apiUrl?: string | undefined;
+            };
+            default: {
+                name: string;
+                url: string;
+                apiUrl?: string | undefined;
+            };
+        } | undefined;
+        blockTime?: number | undefined;
+        contracts?: import("viem").Prettify<{
+            [key: string]: import("viem").ChainContract | {
+                [sourceId: number]: import("viem").ChainContract | undefined;
+            } | undefined;
+        } & {
+            ensRegistry?: import("viem").ChainContract | undefined;
+            ensUniversalResolver?: import("viem").ChainContract | undefined;
+            multicall3?: import("viem").ChainContract | undefined;
+            erc6492Verifier?: import("viem").ChainContract | undefined;
+        }> | undefined;
+        ensTlds?: readonly string[] | undefined;
+        id: number;
+        name: string;
+        nativeCurrency: {
+            name: string;
+            symbol: string;
+            decimals: number;
+        };
+        experimental_preconfirmationTime?: number | undefined;
+        rpcUrls: {
+            [key: string]: {
+                http: readonly string[];
+                webSocket?: readonly string[] | undefined;
+            };
+            default: {
+                http: readonly string[];
+                webSocket?: readonly string[] | undefined;
+            };
+        };
+        sourceId?: number | undefined;
+        testnet?: boolean | undefined;
+    } & import("viem").ChainConfig<import("viem").ChainFormatters | undefined, Record<string, unknown> | undefined>;
+    readonly account: Account;
+};
+export type UnwrapNameParameters<name extends string, chain extends Chain, account extends Account, chainOverride extends ChainWithContracts<'ensNameWrapper'>> = UnwrapNameWriteParametersParameters<name> & WriteTransactionParameters<chain, account, chainOverride>;
+export type UnwrapNameReturnType = Hash;
+export type UnwrapNameErrorType = UnwrapNameWriteParametersErrorType | ClientWithOverridesErrorType | WriteContractErrorType;
+/**
+ * Unwraps a name.
+ * @param client - {@link Client}
+ * @param options - {@link UnwrapNameParameters}
+ * @returns Transaction hash. {@link UnwrapNameReturnType}
+ *
+ * @example
+ * import { createWalletClient, custom } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { unwrapName } from '@ensdomains/ensjs/wallet'
+ *
+ * const wallet = createWalletClient({
+ *   chain: addEnsContracts(mainnet),
+ *   transport: custom(window.ethereum),
+ * })
+ * const hash = await unwrapName(wallet, {
+ *   name: 'example.eth',
+ *   newOwnerAddress: '0xFe89cc7aBB2C4183683ab71653C4cdc9B02D44b7',
+ *   newRegistrantAddress: '0xFe89cc7aBB2C4183683ab71653C4cdc9B02D44b7',
+ * })
+ * // 0x...
+ */
+export declare function unwrapName<name extends string, chain extends Chain, account extends Account, chainOverride extends ChainWithContracts<'ensNameWrapper'>>(client: RequireClientContracts<chain, 'ensNameWrapper', account>, { name, newOwnerAddress, newRegistrantAddress, ...txArgs }: UnwrapNameParameters<name, chain, account, chainOverride>): Promise<UnwrapNameReturnType>;
+//# sourceMappingURL=unwrapName.d.ts.map

package/dist/actions/wallet/unwrapName.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"unwrapName.d.ts","sourceRoot":"","sources":["../../../src/actions/wallet/unwrapName.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,OAAO,EACP,OAAO,EACP,KAAK,EACL,gCAAgC,EAChC,IAAI,EACJ,sBAAsB,EAEvB,MAAM,MAAM,CAAA;AAGb,OAAO,EACL,KAAK,kBAAkB,EAEvB,KAAK,sBAAsB,EAC5B,MAAM,wBAAwB,CAAA;AAK/B,OAAO,EACL,iCAAiC,EACjC,kCAAkC,EACnC,MAAM,yBAAyB,CAAA;AAChC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAA;AACtD,OAAO,KAAK,EACV,mBAAmB,EACnB,WAAW,EACX,0BAA0B,EAC3B,MAAM,sBAAsB,CAAA;AAE7B,OAAO,EACL,KAAK,4BAA4B,EAElC,MAAM,oCAAoC,CAAA;AAE3C,OAAO,EACL,KAAK,+BAA+B,EAErC,MAAM,4CAA4C,CAAA;AAEnD,MAAM,MAAM,mCAAmC,CAAC,IAAI,SAAS,MAAM,IAAI;IACrE,yBAAyB;IACzB,IAAI,EAAE,IAAI,CAAA;IACV,0CAA0C;IAC1C,eAAe,EAAE,OAAO,CAAA;IACxB,0DAA0D;IAC1D,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,mBAAmB,GAC9C;IACE,oBAAoB,EAAE,OAAO,CAAA;CAC9B,GACD;IACE,oBAAoB,CAAC,EAAE,KAAK,CAAA;CAC7B,CAAC,CAAA;AAIN,MAAM,MAAM,kCAAkC,GAC1C,+BAA+B,GAC/B,iCAAiC,GACjC,kCAAkC,GAClC,gCAAgC,GAChC,SAAS,CAAA;AAEb,eAAO,MAAM,yBAAyB,GACpC,IAAI,SAAS,MAAM,EACnB,KAAK,SAAS,KAAK,EACnB,OAAO,SAAS,OAAO,EAEvB,QAAQ,sBAAsB,CAAC,KAAK,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAChE,kDAIG,mCAAmC,CAAC,IAAI,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;uBAzBjB,CAAC;gCAI1B,CAAC;sBAEuC,CAAC;2BAE1B,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;uBARS,CAAC;gCAI1B,CAAC;sBAEuC,CAAC;2BAE1B,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;CA8DnB,CAAA;AAMD,MAAM,MAAM,oBAAoB,CAC9B,IAAI,SAAS,MAAM,EACnB,KAAK,SAAS,KAAK,EACnB,OAAO,SAAS,OAAO,EACvB,aAAa,SAAS,kBAAkB,CAAC,gBAAgB,CAAC,IACxD,mCAAmC,CAAC,IAAI,CAAC,GAC3C,0BAA0B,CAAC,KAAK,EAAE,OAAO,EAAE,aAAa,CAAC,CAAA;AAE3D,MAAM,MAAM,oBAAoB,GAAG,IAAI,CAAA;AAEvC,MAAM,MAAM,mBAAmB,GAC3B,kCAAkC,GAClC,4BAA4B,GAC5B,sBAAsB,CAAA;AAE1B;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAsB,UAAU,CAC9B,IAAI,SAAS,MAAM,EACnB,KAAK,SAAS,KAAK,EACnB,OAAO,SAAS,OAAO,EACvB,aAAa,SAAS,kBAAkB,CAAC,gBAAgB,CAAC,EAE1D,MAAM,EAAE,sBAAsB,CAAC,KAAK,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAChE,EACE,IAAI,EACJ,eAAe,EACf,oBAAoB,EACpB,GAAG,MAAM,EACV,EAAE,oBAAoB,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,aAAa,CAAC,GAC3D,OAAO,CAAC,oBAAoB,CAAC,CAgB/B"}

package/dist/actions/wallet/unwrapName.js

@@ -0,0 +1,84 @@
+import { writeContract } from 'viem/actions';
+import { getAction } from 'viem/utils';
+import { getChainContractAddress, } from '../../clients/chain.js';
+import { nameWrapperUnwrapEth2ldSnippet, nameWrapperUnwrapSnippet, } from '../../contracts/nameWrapper.js';
+import { AdditionalParameterSpecifiedError, RequiredParameterNotSpecifiedError, } from '../../errors/general.js';
+import { ASSERT_NO_TYPE_ERROR } from '../../types/internal.js';
+import { clientWithOverrides, } from '../../utils/clientWithOverrides.js';
+import { getNameType } from '../../utils/name/getNameType.js';
+import { makeLabelNodeAndParent, } from '../../utils/name/makeLabelNodeAndParent.js';
+export const unwrapNameWriteParameters = (client, { name, newOwnerAddress, newRegistrantAddress, }) => {
+    ASSERT_NO_TYPE_ERROR(client);
+    const { labelhash, parentNode } = makeLabelNodeAndParent(name);
+    const nameWrapperAddress = getChainContractAddress({
+        chain: client.chain,
+        contract: 'ensNameWrapper',
+    });
+    const nameType = getNameType(name);
+    if (nameType === 'eth-2ld') {
+        if (!newRegistrantAddress)
+            throw new RequiredParameterNotSpecifiedError({
+                parameter: 'newRegistrantAddress',
+                details: 'Must provide newRegistrantAddress for eth-2ld names',
+            });
+        return {
+            address: nameWrapperAddress,
+            abi: nameWrapperUnwrapEth2ldSnippet,
+            functionName: 'unwrapETH2LD',
+            args: [labelhash, newRegistrantAddress, newOwnerAddress],
+            chain: client.chain,
+            account: client.account,
+        };
+    }
+    if (newRegistrantAddress)
+        throw new AdditionalParameterSpecifiedError({
+            parameter: 'newRegistrantAddress',
+            allowedParameters: ['name', 'newOwnerAddress'],
+            details: 'newRegistrantAddress can only be specified for eth-2ld names',
+        });
+    return {
+        address: nameWrapperAddress,
+        abi: nameWrapperUnwrapSnippet,
+        functionName: 'unwrap',
+        args: [parentNode, labelhash, newOwnerAddress],
+        chain: client.chain,
+        account: client.account,
+    };
+};
+/**
+ * Unwraps a name.
+ * @param client - {@link Client}
+ * @param options - {@link UnwrapNameParameters}
+ * @returns Transaction hash. {@link UnwrapNameReturnType}
+ *
+ * @example
+ * import { createWalletClient, custom } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { unwrapName } from '@ensdomains/ensjs/wallet'
+ *
+ * const wallet = createWalletClient({
+ *   chain: addEnsContracts(mainnet),
+ *   transport: custom(window.ethereum),
+ * })
+ * const hash = await unwrapName(wallet, {
+ *   name: 'example.eth',
+ *   newOwnerAddress: '0xFe89cc7aBB2C4183683ab71653C4cdc9B02D44b7',
+ *   newRegistrantAddress: '0xFe89cc7aBB2C4183683ab71653C4cdc9B02D44b7',
+ * })
+ * // 0x...
+ */
+export async function unwrapName(client, { name, newOwnerAddress, newRegistrantAddress, ...txArgs }) {
+    ASSERT_NO_TYPE_ERROR(client);
+    const writeParameters = unwrapNameWriteParameters(clientWithOverrides(client, txArgs), {
+        name,
+        newOwnerAddress,
+        newRegistrantAddress,
+    });
+    const writeContractAction = getAction(client, writeContract, 'writeContract');
+    return writeContractAction({
+        ...writeParameters,
+        ...txArgs,
+    });
+}
+//# sourceMappingURL=unwrapName.js.map

package/dist/actions/wallet/unwrapName.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"unwrapName.js","sourceRoot":"","sources":["../../../src/actions/wallet/unwrapName.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAA;AAC5C,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AACtC,OAAO,EAEL,uBAAuB,GAExB,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EACL,8BAA8B,EAC9B,wBAAwB,GACzB,MAAM,gCAAgC,CAAA;AACvC,OAAO,EACL,iCAAiC,EACjC,kCAAkC,GACnC,MAAM,yBAAyB,CAAA;AAOhC,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAA;AAC9D,OAAO,EAEL,mBAAmB,GACpB,MAAM,oCAAoC,CAAA;AAC3C,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAA;AAC7D,OAAO,EAEL,sBAAsB,GACvB,MAAM,4CAA4C,CAAA;AA0BnD,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAKvC,MAAgE,EAChE,EACE,IAAI,EACJ,eAAe,EACf,oBAAoB,GACsB,EAC5C,EAAE;IACF,oBAAoB,CAAC,MAAM,CAAC,CAAA;IAE5B,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,GAAG,sBAAsB,CAAC,IAAI,CAAC,CAAA;IAC9D,MAAM,kBAAkB,GAAG,uBAAuB,CAAC;QACjD,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,QAAQ,EAAE,gBAAgB;KAC3B,CAAC,CAAA;IACF,MAAM,QAAQ,GAAG,WAAW,CAAC,IAAI,CAAC,CAAA;IAElC,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QAC3B,IAAI,CAAC,oBAAoB;YACvB,MAAM,IAAI,kCAAkC,CAAC;gBAC3C,SAAS,EAAE,sBAAsB;gBACjC,OAAO,EAAE,qDAAqD;aAC/D,CAAC,CAAA;QAEJ,OAAO;YACL,OAAO,EAAE,kBAAkB;YAC3B,GAAG,EAAE,8BAA8B;YACnC,YAAY,EAAE,cAAc;YAC5B,IAAI,EAAE,CAAC,SAAS,EAAE,oBAAoB,EAAE,eAAe,CAAC;YACxD,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,OAAO,EAAE,MAAM,CAAC,OAAO;SAGxB,CAAA;IACH,CAAC;IAED,IAAI,oBAAoB;QACtB,MAAM,IAAI,iCAAiC,CAAC;YAC1C,SAAS,EAAE,sBAAsB;YACjC,iBAAiB,EAAE,CAAC,MAAM,EAAE,iBAAiB,CAAC;YAC9C,OAAO,EAAE,8DAA8D;SACxE,CAAC,CAAA;IAEJ,OAAO;QACL,OAAO,EAAE,kBAAkB;QAC3B,GAAG,EAAE,wBAAwB;QAC7B,YAAY,EAAE,QAAQ;QACtB,IAAI,EAAE,CAAC,UAAU,EAAE,SAAS,EAAE,eAAe,CAAC;QAC9C,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,OAAO,EAAE,MAAM,CAAC,OAAO;KACoD,CAAA;AAC/E,CAAC,CAAA;AAqBD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAM9B,MAAgE,EAChE,EACE,IAAI,EACJ,eAAe,EACf,oBAAoB,EACpB,GAAG,MAAM,EACiD;IAE5D,oBAAoB,CAAC,MAAM,CAAC,CAAA;IAE5B,MAAM,eAAe,GAAG,yBAAyB,CAC/C,mBAAmB,CAAC,MAAM,EAAE,MAAM,CAAC,EACnC;QACE,IAAI;QACJ,eAAe;QACf,oBAAoB;KACwB,CAC/C,CAAA;IACD,MAAM,mBAAmB,GAAG,SAAS,CAAC,MAAM,EAAE,aAAa,EAAE,eAAe,CAAC,CAAA;IAC7E,OAAO,mBAAmB,CAAC;QACzB,GAAG,eAAe;QAClB,GAAG,MAAM;KACiB,CAAC,CAAA;AAC/B,CAAC"}