Caravan Documentation
    Preparing search index...

    Class LedgerSignMultisigTransaction

    Returns a signature for a bitcoin transaction with inputs from one or many multisig addresses.

    • inputs is an array of UTXO objects from @caravan/bitcoin
    • outputs is an array of TransactionOutput objects from @caravan/bitcoin
    • bip32Paths is an array of (string) BIP32 paths, one for each input, identifying the path on this device to sign that input with
    import {
      generateMultisigFromHex, TESTNET, P2SH,
    } from "@caravan/bitcoin";
    import {LedgerSignMultisigTransaction} from "@caravan/wallets";
    const redeemScript = "5...ae";
    const inputs = [
      {
        txid: "8d276c76b3550b145e44d35c5833bae175e0351b4a5c57dc1740387e78f57b11",
        index: 1,
        multisig: generateMultisigFromHex(TESTNET, P2SH, redeemScript),
        amountSats: '1234000'
      },
      // other inputs...
    ];
    const outputs = [
      {
        amountSats: '1299659',
        address: "2NGHod7V2TAAXC1iUdNmc6R8UUd4TVTuBmp"
      },
      // other outputs...
    ];
    const interaction = new LedgerSignMultisigTransaction({
      network: TESTNET,
      inputs,
      outputs,
      bip32Paths: ["m/45'/0'/0'/0", // add more, 1 per input],
    });
    const signature = await interaction.run();
    console.log(signatures);
    // ["ababab...", // 1 per input]

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    appName? appVersion? bip32Paths direct environment inputs isLegacySupported isV2Supported keyDetails? network outputs psbt? pubkeys? returnSignatureArray? v2Options?

    Methods

    anySegwitInputs closeTransport hasMessagesFor isAppSupported isLegacyApp isSupported ledgerBIP32Path ledgerInputs ledgerKeysets ledgerOutputScriptHex messageFor messages messagesFor messageTextFor parse parseSignature postProcessingTime preProcessingTime request run setAppVersion signatureFormatter withApp withTransport

    Constructors

    Properties

    appName?: string
    appVersion?: string
    bip32Paths: string[]
    direct: boolean
    environment: Parser
    inputs: LegacyInput[]
    isLegacySupported: true

    Whether or not the interaction is supported in legacy versions of the Ledger App (<=v2.0.6)

    isV2Supported: false

    Whether or not the interaction is supported in non-legacy versions of the Ledger App (>=v2.1.0)

    keyDetails?: { path: string; xfp: string }
    network: BitcoinNetwork
    outputs: object[]
    psbt?: string
    pubkeys?: Buffer[]
    returnSignatureArray?: boolean
    v2Options?: LedgerV2SignTxConstructorArguments

    Methods

    • Close the Transport to free the interface (E.g. could be used in another tab now that the interaction is over)

      The way the pubkey/xpub/fingerprints are grabbed makes this a little tricky. Instead of re-writing how that works, let's just add a way to explicitly close the transport.

      Returns Promise<any>

    • Inheriting classes should set properties this.isLegacySupported and this.isV2Supported to indicate whether a given interaction has support for a given interaction. This method can then be called to check the version of the app being called and return whether or not the interaction is supported based on that version

      Returns Promise<boolean>

    • Subclasses can override this method to indicate they are not supported.

      This method has access to whatever options may have been passed in by the constructor as well as the ability to interact with this.environment to determine whether the functionality is supported. See the Bowser documentation for more details: https://github.com/lancedikson/bowser

      Returns boolean

      isSupported() {
        return this.environment.satisfies({
          * declare browsers per OS
          windows: {
            "internet explorer": ">10",
          },
          macos: {
            safari: ">10.1"
          },

          * per platform (mobile, desktop or tablet)
          mobile: {
            safari: '>=9',
            'android browser': '>3.10'
          },

          * or in general
          chrome: "~20.1.1432",
          firefox: ">31",
          opera: ">=22",

          * also supports equality operator
          chrome: "=20.1.1432", * will match particular build only

          * and loose-equality operator
          chrome: "~20",        * will match any 20.* sub-version
          chrome: "~20.1"       * will match any 20.1.* sub-version (20.1.19 as well as 20.1.12.42-alpha.1)
        });
      }

    • Return messages filtered by the given options.

      Multiple options can be given at once to filter along multiple dimensions.

      Parameters

      • __namedParameters: MessageMethodArgs

      Returns Message[]

      import {PENDING, ACTIVE} from "@caravan/bitcoin";
      // Create any interaction instance
      interaction.messages().forEach(msg => console.log(msg));
        { code: "device.connect", state: "pending", level: "info", text: "Please plug in your device."}
        { code: "device.active", state: "active", level: "info", text: "Communicating with your device..."}
        { code: "device.active.warning", state: "active", level: "warning", text: "Your device will warn you about...", version: "2.x"}
      interaction.messagesFor({state: PENDING}).forEach(msg => console.log(msg));
        { code: "device.connect", state: "pending", level: "info", text: "Please plug in your device."}
      interaction.messagesFor({code: ACTIVE}).forEach(msg => console.log(msg));
        { code: "device.active", state: "active", level: "info", text: "Communicating with your device..."}
        { code: "device.active.warning", state: "active", level: "warning", text: "Your device will warn you about...", version: "2.x"}
      interaction.messagesFor({version: /^2/}).forEach(msg => console.log(msg));
        { code: "device.active", state: "active", level: "warning", text: "Your device will warn you about...", version: "2.x"}

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods