@thenamespace/ens-components 0.8.0 → 0.10.0

package/dist/types/index.d.ts

@@ -5,4 +5,5 @@ export * from "./hooks";
 export * from "./types";
 export * from "./utils";
 export * from "./web3";
+export { isL2Chain } from "./types";
 export * from "./theme/ThemeProvider";

package/dist/types/types/auth.d.ts

@@ -0,0 +1,8 @@
+import { Address } from "viem";
+export interface AuthMessage {
+    principal: Address;
+    nonce: string;
+    issued: number;
+    app: string;
+    message: string;
+}

package/dist/types/types/ens.d.ts

@@ -0,0 +1,61 @@
+import { Address } from "viem";
+import { Layer2Network } from "./networks";
+import { EnsTextRecord, EnsAddressRecord } from "./records";
+export interface EnsContenthashRecordDecoded {
+    decoded: string;
+    protocolType: string;
+}
+export interface EnsRecordsDecoded {
+    texts: EnsTextRecord[];
+    addresses: EnsAddressRecord[];
+    contenthash?: EnsContenthashRecordDecoded;
+}
+export interface EnsNameOwner {
+    address: Address;
+    ensName?: string;
+    avatar?: string;
+    isWrapped: boolean;
+}
+type EnsNameLevel = 2 | 3;
+export interface EnsName {
+    name: string;
+    label: string;
+    createdAt: number;
+    expiry: number;
+    isWrapped: boolean;
+    namehash: string;
+    parentName: string;
+    level: EnsNameLevel;
+    owner: string;
+}
+export interface GenericMintedName {
+    name: string;
+    label: string;
+    expiry?: number;
+    namehash: string;
+    parentName: string;
+    owner: string;
+    addresses: Record<string, string>;
+    texts: Record<string, string>;
+    isL2: boolean;
+    chainId: number;
+    hightlighted?: boolean;
+    mintTransaction?: {
+        price: number;
+    };
+}
+export interface L2NameMetadata {
+    resolver: Address;
+    network: Layer2Network;
+    owner: Address;
+}
+export interface IEnsNameFullProfile {
+    ensName: string;
+    ownership: EnsNameOwner;
+    records: EnsRecordsDecoded;
+    resolver: Address;
+    expiry: number;
+    l2Metadata?: L2NameMetadata;
+    subnames: GenericMintedName[];
+}
+export {};

package/dist/types/types/errors.d.ts

@@ -0,0 +1,2 @@
+import { ContractFunctionExecutionError } from "viem";
+export type ContractExecutionError = ContractFunctionExecutionError;

package/dist/types/types/hybrid-resolver.d.ts

@@ -0,0 +1,4 @@
+export interface HybridResolverConfig {
+    resolutionType: number;
+    resolveOffchain: boolean;
+}

package/dist/types/types/index.d.ts

@@ -1,2 +1,12 @@
 export * from "./records";
 export type { ChainName } from "./chain";
+export * from "./listing";
+export * from "./minting";
+export * from "./networks";
+export * from "./ens";
+export * from "./l2";
+export * from "./errors";
+export * from "./auth";
+export * from "./name-listing";
+export * from "./hybrid-resolver";
+export * from "./indexer";

package/dist/types/types/indexer.d.ts

@@ -0,0 +1,27 @@
+export interface L2IndexedSubname {
+    name: string;
+    namehash: string;
+    owner: string;
+    avatar?: string;
+    chainId: number;
+    expiry: number;
+    parentHash: string;
+    records: {
+        addresses: Record<string, string>;
+        texts: Record<string, string>;
+        contenthash: string;
+    };
+    metadata: {
+        blockNumber: number;
+        price: number;
+        fee: number;
+        tx: string;
+    };
+}
+export interface EnsNameMintStats {
+    totalL1Subnames: number;
+    totalL2Subnames: number;
+    totalPrice: number;
+    totalFee: number;
+    totalVolume: number;
+}

package/dist/types/types/l2.d.ts

@@ -0,0 +1,34 @@
+import { Layer2Network } from "./networks";
+export interface IL2Node {
+    label: string;
+    namehash: string;
+    name: string;
+    owner: string;
+    addresses: Record<string, string>;
+    texts: Record<string, string>;
+    contenthash?: string;
+    chainId: number;
+    expiry?: number;
+    mintTransaction?: {
+        price: number;
+        paymentReceiver: string;
+    };
+}
+export interface L2Registry {
+    parentControl: number;
+    label: string;
+    TLD: string;
+    network: Layer2Network;
+    deployment: {
+        address: string;
+    };
+    isDeployed: boolean;
+    expirableType: number;
+    owner: string;
+    tokenName: string;
+    tokenSymbol: string;
+}
+export declare enum L2ExpirableType {
+    Expirable = 1,
+    NotExpirable = 0
+}

