Caravan Documentation
    Preparing search index...

    Interface TransactionTemplateOptions

    Configuration options for creating a transaction template. This is used to set up the initial state and parameters for a new transaction.

    interface TransactionTemplateOptions {
        dustThreshold?: string;
        globalXpubs?: GlobalXpub[];
        inputs?: BtcTxInputTemplate[];
        network: Network;
        outputs?: BtcTxOutputTemplate[];
        requiredSigners: number;
        scriptType: MultisigAddressType;
        targetFeeRate: number;
        totalSigners: number;
    }
    Index

    Properties

    dustThreshold? globalXpubs? inputs? network outputs? requiredSigners scriptType targetFeeRate totalSigners

    Properties

    dustThreshold?: string

    The dust threshold in satoshis. Outputs below this value are considered uneconomical to spend.

    https://github.com/bitcoin/bitcoin/blob/master/src/policy/policy.cpp

    globalXpubs?: GlobalXpub[]

    Optional array of global xpubs to include in the PSBT

    inputs?: BtcTxInputTemplate[]

    Optional array of input templates to use in the transaction.

    network: Network

    The Bitcoin network to use (mainnet, testnet, or regtest).

    outputs?: BtcTxOutputTemplate[]

    Optional array of output templates to use in the transaction.

    requiredSigners: number

    The number of signatures required in a multisig setup. This is used for multisig transactions and affects the transaction size.

    scriptType: MultisigAddressType

    The type of script used for the transaction (e.g., "p2pkh", "p2sh", "p2wpkh", "p2wsh"). This affects how the transaction is constructed and signed.

    targetFeeRate: number

    The target fee rate in satoshis per virtual byte. This is used to calculate the appropriate fee for the transaction.

    totalSigners: number

    The total number of signers in a multisig setup. This is used along with requiredSigners for multisig transactions.

    Settings

    Member Visibility

    On This Page

    Properties