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:75

Accessors

mintUrl

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

webSocketConnection

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

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:482

checkMeltQuoteBolt11

checkMeltQuoteBolt11(
quote: string,
customRequest?: RequestFn,
): Promise<PartialMeltQuoteResponse>
Gets an existing melt quote.
Parameters
- quote: string
  Quote ID.
- OptionalcustomRequest: RequestFn
  Optional override for the request function.
Returns Promise<PartialMeltQuoteResponse>
The melt quote response.
- Defined in src/mint/Mint.ts:351

checkMeltQuoteBolt12

checkMeltQuoteBolt12(
quote: string,
customRequest?: RequestFn,
): Promise<MeltQuoteResponse>
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<MeltQuoteResponse>
Updated quote with current payment state and preimage if available.
- Defined in src/mint/Mint.ts:384

checkMintQuoteBolt11

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

checkMintQuoteBolt12

checkMintQuoteBolt12(
quote: string,
customRequest?: RequestFn,
): Promise<Bolt12MintQuoteResponse>
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<Bolt12MintQuoteResponse>
Updated quote with current payment and issuance amounts.
- Defined in src/mint/Mint.ts:235

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:576

createMeltQuoteBolt11

createMeltQuoteBolt11(
meltQuotePayload: MeltQuotePayload,
customRequest?: RequestFn,
): Promise<PartialMeltQuoteResponse>
Requests a new melt quote from the mint.
Parameters
- meltQuotePayload: MeltQuotePayload
  Payload for creating a new melt quote.
- OptionalcustomRequest: RequestFn
  Optional override for the request function.
Returns Promise<PartialMeltQuoteResponse>
The melt quote response.
- Defined in src/mint/Mint.ts:301

createMeltQuoteBolt12

createMeltQuoteBolt12(
meltQuotePayload: MeltQuotePayload,
customRequest?: RequestFn,
): Promise<MeltQuoteResponse>
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: MeltQuotePayload
  Payload containing the BOLT12 offer to pay and unit.
- OptionalcustomRequest: RequestFn
  Optional override for the request function.
Returns Promise<MeltQuoteResponse>
Melt quote with amount, fee reserve, and payment state.
- Defined in src/mint/Mint.ts:331

createMintQuoteBolt11

createMintQuoteBolt11(
mintQuotePayload: MintQuotePayload,
customRequest?: RequestFn,
): Promise<PartialMintQuoteResponse>
Requests a new mint quote from the mint.
Parameters
- mintQuotePayload: MintQuotePayload
  Payload for creating a new mint quote.
- OptionalcustomRequest: RequestFn
  Optional override for the request function.
Returns Promise<PartialMintQuoteResponse>
A new mint quote containing a payment request for the specified amount and unit.
- Defined in src/mint/Mint.ts:177

createMintQuoteBolt12

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

disconnectWebSocket

disconnectWebSocket(): void
Closes a websocket connection.

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

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:124

getKeys

getKeys(
    keysetId?: string,
    mintUrl?: string,
    customRequest?: RequestFn,
): Promise<MintActiveKeys>
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<MintActiveKeys>
The mint's public keys.
- Defined in src/mint/Mint.ts:510

getKeySets

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

getLazyMintInfo

getLazyMintInfo(): Promise<MintInfo>
Lazily fetches and caches the mint's info if not already loaded.

Returns Promise<MintInfo>
The parsed MintInfo object.
- Defined in src/mint/Mint.ts:138

meltBolt11

meltBolt11(
meltPayload: MeltPayload,
options?: { customRequest?: RequestFn; preferAsync?: boolean },
): Promise<PartialMeltQuoteResponse>
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: MeltPayload
  The melt payload containing inputs and optional outputs.
- Optionaloptions: { customRequest?: RequestFn; preferAsync?: boolean }
  - OptionalcustomRequest?: RequestFn
    Optional override for the request function.
  - OptionalpreferAsync?: boolean
    Optional override to set 'respond-async' header.
Returns Promise<PartialMeltQuoteResponse>
The melt response.
- Defined in src/mint/Mint.ts:407

meltBolt12

meltBolt12(
meltPayload: MeltPayload,
options?: { customRequest?: RequestFn; preferAsync?: boolean },
): Promise<MeltQuoteResponse>
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: MeltPayload
  Payload containing quote ID, inputs, and optional outputs for change.
- Optionaloptions: { customRequest?: RequestFn; preferAsync?: boolean }
  - OptionalcustomRequest?: RequestFn
    Optional override for the request function.
  - OptionalpreferAsync?: boolean
    Optional override to set 'respond-async' header.
Returns Promise<MeltQuoteResponse>
Payment result with state and optional change signatures.
- Defined in src/mint/Mint.ts:453

mintBolt11

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

mintBolt12

mintBolt12(
mintPayload: MintPayload,
customRequest?: RequestFn,
): Promise<MintResponse>
Mints new tokens using a BOLT12 quote by requesting blind signatures on the provided outputs.
Parameters
- mintPayload: MintPayload
  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.
- Defined in src/mint/Mint.ts:278

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:554

swap

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

Class Mint

Remarks

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns Mint

Accessors

mintUrl

Returns string

webSocketConnection

Returns undefined | WSConnection

Methods

check

Parameters

Returns Promise<CheckStateResponse>

checkMeltQuoteBolt11

Parameters

Returns Promise<PartialMeltQuoteResponse>

checkMeltQuoteBolt12

Parameters

Returns Promise<MeltQuoteResponse>

checkMintQuoteBolt11

Parameters

Returns Promise<PartialMintQuoteResponse>

checkMintQuoteBolt12

Parameters

Returns Promise<Bolt12MintQuoteResponse>

connectWebSocket

Returns Promise<void>

createMeltQuoteBolt11

Parameters

Returns Promise<PartialMeltQuoteResponse>

createMeltQuoteBolt12

Parameters

Returns Promise<MeltQuoteResponse>

createMintQuoteBolt11

Parameters

Returns Promise<PartialMintQuoteResponse>

createMintQuoteBolt12

Parameters

Returns Promise<Bolt12MintQuoteResponse>

disconnectWebSocket

Returns void

getInfo

Parameters

Returns Promise<GetInfoResponse>

getKeys

Parameters

Returns Promise<MintActiveKeys>

getKeySets

Parameters

Returns Promise<MintAllKeysets>

getLazyMintInfo

Returns Promise<MintInfo>

meltBolt11

Parameters

OptionalcustomRequest?: RequestFn

OptionalpreferAsync?: boolean

Returns Promise<PartialMeltQuoteResponse>

meltBolt12

Parameters

OptionalcustomRequest?: RequestFn

OptionalpreferAsync?: boolean

Returns Promise<MeltQuoteResponse>

mintBolt11

Parameters

Returns Promise<MintResponse>

mintBolt12

Parameters

Returns Promise<MintResponse>

oidcAuth

Parameters

Returns Promise<OIDCAuth>

Example

restore

Parameters

`Optional`customRequest?: RequestFn

`Optional`preferAsync?: boolean

`Optional`customRequest?: RequestFn

`Optional`preferAsync?: boolean