Class CashuMint

Class represents Cashu Mint API. This class contains Lower level functions that are implemented by CashuWallet.

Constructors

constructor

new CashuMint(
    _mintUrl: string,
    _customRequest?: <T>(options: RequestOptions) => Promise<T>,
    authTokenGetter?: () => Promise<string>,
    options?: { logger?: Logger },
): CashuMint
Parameters
- _mintUrl: string
  Requires mint URL to create this object.
- Optional_customRequest: <T>(options: RequestOptions) => Promise<T>
  If passed, use custom request implementation for network communication with the mint.
- OptionalauthTokenGetter: () => Promise<string>
  A function that is called by the CashuMint instance to obtain a NUT-22 BlindedAuthToken (e.g. from a database or localstorage)
- Optionaloptions: { logger?: Logger }
Returns CashuMint
- Defined in src/CashuMint.ts:57

Accessors

mintUrl

get mintUrl(): string
Returns string
- Defined in src/CashuMint.ts:77

webSocketConnection

get webSocketConnection(): undefined | WSConnection
Returns undefined | WSConnection
- Defined in src/CashuMint.ts:865

Methods

check

check(checkPayload: CheckStatePayload): Promise<CheckStateResponse>
Checks if specific proofs have already been redeemed.
Parameters
- checkPayload: CheckStatePayload
Returns Promise<CheckStateResponse>
Redeemed and unredeemed ordered list of booleans.
- Defined in src/CashuMint.ts:799

checkMeltQuote

checkMeltQuote(quote: string): Promise<PartialMeltQuoteResponse>
Gets an existing melt quote.
Parameters
- quote: string
  Quote ID.
Returns Promise<PartialMeltQuoteResponse>
- Defined in src/CashuMint.ts:557

checkMeltQuoteBolt12

checkMeltQuoteBolt12(quote: string): 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.
Returns Promise<MeltQuoteResponse>
Updated quote with current payment state and preimage if available.
- Defined in src/CashuMint.ts:595

checkMintQuote

checkMintQuote(quote: string): Promise<PartialMintQuoteResponse>
Gets an existing mint quote from the mint.
Parameters
- quote: string
  Quote ID.
Returns Promise<PartialMintQuoteResponse>
The mint will create and return a Lightning invoice for the specified amount.
- Defined in src/CashuMint.ts:284

checkMintQuoteBolt12

checkMintQuoteBolt12(quote: string): Promise<Bolt12MintQuoteResponse>
Gets an existing BOLT12 mint quote from the mint.
Parameters
- quote: string
  Quote ID to check.
Returns Promise<Bolt12MintQuoteResponse>
Updated quote with current payment and issuance amounts.
- Defined in src/CashuMint.ts:320

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/CashuMint.ts:831

createMeltQuote

createMeltQuote(
meltQuotePayload: MeltQuotePayload,
): Promise<PartialMeltQuoteResponse>
Requests a new melt quote from the mint.
Parameters
- meltQuotePayload: MeltQuotePayload
Returns Promise<PartialMeltQuoteResponse>
- Defined in src/CashuMint.ts:457

createMeltQuoteBolt12

createMeltQuoteBolt12(
meltQuotePayload: MeltQuotePayload,
): 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.
Returns Promise<MeltQuoteResponse>
Melt quote with amount, fee reserve, and payment state.
- Defined in src/CashuMint.ts:501

createMintQuote

createMintQuote(
mintQuotePayload: MintQuotePayload,
): Promise<PartialMintQuoteResponse>
Requests a new mint quote from the mint.
Parameters
- mintQuotePayload: MintQuotePayload
  Payload for creating a new mint quote.
Returns Promise<PartialMintQuoteResponse>
The mint will create and return a new mint quote containing a payment request for the specified amount and unit.
- Defined in src/CashuMint.ts:193

createMintQuoteBolt12

createMintQuoteBolt12(
mintQuotePayload: Bolt12MintQuotePayload,
): 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.
Returns Promise<Bolt12MintQuoteResponse>
A mint quote containing a BOLT12 offer.
- Defined in src/CashuMint.ts:237

disconnectWebSocket

disconnectWebSocket(): void
Closes a websocket connection.

