Caravan Documentation
    Preparing search index...

    Class TrezorGetMetadata

    Returns metadata about Trezor device.

    Includes model name, device label, firmware version, & PIN/passphrase enablement.

    import {TrezorGetMetadata} from "@caravan/wallets";
    const interaction = new TrezorGetMetadata();
    const result = await interaction.run();
    console.log(result);
    {
      spec: "Model 1 v1.8.3 w/PIN",
      model: "Model 1",
      version: {
        major: 1,
        minor: 8,
        patch: 3,
        string: "1.8.3",
      },
      label: "My Trezor",
      pin: true,
      passphrase: false,
    }

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    direct environment network trezorCoin

    Methods

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

    Constructors

    Properties

    direct: boolean
    environment: Parser
    network: null | Network
    trezorCoin: 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"}

    • Parses Trezor device featuress into an appropriate metadata shape.

      Parameters

      • payload: any

      Returns {
          label: any;
          model: string;
          passphrase: any;
          pin: any;
          spec: string;
          version: { major: any; minor: any; patch: any; string: string };
      }

    • 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