package/dist/types/types/list-manager.d.ts

@@ -0,0 +1,179 @@
+import { Address } from "viem";
+export declare enum ListingNetwork {
+    Mainnet = "MAINNET",
+    Sepolia = "SEPOLIA",
+    Optimism = "OPTIMISM",
+    Base = "BASE",
+    BaseSepolia = "BASE_SEPOLIA"
+}
+export interface NamespaceListing {
+    name: string;
+    namehash: string;
+    nameNetwork: ListingNetwork;
+    type: ListingType;
+    currency: ListingCurrency;
+    createdAt?: string;
+    updatedAt?: string;
+    whitelist?: ListingWhitelist;
+    deadline?: ListingDeadline;
+    prices: ListingPrices;
+    isVerified: boolean;
+    owner: string;
+    paymentWallet: string;
+    tokenGatedAccess?: TokenGatedAccess[];
+    metadata?: ListingMetadata;
+    reservations?: ReservedLabel[];
+    l2Metadata?: L2Registry;
+}
+export interface ListingWhitelist {
+    type: WhitelistType;
+    wallets: Address[];
+}
+export interface ListingDeadline {
+    type: DeadlineType;
+    timestamp: number;
+}
+export declare enum ListingType {
+    L1 = "L1",
+    L2 = "L2"
+}
+export declare enum ListingCurrency {
+    ETH = "ETH",
+    DOLLAR = "DOLLAR"
+}
+export declare enum WhitelistType {
+    ONLY_WHITELISTED = 1,
+    FREE_MINT = 2
+}
+export interface ListingWhitelist {
+    type: WhitelistType;
+    wallets: Address[];
+}
+export declare enum DeadlineType {
+    CANT_MINT_AFTER_EXPIRY = 1
+}
+export interface ListingDeadline {
+    type: DeadlineType;
+    timestamp: number;
+}
+export interface SpecialPrices {
+    letterOnlyPrice?: number;
+    numberOnlyPrice?: number;
+    emojiOnlyPrice?: number;
+}
+export interface LabelPrice {
+    numberOfLetters: number;
+    price: number;
+}
+export interface ListingPrices {
+    basePrice: number;
+    labelPrices?: LabelPrice[];
+    specialPrices?: SpecialPrices;
+}
+export declare enum ListingTokenType {
+    ERC20 = "ERC20",
+    ERC721 = "ERC721",
+    ERC1155 = "ERC1155"
+}
+export interface TokenGatedAccess {
+    tokenType: ListingTokenType;
+    tokenAddress: string;
+    tokenId?: string;
+    erc20MinTokenBalance?: number;
+    erc20TokenDecimals?: number;
+    tokenNetwork: ListingNetwork;
+}
+export interface ListingMetadata {
+    description?: string;
+    holderBenefits?: string;
+}
+export interface ReservedLabel {
+    label: string;
+    price?: number;
+    isMintable: boolean;
+}
+export interface L2Registry {
+    isBurnable: boolean;
+    isExpirable: boolean;
+    registryNetwork: ListingNetwork;
+    registryName: string;
+    registrySymbol: string;
+    isDeployed: boolean;
+    registryAddress?: string;
+    name: string;
+    nameNetwork: ListingNetwork;
+    registryOwner: string;
+}
+export interface CreateL2RegistryRequest {
+    tokenName: string;
+    tokenSymbol: string;
+    isBurnable: boolean;
+    isExpirable: boolean;
+    tokenOwner?: string;
+    tokenNetwork: ListingNetwork;
+}
+export interface CreateListingRequest {
+    name: string;
+    nameNetwork: ListingNetwork;
+    type: ListingType;
+    currency: ListingCurrency;
+    whitelist?: ListingWhitelist;
+    deadline?: ListingDeadline;
+    prices: ListingPrices;
+    paymentWallet?: string;
+    tokenGatedAccess?: TokenGatedAccess[];
+    metadata?: ListingMetadata;
+    reservations?: ReservedLabel[];
+    l2Registry?: CreateL2RegistryRequest;
+}
+export interface ListingStatusDTO {
+    name: string;
+    nameNetwork: ListingNetwork;
+    listingCreated: boolean;
+    listingVerified: boolean;
+    type: ListingType;
+    registryDeployed: boolean;
+    approvalGiven: boolean;
+    nameWrapped: boolean;
+    l2Network: ListingNetwork;
+    resolverSet: boolean;
+    resolverConfigured: boolean;
+}
+export interface GetRegistryParametersRequest {
+    ensName: string;
+    isTestnet?: boolean;
+    registryNetwork: ListingNetwork;
+}
+export interface GetRegistryParametersResponse {
+    parameters: {
+        tokenName: string;
+        tokenSymbol: string;
+        label: string;
+        TLD: string;
+        owner: string;
+        parentControl: number;
+        expirableType: number;
+        signatureExpiry: number;
+    };
+    signature: string;
+}
+export interface ListingSuggestion {
+    label: string;
+    parentName: string;
+    nameNetwork: ListingNetwork;
+    listingType: ListingType;
+    l2Network?: ListingNetwork;
+    price: number;
+    fee: number;
+    isStandardFee: boolean;
+    totalPrice: number;
+}
+export interface ListingSuggestionRequest {
+    label: string;
+    parentName?: string;
+    page?: number;
+    size?: number;
+    minterAddress: Address;
+    listingType?: ListingType;
+    nameNetwork: ListingNetwork;
+}

