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

Accessors

mintUrl

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

webSocketConnection

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

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

checkMeltQuote

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

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

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

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

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

disconnectWebSocket

disconnectWebSocket(): void
Closes a websocket connection.

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

getInfo

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

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

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

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

getLazyMintInfo

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

handleBlindAuth

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

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

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

restore

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

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

`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:440

`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:340

`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:207

`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:286

`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:161

`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:83

`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:468

`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:511

`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:392

`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:247

`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:538

`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:120

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>

checkMintQuote

Parameters

Returns Promise<PartialMintQuoteResponse>

connectWebSocket

Returns Promise<void>

createMeltQuote

Parameters

Returns Promise<PartialMeltQuoteResponse>

createMintQuote

Parameters

Returns Promise<PartialMintQuoteResponse>

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>

mint

Parameters

Returns Promise<MintResponse>

restore

Parameters

Returns Promise<PostRestoreResponse>

swap

Parameters

Returns Promise<SwapResponse>

Staticcheck

Parameters

Returns Promise<CheckStateResponse>

StaticcheckMeltQuote

Parameters

Returns Promise<PartialMeltQuoteResponse>

StaticcheckMintQuote

Parameters

Returns Promise<PartialMintQuoteResponse>

StaticcreateMeltQuote

Parameters

Returns Promise<PartialMeltQuoteResponse>

StaticcreateMintQuote

Parameters

Returns Promise<PartialMintQuoteResponse>

StaticgetInfo

Parameters

Returns Promise<GetInfoResponse>

StaticgetKeys

Parameters

Returns Promise<MintActiveKeys>

StaticgetKeySets

`Static`check

`Static`checkMeltQuote

`Static`checkMintQuote

`Static`createMeltQuote

`Static`createMintQuote

`Static`getInfo

`Static`getKeys

`Static`getKeySets

`Static`melt

`Static`mint

`Static`restore

`Static`swap