@cashu/cashu-ts
    Preparing search index...

    Type Alias SwapOptions

    Optional parameters for configuring the swap operation:

    • amount: amount to send while performing the optimal split (least proofs possible). can be set to undefined if preference is set.
    • Proofs proofs matching that amount.
    • OutputAmounts? optionally specify the output's amounts to keep and to send.
    • Counter? optionally set counter to derive secret deterministically. CashuWallet class must be initialized with seed phrase to take effect.
    • KeysetId? override the keysetId derived from the current mintKeys with a custom one. This should be a keyset that was fetched from the /keysets endpoint.
    • IncludeFees? include estimated fees for the receiver to receive the proofs.
    • ProofsWeHave? optionally provide all currently stored proofs of this mint. Cashu-ts will use them to derive the optimal output amounts.
    • Pubkey? optionally locks ecash to pubkey. Will not be deterministic, even if counter is set!
    • Privkey? will create a signature on the proofs secrets if set.
    • outputData : Specify your own OutputData (blinded messages)
    • p2pk : Specify options to lock the proofs according to NUT-11.
    type SwapOptions = {
        counter?: number;
        includeFees?: boolean;
        keysetId?: string;
        outputAmounts?: OutputAmounts;
        outputData?: {
            keep?: OutputDataLike[] | OutputDataFactory;
            send?: OutputDataLike[] | OutputDataFactory;
        };
        p2pk?: {
            locktime?: number;
            pubkey: string
            | string[];
            refundKeys?: string[];
            requiredRefundSignatures?: number;
            requiredSignatures?: number;
        };
        privkey?: string;
        proofsWeHave?: Proof[];
        pubkey?: string;
    }
    Index

    Properties

    counter? includeFees? keysetId? outputAmounts? outputData? p2pk? privkey? proofsWeHave? pubkey?

    Properties

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

    Settings

    Member Visibility

    On This Page

    Properties