Class Mint

Class represents Cashu Mint API.

Remarks

This class contains lower-level functions that are implemented by Wallet.

Constructors

constructor

new Mint(
    mintUrl: string,
    options?: {
        authProvider?: AuthProvider;
        customRequest?: RequestFn;
        logger?: Logger;
    },
): Mint
Parameters
- mintUrl: string
  Requires mint URL to create this object.
- Optionaloptions: { authProvider?: AuthProvider; customRequest?: RequestFn; logger?: Logger }
Returns Mint
- Defined in src/mint/Mint.ts:76

Accessors

mintUrl

get mintUrl(): string
Returns string
- Defined in src/mint/Mint.ts:91

webSocketConnection

get webSocketConnection(): WSConnection | undefined
Returns WSConnection | undefined
- Defined in src/mint/Mint.ts:772

Methods

check

check(
checkPayload: CheckStatePayload,
customRequest?: RequestFn,
): Promise<CheckStateResponse>
Checks if specific proofs have already been redeemed.
Parameters
- checkPayload: CheckStatePayload
  The payload containing proofs to check.
- OptionalcustomRequest: RequestFn
  Optional override for the request function.
Returns Promise<CheckStateResponse>
Redeemed and unredeemed ordered list of booleans.
- Defined in src/mint/Mint.ts:621

checkMeltQuote

checkMeltQuote<TRes extends MeltQuoteBaseResponse = MeltQuoteBaseResponse>(
    method: string,
    quote: string,
    options?: {
        customRequest?: RequestFn;
        normalize?: (raw: Record<string, unknown>) => TRes;
    },
): Promise<TRes>
Checks an existing melt quote for any payment method.
Type Parameters
- TRes extends MeltQuoteBaseResponse = MeltQuoteBaseResponse
Parameters
- method: string
  The payment method (e.g., 'bolt11', 'bolt12', or custom method name).
- quote: string
  Quote ID.
- Optionaloptions: {
  customRequest?: RequestFn;
  normalize?: (raw: Record<string, unknown>) => TRes;
  }
  - OptionalcustomRequest?: RequestFn
    Optional override for the request function.
  - Optionalnormalize?: (raw: Record<string, unknown>) => TRes
    Optional callback to normalize method-specific response fields.
Returns Promise<TRes>
The melt quote response.

Remarks
Uses /v1/melt/quote/{method}/{quote} and validates method format. Normalization follows the same stacking pattern as Mint.createMeltQuote.
- Defined in src/mint/Mint.ts:478

checkMeltQuoteBolt11

checkMeltQuoteBolt11(
quote: string,
customRequest?: RequestFn,
): Promise<MeltQuoteBolt11Response>
Gets an existing melt quote.
Parameters
- quote: string
  Quote ID.
- OptionalcustomRequest: RequestFn
  Optional override for the request function.
Returns Promise<MeltQuoteBolt11Response>
The melt quote response.

Remarks
Thin wrapper around checkMeltQuote('bolt11', ...).
- Defined in src/mint/Mint.ts:502

checkMeltQuoteBolt12

checkMeltQuoteBolt12(
quote: string,
customRequest?: RequestFn,
): Promise<MeltQuoteBolt11Response>
Gets an existing BOLT12 melt quote from the mint. Returns current payment state (UNPAID, PENDING, or PAID) and payment preimage if paid.
Parameters
- quote: string
  Quote ID to check.
- OptionalcustomRequest: RequestFn
  Optional override for the request function.
Returns Promise<MeltQuoteBolt11Response>
Updated quote with current payment state and preimage if available.

Remarks
Thin wrapper around checkMeltQuote('bolt12', ...).
- Defined in src/mint/Mint.ts:519

checkMintQuote

