Class CashuWallet

Class that represents a Cashu wallet. This class should act as the entry point for this library

Hierarchy

CashuWallet

Index

Constructors

constructor

Properties

_keys _keysetId mint

Accessors

keys keysetId

Methods

changedKeys checkProofsSpent createBlankOutputs createPaymentPayload createRandomBlindedMessages createSplitPayload getFee getKeys initKeys payLnInvoice payLnInvoiceWithToken receive receiveTokenEntry requestMint requestTokens send splitReceive

Constructors

constructor

new CashuWallet(mint, keys?): CashuWallet
Parameters
- mint: CashuMint
  
  Cashu mint instance is used to make api calls
- Optional keys: MintKeys
  
  public keys from the mint
Returns CashuWallet
- Defined in src/CashuWallet.ts:36

Properties

`Private` _keys

_keys: MintKeys

`Private` _keysetId

_keysetId: string = ''

mint

mint: CashuMint

Accessors

keys

get keys(): MintKeys
Returns MintKeys
- Defined in src/CashuWallet.ts:44
set keys(keys): void
Parameters
- keys: MintKeys
Returns void
- Defined in src/CashuWallet.ts:47

keysetId

get keysetId(): string
Returns string
- Defined in src/CashuWallet.ts:51

Methods

`Private` changedKeys

changedKeys(promises?): Promise<undefined | MintKeys>
Parameters
- promises: (Proof | SerializedBlindedSignature)[] = []
Returns Promise<undefined | MintKeys>
- Defined in src/CashuWallet.ts:286

checkProofsSpent

checkProofsSpent<T>(proofs): Promise<T[]>
returns proofs that are already spent (use for keeping wallet state clean)
Type Parameters
- T extends {
  secret: string;
  }
Parameters
- proofs: T[]
  
  (only the 'secret' field is required)
Returns Promise<T[]>
- Defined in src/CashuWallet.ts:59

`Private` createBlankOutputs

createBlankOutputs(feeReserve): BlindedMessageData
Parameters
- feeReserve: number
Returns BlindedMessageData
- Defined in src/CashuWallet.ts:368

createPaymentPayload

createPaymentPayload(invoice, proofs): PaymentPayload
Parameters
- invoice: string
- proofs: Proof[]
Returns PaymentPayload
- Defined in src/CashuWallet.ts:113

`Private` createRandomBlindedMessages

createRandomBlindedMessages(amount): BlindedMessageData & {
amounts: number[];
}
Parameters
- amount: number
Returns BlindedMessageData & {
amounts: number[];
}
- Defined in src/CashuWallet.ts:351

`Private` createSplitPayload

createSplitPayload(amount1, amount2, proofsToSend): {
    amount1BlindedMessages: BlindedTransaction;
    amount2BlindedMessages: BlindedTransaction;
    payload: SplitPayload;
}
Parameters
- amount1: number
- amount2: number
- proofsToSend: Proof[]
Returns {
    amount1BlindedMessages: BlindedTransaction;
    amount2BlindedMessages: BlindedTransaction;
    payload: SplitPayload;
}
- amount1BlindedMessages: BlindedTransaction
- amount2BlindedMessages: BlindedTransaction
- payload: SplitPayload
- Defined in src/CashuWallet.ts:317

getFee

getFee(invoice): Promise<number>
Estimate fees for a given LN invoice
Parameters
- invoice: string
  
  LN invoice that needs to get a fee estimate
Returns Promise<number>

estimated Fee
- Defined in src/CashuWallet.ts:108

`Private` getKeys

getKeys(arr, mint?): Promise<MintKeys>
Parameters
- arr: SerializedBlindedSignature[]
- Optional mint: string
Returns Promise<MintKeys>
- Defined in src/CashuWallet.ts:300

`Private` initKeys

initKeys(): Promise<void>
Returns Promise<void>
- Defined in src/CashuWallet.ts:280

payLnInvoice

payLnInvoice(invoice, proofsToSend, feeReserve?): Promise<PayLnInvoiceResponse>
Executes a payment of an invoice on the Lightning network. The combined amount of Proofs has to match the payment amount including fees.
Parameters
- invoice: string
- proofsToSend: Proof[]
  
  the exact amount to send including fees
- Optional feeReserve: number
Returns Promise<PayLnInvoiceResponse>
- Defined in src/CashuWallet.ts:83

payLnInvoiceWithToken

payLnInvoiceWithToken(invoice, token): Promise<PayLnInvoiceResponse>
Use a cashu token to pay an ln invoice
Parameters
- invoice: string
  
  Lightning invoice
- token: string
  
  cashu token
Returns Promise<PayLnInvoiceResponse>
- Defined in src/CashuWallet.ts:124

receive

receive(encodedToken): Promise<ReceiveResponse>
Receive an encoded Cashu token
Parameters
- encodedToken: string
  
  Cashu token
Returns Promise<ReceiveResponse>

New token with newly created proofs, token entries that had errors, and newKeys if they have changed
- Defined in src/CashuWallet.ts:136

`Private` receiveTokenEntry

receiveTokenEntry(tokenEntry): Promise<ReceiveTokenEntryResponse>
Receive a single cashu token entry
Parameters
- tokenEntry: TokenEntry
  
  a single entry of a cashu token
Returns Promise<ReceiveTokenEntryResponse>

New token entry with newly created proofs, proofs that had errors, and newKeys if they have changed
- Defined in src/CashuWallet.ts:176

requestMint

requestMint(amount): Promise<RequestMintResponse>
Starts a minting process by requesting an invoice from the mint
Parameters
- amount: number
  
  Amount requesting for mint.
Returns Promise<RequestMintResponse>

the mint will create and return a Lightning invoice for the specified amount
- Defined in src/CashuWallet.ts:72

requestTokens

requestTokens(amount, hash): Promise<{
newKeys?: MintKeys;
proofs: Proof[];
}>
Parameters
- amount: number
- hash: string
Returns Promise<{
newKeys?: MintKeys;
proofs: Proof[];
}>
- Defined in src/CashuWallet.ts:266

send

send(amount, proofs): Promise<SendResponse>
Splits and creates sendable tokens
Parameters
- amount: number
  
  amount to send
- proofs: Proof[]
  
  proofs matching that amount
Returns Promise<SendResponse>

promise of the change- and send-proofs
- Defined in src/CashuWallet.ts:222

`Private` splitReceive

splitReceive(amount, amountAvailable): {
amount1: number;
amount2: number;
}
Parameters
- amount: number
- amountAvailable: number
Returns {
amount1: number;
amount2: number;
}
- amount1: number
- amount2: number
- Defined in src/CashuWallet.ts:342

Class CashuWallet

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

mint: CashuMint

Optional keys: MintKeys

Returns CashuWallet

Properties

Private _keys

Private _keysetId

mint

Accessors

keys

Returns MintKeys

Parameters

keys: MintKeys

Returns void

keysetId

Returns string

Methods

Private changedKeys

Parameters

promises: (Proof | SerializedBlindedSignature)[] = []

Returns Promise<undefined | MintKeys>

checkProofsSpent

Type Parameters

T extends { secret: string; }

Parameters

proofs: T[]

Returns Promise<T[]>

Private createBlankOutputs

Parameters

feeReserve: number

Returns BlindedMessageData

createPaymentPayload

Parameters

invoice: string

proofs: Proof[]

Returns PaymentPayload

Private createRandomBlindedMessages

Parameters

amount: number

Returns BlindedMessageData & { amounts: number[]; }

Private createSplitPayload

Parameters

amount1: number

amount2: number

proofsToSend: Proof[]

Returns { amount1BlindedMessages: BlindedTransaction; amount2BlindedMessages: BlindedTransaction; payload: SplitPayload; }

amount1BlindedMessages: BlindedTransaction

amount2BlindedMessages: BlindedTransaction

payload: SplitPayload

getFee

Parameters

invoice: string

Returns Promise<number>

Private getKeys

Parameters

arr: SerializedBlindedSignature[]

Optional mint: string

Returns Promise<MintKeys>

Private initKeys

Returns Promise<void>

payLnInvoice

Parameters

invoice: string

proofsToSend: Proof[]

Optional feeReserve: number

Returns Promise<PayLnInvoiceResponse>

payLnInvoiceWithToken

Parameters

invoice: string

token: string

Returns Promise<PayLnInvoiceResponse>

`Optional` keys: MintKeys

`Private` _keys

`Private` _keysetId

`Private` changedKeys

T extends {
secret: string;
}

`Private` createBlankOutputs

`Private` createRandomBlindedMessages

Returns BlindedMessageData & {
amounts: number[];
}

`Private` createSplitPayload

Returns {
amount1BlindedMessages: BlindedTransaction;
amount2BlindedMessages: BlindedTransaction;
payload: SplitPayload;
}

`Private` getKeys

`Optional` mint: string

`Private` initKeys

`Optional` feeReserve: number

`Private` receiveTokenEntry

Returns Promise<{
newKeys?: MintKeys;
proofs: Proof[];
}>

`Private` splitReceive

Returns {
amount1: number;
amount2: number;
}