Returns void
- Defined in src/CashuMint.ts:859

getInfo

getInfo(): Promise<GetInfoResponse>
Fetches mints info at the /info endpoint.

Returns Promise<GetInfoResponse>
- Defined in src/CashuMint.ts:103

getKeys

getKeys(keysetId?: string, mintUrl?: string): Promise<MintActiveKeys>
Get the mints 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
Returns Promise<MintActiveKeys>
The mints public keys.
- Defined in src/CashuMint.ts:761

getKeySets

getKeySets(): Promise<MintAllKeysets>
Get the mints keysets in no specific order.

Returns Promise<MintAllKeysets>
All the mints past and current keysets.
- Defined in src/CashuMint.ts:789

getLazyMintInfo

getLazyMintInfo(): Promise<MintInfo>
Returns Promise<MintInfo>
- Defined in src/CashuMint.ts:107

handleBlindAuth

handleBlindAuth(path: string): Promise<undefined | string>
Parameters
- path: string
Returns Promise<undefined | string>
- Defined in src/CashuMint.ts:869

melt

melt(meltPayload: MeltPayload): Promise<PartialMeltQuoteResponse>
Ask mint to perform a melt operation. This pays a lightning invoice and destroys tokens matching its amount + fees.
Parameters
- meltPayload: MeltPayload
Returns Promise<PartialMeltQuoteResponse>
- Defined in src/CashuMint.ts:651

meltBolt12

meltBolt12(meltPayload: MeltPayload): 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.
Returns Promise<MeltQuoteResponse>
Payment result with state and optional change signatures.
- Defined in src/CashuMint.ts:692

mint

mint(mintPayload: MintPayload): 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.
Returns Promise<MintResponse>
Serialized blinded signatures.
- Defined in src/CashuMint.ts:365

mintBolt12

mintBolt12(mintPayload: MintPayload): 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.
Returns Promise<MintResponse>
Serialized blinded signatures for the requested outputs.
- Defined in src/CashuMint.ts:407

restore

restore(
restorePayload: { outputs: SerializedBlindedMessage[] },
): Promise<PostRestoreResponse>
Parameters
- restorePayload: { outputs: SerializedBlindedMessage[] }
Returns Promise<PostRestoreResponse>
- Defined in src/CashuMint.ts:822

swap

swap(swapPayload: SwapPayload): Promise<SwapResponse>
Performs a swap operation with ecash inputs and outputs.
Parameters
- swapPayload: SwapPayload
  Payload containing inputs and outputs.
Returns Promise<SwapResponse>
Signed outputs.
- Defined in src/CashuMint.ts:151

`Static`check

check(
    mintUrl: string,
    checkPayload: CheckStatePayload,
    customRequest?: <T>(options: RequestOptions) => Promise<T>,
): Promise<CheckStateResponse>
Checks if specific proofs have already been redeemed.
Parameters
- mintUrl: string
- checkPayload: CheckStatePayload
- OptionalcustomRequest: <T>(options: RequestOptions) => Promise<T>
Returns Promise<CheckStateResponse>
Redeemed and unredeemed ordered list of booleans.
- Defined in src/CashuMint.ts:705

`Static`checkMeltQuote

checkMeltQuote(
    mintUrl: string,
    quote: string,
    customRequest?: <T>(options: RequestOptions) => Promise<T>,
    blindAuthToken?: string,
    logger?: Logger,
): Promise<PartialMeltQuoteResponse>
Gets an existing melt quote.
Parameters
- mintUrl: string
- quote: string
  Quote ID.
- OptionalcustomRequest: <T>(options: RequestOptions) => Promise<T>
- OptionalblindAuthToken: string
- Optionallogger: Logger
Returns Promise<PartialMeltQuoteResponse>
- Defined in src/CashuMint.ts:520

`Static`checkMeltQuoteBolt12

checkMeltQuoteBolt12(
    mintUrl: string,
    quote: string,
    customRequest?: <T>(options: RequestOptions) => Promise<T>,
    blindAuthToken?: string,
): 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
- mintUrl: string
  The mint's base URL.
- quote: string
  Quote ID to check.
