Get mint details

Use getMintDetails to check whether a wallet can mint a subname and to retrieve the estimated price and fee.

For most integrations, prefer checkName. It takes the whole name, derives the chain from the listing, and reconciles this response with the registry. getMintDetails validation stops at the first failure, so on a gated listing it never evaluates the name at all, and a free name and a taken name return identical responses.

Usage

import type {
  MintDetailsRequest,
  MintDetailsResponse,
} from '@thenamespace/mint-manager';

const request: MintDetailsRequest = {
  parentName: 'example.eth',
  label: 'alice',
  minterAddress: '0x1D84ad46F1ec91b4Bb3208F645aD2fA7aBEc19f8',
  expiryInYears: 1,
};

// `label` must be a single label. Passing 'alice.example.eth' here throws
// INVALID_LABEL rather than hashing it as one long label.

const mintDetails: MintDetailsResponse = await mintClient.getMintDetails(
  request
);

MintDetailsResponse

The data returned from this function answers the questions:

What is the total price of minting a given subname?
Is the minter address allowed to mint a subname?

export interface MintDetailsResponse {
  canMint: boolean;
  estimatedPriceEth: number;
  estimatedFeeEth: number;
  isStandardFee: boolean;
  validationErrors: MintingValidationErrorType[];
}

canMint - Specifies whether a minter address has permission to mint a subname. If this is false, see validationErrors for the reason.
estimatedPriceEth - The price for minting a subname, set by the listing owner.
estimatedFeeEth - The minting fee for minting a subname.
validationErrors - Lists the exact reason the mint cannot proceed, such as an unavailable label, expired listing, missing whitelist entry, or unmet token requirement.

MintingValidationErrorType

Validation errors are a standard set of reasons a subname cannot be minted. They are not interchangeable: what your app should do next depends on whether the obstacle is the name or the minter, and whether another label would help.

Error	Obstacle	Another label helps?	Description
`SUBNAME_TAKEN`	name	Yes	The subname is already registered.
`SUBNAME_RESERVED`	name	Yes	The label is reserved by the parent owner. It is not registered, so the registry reports it free.
`MINTER_NOT_WHITELISTED`	minter	No	The listing uses whitelisting and the minter is not on the list.
`MINTER_NOT_TOKEN_OWNER`	minter	No	The listing is token gated and the minter holds no qualifying token.
`VERIFIED_MINTER_ADDRESS_REQUIRED`	minter	No	The listing requires a verified minter address.
`LISTING_EXPIRED`	listing	No	The listing’s deadline has passed.

Validation stops at the first failure, so validationErrors is a partial list. Clearing one reason can reveal another.

isTestnet on MintDetailsRequest is deprecated and ignored. The network comes from the client’s own isTestnet, so a quote can no longer disagree with the transaction it precedes.

Start building

How to guides

Starter kits

Concepts

Reference

AI tooling

Troubleshooting

Usage

MintDetailsResponse

MintingValidationErrorType

​Usage

​MintDetailsResponse

​MintingValidationErrorType

Usage

MintDetailsResponse

MintingValidationErrorType