Trezor Connect API

From Trezor Wiki
Jump to: navigation, search
Trezor Wiki/Developer/Developers guide/ Trezor Connect API

Trezor Connect is a JavaScript platform made by SatoshiLabs for an easy integration of Trezor device with third-party services (websites or applications).

Trezor Connect can be used as:

Trezor connect can be implemented in:

  • Google Chrome Extension
  • Websites (Google Chrome/Chromium/Mozilla Firefox)

See also:

How Trezor Connect works[edit]

Full documentation of Trezor Connect and its methods is on this GitHub page

After implementing Trezor Connect, a small file containing a declaration of methods is downloaded. Once the Trezor Connect method is used, the connection to the external webpage is established and the Trezor Connect library is going to be downloaded and injected as an invisible iframe into your application. Trezor Connect is open-source, therefore it is provable that it is not saving any information about the device or account. Trezor Bridge has whitelisted domains set to "*" and "localhost" and it is ignoring messages coming from other domains. This ensures that Connect is not providing any data without the user's consent. Trezor Connect works as a tunnel for messages sent from your application to Trezor device via transport layer (Trezor Bridge/WebUSB).

Connect flowchart.png

Note With the newest Trezor Connect API, the iframe element ensures that the communication after authentification with PIN and/or Passphrase persists until
  • application is closed or reloaded
  • device is unplugged or used in another application
  • ten minutes of being idle
The advantages are that the session carries on, it is not necessary to re-enter your PIN and/or Passphrase and, furthermore, it is sending events to application when the device is connected, disconnected or used in another window (application). This feature makes it easier to use the Trezor device with applications.

Like Trezor? Get one here!