Class CashuMint

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

Hierarchy

CashuMint

Index

Constructors

constructor

new CashuMint(_mintUrl, _customRequest?): CashuMint
Parameters
- _mintUrl: string
  
  requires mint URL to create this object
- Optional _customRequest: (<T>(options) => Promise<T>)
  
  if passed, use custom request implementation for network communication with the mint
  - - <T>(options): Promise<T>
    - Type Parameters
      
      T
      
      Parameters
      
      options: RequestOptions
      
      Returns Promise<T>
Returns CashuMint
- Defined in src/CashuMint.ts:40

Properties

`Private` `Optional` _customRequest

_customRequest?: (<T>(options) => Promise<T>)

Type declaration

- <T>(options): Promise<T>
- if passed, use custom request implementation for network communication with the mint
  Type Parameters
  - T
  Parameters
  - options: RequestOptions
  Returns Promise<T>

`Private` _mintUrl

_mintUrl: string

requires mint URL to create this object

Accessors

mintUrl

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

Methods

check

check(checkPayload): 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:413

checkMeltQuote

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

checkMintQuote

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

createMeltQuote

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

createMintQuote

createMintQuote(mintQuotePayload): Promise<MintQuoteResponse>
Requests a new mint quote from the mint.
Parameters
- mintQuotePayload: MintQuotePayload
  
  Payload for creating a new mint quote
Returns Promise<MintQuoteResponse>
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:132

getInfo

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

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

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

getKeys

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

melt

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

mint

