@ensdomains/ensjs 4.1.2 → 5.0.0-alpha.0

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

@@ -0,0 +1,171 @@
+import type { Account, Chain, GetChainContractAddressErrorType, Hash, WriteContractErrorType } from 'viem';
+import { type ChainWithContracts, type RequireClientContracts } from '../../clients/chain.js';
+import { UnsupportedNameTypeError } from '../../errors/general.js';
+import type { Prettify, WriteTransactionParameters } from '../../types/index.js';
+import { type ClientWithOverridesErrorType } from '../../utils/clientWithOverrides.js';
+import { type L2RegistrationParameters, type MakeL2CommitmentErrorType } from '../../utils/l2RegisterHelpers.js';
+import { type WrappedLabelLengthCheckErrorType } from '../../utils/wrapper.js';
+export type CommitNameWriteParametersParameters = L2RegistrationParameters;
+export type CommitNameWriteParametersReturnType<chain extends Chain, account extends Account> = ReturnType<typeof commitNameWriteParameters<chain, account>>;
+export type CommitNameWriteParametersErrorType = UnsupportedNameTypeError | WrappedLabelLengthCheckErrorType | GetChainContractAddressErrorType | MakeL2CommitmentErrorType;
+export declare const commitNameWriteParameters: <chain extends Chain, account extends Account>(client: RequireClientContracts<chain, "ensL2EthRegistrar", account>, args: CommitNameWriteParametersParameters) => {
+    readonly address: `0x${string}`;
+    readonly abi: readonly [{
+        readonly inputs: readonly [{
+            readonly name: "commitment";
+            readonly type: "bytes32";
+        }, {
+            readonly name: "validFrom";
+            readonly type: "uint256";
+        }, {
+            readonly name: "blockTimestamp";
+            readonly type: "uint256";
+        }];
+        readonly name: "CommitmentTooNew";
+        readonly type: "error";
+    }, {
+        readonly inputs: readonly [{
+            readonly name: "commitment";
+            readonly type: "bytes32";
+        }, {
+            readonly name: "validTo";
+            readonly type: "uint256";
+        }, {
+            readonly name: "blockTimestamp";
+            readonly type: "uint256";
+        }];
+        readonly name: "CommitmentTooOld";
+        readonly type: "error";
+    }, {
+        readonly inputs: readonly [{
+            readonly name: "duration";
+            readonly type: "uint64";
+        }, {
+            readonly name: "minDuration";
+            readonly type: "uint256";
+        }];
+        readonly name: "DurationTooShort";
+        readonly type: "error";
+    }, {
+        readonly inputs: readonly [{
+            readonly name: "required";
+            readonly type: "uint256";
+        }, {
+            readonly name: "provided";
+            readonly type: "uint256";
+        }];
+        readonly name: "InsufficientValue";
+        readonly type: "error";
+    }, {
+        readonly inputs: readonly [];
+        readonly name: "MaxCommitmentAgeTooLow";
+        readonly type: "error";
+    }, {
+        readonly inputs: readonly [{
+            readonly name: "name";
+            readonly type: "string";
+        }];
+        readonly name: "NameNotAvailable";
+        readonly type: "error";
+    }, {
+        readonly inputs: readonly [{
+            readonly name: "commitment";
+            readonly type: "bytes32";
+        }];
+        readonly name: "UnexpiredCommitmentExists";
+        readonly type: "error";
+    }, {
+        readonly inputs: readonly [{
+            readonly name: "commitment";
+            readonly type: "bytes32";
+        }];
+        readonly name: "commit";
+        readonly outputs: readonly [];
+        readonly stateMutability: "nonpayable";
+        readonly type: "function";
+    }];
+    readonly functionName: "commit";
+    readonly args: readonly [`0x${string}`];
+    readonly chain: Omit<Chain, "contracts"> & {
+        contracts: {
+            ensL2EthRegistrar: 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 CommitNameParameters<chain extends Chain, account extends Account, chainOverride extends ChainWithContracts<'ensL2EthRegistrar'> | undefined> = Prettify<CommitNameWriteParametersParameters & WriteTransactionParameters<chain, account, chainOverride>>;
+export type CommitNameReturnType = Hash;
+export type CommitNameErrorType = CommitNameWriteParametersErrorType | ClientWithOverridesErrorType | WriteContractErrorType;
+/**
+ * Commits a name to be registered
+ * @param client - {@link Client}
+ * @param options - {@link CommitNameOptions}
+ * @returns Transaction hash. {@link CommitNameReturnType}
+ *
+ * @example
+ * import { createWalletClient, custom } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { commitName } from '@ensdomains/ensjs/wallet'
+ * import { randomSecret } from '@ensdomains/ensjs/utils'
+ *
+ * const wallet = createWalletClient({
+ *   chain: addEnsContracts(mainnet),
+ *   transport: custom(window.ethereum),
+ * })
+ * const secret = randomSecret()
+ * const hash = await commitName(wallet, {
+ *   name: 'example.eth',
+ *   owner: '0xFe89cc7aBB2C4183683ab71653C4cdc9B02D44b7',
+ *   duration: 31536000, // 1 year
+ *   secret,
+ * })
+ * // 0x...
+ */
+export declare function commitName<chain extends Chain, account extends Account, chainOverride extends ChainWithContracts<'ensL2EthRegistrar'> | undefined>(client: RequireClientContracts<chain, 'ensL2EthRegistrar', account>, { name, owner, duration, secret, resolverAddress, subregistryAddress, ...txArgs }: CommitNameParameters<chain, account, chainOverride>): Promise<CommitNameReturnType>;
+//# sourceMappingURL=commitName.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"commitName.d.ts","sourceRoot":"","sources":["../../../src/actions/wallet/commitName.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,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;AAE/B,OAAO,EAAE,wBAAwB,EAAE,MAAM,yBAAyB,CAAA;AAClE,OAAO,KAAK,EAAE,QAAQ,EAAE,0BAA0B,EAAE,MAAM,sBAAsB,CAAA;AAEhF,OAAO,EACL,KAAK,4BAA4B,EAElC,MAAM,oCAAoC,CAAA;AAC3C,OAAO,EACL,KAAK,wBAAwB,EAC7B,KAAK,yBAAyB,EAE/B,MAAM,kCAAkC,CAAA;AAEzC,OAAO,EACL,KAAK,gCAAgC,EAEtC,MAAM,wBAAwB,CAAA;AAgC/B,MAAM,MAAM,mCAAmC,GAAG,wBAAwB,CAAA;AAE1E,MAAM,MAAM,mCAAmC,CAC7C,KAAK,SAAS,KAAK,EACnB,OAAO,SAAS,OAAO,IACrB,UAAU,CAAC,OAAO,yBAAyB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAA;AAEhE,MAAM,MAAM,kCAAkC,GAC1C,wBAAwB,GACxB,gCAAgC,GAChC,gCAAgC,GAChC,yBAAyB,CAAA;AAE7B,eAAO,MAAM,yBAAyB,GACpC,KAAK,SAAS,KAAK,EACnB,OAAO,SAAS,OAAO,EAEvB,QAAQ,sBAAsB,CAAC,KAAK,EAAE,mBAAmB,EAAE,OAAO,CAAC,EACnE,MAAM,mCAAmC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;uBArCqB,CAAC;gCAG1D,CAAC;sBAA+C,CAAC;2BAIzC,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;CAwDf,CAAA;AAMD,MAAM,MAAM,oBAAoB,CAC9B,KAAK,SAAS,KAAK,EACnB,OAAO,SAAS,OAAO,EACvB,aAAa,SAAS,kBAAkB,CAAC,mBAAmB,CAAC,GAAG,SAAS,IACvE,QAAQ,CACV,mCAAmC,GACjC,0BAA0B,CAAC,KAAK,EAAE,OAAO,EAAE,aAAa,CAAC,CAC5D,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG,IAAI,CAAA;AAEvC,MAAM,MAAM,mBAAmB,GAC3B,kCAAkC,GAClC,4BAA4B,GAC5B,sBAAsB,CAAA;AAE1B;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAsB,UAAU,CAC9B,KAAK,SAAS,KAAK,EACnB,OAAO,SAAS,OAAO,EACvB,aAAa,SAAS,kBAAkB,CAAC,mBAAmB,CAAC,GAAG,SAAS,EAEzE,MAAM,EAAE,sBAAsB,CAAC,KAAK,EAAE,mBAAmB,EAAE,OAAO,CAAC,EACnE,EACE,IAAI,EACJ,KAAK,EACL,QAAQ,EACR,MAAM,EACN,eAAe,EACf,kBAAkB,EAClB,GAAG,MAAM,EACV,EAAE,oBAAoB,CAAC,KAAK,EAAE,OAAO,EAAE,aAAa,CAAC,GACrD,OAAO,CAAC,oBAAoB,CAAC,CAmB/B"}

package/dist/actions/wallet/commitName.js

@@ -0,0 +1,76 @@
+import { writeContract } from 'viem/actions';
+import { getAction } from 'viem/utils';
+import { getChainContractAddress, } from '../../clients/chain.js';
+import { l2EthRegistrarCommitSnippet } from '../../contracts/l2EthRegistrar.js';
+import { UnsupportedNameTypeError } from '../../errors/general.js';
+import { ASSERT_NO_TYPE_ERROR } from '../../types/internal.js';
+import { clientWithOverrides, } from '../../utils/clientWithOverrides.js';
+import { makeL2Commitment, } from '../../utils/l2RegisterHelpers.js';
+import { getNameType } from '../../utils/name/getNameType.js';
+import { wrappedLabelLengthCheck, } from '../../utils/wrapper.js';
+export const commitNameWriteParameters = (client, args) => {
+    ASSERT_NO_TYPE_ERROR(client);
+    const labels = args.name.split('.');
+    const nameType = getNameType(args.name);
+    if (nameType !== 'eth-2ld')
+        throw new UnsupportedNameTypeError({
+            nameType,
+            supportedNameTypes: ['eth-2ld'],
+            details: 'Only 2ld-eth name registration is supported',
+        });
+    wrappedLabelLengthCheck(labels[0]);
+    return {
+        address: getChainContractAddress({
+            chain: client.chain,
+            contract: 'ensL2EthRegistrar',
+        }),
+        abi: l2EthRegistrarCommitSnippet,
+        functionName: 'commit',
+        args: [makeL2Commitment(args)],
+        chain: client.chain,
+        account: client.account,
+    };
+};
+/**
+ * Commits a name to be registered
+ * @param client - {@link Client}
+ * @param options - {@link CommitNameOptions}
+ * @returns Transaction hash. {@link CommitNameReturnType}
+ *
+ * @example
+ * import { createWalletClient, custom } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { commitName } from '@ensdomains/ensjs/wallet'
+ * import { randomSecret } from '@ensdomains/ensjs/utils'
+ *
+ * const wallet = createWalletClient({
+ *   chain: addEnsContracts(mainnet),
+ *   transport: custom(window.ethereum),
+ * })
+ * const secret = randomSecret()
+ * const hash = await commitName(wallet, {
+ *   name: 'example.eth',
+ *   owner: '0xFe89cc7aBB2C4183683ab71653C4cdc9B02D44b7',
+ *   duration: 31536000, // 1 year
+ *   secret,
+ * })
+ * // 0x...
+ */
+export async function commitName(client, { name, owner, duration, secret, resolverAddress, subregistryAddress, ...txArgs }) {
+    ASSERT_NO_TYPE_ERROR(client);
+    const writeParameters = commitNameWriteParameters(clientWithOverrides(client, txArgs), {
+        name,
+        owner,
+        duration,
+        secret,
+        resolverAddress,
+        subregistryAddress,
+    });
+    const writeContractAction = getAction(client, writeContract, 'writeContract');
+    return writeContractAction({
+        ...writeParameters,
+        ...txArgs,
+    });
+}
+//# sourceMappingURL=commitName.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"commitName.js","sourceRoot":"","sources":["../../../src/actions/wallet/commitName.ts"],"names":[],"mappings":"AAQA,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,EAAE,2BAA2B,EAAE,MAAM,mCAAmC,CAAA;AAC/E,OAAO,EAAE,wBAAwB,EAAE,MAAM,yBAAyB,CAAA;AAElE,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAA;AAC9D,OAAO,EAEL,mBAAmB,GACpB,MAAM,oCAAoC,CAAA;AAC3C,OAAO,EAGL,gBAAgB,GACjB,MAAM,kCAAkC,CAAA;AACzC,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAA;AAC7D,OAAO,EAEL,uBAAuB,GACxB,MAAM,wBAAwB,CAAA;AA6C/B,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAIvC,MAAmE,EACnE,IAAyC,EACzC,EAAE;IACF,oBAAoB,CAAC,MAAM,CAAC,CAAA;IAE5B,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IACnC,MAAM,QAAQ,GAAG,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACvC,IAAI,QAAQ,KAAK,SAAS;QACxB,MAAM,IAAI,wBAAwB,CAAC;YACjC,QAAQ;YACR,kBAAkB,EAAE,CAAC,SAAS,CAAC;YAC/B,OAAO,EAAE,6CAA6C;SACvD,CAAC,CAAA;IACJ,uBAAuB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;IAClC,OAAO;QACL,OAAO,EAAE,uBAAuB,CAAC;YAC/B,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,QAAQ,EAAE,mBAAmB;SAC9B,CAAC;QACF,GAAG,EAAE,2BAA2B;QAChC,YAAY,EAAE,QAAQ;QACtB,IAAI,EAAE,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;QAC9B,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,OAAO,EAAE,MAAM,CAAC,OAAO;KAGxB,CAAA;AACH,CAAC,CAAA;AAsBD;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAK9B,MAAmE,EACnE,EACE,IAAI,EACJ,KAAK,EACL,QAAQ,EACR,MAAM,EACN,eAAe,EACf,kBAAkB,EAClB,GAAG,MAAM,EAC2C;IAEtD,oBAAoB,CAAC,MAAM,CAAC,CAAA;IAE5B,MAAM,eAAe,GAAG,yBAAyB,CAC/C,mBAAmB,CAAC,MAAM,EAAE,MAAM,CAAC,EACnC;QACE,IAAI;QACJ,KAAK;QACL,QAAQ;QACR,MAAM;QACN,eAAe;QACf,kBAAkB;KACnB,CACF,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"}

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

@@ -0,0 +1,83 @@
+import { type Account, type Address, type Chain, type EncodeFunctionDataErrorType, type GetChainContractAddressErrorType, type Hash, type SendTransactionErrorType } from 'viem';
+import { type ChainWithContracts, type RequireClientContracts } from '../../clients/chain.js';
+import { BaseError } from '../../errors/base.js';
+import { InvalidContractTypeError, UnsupportedNameTypeError } from '../../errors/general.js';
+import type { AnyDate, Prettify, SimpleTransactionRequest, WriteTransactionParameters } from '../../types/index.js';
+import { type EncodeFusesErrorType, type EncodeFusesInputObject } from '../../utils/fuses.js';
+import { type MakeLabelNodeAndParentErrorType } from '../../utils/name/makeLabelNodeAndParent.js';
+import { type ExpiryToBigIntErrorType, type MakeDefaultExpiryErrorType, type WrappedLabelLengthCheckErrorType } from '../../utils/wrapper.js';
+import { type GetWrapperDataErrorType } from '../public/getWrapperData.js';
+type RegistryCreateSubnameDataParameters = {
+    contract: 'registry';
+    expiry?: never;
+    fuses?: never;
+};
+type NameWrapperCreateSubnameDataParameters = {
+    contract: 'nameWrapper';
+    expiry?: AnyDate;
+    fuses?: EncodeFusesInputObject;
+};
+declare class CreateSubnamePermissionDeniedError extends BaseError {
+    parentName: string;
+    name: string;
+    constructor({ parentName }: {
+        parentName: string;
+    });
+}
+declare class CreateSubnameParentNotLockedError extends BaseError {
+    parentName: string;
+    name: string;
+    constructor({ parentName }: {
+        parentName: string;
+    });
+}
+export type MakeCreateSubnameFunctionDataParameters = {
+    /** Subname to create */
+    name: string;
+    /** New owner of subname */
+    owner: Address;
+    /** Contract to create subname on */
+    contract: 'registry' | 'nameWrapper';
+    /** Resolver address to set */
+    resolverAddress?: Address;
+    /** Expiry to set (only on NameWrapper) */
+    expiry?: AnyDate;
+    /** Fuses to set (only on NameWrapper) */
+    fuses?: EncodeFusesInputObject;
+} & (RegistryCreateSubnameDataParameters | NameWrapperCreateSubnameDataParameters);
+export type MakeCreateSubnameFunctionDataReturnType = SimpleTransactionRequest;
+export type MakeCreateSubnameFunctionDataErrorType = GetChainContractAddressErrorType | UnsupportedNameTypeError | MakeLabelNodeAndParentErrorType | EncodeFunctionDataErrorType | WrappedLabelLengthCheckErrorType | EncodeFusesErrorType | ExpiryToBigIntErrorType | MakeDefaultExpiryErrorType | InvalidContractTypeError;
+export declare const makeCreateSubnameFunctionData: <chain extends Chain, account extends Account | undefined>(wallet: RequireClientContracts<chain, "ensPublicResolver" | "ensNameWrapper", account>, { name, contract, owner, resolverAddress, expiry, fuses, }: MakeCreateSubnameFunctionDataParameters) => MakeCreateSubnameFunctionDataReturnType;
+type CheckCanCreateSubnameErrorType = GetWrapperDataErrorType | CreateSubnamePermissionDeniedError | EncodeFusesErrorType | CreateSubnameParentNotLockedError;
+export type CreateSubnameParameters<chain extends Chain, account extends Account | undefined, chainOverride extends ChainWithContracts<'ensPublicResolver' | 'ensNameWrapper'> | undefined> = Prettify<MakeCreateSubnameFunctionDataParameters & WriteTransactionParameters<chain, account, chainOverride>>;
+export type CreateSubnameReturnType = Hash;
+export type CreateSubnameErrorType = CheckCanCreateSubnameErrorType | MakeCreateSubnameFunctionDataErrorType | SendTransactionErrorType;
+/**
+ * Creates a subname
+ * @param wallet - {@link ClientWithAccount}
+ * @param parameters - {@link CreateSubnameParameters}
+ * @returns Transaction hash. {@link CreateSubnameReturnType}
+ *
+ * @example
+ * import { createWalletClient, custom } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { createSubname } from '@ensdomains/ensjs/wallet'
+ *
+ * const wallet = createWalletClient({
+ *   chain: addEnsContracts(mainnet),
+ *   transport: custom(window.ethereum),
+ * })
+ * const hash = await createSubname(wallet, {
+ *   name: 'sub.ens.eth',
+ *   owner: '0xFe89cc7aBB2C4183683ab71653C4cdc9B02D44b7',
+ *   contract: 'registry',
+ * })
+ * // 0x...
+ */
+export declare function createSubname<chain extends Chain, account extends Account | undefined, chainOverride extends ChainWithContracts<'ensPublicResolver' | 'ensNameWrapper'> | undefined = ChainWithContracts<'ensPublicResolver' | 'ensNameWrapper'>>(wallet: RequireClientContracts<chain, 'ensNameWrapper' | 'ensPublicResolver', account>, { name, contract, owner, resolverAddress, expiry, fuses, ...txArgs }: CreateSubnameParameters<chain, account, chainOverride>): Promise<CreateSubnameReturnType>;
+export declare namespace createSubname {
+    var makeFunctionData: <chain extends Chain, account extends Account | undefined>(wallet: RequireClientContracts<chain, "ensPublicResolver" | "ensNameWrapper", account>, { name, contract, owner, resolverAddress, expiry, fuses, }: MakeCreateSubnameFunctionDataParameters) => MakeCreateSubnameFunctionDataReturnType;
+}
+export {};
+//# sourceMappingURL=createSubname.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"createSubname.d.ts","sourceRoot":"","sources":["../../../src/actions/wallet/createSubname.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,OAAO,EACZ,KAAK,OAAO,EACZ,KAAK,KAAK,EAEV,KAAK,2BAA2B,EAEhC,KAAK,gCAAgC,EACrC,KAAK,IAAI,EACT,KAAK,wBAAwB,EAG9B,MAAM,MAAM,CAAA;AAEb,OAAO,EACL,KAAK,kBAAkB,EAEvB,KAAK,sBAAsB,EAC5B,MAAM,wBAAwB,CAAA;AAG/B,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AAChD,OAAO,EACL,wBAAwB,EACxB,wBAAwB,EACzB,MAAM,yBAAyB,CAAA;AAChC,OAAO,KAAK,EACV,OAAO,EACP,QAAQ,EACR,wBAAwB,EACxB,0BAA0B,EAC3B,MAAM,sBAAsB,CAAA;AAK7B,OAAO,EACL,KAAK,oBAAoB,EACzB,KAAK,sBAAsB,EAG5B,MAAM,sBAAsB,CAAA;AAE7B,OAAO,EACL,KAAK,+BAA+B,EAErC,MAAM,4CAA4C,CAAA;AACnD,OAAO,EACL,KAAK,uBAAuB,EAE5B,KAAK,0BAA0B,EAE/B,KAAK,gCAAgC,EAEtC,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EACL,KAAK,uBAAuB,EAE7B,MAAM,6BAA6B,CAAA;AAEpC,KAAK,mCAAmC,GAAG;IACzC,QAAQ,EAAE,UAAU,CAAA;IACpB,MAAM,CAAC,EAAE,KAAK,CAAA;IACd,KAAK,CAAC,EAAE,KAAK,CAAA;CACd,CAAA;AAED,KAAK,sCAAsC,GAAG;IAC5C,QAAQ,EAAE,aAAa,CAAA;IACvB,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,KAAK,CAAC,EAAE,sBAAsB,CAAA;CAC/B,CAAA;AAMD,cAAM,kCAAmC,SAAQ,SAAS;IACxD,UAAU,EAAE,MAAM,CAAA;IAET,IAAI,SAAuC;gBAExC,EAAE,UAAU,EAAE,EAAE;QAAE,UAAU,EAAE,MAAM,CAAA;KAAE;CAMnD;AAED,cAAM,iCAAkC,SAAQ,SAAS;IACvD,UAAU,EAAE,MAAM,CAAA;IAET,IAAI,SAAsC;gBAEvC,EAAE,UAAU,EAAE,EAAE;QAAE,UAAU,EAAE,MAAM,CAAA;KAAE;CAMnD;AAKD,MAAM,MAAM,uCAAuC,GAAG;IACpD,wBAAwB;IACxB,IAAI,EAAE,MAAM,CAAA;IACZ,2BAA2B;IAC3B,KAAK,EAAE,OAAO,CAAA;IACd,oCAAoC;IACpC,QAAQ,EAAE,UAAU,GAAG,aAAa,CAAA;IACpC,8BAA8B;IAC9B,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,0CAA0C;IAC1C,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,yCAAyC;IACzC,KAAK,CAAC,EAAE,sBAAsB,CAAA;CAC/B,GAAG,CACA,mCAAmC,GACnC,sCAAsC,CACzC,CAAA;AAED,MAAM,MAAM,uCAAuC,GAAG,wBAAwB,CAAA;AAE9E,MAAM,MAAM,sCAAsC,GAC9C,gCAAgC,GAChC,wBAAwB,GACxB,+BAA+B,GAC/B,2BAA2B,GAC3B,gCAAgC,GAChC,oBAAoB,GACpB,uBAAuB,GACvB,0BAA0B,GAC1B,wBAAwB,CAAA;AAE5B,eAAO,MAAM,6BAA6B,GACxC,KAAK,SAAS,KAAK,EACnB,OAAO,SAAS,OAAO,GAAG,SAAS,EAEnC,QAAQ,sBAAsB,CAC5B,KAAK,EACL,mBAAmB,GAAG,gBAAgB,EACtC,OAAO,CACR,EACD,4DAUG,uCAAuC,KACzC,uCA+DF,CAAA;AAMD,KAAK,8BAA8B,GAC/B,uBAAuB,GACvB,kCAAkC,GAClC,oBAAoB,GACpB,iCAAiC,CAAA;AAsCrC,MAAM,MAAM,uBAAuB,CACjC,KAAK,SAAS,KAAK,EACnB,OAAO,SAAS,OAAO,GAAG,SAAS,EACnC,aAAa,SACT,kBAAkB,CAAC,mBAAmB,GAAG,gBAAgB,CAAC,GAC1D,SAAS,IACX,QAAQ,CACV,uCAAuC,GACrC,0BAA0B,CAAC,KAAK,EAAE,OAAO,EAAE,aAAa,CAAC,CAC5D,CAAA;AAED,MAAM,MAAM,uBAAuB,GAAG,IAAI,CAAA;AAE1C,MAAM,MAAM,sBAAsB,GAC9B,8BAA8B,GAC9B,sCAAsC,GACtC,wBAAwB,CAAA;AAE5B;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAsB,aAAa,CACjC,KAAK,SAAS,KAAK,EACnB,OAAO,SAAS,OAAO,GAAG,SAAS,EACnC,aAAa,SACT,kBAAkB,CAAC,mBAAmB,GAAG,gBAAgB,CAAC,GAC1D,SAAS,GAAG,kBAAkB,CAAC,mBAAmB,GAAG,gBAAgB,CAAC,EAE1E,MAAM,EAAE,sBAAsB,CAC5B,KAAK,EACL,gBAAgB,GAAG,mBAAmB,EACtC,OAAO,CACR,EACD,EACE,IAAI,EACJ,QAAQ,EACR,KAAK,EACL,eAAe,EACf,MAAM,EACN,KAAK,EACL,GAAG,MAAM,EACV,EAAE,uBAAuB,CAAC,KAAK,EAAE,OAAO,EAAE,aAAa,CAAC,GACxD,OAAO,CAAC,uBAAuB,CAAC,CAsBlC;yBA3CqB,aAAa;2BA3KjC,KAAK,SAAS,KAAK,EACnB,OAAO,SAAS,OAAO,GAAG,SAAS,UAE3B,sBAAsB,CAC5B,KAAK,EACL,mBAAmB,GAAG,gBAAgB,EACtC,OAAO,CACR,8DAWE,uCAAuC,KACzC,uCAAuC"}

package/dist/actions/wallet/createSubname.js

@@ -0,0 +1,173 @@
+import { encodeFunctionData, } from 'viem';
+import { sendTransaction } from 'viem/actions';
+import { getChainContractAddress, } from '../../clients/chain.js';
+import { nameWrapperSetSubnodeRecordSnippet } from '../../contracts/nameWrapper.js';
+import { registrySetSubnodeRecordSnippet } from '../../contracts/registry.js';
+import { BaseError } from '../../errors/base.js';
+import { InvalidContractTypeError, UnsupportedNameTypeError, } from '../../errors/general.js';
+import { ASSERT_NO_TYPE_ERROR, EXCLUDE_TYPE_ERROR, } from '../../types/internal.js';
+import { encodeFuses, ParentFuses, } from '../../utils/fuses.js';
+import { getNameType } from '../../utils/name/getNameType.js';
+import { makeLabelNodeAndParent, } from '../../utils/name/makeLabelNodeAndParent.js';
+import { expiryToBigInt, makeDefaultExpiry, wrappedLabelLengthCheck, } from '../../utils/wrapper.js';
+import { getWrapperData, } from '../public/getWrapperData.js';
+// ================================
+// Errors
+// ================================
+class CreateSubnamePermissionDeniedError extends BaseError {
+    constructor({ parentName }) {
+        super(`Create subname error: ${parentName} as burned CANNOT_CREATE_SUBDOMAIN fuse`);
+        Object.defineProperty(this, "parentName", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "name", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 'CreateSubnamePermissionDeniedError'
+        });
+        this.parentName = parentName;
+    }
+}
+class CreateSubnameParentNotLockedError extends BaseError {
+    constructor({ parentName }) {
+        super(`Create subname error: Cannot burn PARENT_CANNOT_CONTROL when ${parentName} has not burned CANNOT_UNWRAP fuse`);
+        Object.defineProperty(this, "parentName", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "name", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 'CreateSubnameParentNotLockedError'
+        });
+        this.parentName = parentName;
+    }
+}
+export const makeCreateSubnameFunctionData = (wallet, { name, contract, owner, resolverAddress = getChainContractAddress({
+    chain: EXCLUDE_TYPE_ERROR(wallet).chain,
+    contract: 'ensPublicResolver',
+}), expiry, fuses, }) => {
+    ASSERT_NO_TYPE_ERROR(wallet);
+    const nameType = getNameType(name);
+    if (nameType === 'tld' || nameType === 'root')
+        throw new UnsupportedNameTypeError({
+            nameType,
+            supportedNameTypes: [
+                'eth-2ld',
+                'eth-subname',
+                'other-2ld',
+                'other-subname',
+            ],
+        });
+    const { label, labelhash, parentNode } = makeLabelNodeAndParent(name);
+    switch (contract) {
+        case 'registry': {
+            return {
+                to: getChainContractAddress({
+                    chain: wallet.chain,
+                    contract: 'ensRegistry',
+                }),
+                data: encodeFunctionData({
+                    abi: registrySetSubnodeRecordSnippet,
+                    functionName: 'setSubnodeRecord',
+                    args: [parentNode, labelhash, owner, resolverAddress, BigInt(0)],
+                }),
+            };
+        }
+        case 'nameWrapper': {
+            wrappedLabelLengthCheck(label);
+            const generatedFuses = fuses ? encodeFuses({ input: fuses }) : 0;
+            const generatedExpiry = expiry
+                ? expiryToBigInt(expiry)
+                : makeDefaultExpiry(generatedFuses);
+            return {
+                to: getChainContractAddress({
+                    chain: wallet.chain,
+                    contract: 'ensNameWrapper',
+                }),
+                data: encodeFunctionData({
+                    abi: nameWrapperSetSubnodeRecordSnippet,
+                    functionName: 'setSubnodeRecord',
+                    args: [
+                        parentNode,
+                        label,
+                        owner,
+                        resolverAddress,
+                        BigInt(0),
+                        generatedFuses,
+                        generatedExpiry,
+                    ],
+                }),
+            };
+        }
+        default:
+            throw new InvalidContractTypeError({
+                contractType: contract,
+                supportedContractTypes: ['registry', 'nameWrapper'],
+            });
+    }
+};
+const checkCanCreateSubname = async (wallet, { name, fuses, contract, }) => {
+    if (contract !== 'nameWrapper')
+        return;
+    const parentName = name.split('.').slice(1).join('.');
+    if (parentName === 'eth')
+        return;
+    const parentWrapperData = await getWrapperData(wallet, { name: parentName });
+    if (parentWrapperData?.fuses?.child?.CANNOT_CREATE_SUBDOMAIN)
+        throw new CreateSubnamePermissionDeniedError({ parentName });
+    const generatedFuses = fuses ? encodeFuses({ input: fuses }) : 0;
+    const isBurningPCC = fuses && BigInt(generatedFuses) & ParentFuses.PARENT_CANNOT_CONTROL;
+    const isParentCannotUnwrapBurned = parentWrapperData?.fuses?.child?.CANNOT_UNWRAP;
+    if (isBurningPCC && !isParentCannotUnwrapBurned)
+        throw new CreateSubnameParentNotLockedError({ parentName });
+};
+/**
+ * Creates a subname
+ * @param wallet - {@link ClientWithAccount}
+ * @param parameters - {@link CreateSubnameParameters}
+ * @returns Transaction hash. {@link CreateSubnameReturnType}
+ *
+ * @example
+ * import { createWalletClient, custom } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { createSubname } from '@ensdomains/ensjs/wallet'
+ *
+ * const wallet = createWalletClient({
+ *   chain: addEnsContracts(mainnet),
+ *   transport: custom(window.ethereum),
+ * })
+ * const hash = await createSubname(wallet, {
+ *   name: 'sub.ens.eth',
+ *   owner: '0xFe89cc7aBB2C4183683ab71653C4cdc9B02D44b7',
+ *   contract: 'registry',
+ * })
+ * // 0x...
+ */
+export async function createSubname(wallet, { name, contract, owner, resolverAddress, expiry, fuses, ...txArgs }) {
+    ASSERT_NO_TYPE_ERROR(wallet);
+    await checkCanCreateSubname(wallet, { name, fuses, contract });
+    const data = makeCreateSubnameFunctionData(wallet, {
+        name,
+        contract,
+        owner,
+        resolverAddress,
+        expiry,
+        fuses,
+    });
+    const writeArgs = {
+        ...data,
+        ...txArgs,
+    };
+    return sendTransaction(wallet, writeArgs);
+}
+createSubname.makeFunctionData = makeCreateSubnameFunctionData;
+//# sourceMappingURL=createSubname.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"createSubname.js","sourceRoot":"","sources":["../../../src/actions/wallet/createSubname.ts"],"names":[],"mappings":"AAAA,OAAO,EAML,kBAAkB,GAMnB,MAAM,MAAM,CAAA;AACb,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAA;AAC9C,OAAO,EAEL,uBAAuB,GAExB,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EAAE,kCAAkC,EAAE,MAAM,gCAAgC,CAAA;AACnF,OAAO,EAAE,+BAA+B,EAAE,MAAM,6BAA6B,CAAA;AAC7E,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AAChD,OAAO,EACL,wBAAwB,EACxB,wBAAwB,GACzB,MAAM,yBAAyB,CAAA;AAOhC,OAAO,EACL,oBAAoB,EACpB,kBAAkB,GACnB,MAAM,yBAAyB,CAAA;AAChC,OAAO,EAGL,WAAW,EACX,WAAW,GACZ,MAAM,sBAAsB,CAAA;AAC7B,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAA;AAC7D,OAAO,EAEL,sBAAsB,GACvB,MAAM,4CAA4C,CAAA;AACnD,OAAO,EAEL,cAAc,EAEd,iBAAiB,EAEjB,uBAAuB,GACxB,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EAEL,cAAc,GACf,MAAM,6BAA6B,CAAA;AAcpC,mCAAmC;AACnC,SAAS;AACT,mCAAmC;AAEnC,MAAM,kCAAmC,SAAQ,SAAS;IAKxD,YAAY,EAAE,UAAU,EAA0B;QAChD,KAAK,CACH,yBAAyB,UAAU,yCAAyC,CAC7E,CAAA;QAPH;;;;;WAAkB;QAET;;;;mBAAO,oCAAoC;WAAA;QAMlD,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;IAC9B,CAAC;CACF;AAED,MAAM,iCAAkC,SAAQ,SAAS;IAKvD,YAAY,EAAE,UAAU,EAA0B;QAChD,KAAK,CACH,gEAAgE,UAAU,oCAAoC,CAC/G,CAAA;QAPH;;;;;WAAkB;QAET;;;;mBAAO,mCAAmC;WAAA;QAMjD,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;IAC9B,CAAC;CACF;AAoCD,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAI3C,MAIC,EACD,EACE,IAAI,EACJ,QAAQ,EACR,KAAK,EACL,eAAe,GAAG,uBAAuB,CAAC;IACxC,KAAK,EAAE,kBAAkB,CAAC,MAAM,CAAC,CAAC,KAAK;IACvC,QAAQ,EAAE,mBAAmB;CAC9B,CAAC,EACF,MAAM,EACN,KAAK,GACmC,EACD,EAAE;IAC3C,oBAAoB,CAAC,MAAM,CAAC,CAAA;IAE5B,MAAM,QAAQ,GAAG,WAAW,CAAC,IAAI,CAAC,CAAA;IAClC,IAAI,QAAQ,KAAK,KAAK,IAAI,QAAQ,KAAK,MAAM;QAC3C,MAAM,IAAI,wBAAwB,CAAC;YACjC,QAAQ;YACR,kBAAkB,EAAE;gBAClB,SAAS;gBACT,aAAa;gBACb,WAAW;gBACX,eAAe;aAChB;SACF,CAAC,CAAA;IAEJ,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,GAAG,sBAAsB,CAAC,IAAI,CAAC,CAAA;IAErE,QAAQ,QAAQ,EAAE,CAAC;QACjB,KAAK,UAAU,CAAC,CAAC,CAAC;YAChB,OAAO;gBACL,EAAE,EAAE,uBAAuB,CAAC;oBAC1B,KAAK,EAAE,MAAM,CAAC,KAAK;oBACnB,QAAQ,EAAE,aAAa;iBACxB,CAAC;gBACF,IAAI,EAAE,kBAAkB,CAAC;oBACvB,GAAG,EAAE,+BAA+B;oBACpC,YAAY,EAAE,kBAAkB;oBAChC,IAAI,EAAE,CAAC,UAAU,EAAE,SAAS,EAAE,KAAK,EAAE,eAAe,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;iBACjE,CAAC;aACH,CAAA;QACH,CAAC;QACD,KAAK,aAAa,CAAC,CAAC,CAAC;YACnB,uBAAuB,CAAC,KAAK,CAAC,CAAA;YAC9B,MAAM,cAAc,GAAG,KAAK,CAAC,CAAC,CAAC,WAAW,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;YAChE,MAAM,eAAe,GAAG,MAAM;gBAC5B,CAAC,CAAC,cAAc,CAAC,MAAM,CAAC;gBACxB,CAAC,CAAC,iBAAiB,CAAC,cAAc,CAAC,CAAA;YACrC,OAAO;gBACL,EAAE,EAAE,uBAAuB,CAAC;oBAC1B,KAAK,EAAE,MAAM,CAAC,KAAK;oBACnB,QAAQ,EAAE,gBAAgB;iBAC3B,CAAC;gBACF,IAAI,EAAE,kBAAkB,CAAC;oBACvB,GAAG,EAAE,kCAAkC;oBACvC,YAAY,EAAE,kBAAkB;oBAChC,IAAI,EAAE;wBACJ,UAAU;wBACV,KAAK;wBACL,KAAK;wBACL,eAAe;wBACf,MAAM,CAAC,CAAC,CAAC;wBACT,cAAc;wBACd,eAAe;qBAChB;iBACF,CAAC;aACH,CAAA;QACH,CAAC;QACD;YACE,MAAM,IAAI,wBAAwB,CAAC;gBACjC,YAAY,EAAE,QAAQ;gBACtB,sBAAsB,EAAE,CAAC,UAAU,EAAE,aAAa,CAAC;aACpD,CAAC,CAAA;IACN,CAAC;AACH,CAAC,CAAA;AAYD,MAAM,qBAAqB,GAAG,KAAK,EACjC,MAGC,EACD,EACE,IAAI,EACJ,KAAK,EACL,QAAQ,GAIT,EACc,EAAE;IACjB,IAAI,QAAQ,KAAK,aAAa;QAAE,OAAM;IAEtC,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IACrD,IAAI,UAAU,KAAK,KAAK;QAAE,OAAM;IAEhC,MAAM,iBAAiB,GAAG,MAAM,cAAc,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAAA;IAC5E,IAAI,iBAAiB,EAAE,KAAK,EAAE,KAAK,EAAE,uBAAuB;QAC1D,MAAM,IAAI,kCAAkC,CAAC,EAAE,UAAU,EAAE,CAAC,CAAA;IAE9D,MAAM,cAAc,GAAG,KAAK,CAAC,CAAC,CAAC,WAAW,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IAChE,MAAM,YAAY,GAChB,KAAK,IAAI,MAAM,CAAC,cAAc,CAAC,GAAG,WAAW,CAAC,qBAAqB,CAAA;IACrE,MAAM,0BAA0B,GAC9B,iBAAiB,EAAE,KAAK,EAAE,KAAK,EAAE,aAAa,CAAA;IAChD,IAAI,YAAY,IAAI,CAAC,0BAA0B;QAC7C,MAAM,IAAI,iCAAiC,CAAC,EAAE,UAAU,EAAE,CAAC,CAAA;AAC/D,CAAC,CAAA;AAwBD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAOjC,MAIC,EACD,EACE,IAAI,EACJ,QAAQ,EACR,KAAK,EACL,eAAe,EACf,MAAM,EACN,KAAK,EACL,GAAG,MAAM,EAC8C;IAEzD,oBAAoB,CAAC,MAAM,CAAC,CAAA;IAE5B,MAAM,qBAAqB,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAA;IAE9D,MAAM,IAAI,GAAG,6BAA6B,CACxC,MAAM,EACN;QACE,IAAI;QACJ,QAAQ;QACR,KAAK;QACL,eAAe;QACf,MAAM;QACN,KAAK;KACqC,CAC7C,CAAA;IACD,MAAM,SAAS,GAAG;QAChB,GAAG,IAAI;QACP,GAAG,MAAM;KACgE,CAAA;IAE3E,OAAO,eAAe,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;AAC3C,CAAC;AAED,aAAa,CAAC,gBAAgB,GAAG,6BAA6B,CAAA"}