checkMintQuote<TRes extends MintQuoteBaseResponse = MintQuoteBaseResponse>(
    method: string,
    quote: string,
    options?: {
        customRequest?: RequestFn;
        normalize?: (raw: Record<string, unknown>) => TRes;
    },
): Promise<TRes>
Checks an existing mint quote for any payment method.
Type Parameters
- TRes extends MintQuoteBaseResponse = MintQuoteBaseResponse
Parameters
- method: string
  The payment method (e.g., 'bolt11', 'bolt12', or custom method name).
- quote: string
  Quote ID.
- Optionaloptions: {
  customRequest?: RequestFn;
  normalize?: (raw: Record<string, unknown>) => TRes;
  }
  - OptionalcustomRequest?: RequestFn
    Optional override for the request function.
  - Optionalnormalize?: (raw: Record<string, unknown>) => TRes
    Optional callback to normalize method-specific response fields.
Returns Promise<TRes>
The mint quote response.

Remarks
Uses /v1/mint/quote/{method}/{quote} and validates method format. Normalization follows the same stacking pattern as Mint.createMintQuote.
- Defined in src/mint/Mint.ts:275

checkMintQuoteBolt11

checkMintQuoteBolt11(
quote: string,
customRequest?: RequestFn,
): Promise<MintQuoteBolt11Response>
Gets an existing mint quote from the mint.
Parameters
- quote: string
  Quote ID.
- OptionalcustomRequest: RequestFn
  Optional override for the request function.
Returns Promise<MintQuoteBolt11Response>
The status of the mint quote, including payment details and state.

Remarks
Thin wrapper around checkMintQuote('bolt11', ...).
- Defined in src/mint/Mint.ts:299

checkMintQuoteBolt12

checkMintQuoteBolt12(
quote: string,
customRequest?: RequestFn,
): Promise<MintQuoteBolt12Response>
Gets an existing BOLT12 mint quote from the mint.
Parameters
- quote: string
  Quote ID to check.
- OptionalcustomRequest: RequestFn
  Optional override for the request function.
Returns Promise<MintQuoteBolt12Response>
Updated quote with current payment and issuance amounts.

Remarks
Thin wrapper around checkMintQuote('bolt12', ...).
- Defined in src/mint/Mint.ts:315

connectWebSocket

connectWebSocket(): Promise<void>
Tries to establish a websocket connection with the websocket mint url according to NUT-17.

Returns Promise<void>
- Defined in src/mint/Mint.ts:734

createMeltQuote

createMeltQuote<TRes extends MeltQuoteBaseResponse = MeltQuoteBaseResponse>(
    method: string,
    payload: Record<string, unknown>,
    options?: {
        customRequest?: RequestFn;
        normalize?: (raw: Record<string, unknown>) => TRes;
    },
): Promise<TRes>
Creates a melt quote for any payment method.
Type Parameters
- TRes extends MeltQuoteBaseResponse = MeltQuoteBaseResponse
Parameters
- method: string
  The payment method (e.g., 'bolt11', 'bolt12', or custom method name).
- payload: Record<string, unknown>
  The request body to POST (method-specific fields).
- Optionaloptions: {
  customRequest?: RequestFn;
  normalize?: (raw: Record<string, unknown>) => TRes;
  }
  - OptionalcustomRequest?: RequestFn
    Optional override for the request function.
  - Optionalnormalize?: (raw: Record<string, unknown>) => TRes
    Optional callback to normalize method-specific response fields.
Returns Promise<TRes>
The melt quote response.

Remarks
Uses /v1/melt/quote/{method} and validates method format. Base normalization (amount, expiry, change) is always applied. For first-class methods (bolt11/bolt12), bolt-specific normalization (fee_reserve, request) is stacked on top. Custom methods can supply an optional normalize callback for their own fields.
- Defined in src/mint/Mint.ts:406

createMeltQuoteBolt11

createMeltQuoteBolt11(
meltQuotePayload: MeltQuoteBolt11Request,
customRequest?: RequestFn,
): Promise<MeltQuoteBolt11Response>
Requests a new melt quote from the mint.
Parameters
- meltQuotePayload: MeltQuoteBolt11Request
  Payload for creating a new melt quote.
