Integrate Trezor devices with your project

Installation of the package

npm install @trezor/connect
# or
yarn add @trezor/connect

Import from the package

import TrezorConnect from '@trezor/connect';

Initialization of the project

    TrezorConnect.init({
        lazyLoad: true, // this param prevents iframe injection until
        // TrezorConnect.method is called
        manifest: {
            email: 'developer@xyz.com',
            appUrl: 'http://your.application.com',
        },
    });

Trezor Connect Manifest requires that you, as a Trezor Connect integrator, share your email and application URL with us. This provides us with the ability to reach you in case of any required maintenance. This subscription is mandatory.

If you need more customization, refer to init method documentation

How to use?

Here is an example of how to get the device's public key:

TrezorConnect.getPublicKey({
    "path": "m/49'/0'/0'",
        "showOnTrezor": true
});

More methods with detailed explanation can be found on the left under the 'Coin methods' section. You can also try the Method Testing Tool, where you can try interacting with the device by yourself.

Installation of the package

npm install @trezor/connect-web
# or
yarn add @trezor/connect-web

or include the library as inline script:

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

Import from the package

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

or use inline:

var TrezorConnect = window.TrezorConnect;

Initialization of the project

TrezorConnect.init({
    lazyLoad: true, // this param prevents iframe injection until
    // TrezorConnect.method is called
    manifest: {
        email: 'developer@xyz.com',
        appUrl: 'http://your.application.com',
    },
});

Trezor Connect Manifest requires that you, as a Trezor Connect integrator, share your email and application URL with us. This provides us with the ability to reach you in case of any required maintenance. This subscription is mandatory.

If you need more customization, refer to init method documentation

How to use?

Here is an example of how to get the device's public key:

TrezorConnect.getPublicKey({
    path: "m/44'/0'/0'/0/0",
    showOnTrezor: true,
});

More methods with detailed explanation can be found on the left under the 'Coin methods' section. You can also try the Method Testing Tool, where you can try interacting with the device by yourself.

Installation of the package

npm install @trezor/connect-webextension
# or
yarn add @trezor/connect-webextension

We support two methods for integrating the library into your extension - automatic content script injection and manual content script injection.

For automatic content script injection, modify your extension's manifest.json to include scripting permissions, specify host_permissions, and define your service worker script as shown below:

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

For manual content script injection, you can find more information in the README.

Import in the service worker

In your serviceWorker.js, use importScripts to import the library. Ensure you replace <path> with the actual path to the library file:

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

Or if you're using ES modules:

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

The library is only available in the service worker context, so to use it in your extension's UI, you need to communicate with the service worker. This mechanism is not provided by the library, this depends on your extension's architecture. Also it should be noted that the service worker may be idle when the extension is not in use, so you should implement a mechanism to keep it alive or wake it up when needed.

Initialization of the extension

TrezorConnect.init({
    lazyLoad: true, // this param prevents iframe injection until
    // TrezorConnect.method is called
    manifest: {
        email: 'developer@xyz.com',
        appUrl: 'http://your.application.com',
    },
});

Trezor Connect Manifest requires that you, as a Trezor Connect integrator, share your email and application URL with us. This provides us with the ability to reach you in case of any required maintenance. This subscription is mandatory.

To ensure your extension is displayed with its name rather than its ID, you need to open a Pull Request to include it in the knownHosts section of our configuration file.

If you need more customization, refer to init method documentation

How to use?

Here is an example of how to get the device's public key:

TrezorConnect.getPublicKey({
    path: "m/44'/0'/0'/0/0",
    showOnTrezor: true,
});

More methods with detailed explanation can be found on the left under the 'Coin methods' section. You can also try the Method Testing Tool, where you can try interacting with the device by yourself.

Installation of the package

Simply install the package using your preferred package manager:

npm install @trezor/connect-mobile
# or
yarn add @trezor/connect-mobile

Initialization of the API

import * as Linking from 'expo-linking';
 
TrezorConnect.init({
    manifest: {
        email: 'developer@xyz.com',
        appUrl: 'http://your.application.com',
    },
    deeplinkOpen: url => {
        Linking.openURL(url);
    },
    deeplinkCallbackUrl: Linking.createURL('/connect'),
});

Trezor Connect Manifest requires that you, as a Trezor Connect integrator, share your email and application URL with us. This provides us with the ability to reach you in case of any required maintenance. This subscription is mandatory.

The deeplink SDK needs two extra parameters: deeplinkOpen and deeplinkCallbackUrl. The deeplinkOpen function is used to open the Trezor Suite app, and the deeplinkCallbackUrl is the URL that the app will redirect to after the operation is complete.

In this example, we are using the Linking API from Expo to open the Trezor Suite app, however this may be different depending on your mobile app's environment.

Handling callbacks

The app needs to pass results from the callback URL back to the SDK. This can be done by listening to the URL and passing the data to the SDK using the handleDeeplink method.

useEffect(() => {
    const subscription = Linking.addEventListener('url', event => {
        TrezorConnect.handleDeeplink(event.url);
    });
 
    return () => subscription?.remove();
}, []);

How to use?

Here is an example of how to get the device's public key:

TrezorConnect.getPublicKey({
    path: "m/44'/0'/0'/0/0",
    showOnTrezor: true,
});

More methods with detailed explanation can be found on the left under the 'Coin methods' section. You can also try the Method Testing Tool, where you can try interacting with the device by yourself.