@thenamespace/ens-components 0.26.0 → 0.28.0

package/dist/index.d.ts

@@ -3,16 +3,16 @@ import { Address, Hash, ContractFunctionExecutionError, TransactionReceipt } fro
 import * as React$1 from 'react';
 import React__default, { ReactNode, PropsWithChildren } from 'react';
 
-interface EnsRecords {
-    addresses: EnsAddressRecord[];
-    texts: EnsTextRecord[];
+interface EnsRecords$1 {
+    addresses: EnsAddressRecord$1[];
+    texts: EnsTextRecord$1[];
     contenthash?: EnsContenthashRecord;
 }
-interface EnsTextRecord {
+interface EnsTextRecord$1 {
     key: string;
     value: string;
 }
-interface EnsAddressRecord {
+interface EnsAddressRecord$1 {
     coinType: number;
     value: string;
 }
@@ -28,7 +28,7 @@ declare enum ContenthashProtocol {
     Swarm = "swarm"
 }
 
-type ChainName = "eth" | "arb" | "base" | "bitcoin" | "matic" | "op" | "sol" | "zora" | "celo";
+type ChainName$1 = "eth" | "arb" | "base" | "bitcoin" | "matic" | "op" | "sol" | "zora" | "celo";
 
 declare enum TxProgress {
     Pending = 0,
@@ -36,9 +36,34 @@ declare enum TxProgress {
     Failed = 2
 }
 
+interface NameListing {
+    type: ListingType;
+    name: string;
+    isVerified: boolean;
+    l2Metadata?: {
+        isBurnable: boolean;
+        isExpirable: boolean;
+        registryAddress: Address;
+        registryNetwork: ListingNetwork;
+    };
+    nameNetwork: ListingNetwork;
+}
+declare enum ListingType {
+    L1 = "L1",
+    L2 = "L2"
+}
+declare enum ListingNetwork {
+    Base = "BASE",
+    Optimism = "OPTIMISM",
+    Mainnet = "MAINNET",
+    Sepolia = "SEPOLIA",
+    BaseSepolia = "BASE_SEPOLIA"
+}
+declare const getChainIdForListingNetwork: (network: ListingNetwork) => number;
+
 interface SelectRecordsFormProps {
-    records: EnsRecords;
-    onRecordsUpdated: (records: EnsRecords) => void;
+    records: EnsRecords$1;
+    onRecordsUpdated: (records: EnsRecords$1) => void;
     actionButtons?: React.ReactNode;
 }
 declare const SelectRecordsForm: ({ records, onRecordsUpdated, actionButtons, }: SelectRecordsFormProps) => react_jsx_runtime.JSX.Element;
@@ -70,32 +95,32 @@ declare const debounce: <T extends (...args: any[]) => any>(func: T, wait: numbe
 declare function convertEVMChainIdToCoinType(chainId: number): number;
 
 interface EnsRecordsDiff {
-    textsAdded: EnsTextRecord[];
-    textsModified: EnsTextRecord[];
-    textsRemoved: EnsTextRecord[];
-    addressesAdded: EnsAddressRecord[];
-    addressesRemoved: EnsAddressRecord[];
-    addressesModified: EnsAddressRecord[];
+    textsAdded: EnsTextRecord$1[];
+    textsModified: EnsTextRecord$1[];
+    textsRemoved: EnsTextRecord$1[];
+    addressesAdded: EnsAddressRecord$1[];
+    addressesRemoved: EnsAddressRecord$1[];
+    addressesModified: EnsAddressRecord$1[];
     contenthashAdded?: EnsContenthashRecord;
     contenthashRemoved: boolean;
     contenthashModified?: EnsContenthashRecord;
     isDifferent: boolean;
 }
-declare const getEnsRecordsDiff: (oldRecords: EnsRecords, newRecords: EnsRecords) => EnsRecordsDiff;
+declare const getEnsRecordsDiff: (oldRecords: EnsRecords$1, newRecords: EnsRecords$1) => EnsRecordsDiff;
 interface RecordValidationError {
     type: "address" | "text" | "contenthash";
     reason: string;
 }
-declare const validateEnsRecords: (ensRecords: EnsRecords) => {
+declare const validateEnsRecords: (ensRecords: EnsRecords$1) => {
     validationFailed: boolean;
     errors: RecordValidationError[];
 };
-declare const diffToEnsRecords: (diff: EnsRecordsDiff) => EnsRecords;
+declare const diffToEnsRecords: (diff: EnsRecordsDiff) => EnsRecords$1;
 
 declare const ensureFloatInput: (value: string) => string;
 declare const formatFloat: (value: string | number, decimals?: number) => number;
 
-declare const convertToResolverData: (name: string, records: EnsRecords) => `0x${string}`[];
+declare const convertToResolverData: (name: string, records: EnsRecords$1) => `0x${string}`[];
 declare const convertToMulticallResolverData: (name: string, recordsDiff: EnsRecordsDiff) => `0x${string}`[];
 
 declare const createEnsReferer: (address: Address) => Hash;
@@ -115,7 +140,7 @@ interface EnsRecordsFormProps {
     resolverAddress?: Address;
     isTestnet?: boolean;
     name: string;
-    existingRecords: EnsRecords;
+    existingRecords: EnsRecords$1;
     noBorder?: boolean;
     className?: string;
     onCancel?: () => void;
@@ -125,6 +150,36 @@ interface EnsRecordsFormProps {
 }
 declare const EnsRecordsForm: ({ name, existingRecords, resolverChainId, isTestnet, resolverAddress, noBorder, className, onCancel, onGreat, onRecordsUpdated, onTransactionSent }: EnsRecordsFormProps) => react_jsx_runtime.JSX.Element;
 
+interface MintSuccessData {
+    fullName: string;
+    label: string;
+    parentName: string;
+    txHash: string;
+    price: string;
+    transactionFees: string;
+    records: EnsRecords$1;
+}
+interface SubnameMintedData {
+    label: string;
+    parentName: string;
+    fullSubname: string;
+    records: EnsRecords$1;
+    price: string;
+    transactionFees: string;
+    ownerAddress: string;
+    txHash: string;
+    chainId: number;
+}
+interface SubnameMintFormProps {
+    parentName: string;
+    label?: string;
+    isTestnet?: boolean;
+    onCancel?: () => void;
+    onSuccess?: (data: MintSuccessData) => void;
+    onSubnameMinted?: (data: SubnameMintedData) => void;
+}
+declare const SubnameMintForm: ({ parentName, label, isTestnet, onCancel, onSuccess, onSubnameMinted, }: SubnameMintFormProps) => react_jsx_runtime.JSX.Element;
+
 type ButtonVariant = "solid" | "outline" | "ghost" | "destructive";
 type ButtonSize = "sm" | "md" | "lg";
 interface ButtonProps extends Omit<React__default.ButtonHTMLAttributes<HTMLButtonElement>, "prefix"> {
@@ -185,7 +240,7 @@ interface IconProps {
 declare const Icon: React__default.FC<IconProps>;
 
 interface ChainIconProps extends React__default.SVGProps<SVGSVGElement> {
-    chain: ChainName;
+    chain: ChainName$1;
     size?: number;
 }
 declare const ChainIcon: React__default.FC<ChainIconProps>;
@@ -234,8 +289,10 @@ interface ContenthashIconProps extends React.SVGProps<SVGSVGElement> {
 declare const ContenthashIcon: (props: ContenthashIconProps) => react_jsx_runtime.JSX.Element | null;
 
 type AlertVariant = "error" | "warning" | "info" | "success";
+type AlertPosition = "vertical" | "horizontal";
 interface AlertProps {
     variant?: AlertVariant;
+    position?: AlertPosition;
     children: React__default.ReactNode;
     className?: string;
     onClose?: () => void;
@@ -320,19 +377,41 @@ interface ProgressBarProps {
 }
 declare function ProgressBar({ progress }: ProgressBarProps): react_jsx_runtime.JSX.Element;
 
+interface PricingDisplayProps {
+    primaryFee: {
+        label: string;
+        amount: number | string;
+        isChecking: boolean;
+    };
+    networkFees?: {
+        amount: number | string;
+        isChecking: boolean;
+    };
+    total: {
+        amount: number | string;
+        isChecking: boolean;
+    };
+    expiryPicker?: {
+        years: number;
+        onYearsChange: (years: number) => void;
+    };
+    className?: string;
+}
+declare const PricingDisplay: React__default.FC<PricingDisplayProps>;
+
 interface SupportedEnsAddress {
     validateFunc?: (value: string) => boolean;
     isEMV?: boolean;
     label: string;
     coinType: number;
     chainId?: number;
-    chainName: ChainName;
+    chainName: ChainName$1;
     placeholder?: string;
 }
 declare const supportedAddresses: SupportedEnsAddress[];
 declare const getSupportedAddressMap: () => Record<number, SupportedEnsAddress>;
 declare const getSupportedAddressByCoin: (coin: number) => SupportedEnsAddress | undefined;
-declare const getSupportedAddressByName: (name: ChainName) => SupportedEnsAddress | undefined;
+declare const getSupportedAddressByName: (name: ChainName$1) => SupportedEnsAddress | undefined;
 declare const getSupportedAddressByChainId: (chainId: number) => SupportedEnsAddress | undefined;
 type TextCategory = "profile" | "social";
 interface SupportedText {
@@ -452,7 +531,7 @@ interface RegistrationRequest {
     owner: Address;
     expiryInYears: number;
     secret: string;
-    records: EnsRecords;
+    records: EnsRecords$1;
     referrer?: Address;
 }
 declare const useRegisterENS: ({ isTestnet }: {
@@ -494,5 +573,170 @@ declare const useENSResolver: ({ resolverChainId, isTestnet, }: {
     setUpdateRecordsTx: (update: UpdateRecordsRequest) => Promise<`0x${string}`>;
 };
 
-export { Accordion, Alert, Button, Card, ChainIcon, ConnectAndSetChain, ContenthashIcon, ContenthashProtocol, ContractErrorLabel, Dropdown, ENS_RESOLVER_ABI, EnsNameRegistrationForm, EnsRecordsForm, Icon, Input, MULTICALL, Modal, ProfileHeader, ProgressBar, SET_ADDRESS_FUNC, SET_CONTENTHASH_FUNC, SET_TEXT_FUNC, SelectRecordsForm, ShurikenSpinner, Text, TextRecordCategory, Textarea, ThemeProvider, Tooltip, TxProgress, WalletConnectProvider, capitalize, convertEVMChainIdToCoinType, convertToMulticallResolverData, convertToResolverData, createEnsReferer, debounce, deepCopy, diffToEnsRecords, ensureFloatInput, equalsIgnoreCase, formatFloat, getBlockExplorer, getBlockExplorerAddressUrl, getBlockExplorerName, getBlockExplorerTransactionUrl, getEnsAppUrl, getEnsRecordsDiff, getSupportedAddressByChainId, getSupportedAddressByCoin, getSupportedAddressByName, getSupportedAddressMap, getSupportedChashByProtocol, getSupportedText, isCommitmentToNewErr, isContenthashValid, isUserDeniedError, supportedAddresses, supportedContenthashRecords, supportedTexts, useENSResolver, useRegisterENS, useTheme, useWaitTransaction, validateEnsRecords };
-export type { AccordionProps, AlertProps, AlertVariant, ButtonProps, ButtonSize, ButtonVariant, ChainName, ConnectAndSetChainProps, ContractErrorLabelProps, DropdownProps, EnsAddressRecord, EnsContenthashRecord, EnsRecords, EnsRecordsDiff, EnsTextRecord, IconName, IconProps, InputProps, InputSize, InputType, ModalProps, ModalSize, ProfileHeaderProps, RecordValidationError, RegistrationRequest, ShurikenSpinnerProps, SupportedContenthashRecord, SupportedEnsAddress, SupportedText, SupportedTextRecord, TextCategory, TextColor, TextProps, TextSize, TextWeight, TextareaProps, TextareaSize, ThemeContextValue, ThemeName, ThemeProviderProps, TooltipPosition, TooltipProps };
+declare enum ChainName {
+    Ethereum = "eth",
+    Default = "default",
+    Solana = "sol",
+    Arbitrum = "arb",
+    Optimism = "op",
+    Base = "base",
+    Polygon = "polygon",
+    Bsc = "bsc",
+    Avalanche = "avax",
+    Gnosis = "gnosis",
+    Zksync = "zksync",
+    Cosmos = "cosmos",
+    Near = "near",
+    Linea = "linea",
+    Scroll = "scroll",
+    Bitcoin = "btc",
+    Starknet = "starknet"
+}
+
+declare enum ContenthashType {
+    Ipfs = "ipfs",
+    Onion = "onion3",
+    Swarm = "swarm",
+    Arweave = "arweave",
+    Skynet = "syknet"
+}
+
+/** Parameters for estimating mint details and price. */
+interface MintDetailsRequest {
+    parentName: string;
+    label: string;
+    minterAddress: string;
+    expiryInYears?: number;
+    isTestnet?: boolean;
+}
+/** Estimated details and validations for a mint request. */
+interface MintDetailsResponse {
+    /**
+     * Flag indicating if subname can be minted based on passed parameters.
+     */
+    canMint: boolean;
+    /**
+     * Estimated price of minting in ETH
+     */
+    estimatedPriceEth: number;
+    /**
+     * Estimated fee for minting in ETH
+     */
+    estimatedFeeEth: number;
+    /**
+     * Flag indicating if standard fee is a fixed fee which is not subtracted from the minting price.
+     */
+    isStandardFee: boolean;
+    /**
+     * List of validation errors if there were any. Populated if {@link canMint} is false.
+     */
+    validationErrors: MintingValidationErrorType[];
+}
+/**
+ * Describes all possible error codes that could be thrown while attempting to mint the subname.
+ */
+/** Error codes describing why a mint cannot proceed. */
+type MintingValidationErrorType = "SUBNAME_TAKEN" | "MINTER_NOT_TOKEN_OWNER" | "MINTER_NOT_WHITELISTED" | "LISTING_EXPIRED" | "SUBNAME_RESERVED" | "VERIFIED_MINTER_ADDRESS_REQUIRED";
+/** Prepared transaction data for calling the mint function on-chain. */
+interface MintTransactionResponse {
+    contractAddress: Address;
+    args: any[];
+    account: string;
+    abi: any;
+    functionName: string;
+    value: bigint;
+}
+/** Parameters for preparing a mint transaction. */
+interface MintTransactionRequest {
+    parentName: string;
+    label: string;
+    owner?: string;
+    minterAddress: Address;
+    expiryInYears?: number;
+    records?: EnsRecords;
+}
+/** Single ENS text record to set for the subname. */
+interface EnsTextRecord {
+    key: string;
+    value: string;
+}
+/** Address record for a specific chain (by coin type or ChainName). */
+interface EnsAddressRecord {
+    chain: ChainName | number;
+    value: string;
+}
+/** Contenthash record (ipfs, ipns, swarm, etc.). */
+interface ContenthashRecord {
+    type: ContenthashType;
+    value: string;
+}
+/** Optional records to be applied at mint time. */
+interface EnsRecords {
+    texts?: EnsTextRecord[];
+    addresses?: EnsAddressRecord[];
+    contenthash?: ContenthashRecord;
+}
+
+/**
+ * Main client interface for preparing mint transactions and checking
+ * subname availability across L1 and supported L2 networks.
+ *
+ * @example
+ * ```typescript
+ * import { createMintClient } from '@thenamespace/mint-manager';
+ *
+ * // Zero-config (mainnet)
+ * const client = createMintClient();
+ *
+ * // Testnet
+ * const testnet = createMintClient({
+ *   isTestnet: true,
+ *   customRpcUrls: { [baseSepolia.id]: ALCHEMY_BASE_SEPOLIA_RPC }
+ * });
+ * ```
+ */
+interface MintClient {
+    /** Fetches estimated minting parameters and price quote. */
+    getMintDetails(request: MintDetailsRequest): Promise<MintDetailsResponse>;
+    /**
+     * Returns ABI, args and value for submitting the mint transaction.
+     * Includes resolver data if records are provided.
+     */
+    getMintTransactionParameters(request: MintTransactionRequest): Promise<MintTransactionResponse>;
+    /** Checks availability of an L1 subname using ENS Registry. */
+    isL1SubnameAvailable(subname: string): Promise<boolean>;
+    /** Checks availability of an L2 subname on a specific chain. */
+    isL2SubnameAvailable(subname: string, chainId: number): Promise<boolean>;
+}
+
+interface UseMintManagerParams {
+    isTestnet?: boolean;
+}
+declare const useMintManager: ({ isTestnet }: UseMintManagerParams) => {
+    mintClient: MintClient;
+    getListingDetails: (name: string) => Promise<NameListing>;
+};
+
+interface MintSubnameResult {
+    txHash: Hash;
+    price: bigint;
+}
+interface EstimatedFees {
+    gasEstimate: bigint;
+    gasPrice: bigint;
+    totalFeeWei: bigint;
+    totalFeeEth: number;
+}
+interface EstimateFeesParams {
+    mintTx: MintTransactionResponse;
+    account: Address;
+}
+declare const useMintSubname: ({ chainId }: {
+    chainId: number;
+}) => {
+    mintSubname: (mintTx: MintTransactionResponse) => Promise<MintSubnameResult>;
+    estimateTransactionFees: (params: EstimateFeesParams) => Promise<EstimatedFees | null>;
+};
+
+export { Accordion, Alert, Button, Card, ChainIcon, ConnectAndSetChain, ContenthashIcon, ContenthashProtocol, ContractErrorLabel, Dropdown, ENS_RESOLVER_ABI, EnsNameRegistrationForm, EnsRecordsForm, Icon, Input, ListingNetwork, ListingType, MULTICALL, Modal, PricingDisplay, ProfileHeader, ProgressBar, SET_ADDRESS_FUNC, SET_CONTENTHASH_FUNC, SET_TEXT_FUNC, SelectRecordsForm, ShurikenSpinner, SubnameMintForm, Text, TextRecordCategory, Textarea, ThemeProvider, Tooltip, TxProgress, WalletConnectProvider, capitalize, convertEVMChainIdToCoinType, convertToMulticallResolverData, convertToResolverData, createEnsReferer, debounce, deepCopy, diffToEnsRecords, ensureFloatInput, equalsIgnoreCase, formatFloat, getBlockExplorer, getBlockExplorerAddressUrl, getBlockExplorerName, getBlockExplorerTransactionUrl, getChainIdForListingNetwork, getEnsAppUrl, getEnsRecordsDiff, getSupportedAddressByChainId, getSupportedAddressByCoin, getSupportedAddressByName, getSupportedAddressMap, getSupportedChashByProtocol, getSupportedText, isCommitmentToNewErr, isContenthashValid, isUserDeniedError, supportedAddresses, supportedContenthashRecords, supportedTexts, useENSResolver, useMintManager, useMintSubname, useRegisterENS, useTheme, useWaitTransaction, validateEnsRecords };
+export type { AccordionProps, AlertPosition, AlertProps, AlertVariant, ButtonProps, ButtonSize, ButtonVariant, ChainName$1 as ChainName, ConnectAndSetChainProps, ContractErrorLabelProps, DropdownProps, EnsAddressRecord$1 as EnsAddressRecord, EnsContenthashRecord, EnsRecords$1 as EnsRecords, EnsRecordsDiff, EnsTextRecord$1 as EnsTextRecord, EstimatedFees, IconName, IconProps, InputProps, InputSize, InputType, ModalProps, ModalSize, NameListing, PricingDisplayProps, ProfileHeaderProps, RecordValidationError, RegistrationRequest, ShurikenSpinnerProps, SupportedContenthashRecord, SupportedEnsAddress, SupportedText, SupportedTextRecord, TextCategory, TextColor, TextProps, TextSize, TextWeight, TextareaProps, TextareaSize, ThemeContextValue, ThemeName, ThemeProviderProps, TooltipPosition, TooltipProps };