Type Alias SendOptions

SendOptions: {
    counter?: number;
    includeDleq?: boolean;
    includeFees?: boolean;
    keysetId?: string;
    offline?: boolean;
    outputAmounts?: OutputAmounts;
    outputData?: {
        keep?: OutputDataLike[] | OutputDataFactory;
        send?: OutputDataLike[] | OutputDataFactory;
    };
    p2pk?: { locktime?: number; pubkey: string; refundKeys?: string[] };
    privkey?: string;
    proofsWeHave?: Proof[];
    pubkey?: string;
}

Type declaration

  • Optionalcounter?: number
  • OptionalincludeDleq?: boolean
  • OptionalincludeFees?: boolean
  • OptionalkeysetId?: string
  • Optionaloffline?: boolean
  • OptionaloutputAmounts?: OutputAmounts
  • OptionaloutputData?: {
        keep?: OutputDataLike[] | OutputDataFactory;
        send?: OutputDataLike[] | OutputDataFactory;
    }
  • Optionalp2pk?: { locktime?: number; pubkey: string; refundKeys?: string[] }
  • Optionalprivkey?: string
  • OptionalproofsWeHave?: Proof[]
  • Optionalpubkey?: string

Param: options

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): 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.

Settings

Member Visibility