- OptionalcustomRequest: <T>(options: RequestOptions) => Promise<T>
  Optional custom request implementation.
- OptionalblindAuthToken: string
  Optional authentication token for NUT-22.
Returns Promise<MeltQuoteResponse>
Updated quote with current payment state and preimage if available.
- Defined in src/CashuMint.ts:572

`Static`checkMintQuote

checkMintQuote(
    mintUrl: string,
    quote: string,
    customRequest?: <T>(options: RequestOptions) => Promise<T>,
    blindAuthToken?: string,
    logger?: Logger,
): Promise<PartialMintQuoteResponse>
Gets an existing mint quote from the mint.
Parameters
- mintUrl: string
- quote: string
  Quote ID.
- OptionalcustomRequest: <T>(options: RequestOptions) => Promise<T>
- OptionalblindAuthToken: string
- Optionallogger: Logger
Returns Promise<PartialMintQuoteResponse>
The mint will create and return a Lightning invoice for the specified amount.
- Defined in src/CashuMint.ts:257

`Static`checkMintQuoteBolt12

checkMintQuoteBolt12(
    mintUrl: string,
    quote: string,
    customRequest?: <T>(options: RequestOptions) => Promise<T>,
    blindAuthToken?: string,
): Promise<Bolt12MintQuoteResponse>
Gets an existing BOLT12 mint quote from the mint.
Parameters
- mintUrl: string
  The mint's base URL.
- quote: string
  Quote ID to check.
- OptionalcustomRequest: <T>(options: RequestOptions) => Promise<T>
  Optional custom request implementation.
- OptionalblindAuthToken: string
  Optional authentication token for NUT-22.
Returns Promise<Bolt12MintQuoteResponse>
Updated quote with current payment and issuance amounts.
- Defined in src/CashuMint.ts:298

`Static`createMeltQuote

createMeltQuote(
    mintUrl: string,
    meltQuotePayload: MeltQuotePayload,
    customRequest?: <T>(options: RequestOptions) => Promise<T>,
    blindAuthToken?: string,
    logger?: Logger,
): Promise<PartialMeltQuoteResponse>
Requests a new melt quote from the mint.
Parameters
- mintUrl: string
- meltQuotePayload: MeltQuotePayload
- OptionalcustomRequest: <T>(options: RequestOptions) => Promise<T>
- OptionalblindAuthToken: string
- Optionallogger: Logger
Returns Promise<PartialMeltQuoteResponse>
- Defined in src/CashuMint.ts:419

`Static`createMeltQuoteBolt12

createMeltQuoteBolt12(
    mintUrl: string,
    meltQuotePayload: MeltQuotePayload,
    customRequest?: <T>(options: RequestOptions) => Promise<T>,
    blindAuthToken?: string,
): 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
- mintUrl: string
  The mint's base URL.
- meltQuotePayload: MeltQuotePayload
  Payload containing the BOLT12 offer to pay and unit.
- OptionalcustomRequest: <T>(options: RequestOptions) => Promise<T>
  Optional custom request implementation.
- OptionalblindAuthToken: string
  Optional authentication token for NUT-22.
Returns Promise<MeltQuoteResponse>
Melt quote with amount, fee reserve, and payment state.
- Defined in src/CashuMint.ts:477

`Static`createMintQuote

createMintQuote(
    mintUrl: string,
    mintQuotePayload: MintQuotePayload,
    customRequest?: <T>(options: RequestOptions) => Promise<T>,
    blindAuthToken?: string,
    logger?: Logger,
): Promise<PartialMintQuoteResponse>
Requests a new mint quote from the mint.
Parameters
- mintUrl: string
- mintQuotePayload: MintQuotePayload
  Payload for creating a new mint quote.
- OptionalcustomRequest: <T>(options: RequestOptions) => Promise<T>
- OptionalblindAuthToken: string
- Optionallogger: Logger
Returns Promise<PartialMintQuoteResponse>
The mint will create and return a new mint quote containing a payment request for the specified amount and unit.
- Defined in src/CashuMint.ts:165

`Static`createMintQuoteBolt12