package/dist/types/types/listing.d.ts

@@ -0,0 +1,136 @@
+import { Layer2Network, SupportedChainName, Web3Network } from "./networks";
+export interface INameListing {
+    node: string;
+    fullName: string;
+    basePrice: number;
+    label: string;
+    whitelist: string[];
+    network: Web3Network;
+    whitelistType: number;
+    reservations: IReservedSubname[];
+    specialPrices: ILabelPrice[];
+    deadline: number;
+    tokenGatedAccess?: ITokenGatedAccess[];
+    listingOwner: string;
+    isListed: boolean;
+    isApproved: boolean;
+    listingType?: ListingType;
+    specialLabelRules?: ISpecialLabelRules;
+    registryNetwork?: Layer2Network;
+}
+export type TokenGatedType = "ERC20" | "ERC1155" | "ERC721";
+export interface ILabelPrice {
+    letters: number;
+    price: number;
+}
+export interface IReservedSubname {
+    label: string;
+    isMintable: boolean;
+    price: number;
+}
+export interface ITokenGatedAccess {
+    tokenAddress: string;
+    tokenId?: string;
+    tokenType: TokenGatedType;
+    erc20TokenAmount?: number;
+    tokenNetwork: SupportedChainName;
+    erc20TokenDecimals?: number;
+}
+export interface CreateListingRequest {
+    label: string;
+    basePrice: number;
+    whitelist?: string[];
+    whitelistType: number;
+    reservations?: IReservedSubname[];
+    specialPrices?: ILabelPrice[];
+    deadline?: number;
+    tokenGatedAccess?: ITokenGatedAccess[];
+    network: Web3Network;
+    listingType?: ListingType;
+    specialLabelRules?: ISpecialLabelRules;
+    l2Token?: L2TokenCreateRequest;
+}
+export interface L2TokenCreateRequest {
+    tokenSymbol: string;
+    tokenName: string;
+    listingType: L2ListingType;
+    parentControl: ParentControl;
+    l2Network: Layer2Network;
+}
+export interface L2TokenParameters {
+    token: string;
+    listingName: string;
+    ensName: string;
+    owner: string;
+    resolver: string;
+    baseUri: string;
+    parentControl: ParentControl;
+    listingType: L2ListingType;
+}
+export declare enum ParentControl {
+    NO_CONTROL = 0,
+    CONTROLLABLE = 1
+}
+export declare enum L2ListingType {
+    BASIC = 0,
+    EXPIRABLE = 1
+}
+export interface IMintableListing {
+    parentLabel: string;
+    parentNamehash: string;
+    parentName: string;
+    subnameLabel: string;
+    mintPrice: number;
+    listingOwner: string;
+    created: number;
+    verificationReason?: any;
+    listingType: ListingType;
+}
+export interface IGetMintableListingsParams {
+    subnameLabel: string;
+    parentLabel?: string;
+    owner?: string;
+    minterAddress: string;
+    currentPage?: number;
+    pageSize?: number;
+    network: null;
+    registrationPerion?: number;
+}
+export declare enum ListingType {
+    SELL_UNRUGGABLE = "sellUnruggable",
+    RENTING = "renting",
+    L2 = "l2"
+}
+export interface ISpecialLabelRules {
+    onlyLettersPrice?: number;
+    onlyNumbersPrice?: number;
+    onlyEmojiPrice?: number;
+}
+export interface IListingStats {
+    subnamesSold: number;
+    subnameProfile: number;
+    subnameVolume: number;
+}
+export interface GetMintableListingsParams {
+    subnameLabel: string;
+    parentLabel?: string;
+    owner?: string;
+    minterAddress: string;
+    currentPage?: number;
+    pageSize?: number;
+    network: Web3Network;
+    showL2Listings: boolean;
+}
+export interface MintableListing {
+    parentLabel: string;
+    parentNamehash: string;
+    parentName: string;
+    subnameLabel: string;
+    mintPrice: number;
+    listingOwner: string;
+    created: number;
+    verificationReason?: any;
+    listingType: ListingType;
+    network: Web3Network;
+    l2Network: Layer2Network;
+}