- OptionalcustomRequest: RequestFn
  Optional override for the request function.
Returns Promise<MeltQuoteBolt11Response>
The melt quote response.

Remarks
Thin wrapper around createMeltQuote('bolt11', ...).
- Defined in src/mint/Mint.ts:430

createMeltQuoteBolt12

createMeltQuoteBolt12(
meltQuotePayload: MeltQuoteBolt12Request,
customRequest?: RequestFn,
): Promise<MeltQuoteBolt11Response>
Requests a new BOLT12 melt quote from the mint for paying a Lightning Network offer. For amount-less offers, specify the amount in options.amountless.amount_msat.
Parameters
- meltQuotePayload: MeltQuoteBolt12Request
  Payload containing the BOLT12 offer to pay and unit.
- OptionalcustomRequest: RequestFn
  Optional override for the request function.
Returns Promise<MeltQuoteBolt11Response>
Melt quote with amount, fee reserve, and payment state.

Remarks
Thin wrapper around createMeltQuote('bolt12', ...).
- Defined in src/mint/Mint.ts:451

createMintQuote

createMintQuote<TRes extends MintQuoteBaseResponse = MintQuoteBaseResponse>(
    method: string,
    payload: Record<string, unknown>,
    options?: {
        customRequest?: RequestFn;
        normalize?: (raw: Record<string, unknown>) => TRes;
    },
): Promise<TRes>
Creates a mint quote for any payment method.
Type Parameters
- TRes extends MintQuoteBaseResponse = MintQuoteBaseResponse
Parameters
- method: string
  The payment method (e.g., 'bolt11', 'bolt12', or custom method name).
- payload: Record<string, unknown>
  The request body to POST (method-specific fields).
- Optionaloptions: {
  customRequest?: RequestFn;
  normalize?: (raw: Record<string, unknown>) => TRes;
  }
  - OptionalcustomRequest?: RequestFn
    Optional override for the request function.
  - Optionalnormalize?: (raw: Record<string, unknown>) => TRes
    Optional callback to normalize method-specific response fields.
Returns Promise<TRes>
The mint quote response.

Remarks
Uses /v1/mint/quote/{method} and validates method format. Base normalization is applied automatically. For first-class methods (bolt11/bolt12), method-specific normalization is stacked on top. Custom methods can supply an optional normalize callback for their own fields.
- Defined in src/mint/Mint.ts:200

createMintQuoteBolt11

createMintQuoteBolt11(
mintQuotePayload: MintQuoteBolt11Request,
customRequest?: RequestFn,
): Promise<MintQuoteBolt11Response>
Requests a new mint quote from the mint.
Parameters
- mintQuotePayload: MintQuoteBolt11Request
  Payload for creating a new mint quote.
- OptionalcustomRequest: RequestFn
  Optional override for the request function.
Returns Promise<MintQuoteBolt11Response>
A new mint quote containing a payment request for the specified amount and unit.

Remarks
Thin wrapper around createMintQuote('bolt11', ...).
- Defined in src/mint/Mint.ts:224

createMintQuoteBolt12

createMintQuoteBolt12(
mintQuotePayload: MintQuoteBolt12Request,
customRequest?: RequestFn,
): Promise<MintQuoteBolt12Response>
Requests a new BOLT12 mint quote from the mint using Lightning Network offers.
Parameters
- mintQuotePayload: MintQuoteBolt12Request
  Payload containing amount, unit, optional description, and required pubkey.
- OptionalcustomRequest: RequestFn
  Optional override for the request function.
Returns Promise<MintQuoteBolt12Response>
A mint quote containing a BOLT12 offer.

Remarks
Thin wrapper around createMintQuote('bolt12', ...).
- Defined in src/mint/Mint.ts:248

disconnectWebSocket

disconnectWebSocket(): void
Closes a websocket connection.

Returns void
- Defined in src/mint/Mint.ts:766

getInfo

getInfo(customRequest?: RequestFn): Promise<GetInfoResponse>
Fetches mint's info at the /info endpoint.
Parameters
- OptionalcustomRequest: RequestFn
  Optional override for the request function.
