Caravan Documentation
    Preparing search index...

    Class TrezorExportHDNode

    Base class for interactions exporting information about an HD node at a given BIP32 path.

    You may want to use TrezorExportPublicKey or TrezorExportExtendedPublicKey directly.

    import {Network} from "@caravan/bitcoin";
    import {TrezorExportHDNode} from "@caravan/wallets";
    const interaction = new TrezorExportHDNode({network: Network.MAINNET, bip32Path: "m/48'/0'/0'/2'/0"});
    const node = await interaction.run();
    console.log(node); // {publicKey: "", xpub: "", ...}

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    bip32Path bip32ValidationErrorMessage direct environment includeXFP network trezorCoin

    Methods

    connectParams extractDetailsFromPayload hasMessagesFor isSupported messageFor messages messagesFor messageTextFor parse parsePayload parseSignature request run signatureFormatter

    Constructors

    Properties

    bip32Path: string
    bip32ValidationErrorMessage: { code?: string; text?: string }
    direct: boolean
    environment: Parser
    includeXFP: boolean
    network: null | Network
    trezorCoin: string

    Methods

    • See https://github.com/trezor/connect/blob/v8/docs/methods/getPublicKey.md.

      Returns
          | (
              | {
                  (params: Params<{} & {}>): Response<{} & {}>;
                  (params: BundledParams<{} & {}>): Response<({} & {})[]>;
              }
              | { bundle: { path: string }[]; coin: string; crossChain: boolean }
          )[]
          | (
              | {
                  (params: Params<{} & {}>): Response<{} & {}>;
                  (params: BundledParams<{} & {}>): Response<({} & {})[]>;
              }
              | { coin: string; crossChain: boolean; path: string }
          )[]

    • Parameters

      • __namedParameters: { payload: any; pubkey: any }

      Returns { keyMaterial: string; rootFingerprint: string }

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

    • Awaits the call of this.method, passing in the output of this.params().

      If the call returns but is unsuccessful (result.success) is false, will throw the returned error message. If some other error is thrown, it will not be caught.

      Otherwise it returns the result of passing result.payload to this.parsePayload.

      Returns Promise<any>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods