Cashu-TS - v4.13.0
    Preparing search index...

    Type Alias SwapPreview

    Preview of a swap transaction created by prepareSend / prepareReceive.

    Contains JSON-unsafe values (bigint, Uint8Array); persist via serializeSwapPreview and rehydrate with deserializeSwapPreview.

    type SwapPreview = {
        amount: Amount;
        fees: Amount;
        inputs: Proof[];
        keepOutputs?: OutputDataLike[];
        keysetId: string;
        sendOutputs?: OutputDataLike[];
        unselectedProofs?: Proof[];
    }
    Index

    Properties

    amount fees inputs keepOutputs? keysetId sendOutputs? unselectedProofs?

    Properties

    amount: Amount

    Amount being sent or received (excluding fees).

    fees: Amount

    Total fees for the swap (inc receiver's fees if applicable)

    inputs: Proof[]

    Input Proofs for this transaction.

    keepOutputs?: OutputDataLike[]

    Blinding data to construct proofs to keep.

    keysetId: string

    Keyset the wallet prepared generated outputs under. Custom outputs name their own keyset per output.

    Read outputData[i].blindedMessage.id instead. Removed in v5.

    sendOutputs?: OutputDataLike[]

    Blinding data to construct proofs to send.

    unselectedProofs?: Proof[]

    Proofs not selected for this transaction (can be returned to storage).

    Settings

    Member Visibility

    On This Page

    Properties