Caravan Documentation
    Preparing search index...

    Class IndirectKeystoreInteraction

    Base class for indirect keystore interactions.

    Subclasses must implement two methods: request and parse. Application code will pass the result of calling request to some external process (HTTP request, QR code, &c.) and pass the response to parse which should return a result.

    import {IndirectKeystoreInteraction} from "@caravan/wallets";
    class SimpleIndirectInteraction extends IndirectKeystoreInteraction {   *

      constructor({param}) {
        super();
        this.param = param;
      }

      request() {
        // Construct the data to be passed to the keystore...
        return this.param;
      }

      parse(response) {
        // Parse data returned from the keystore...
        return response;
      }

    }

    const interaction = new SimpleIndirectInteraction({param: "foo"});

    const request = interaction.request();
    const response = "bar"; // Or do something complicated with `request`
    const result = interaction.parse(response);
    console.log(result);
    // "bar"

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    environment indirect workflow

    Methods

    hasMessagesFor isSupported messageFor messages messagesFor messageTextFor parse request run

    Constructors

    Properties

    environment: Parser
    indirect: boolean
    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"}

    • Parse the response into a result.

      Subclasses must override this function. It must accept an appropriate kind of response object and return the final result of this interaction.

      Parameters

      • response: string | Record<string, unknown>

      Returns void

    • Provide the request.

      Subclasses may override this function. It can return any kind of object. Strings, data for QR codes, HTTP requests, command lines, functions, &c. are all allowed. Whatever is appropriate for the interaction.

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods