Skip to main content

SendOptions

@cashu/cashu-ts

@cashu/cashu-ts / SendOptions

Type Alias: SendOptions

SendOptions = object

Defined in: cashu-ts/src/model/types/index.ts:51

Param​

Optional parameters for configuring the send operation:

  • outputAmounts (OutputAmounts): Specify the amounts to keep and send in the output.
  • counter (number): Set a counter to derive secrets deterministically. Requires the CashuWallet class to be initialized with a seed phrase.
  • proofsWeHave (Array<Proof>): Provide all currently stored proofs for the mint. Used to derive optimal output amounts.
  • pubkey (string): Lock eCash to a specified public key. Note that this will not be deterministic, even if a counter is set.
  • privkey (string): Create a signature for the output secrets if provided.
  • keysetId (string): Override the keyset ID derived from the current mint keys with a custom one. The keyset ID should be fetched from the /keysets endpoint.
  • offline (boolean): Send proofs offline, if enabled.
  • includeFees (boolean): Include fees in the response, if enabled.
  • includeDleq (boolean): Include DLEQ proofs in the proofs to be sent, if enabled.

Properties​

counter?​

optional counter: number

Defined in: cashu-ts/src/model/types/index.ts:54

includeDleq?​

optional includeDleq: boolean

Defined in: cashu-ts/src/model/types/index.ts:60

includeFees?​

optional includeFees: boolean

Defined in: cashu-ts/src/model/types/index.ts:59

keysetId?​

optional keysetId: string

Defined in: cashu-ts/src/model/types/index.ts:57

offline?​

optional offline: boolean

Defined in: cashu-ts/src/model/types/index.ts:58

outputAmounts?​

optional outputAmounts: OutputAmounts

Defined in: cashu-ts/src/model/types/index.ts:52

outputData?​

optional outputData: object

Defined in: cashu-ts/src/model/types/index.ts:61

keep?​

optional keep: OutputDataLike[] | OutputDataFactory

send?​

optional send: OutputDataLike[] | OutputDataFactory

p2pk?​

optional p2pk: object

Defined in: cashu-ts/src/model/types/index.ts:65

locktime?​

optional locktime: number

pubkey​

pubkey: string

refundKeys?​

optional refundKeys: string[]

privkey?​

optional privkey: string

Defined in: cashu-ts/src/model/types/index.ts:56

proofsWeHave?​

optional proofsWeHave: Proof[]

Defined in: cashu-ts/src/model/types/index.ts:53

pubkey?​

optional pubkey: string

Defined in: cashu-ts/src/model/types/index.ts:55