Caravan Documentation
    Preparing search index...

    Class CustomSignMultisigTransaction

    Returns signature request data via a PSBT for a Custom "device" to sign and accepts a PSBT for parsing signatures from a Custom "device"

    const interaction = new CustomSignMultisigTransaction({network, inputs, outputs, bip32paths, psbt});
    console.log(interaction.request());
    // "cHNidP8BA..."

    // Parse signatures from a signed PSBT
    const signatures = interaction.parse(psbt);
    console.log(signatures);
    // {'029e866...': ['3045...01', ...]}

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    bip32Paths environment indirect inputs network outputs psbt workflow

    Methods

    hasMessagesFor isSupported messageFor messages messagesFor messageTextFor parse request run

    Constructors

    Properties

    bip32Paths: any
    environment: Parser
    indirect: boolean
    inputs: any
    network: BitcoinNetwork
    outputs: any
    psbt: any
    workflow: string[]

    Methods

    • 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"}

    • This calls a function in @caravan/bitcoin which parses PSBT files for sigantures and then returns an object with the format { pubkey1 : [sig1, sig2, ...], pubkey2 : [sig1, sig2, ...] } This format may change in the future or there may be additional options for return type.

      Parameters

      • psbtObject: any

      Returns {}

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods