Caravan Documentation
    Preparing search index...

    Class CustomExportExtendedPublicKey

    Base class for text-based (or clipboard pasted) ExtendedPublicKey This class handles parsing/validating the xpub and relevant derivation properties. If no root fingerprint is provided, one will be deterministically assigned.

    const interaction = new CustomExportExtendedPublicKey({network: Network.MAINNET, bip32Path: "m/45'/0'/0'"});
    const {xpub, rootFingerprint, bip32Path} = interaction.parse({xpub: xpub..., rootFingerprint: 0f056943});
    console.log(xpub);
    // "xpub..."
    console.log(rootFingerprint);
    // "0f056943"
    console.log(bip32Path);
    // "m/45'/0'/0'"
    ** OR **
    * const {xpub, rootFingerprint, bip32Path} = interaction.parse({xpub: xpub...});
    console.log(xpub);
    // "xpub..."
    console.log(rootFingerprint);
    // "096aed5e"
    console.log(bip32Path);
    // "m/45'/0'/0'"

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    bip32Path environment indirect network validationErrorMessages workflow

    Methods

    hasMessagesFor isSupported messageFor messages messagesFor messageTextFor parse request run

    Constructors

    Properties

    bip32Path: string
    environment: Parser
    indirect: boolean
    network: BitcoinNetwork
    validationErrorMessages: 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 array for this interaction.

      The messages array is a (possibly empty) array of Message objects.

      Subclasses should override this method and add messages as needed. Make sure to call super.messages() to return an empty messages array for you to begin populating.

      Returns Message[]

    • 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