createMintQuoteBolt12(
    mintUrl: string,
    mintQuotePayload: Bolt12MintQuotePayload,
    customRequest?: <T>(options: RequestOptions) => Promise<T>,
    blindAuthToken?: string,
): Promise<Bolt12MintQuoteResponse>
Requests a new BOLT12 mint quote from the mint using Lightning Network offers.
Parameters
- mintUrl: string
  The mint's base URL.
- mintQuotePayload: Bolt12MintQuotePayload
  Payload containing amount, unit, optional description, and required pubkey.
- OptionalcustomRequest: <T>(options: RequestOptions) => Promise<T>
  Optional custom request implementation.
- OptionalblindAuthToken: string
  Optional authentication token for NUT-22.
Returns Promise<Bolt12MintQuoteResponse>
A mint quote containing a BOLT12 offer.
- Defined in src/CashuMint.ts:213

`Static`getInfo

getInfo(
    mintUrl: string,
    customRequest?: <T>(options: RequestOptions) => Promise<T>,
    logger?: Logger,
): Promise<GetInfoResponse>
Fetches mints info at the /info endpoint.
Parameters
- mintUrl: string
- OptionalcustomRequest: <T>(options: RequestOptions) => Promise<T>
- Optionallogger: Logger
Returns Promise<GetInfoResponse>
- Defined in src/CashuMint.ts:87

`Static`getKeys

getKeys(
    mintUrl: string,
    keysetId?: string,
    customRequest?: <T>(options: RequestOptions) => Promise<T>,
): Promise<MintActiveKeys>
Get the mints public keys.
Parameters
- mintUrl: string
- OptionalkeysetId: string
  Optional param to get the keys for a specific keyset. If not specified, the keys from all active keysets are fetched.
- OptionalcustomRequest: <T>(options: RequestOptions) => Promise<T>
Returns Promise<MintActiveKeys>
- Defined in src/CashuMint.ts:733

`Static`getKeySets

getKeySets(
mintUrl: string,
customRequest?: <T>(options: RequestOptions) => Promise<T>,
): Promise<MintAllKeysets>
Get the mints keysets in no specific order.
Parameters
- mintUrl: string
- OptionalcustomRequest: <T>(options: RequestOptions) => Promise<T>
Returns Promise<MintAllKeysets>
All the mints past and current keysets.
- Defined in src/CashuMint.ts:776

`Static`melt

melt(
    mintUrl: string,
    meltPayload: MeltPayload,
    customRequest?: <T>(options: RequestOptions) => Promise<T>,
    blindAuthToken?: string,
    logger?: Logger,
): 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
- mintUrl: string
- meltPayload: MeltPayload
- OptionalcustomRequest: <T>(options: RequestOptions) => Promise<T>
- OptionalblindAuthToken: string
- Optionallogger: Logger
Returns Promise<PartialMeltQuoteResponse>
- Defined in src/CashuMint.ts:615

`Static`meltBolt12

meltBolt12(
    mintUrl: string,
    meltPayload: MeltPayload,
    customRequest?: <T>(options: RequestOptions) => Promise<T>,
    blindAuthToken?: string,
): 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
- mintUrl: string
  The mint's base URL.
- meltPayload: MeltPayload
  Payload containing quote ID, inputs, and optional outputs for change.
- OptionalcustomRequest: <T>(options: RequestOptions) => Promise<T>
  Optional custom request implementation.
- OptionalblindAuthToken: string
  Optional authentication token for NUT-22.
Returns Promise<MeltQuoteResponse>
Payment result with state and optional change signatures.
- Defined in src/CashuMint.ts:667

`Static`mint

mint(
    mintUrl: string,
    mintPayload: MintPayload,
    customRequest?: <T>(options: RequestOptions) => Promise<T>,
    blindAuthToken?: string,
): Promise<MintResponse>
Mints new tokens by requesting blind signatures on the provided outputs.
Parameters
- mintUrl: string
- mintPayload: MintPayload
  Payload containing the outputs to get blind signatures on.
- OptionalcustomRequest: <T>(options: RequestOptions) => Promise<T>
- OptionalblindAuthToken: string
Returns Promise<MintResponse>
Serialized blinded signatures.
- Defined in src/CashuMint.ts:338

`Static`mintBolt12

