JSPM

  • Created
  • Published
  • Downloads 92626
  • Score
    100M100P100Q172954F
  • License SEE LICENSE IN LICENSE.md

High-level javascript interface for Trezor hardware wallet in web environment.

Package Exports

  • @trezor/connect-web
  • @trezor/connect-web/lib/channels/window-serviceworker
  • @trezor/connect-web/lib/channels/window-serviceworker.js
  • @trezor/connect-web/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-web) 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-web

Build Status NPM Known Vulnerabilities

This package is bundled into web implementations. User interface is presented in a secure popup window served from connect.trezor.io/<version>/popup.html. To try it out, use @trezor/connect-explorer hosted here.

Contains minimum of code required to:

  • Define TrezorConnect API object
  • Create and handle communication between @trezor/connect-iframe hosted on https://connect.trezor.io/<version>/iframe.html
  • Create and handle communication and lifecycle of @trezor/connect-popup hosted on https://connect.trezor.io/<version>/popup.html

Installation

Install library as npm module:

npm install @trezor/connect-web

or

yarn add @trezor/connect-web

Include library as inline script:

<script src="https://connect.trezor.io/9/trezor-connect.js"></script>

Initialization

ES6

import TrezorConnect from '@trezor/connect-web';

Inline

var TrezorConnect = window.TrezorConnect;

For more instructions refer to this document

Development

  • clone repository: git clone git@github.com:trezor/trezor-suite.git
  • install node_modules: yarn && yarn build:libs
  • generate certs yarn workspace @trezor/connect-web predev
  • It is possible to run local dev server with iframe and popup using: yarn workspace @trezor/connect-web dev Note: don't forget to visit https://localhost:8088/ and allow self-signed certificate. No UI is displayed here.