Returns Promise<GetInfoResponse>
The mint's information response.
- Defined in src/mint/Mint.ts:125

getKeys

getKeys(
    keysetId?: string,
    mintUrl?: string,
    customRequest?: RequestFn,
): Promise<GetKeysResponse>
Get the mint's public keys.
Parameters
- OptionalkeysetId: string
  Optional param to get the keys for a specific keyset. If not specified, the keys from all active keysets are fetched.
- OptionalmintUrl: string
  Optional alternative mint URL to use for this request.
- OptionalcustomRequest: RequestFn
  Optional override for the request function.
Returns Promise<GetKeysResponse>
The mint's public keys.
- Defined in src/mint/Mint.ts:649

getKeySets

getKeySets(customRequest?: RequestFn): Promise<GetKeysetsResponse>
Get the mint's keysets in no specific order.
Parameters
- OptionalcustomRequest: RequestFn
  Optional override for the request function.
Returns Promise<GetKeysetsResponse>
All the mint's past and current keysets.
- Defined in src/mint/Mint.ts:684

getLazyMintInfo

getLazyMintInfo(customRequest?: RequestFn): Promise<MintInfo>
Lazily fetches and caches the mint's info if not already loaded.
Parameters
- OptionalcustomRequest: RequestFn
Returns Promise<MintInfo>
The parsed MintInfo object.
- Defined in src/mint/Mint.ts:138

melt

melt<TRes extends Record<string, unknown> = Record<string, unknown>>(
    method: string,
    meltPayload: MeltRequest,
    options?: {
        customRequest?: RequestFn;
        normalize?: (raw: Record<string, unknown>) => MeltQuoteBaseResponse & TRes;
    },
): Promise<MeltQuoteBaseResponse & TRes>
Generic method to melt tokens using any payment method endpoint.
Type Parameters
- TRes extends Record<string, unknown> = Record<string, unknown>
Parameters
- method: string
  The payment method (e.g., 'bolt11', 'bolt12', or custom method name).
- meltPayload: MeltRequest
  The melt payload containing inputs and optional outputs.
- Optionaloptions: {
  customRequest?: RequestFn;
  normalize?: (raw: Record<string, unknown>) => MeltQuoteBaseResponse & TRes;
  }
  - OptionalcustomRequest?: RequestFn
    Optional override for the request function.
  - Optionalnormalize?: (raw: Record<string, unknown>) => MeltQuoteBaseResponse & TRes
    Optional callback to normalize method-specific response fields.
Returns Promise<MeltQuoteBaseResponse & TRes>
A response object with at least the required melt quote fields.
Remarks
This method enables support for custom payment methods without modifying the Mint class. It constructs the endpoint as /v1/melt/{method} and POSTs the payload. The response must contain the common fields: quote, amount, state, expiry. Method-specific fields (e.g. fee_reserve for bolt11/bolt12) are normalized when present. Custom methods can supply an optional normalize callback for their own fields.
Example
```
const response = await mint.melt('bolt11', { quote: 'q1', inputs: [...], outputs: [...] });
const response = await mint.melt('custom-payment', { quote: 'c1', inputs: [...], outputs: [...] });
```
- Defined in src/mint/Mint.ts:552

meltBolt11

meltBolt11(
meltPayload: MeltRequest,
options?: { customRequest?: RequestFn },
): Promise<MeltQuoteBolt11Response>
Requests the mint to pay for a Bolt11 payment request by providing ecash as inputs to be spent. The inputs contain the amount and the fee_reserves for a Lightning payment. The payload can also contain blank outputs in order to receive back overpaid Lightning fees.
Parameters
- meltPayload: MeltRequest
  The melt payload containing inputs and optional outputs.
- Optionaloptions: { customRequest?: RequestFn }
  - OptionalcustomRequest?: RequestFn
    Optional override for the request function.
Returns Promise<MeltQuoteBolt11Response>
The melt response.

Remarks
Thin wrapper around melt('bolt11', ...).
- Defined in src/mint/Mint.ts:581

meltBolt12

meltBolt12(
meltPayload: MeltRequest,
options?: { customRequest?: RequestFn },
): Promise<MeltQuoteBolt11Response>
Requests the mint to pay a BOLT12 offer by providing ecash inputs to be spent. The inputs must cover the amount plus fee reserves. Optional outputs can be included to receive change for overpaid Lightning fees.
Parameters
- meltPayload: MeltRequest
  Payload containing quote ID, inputs, and optional outputs for change.
- Optionaloptions: { customRequest?: RequestFn }
  - OptionalcustomRequest?: RequestFn
    Optional override for the request function.
Returns Promise<MeltQuoteBolt11Response>
Payment result with state and optional change signatures.

Remarks
Thin wrapper around melt('bolt12', ...).
- Defined in src/mint/Mint.ts:601

mint

mint<TRes extends Record<string, unknown> = Record<string, unknown>>(
    method: string,
    mintPayload: MintRequest,
    options?: {
        customRequest?: RequestFn;
        normalize?: (raw: Record<string, unknown>) => MintResponse & TRes;
    },
): Promise<MintResponse & TRes>
Mints new tokens for a given payment method.
Type Parameters
- TRes extends Record<string, unknown> = Record<string, unknown>
Parameters
- method: string
  The minting method (e.g., 'bolt11', 'bolt12', or custom method name).
- mintPayload: MintRequest
  Payload containing the quote ID and outputs to get blind signatures on.
- Optionaloptions: {
  customRequest?: RequestFn;
  normalize?: (raw: Record<string, unknown>) => MintResponse & TRes;
  }
  - OptionalcustomRequest?: RequestFn
    Optional override for the request function.
  - Optionalnormalize?: (raw: Record<string, unknown>) => MintResponse & TRes
    Optional callback to normalize method-specific response fields.
Returns Promise<MintResponse & TRes>
Serialized blinded signatures for the requested outputs.

Remarks
Uses /v1/mint/{method} and validates method format. Signature amounts are always normalized. Custom methods can supply an optional normalize callback for any additional response fields.
- Defined in src/mint/Mint.ts:364

mintBolt11

mintBolt11(
mintPayload: MintRequest,
customRequest?: RequestFn,
): Promise<MintResponse>
Mints new tokens by requesting blind signatures on the provided outputs.
Parameters
- mintPayload: MintRequest
  Payload containing the outputs to get blind signatures on.
- OptionalcustomRequest: RequestFn
  Optional override for the request function.
Returns Promise<MintResponse>
Serialized blinded signatures.

Remarks
Thin wrapper around mint('bolt11', ...).
- Defined in src/mint/Mint.ts:335

mintBolt12

mintBolt12(
mintPayload: MintRequest,
customRequest?: RequestFn,
): Promise<MintResponse>
Mints new tokens using a BOLT12 quote by requesting blind signatures on the provided outputs.
Parameters
- mintPayload: MintRequest
  Payload containing the quote ID and outputs to get blind signatures on.
- OptionalcustomRequest: RequestFn
  Optional override for the request function.
Returns Promise<MintResponse>
Serialized blinded signatures for the requested outputs.

Remarks
Thin wrapper around mint('bolt12', ...).
- Defined in src/mint/Mint.ts:348

oidcAuth

oidcAuth(opts?: OIDCAuthOptions): Promise<OIDCAuth>

Create an OIDC client using this mint’s NUT-21 metadata.

Parameters

Optionalopts: OIDCAuthOptions

Returns Promise<OIDCAuth>

Example

const oidc = await mint.oidcAuth({ onTokens: (t) => authMgr.setCAT(t.access_token!) });
const start = await oidc.deviceStart();
// show start.user_code / start.verification_uri to the user
const token = await oidc.devicePoll(start.device_code, start.interval ?? 5);
// token.access_token is your CAT

restore