mintBolt12(
    mintUrl: string,
    mintPayload: MintPayload,
    customRequest?: <T>(options: RequestOptions) => Promise<T>,
    blindAuthToken?: string,
): Promise<MintResponse>
Mints new tokens using a BOLT12 quote by requesting blind signatures on the provided outputs.
Parameters
- mintUrl: string
  The mint's base URL.
- mintPayload: MintPayload
  Payload containing the quote ID and outputs to get blind signatures on.
- OptionalcustomRequest: <T>(options: RequestOptions) => Promise<T>
  Optional custom request implementation.
- OptionalblindAuthToken: string
  Optional authentication token for NUT-22.
Returns Promise<MintResponse>
Serialized blinded signatures for the requested outputs.
- Defined in src/CashuMint.ts:379

`Static`restore

restore(
    mintUrl: string,
    restorePayload: PostRestorePayload,
    customRequest?: <T>(options: RequestOptions) => Promise<T>,
): Promise<PostRestoreResponse>
Parameters
- mintUrl: string
- restorePayload: PostRestorePayload
- OptionalcustomRequest: <T>(options: RequestOptions) => Promise<T>
Returns Promise<PostRestoreResponse>
- Defined in src/CashuMint.ts:803

`Static`swap

swap(
    mintUrl: string,
    swapPayload: SwapPayload,
    customRequest?: <T>(options: RequestOptions) => Promise<T>,
    blindAuthToken?: string,
): Promise<SwapResponse>
Performs a swap operation with ecash inputs and outputs.
Parameters
- mintUrl: string
- swapPayload: SwapPayload
  Payload containing inputs and outputs.
- OptionalcustomRequest: <T>(options: RequestOptions) => Promise<T>
- OptionalblindAuthToken: string
Returns Promise<SwapResponse>
Signed outputs.
- Defined in src/CashuMint.ts:124

Class CashuMint

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns CashuMint

Accessors

mintUrl

Returns string

webSocketConnection

Returns undefined | WSConnection

Methods

check

Parameters

Returns Promise<CheckStateResponse>

checkMeltQuote

Parameters

Returns Promise<PartialMeltQuoteResponse>

checkMeltQuoteBolt12

Parameters

Returns Promise<MeltQuoteResponse>

checkMintQuote

Parameters

Returns Promise<PartialMintQuoteResponse>

checkMintQuoteBolt12

Parameters

Returns Promise<Bolt12MintQuoteResponse>

connectWebSocket

Returns Promise<void>

createMeltQuote

Parameters

Returns Promise<PartialMeltQuoteResponse>

createMeltQuoteBolt12

Parameters

Returns Promise<MeltQuoteResponse>

createMintQuote

Parameters

Returns Promise<PartialMintQuoteResponse>

createMintQuoteBolt12

Parameters

Returns Promise<Bolt12MintQuoteResponse>

disconnectWebSocket

Returns void

getInfo

Returns Promise<GetInfoResponse>

getKeys

Parameters

Returns Promise<MintActiveKeys>

getKeySets

Returns Promise<MintAllKeysets>

getLazyMintInfo

Returns Promise<MintInfo>

handleBlindAuth

Parameters

Returns Promise<undefined | string>

melt

Parameters

Returns Promise<PartialMeltQuoteResponse>

meltBolt12

Parameters

Returns Promise<MeltQuoteResponse>

mint

Parameters

Returns Promise<MintResponse>

mintBolt12

Parameters

Returns Promise<MintResponse>

restore

Parameters

Returns Promise<PostRestoreResponse>

swap

Parameters

Returns Promise<SwapResponse>

Staticcheck

Parameters

Returns Promise<CheckStateResponse>

StaticcheckMeltQuote

`Static`check

`Static`checkMeltQuote

`Static`checkMeltQuoteBolt12

`Static`checkMintQuote

`Static`checkMintQuoteBolt12

`Static`createMeltQuote

`Static`createMeltQuoteBolt12

`Static`createMintQuote

`Static`createMintQuoteBolt12

`Static`getInfo

`Static`getKeys

`Static`getKeySets

`Static`melt

`Static`meltBolt12

`Static`mint

`Static`mintBolt12

`Static`restore

`Static`swap