mint(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:196

restore

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

split

split(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:102

`Static` check

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

`Static` checkMeltQuote

checkMeltQuote(mintUrl, quote, customRequest?): Promise<MeltQuoteResponse>
Gets an existing melt quote.
Parameters
- mintUrl: string
- quote: string
  
  Quote ID
- Optional customRequest: (<T>(options) => Promise<T>)
  - - <T>(options): Promise<T>
    - Type Parameters
      
      T
      
      Parameters
      
      options: RequestOptions
      
      Returns Promise<T>
Returns Promise<MeltQuoteResponse>
- Defined in src/CashuMint.ts:245

`Static` checkMintQuote

checkMintQuote(mintUrl, quote, customRequest?): Promise<MintQuoteResponse>
Gets an existing mint quote from the mint.
Parameters
- mintUrl: string
- quote: string
  
  Quote ID
- Optional customRequest: (<T>(options) => Promise<T>)
  - - <T>(options): Promise<T>
    - Type Parameters
      
      T
      
      Parameters
      
      options: RequestOptions
      
      Returns Promise<T>
Returns Promise<MintQuoteResponse>
the mint will create and return a Lightning invoice for the specified amount
- Defined in src/CashuMint.ts:143

`Static` createMeltQuote

createMeltQuote(mintUrl, meltQuotePayload, customRequest?): Promise<MeltQuoteResponse>
Requests a new melt quote from the mint.
Parameters
- mintUrl: string
- meltQuotePayload: MeltQuotePayload
- Optional customRequest: (<T>(options) => Promise<T>)
  - - <T>(options): Promise<T>
    - Type Parameters
      
      T
      
      Parameters
      
      options: RequestOptions
      
      Returns Promise<T>
Returns Promise<MeltQuoteResponse>
- Defined in src/CashuMint.ts:206

`Static` createMintQuote

createMintQuote(mintUrl, mintQuotePayload, customRequest?): Promise<MintQuoteResponse>
Requests a new mint quote from the mint.
Parameters
- mintUrl: string
- mintQuotePayload: MintQuotePayload
  
  Payload for creating a new mint quote
- Optional customRequest: (<T>(options) => Promise<T>)
  - - <T>(options): Promise<T>
    - Type Parameters
      
      T
      
      Parameters
      
      options: RequestOptions
      
      Returns Promise<T>
Returns Promise<MintQuoteResponse>
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:113

`Static` getInfo

getInfo(mintUrl, customRequest?): Promise<GetInfoResponse>
fetches mints info at the /info endpoint
Parameters
- mintUrl: string
- Optional customRequest: (<T>(options) => Promise<T>)
  - - <T>(options): Promise<T>
    - Type Parameters
      
      T
      
      Parameters
      
      options: RequestOptions
      
      Returns Promise<T>
Returns Promise<GetInfoResponse>
- Defined in src/CashuMint.ts:54

`Static` getKeySets

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

`Static` getKeys

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

`Static` melt

melt(mintUrl, meltPayload, customRequest?): Promise<MeltQuoteResponse>
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
- Optional customRequest: (<T>(options) => Promise<T>)
  - - <T>(options): Promise<T>
    - Type Parameters
      
      T
      
      Parameters
      
      options: RequestOptions
      
      Returns Promise<T>
Returns Promise<MeltQuoteResponse>
- Defined in src/CashuMint.ts:287

`Static` mint

mint(mintUrl, mintPayload, customRequest?): 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
- Optional customRequest: (<T>(options) => Promise<T>)
  - - <T>(options): Promise<T>
    - Type Parameters
      
      T
      
      Parameters
      
      options: RequestOptions
      
      Returns Promise<T>
Returns Promise<MintResponse>
serialized blinded signatures
- Defined in src/CashuMint.ts:173

`Static` restore

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

`Static` split

split(mintUrl, swapPayload, customRequest?): Promise<SwapResponse>
Performs a swap operation with ecash inputs and outputs.
Parameters
- mintUrl: string
- swapPayload: SwapPayload
  
  payload containing inputs and outputs
- Optional customRequest: (<T>(options) => Promise<T>)
  - - <T>(options): Promise<T>
    - Type Parameters
      
      T
      
      Parameters
      
      options: RequestOptions
      
      Returns Promise<T>
Returns Promise<SwapResponse>
signed outputs
- Defined in src/CashuMint.ts:79

Class CashuMint

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

_mintUrl: string

Optional _customRequest: (<T>(options) => Promise<T>)

Type Parameters

T

Parameters

options: RequestOptions

Returns Promise<T>

Returns CashuMint

Properties

Private Optional _customRequest

Type declaration

Type Parameters

T

Parameters

options: RequestOptions

Returns Promise<T>

Private _mintUrl

Accessors

mintUrl

Returns string

Methods

check

Parameters

checkPayload: CheckStatePayload

Returns Promise<CheckStateResponse>

checkMeltQuote

Parameters

quote: string

Returns Promise<MeltQuoteResponse>

checkMintQuote

Parameters

quote: string

Returns Promise<MintQuoteResponse>

createMeltQuote

Parameters

meltQuotePayload: MeltQuotePayload

Returns Promise<MeltQuoteResponse>

createMintQuote

Parameters

mintQuotePayload: MintQuotePayload

Returns Promise<MintQuoteResponse>

getInfo

Returns Promise<GetInfoResponse>

getKeySets

Returns Promise<MintAllKeysets>

getKeys

Parameters

Optional keysetId: string

Optional mintUrl: string

Returns Promise<MintActiveKeys>

melt

Parameters

meltPayload: MeltPayload

Returns Promise<MeltQuoteResponse>

mint

Parameters

mintPayload: MintPayload

Returns Promise<MintResponse>

restore

Parameters

restorePayload: { outputs: SerializedBlindedMessage[]; }

outputs: SerializedBlindedMessage[]

Returns Promise<PostRestoreResponse>

split

Parameters

swapPayload: SwapPayload

Returns Promise<SwapResponse>

Static check

Parameters

mintUrl: string

`Optional` _customRequest: (<T>(options) => Promise<T>)

`Private` `Optional` _customRequest

`Private` _mintUrl

`Optional` keysetId: string

`Optional` mintUrl: string

restorePayload: {
outputs: SerializedBlindedMessage[];
}

`Static` check

`Optional` customRequest: (<T>(options) => Promise<T>)

`Static` checkMeltQuote

`Optional` customRequest: (<T>(options) => Promise<T>)

`Static` checkMintQuote

`Optional` customRequest: (<T>(options) => Promise<T>)

`Static` createMeltQuote

`Optional` customRequest: (<T>(options) => Promise<T>)

`Static` createMintQuote

`Optional` customRequest: (<T>(options) => Promise<T>)

`Static` getInfo

`Optional` customRequest: (<T>(options) => Promise<T>)

`Static` getKeySets

`Optional` customRequest: (<T>(options) => Promise<T>)