restore(
restorePayload: PostRestorePayload,
customRequest?: RequestFn,
): Promise<PostRestoreResponse>
Restores proofs from the provided blinded messages.
Parameters
- restorePayload: PostRestorePayload
  The payload containing outputs to restore.
- OptionalcustomRequest: RequestFn
  Optional override for the request function.
Returns Promise<PostRestoreResponse>
The restore response with outputs and signatures.
- Defined in src/mint/Mint.ts:706

setMintInfo

setMintInfo(mintInfo: GetInfoResponse | MintInfo): void
Seeds the mint-info cache from already-fetched data.
Parameters
- mintInfo: GetInfoResponse | MintInfo
Returns void
- Defined in src/mint/Mint.ts:150

swap

swap(swapPayload: SwapRequest, customRequest?: RequestFn): Promise<SwapResponse>
Performs a swap operation with ecash inputs and outputs.
Parameters
- swapPayload: SwapRequest
  Payload containing inputs and outputs.
- OptionalcustomRequest: RequestFn
  Optional override for the request function.
Returns Promise<SwapResponse>
Signed outputs.
- Defined in src/mint/Mint.ts:165

Class Mint

Remarks

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns Mint

Accessors

mintUrl

Returns string

webSocketConnection

Returns WSConnection | undefined

Methods

check

Parameters

Returns Promise<CheckStateResponse>

checkMeltQuote

Type Parameters

Parameters

OptionalcustomRequest?: RequestFn

Optionalnormalize?: (raw: Record<string, unknown>) => TRes

Returns Promise<TRes>

Remarks

checkMeltQuoteBolt11

Parameters

Returns Promise<MeltQuoteBolt11Response>

Remarks

checkMeltQuoteBolt12

Parameters

Returns Promise<MeltQuoteBolt11Response>

Remarks

checkMintQuote

Type Parameters

Parameters

OptionalcustomRequest?: RequestFn

Optionalnormalize?: (raw: Record<string, unknown>) => TRes

Returns Promise<TRes>

Remarks

checkMintQuoteBolt11

Parameters

Returns Promise<MintQuoteBolt11Response>

Remarks

checkMintQuoteBolt12

Parameters

Returns Promise<MintQuoteBolt12Response>

Remarks

connectWebSocket

Returns Promise<void>

createMeltQuote

Type Parameters

Parameters

OptionalcustomRequest?: RequestFn

Optionalnormalize?: (raw: Record<string, unknown>) => TRes

Returns Promise<TRes>

Remarks

createMeltQuoteBolt11

Parameters

Returns Promise<MeltQuoteBolt11Response>

Remarks

createMeltQuoteBolt12

Parameters

Returns Promise<MeltQuoteBolt11Response>

Remarks

createMintQuote

Type Parameters

Parameters

OptionalcustomRequest?: RequestFn

Optionalnormalize?: (raw: Record<string, unknown>) => TRes

Returns Promise<TRes>

Remarks

createMintQuoteBolt11

Parameters

Returns Promise<MintQuoteBolt11Response>

Remarks

createMintQuoteBolt12

Parameters

Returns Promise<MintQuoteBolt12Response>

`Optional`customRequest?: RequestFn

`Optional`normalize?: (raw: Record<string, unknown>) => TRes

`Optional`customRequest?: RequestFn

`Optional`normalize?: (raw: Record<string, unknown>) => TRes

`Optional`customRequest?: RequestFn

`Optional`normalize?: (raw: Record<string, unknown>) => TRes

`Optional`customRequest?: RequestFn

`Optional`normalize?: (raw: Record<string, unknown>) => TRes

`Optional`customRequest?: RequestFn

`Optional`normalize?: (raw: Record<string, unknown>) => MeltQuoteBaseResponse & TRes

`Optional`customRequest?: RequestFn

`Optional`customRequest?: RequestFn

`Optional`customRequest?: RequestFn

`Optional`normalize?: (raw: Record<string, unknown>) => MintResponse & TRes