Private _mintredeemed and unredeemed ordered list of booleans
the mint will create and return a Lightning invoice for the specified amount
the mint will create and return a new mint quote containing a payment request for the specified amount and unit
all the mints past and current keysets.
Optional Returns Promise<MintActiveKeys>the mints public keys
serialized blinded signatures
Performs a swap operation with ecash inputs and outputs.
signed outputs
Static checkredeemed and unredeemed ordered list of booleans
Static checkStatic checkthe mint will create and return a Lightning invoice for the specified amount
Static createStatic createthe mint will create and return a new mint quote containing a payment request for the specified amount and unit
Static getStatic getall the mints past and current keysets.
Static getStatic meltStatic mintserialized blinded signatures
Static restoreStatic splitStatic swapPerforms a swap operation with ecash inputs and outputs.
signed outputs
DEFAULT_DENOMINATION_TARGET)
+Cashu mint instance is used to make api calls
Optional options: { Optional options: { Optional keys?: MintKeysOptional bip39seed?: Uint8ArrayBIP39 seed for deterministic secrets. +This can lead to poor performance, in which case the seed should be directly provided
+Optional denominationtarget number proofs per denomination (default: see
+Optional keys?: MintKeys | MintKeys[]public keys from the mint (will be fetched from mint if not provided)
+Optional keysets?: MintKeyset[]keysets from the mint (will be fetched from mint if not provided)
+Optional mnemonicOptional mintmint info from the mint (will be fetched from mint if not provided)
+Optional unit?: stringOptional unit?: stringoptionally set unit (default is 'sat')
+Private _denominationPrivate _keysPrivate _keysetPrivate _keysetsPrivate _mintPrivate _seedPrivate _unitthe mint will return an existing melt quote
the mint will create and return a Lightning invoice for the specified amount
returns proofs that are already spent (use for keeping wallet state clean)
+Get an array of the states of proofs from the mint (as an array of CheckStateEnum's)
Private constructPrivate createCreates NUT-08 blank outputs (fee returns) for a given fee reserve See: https://github.com/cashubtc/nuts/blob/main/08.md
@@ -256,7 +328,7 @@Private
amount to cover with blank outputs
blinded messages, secrets, and rs
+blinded messages, secrets, and rs
Private createCreates blinded messages for a according to
Optional pubkey: stringblinded messages, secrets, rs, and amounts
+blinded messages, secrets, rs, and amounts
+the mint will create and return a melt quote for the invoice with an amount and fee reserve
Optional Returns Promise<MintQuoteResponse>the mint will return a mint quote with a Lightning invoice for minting tokens of the specified amount and unit
Private createCreates blinded messages for a given amount
Optional amountPreference: AmountPreference[]Optional split: number[]optional preference for splitting proofs into specific amounts. overrides amount param
Optional counter: numberOptional pubkey: stringblinded messages, secrets, rs, and amounts
+blinded messages, secrets, rs, and amounts
Private createCreates a split payload
Optional preference: AmountPreference[] | Preferencesoptional preference for splitting proofs into specific amounts. overrides amount param
-Optional outputAmounts: OutputAmountsOptional counter: numberOptional pubkey: stringOptional privkey: stringPrivate getInitialize the wallet with the mints public keys
+Choose a keyset to activate based on the lowest input fee
+Note: this function will filter out deprecated base64 keysets
Optional keysetId: stringOptional unit: stringactive keyset
+Get information about the mint
+Get all active keys from the mint and set the keyset with the lowest fees as the active wallet keyset.
mint info
+keyset
-Melt tokens for a melt quote. proofsToSend must be at least amount+fee_reserve form the melt quote. -Returns payment proof and change proofs
+calculates the fees based on inputs for a given keyset
ID of the melt quote
+number of inputs
proofs to melt
-Optional options: { Optional counter?: numberOptional keysetOptional privkey?: stringfee amount
+ -Mint tokens for a given mint quote
+calculates the fees based on inputs (proofs)
amount to request
-ID of mint quote
-Optional options: { Optional counter?: numberOptional keysetOptional preference?: AmountPreference[]Optional pubkey?: stringproofs
+input proofs to calculate fees for
+fee amount
+Get keysets from the mint with the unit of the wallet
+keysets with wallet's unit
Helper function that pays a Lightning invoice directly without having to create a melt quote before -The combined amount of Proofs must match the payment amount including fees.
+Get public keys from the mint. If keys were already fetched, it will return those.
+If keysetId is set, it will fetch and return that specific keyset.
+Otherwise, we select an active keyset with the unit of the wallet.
the exact amount to send including fees
+Optional keysetId: stringoptional keysetId to get keys for
Optional meltQuote: MeltQuoteResponsemelt quote for the invoice
-Optional options: { Optional counter?: numberOptional keysetOptional privkey?: stringkeyset
+ -Get information about the mint
+mint info
+Helper function to ingest a Cashu token and pay a Lightning invoice with it.
+Load mint information, keysets and keys. This function can be called if no keysets are passed in the constructor
+Melt proofs for a melt quote. proofsToSend must be at least amount+fee_reserve form the melt quote. This function does not perform coin selection!. +Returns melt quote and change proofs
Lightning invoice
-cashu token
+ID of the melt quote
melt quote for the invoice
+proofs to melt
Optional options: { Optional options: { Optional counter?: numberOptional keysetOptional privkey?: stringReceive an encoded or raw Cashu token (only supports single tokens. It will only process the first token in the token array)
+Mint proofs for a given mint quote
Cashu token
+amount to request
Optional options: { ID of mint quote
+Optional options: { Optional counter?: numberOptional keysetOptional preference?: AmountPreference[]Optional outputOptional privkey?: stringOptional proofsOptional pubkey?: stringNew token with newly created proofs, token entries that had errors
+proofs
Receive a single cashu token entry
+Receive an encoded or raw Cashu token (only supports single tokens. It will only process the first token in the token array)
a single entry of a cashu token
+Cashu token, either as string or decoded
Optional options: { Optional options: { Optional counter?: numberOptional keysetOptional preference?: AmountPreference[]Optional outputOptional privkey?: stringOptional proofsOptional pubkey?: stringNew token entry with newly created proofs, proofs that had errors
+New token with newly created proofs, token entries that had errors
Optional keysetOptional keysetset a custom keysetId to restore from. keysetIds can be loaded with CashuMint.getKeySets()
proofs
Optional includeFees: booleanSplits and creates sendable tokens -if no amount is specified, the amount is implied by the cumulative amount of all proofs -if both amount and preference are set, but the preference cannot fulfill the amount, then we use the default split
+Send proofs of a given amount, by providing at least the required amount of proofs
amount to send while performing the optimal split (least proofs possible). can be set to undefined if preference is set
+amount to send
proofs matching that amount
+array of proofs (accumulated amount of proofs must be >= than amount)
Optional options: { Optional options: { Optional counter?: numberOptional includeOptional keysetOptional preference?: AmountPreference[] | PreferencesOptional offline?: booleanOptional outputOptional privkey?: stringOptional proofsOptional pubkey?: stringpromise of the change- and send-proofs
-Private splitSplits and creates sendable tokens +if no amount is specified, the amount is implied by the cumulative amount of all proofs +if both amount and preference are set, but the preference cannot fulfill the amount, then we use the default split
+amount to send while performing the optimal split (least proofs possible). can be set to undefined if preference is set
+proofs matching that amount
+Optional options: { Optional counter?: numberOptional includeOptional keysetOptional outputpromise of the change- and send-proofs
+Optional amountOptional descriptionOptional idOptional mintsOptional unitStatic from
requires mint URL to create this object