Package Exports

@trezor/connect-webextension
@trezor/connect-webextension/lib/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@trezor/connect-webextension) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@trezor/connect-webextension BETA

This package contains @trezor/connect implementation suitable for webextensions. In short it:

works in service worker
provides access to TrezorConnect api
handles opening of popup page on trezor.io domain when user is expected to approve some operations
returns result to the caller.

Beta

This package is currently in beta. If you find anything not working or not suiting your needs, please open an issue.

How to use

At the moment only bundles build/trezor-connect-webextension.js and build/trezor-connect-webextension.min.js are published.

Option 1: Using Scripting Permissions

Modify your manifest.json to include scripting permissions and specify host_permissions. Also, define your service worker script:

    "permissions": ["scripting"],
    "host_permissions": ["*://connect.trezor.io/9/*"]
    "background": {
        "service_worker": "serviceWorker.js"
    },

Import in Service Worker:

In your serviceWorker.js, import the library build/trezor-connect-webextension.js using importScripts. Replace with the actual path to the library file:

importScripts('<path>/trezor-connect-webextension.js');

This method is recommended for a seamless integration with background processes of your extension.

Option 2: Manual Content Script Injection

Bundle the Library:

Include build/content-script.js from this package into your project's bundle.

Update manifest.json and replace with the actual path to the library file::

  "content_scripts": [
    {
      "js": ["<path>/content-script.js"],
      "matches": ["*://connect.trezor.io/9/*"]
    }
  ],

There are still some open questions, let us know!

should we publish also src? it would require some postinstall build steps however
should we publish other build targets (now te)

Development

yarn
yarn build:libs
yarn workspace @trezor/connect-webextension build
yarn workspace @trezor/connect-iframe build:core-module
yarn workspace @trezor/connect-popup dev

Now you should be able to import from this package, or use directly build/trezor-connect-webextension.js. Popup is running on your localhost, just use it in TrezorConnect.init({ connectSrc: ... })

Roadmap

merge to develop branch
release to npm under beta channel
public release