package/dist/types/types/minting.d.ts

@@ -0,0 +1,75 @@
+import { Address, Hash } from "viem";
+import { Layer2Network, Web3Network } from "./networks";
+export type MintDeniedReason = "SUBNAME_TAKEN" | "MINTER_NOT_TOKEN_OWNER" | "MINTER_NOT_WHITELISTED" | "LISTING_EXPIRED" | "SUBNAME_RESERVED" | "VERIFIED_MINTER_ADDRESS_REQUIRED" | "UNKNOWN_REASON";
+export declare const MintDeniedMessage: Record<MintDeniedReason, string>;
+export interface SimulateMintRequest {
+    label: string;
+    parentLabel: string;
+    network: Web3Network;
+    subnameOwner: Address;
+    minter: Address;
+}
+export interface SimulateMintResponse {
+    canMint: boolean;
+    estimatedPrice: number;
+    estimatedFee: number;
+    validationErrors: MintDeniedReason[];
+    requiresVerifiedMinter: boolean;
+    isStandardFee: boolean;
+}
+export interface L2MintParametersResponse {
+    parameters: L2MintParameters;
+    signature: Hash;
+}
+export interface L2MintParametersRequest {
+    mainNetwork: Web3Network;
+    tokenNetwork: Layer2Network;
+    parentLabel: string;
+    label: string;
+    owner: string;
+    expiry?: number;
+}
+export interface L2MintParameters {
+    label: string;
+    parentLabel: string;
+    resolver: Address;
+    owner: string;
+    expiry: number;
+    price: string;
+    fee: string;
+    paymentReceiver: Address;
+}
+export interface MintParameters {
+    subnameLabel: string;
+    parentNode: string;
+    resolver: string;
+    subnameOwner: string;
+    fuses: number;
+    mintPrice: string;
+    mintFee: string;
+    expiry: number;
+    ttl: number;
+}
+export interface MintParametersRequest {
+    label: string;
+    parentLabel: string;
+    subnameOwner: string;
+    resolver?: string;
+    network: Web3Network;
+    registrationPeriod?: number;
+}
+export interface MintParametersResponse {
+    parameters: MintParameters;
+    signature: Hash;
+}
+export interface MintedL1SubnameEvent {
+    chainId: number;
+    subnameLabel: string;
+    mintFee: number;
+    mintPrice: number;
+    parentNode: string;
+    paymentReceiver: string;
+    sender: string;
+    subnameOwner: string;
+    tx: string;
+}

package/dist/types/types/name-listing/enums.d.ts

@@ -0,0 +1,20 @@
+export declare enum DeadlineType {
+    CANT_MINT_AFTER_EXPIRY = 1
+}
+export declare enum ListingCurrencyType {
+    ETH = "ETH",
+    USD = "DOLLAR"
+}
+export declare enum ListingVersionType {
+    L1 = "L1",
+    L2 = "L2"
+}
+export declare enum ListingTokenType {
+    ERC20 = "ERC20",
+    ERC721 = "ERC721",
+    ERC1155 = "ERC1155"
+}
+export declare enum WhitelistType {
+    ONLY_WHITELISTED = 1,
+    FREE_MINT = 2
+}

package/dist/types/types/name-listing/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./enums";
+export * from "./l2-name-registry";
+export * from "./listing";

package/dist/types/types/name-listing/l2-name-registry.d.ts

@@ -0,0 +1,13 @@
+import { SupportedNetwork } from "../networks";
+export interface L2NameRegistryDTO {
+    isBurnable: boolean;
+    isExpirable: boolean;
+    registryNetwork: SupportedNetwork;
+    registryName: string;
+    registrySymbol: string;
+    isDeployed: boolean;
+    registryAddress?: string;
+    name: string;
+    nameNetwork: SupportedNetwork;
+    registryOwner: string;
+}

package/dist/types/types/name-listing/listing.d.ts

@@ -0,0 +1,73 @@
+import { Address } from "viem";
+import { ListingCurrencyType, ListingVersionType, WhitelistType, DeadlineType, ListingTokenType } from "./enums";
+import { L2NameRegistryDTO } from "./l2-name-registry";
+import { SupportedNetwork } from "../networks";
+export interface WhitelistDTO {
+    type: WhitelistType;
+    wallets: Address[];
+}
+export interface DeadlineDTO {
+    timestamp: number;
+    type: DeadlineType;
+}
+export interface SpecialPriceDTO {
+    letterOnlyPrice?: number;
+    numberOnlyPrice?: number;
+    emojiOnlyPrice?: number;
+}
+export interface LabelPriceDTO {
+    numberOfLetters: number;
+    price: number;
+}
+export interface ListingPricesDTO {
+    basePrice: number;
+    labelPrices?: LabelPriceDTO[];
+    specialPrices?: SpecialPriceDTO;
+}
+export interface TokenGatedAccessDTO {
+    tokenType: ListingTokenType;
+    tokenAddress: string;
+    tokenId?: string;
+    erc20MinTokenBalance?: number;
+    erc20TokenDecimals?: number;
+    tokenNetwork: SupportedNetwork;
+}
+export interface ReservedLabelDTO {
+    label: string;
+    price?: number;
+    isMintable: boolean;
+}
+export declare class ListingMetadataDTO {
+    description?: string;
+    holderBenefits?: string;
+}
+export interface ListingDTO {
+    name: string;
+    namehash: string;
+    nameNetwork: SupportedNetwork;
+    type: ListingVersionType;
+    currency: ListingCurrencyType;
+    createdAt?: string;
+    updatedAt?: string;
+    whitelist?: WhitelistDTO;
+    deadline?: DeadlineDTO;
+    prices: ListingPricesDTO;
+    isVerified: boolean;
+    owner: string;
+    paymentWallet: string;
+    tokenGatedAccess?: TokenGatedAccessDTO[];
+    metadata?: ListingMetadataDTO;
+    reservations?: ReservedLabelDTO[];
+}
+export interface UpdateListingRequestDTO {
+    name: string;
+    nameNetwork: SupportedNetwork;
+    whitelist?: WhitelistDTO;
+    deadline?: DeadlineDTO;
+    prices: ListingPricesDTO;
+    tokenGatedAccess?: TokenGatedAccessDTO[];
+    reservations?: ReservedLabelDTO[];
+}
+export interface FullListingDTO extends ListingDTO {
+    l2Metadata?: L2NameRegistryDTO;
+}

package/dist/types/types/networks.d.ts

@@ -0,0 +1,16 @@
+import { ListingNetwork } from "./list-manager";
+export type Web3Network = "mainnet" | "sepolia";
+export type Layer2Network = "base" | "baseSepolia" | "optimism";
+export type SupportedChainName = Web3Network | Layer2Network;
+export declare const isTestnet: (chainId: number) => boolean;
+export declare const allSupportedChains: SupportedChainName[];
+export declare const isL2Chain: (network: SupportedChainName) => boolean;
+export declare enum SupportedNetwork {
+    Mainnet = "mainnet",
+    Sepolia = "sepolia",
+    Optimism = "optimism",
+    BaseSepolia = "baseSepolia",
+    Base = "base"
+}
+export declare const toListingNetwork: (network: SupportedNetwork) => ListingNetwork;
+export type SupportedNetworkType = "mainnet" | "sepolia" | "optimism" | "baseSepolia" | "base";

package/dist/types/utils/ens.d.ts

@@ -0,0 +1,3 @@
+export declare const isL2EnsName: (ensName: string) => boolean;
+export declare const isSecondLevelDomain: (ensName: string) => boolean;
+export declare const isValidEnsLabel: (label: string) => boolean;

package/dist/types/utils/image-event-emitter.d.ts

@@ -0,0 +1,8 @@
+export declare const AVATAR_UPDATED = "avatarUpdated";
+export declare const COVER_UPDATED = "coverUpdated";
+export declare const notifyAvatarUpdated: () => boolean;
+export declare const onAvatarUpdated: (callback: () => void) => void;
+export declare const offAvatarUpdated: (callback: () => void) => void;
+export declare const notifyCoverUpdated: () => boolean;
+export declare const onCoverUpdated: (callback: () => void) => void;
+export declare const offCoverUpdated: (callback: () => void) => void;