Quick Access
Coin Methods
Bitcoin
Miscellaneous
Methods
Other
init

Init

To initiate TrezorConnect, please provide the manifest object with your email and appURL. This is crucial for us to identify your use of TrezorConnect and to contact you if necessary. If the manifest object is not set, TrezorConnect methods will not be available.

It is also possible to customize more advanced options for TrezorConnect.

const result = await TrezorConnect.init({
    manifest: {
        appUrl: 'https://your.application.com',
        email: 'your@email.com',
    },
    // More advanced options
    debug: true,
    lazyLoad: true,
    coreMode: 'auto',
});

Params

manifest

Object

Required

Application manifest with your email and appUrl.

connectSrc

String

Optional

Set custom src for TrezorConnect iframe.

debug

Boolean

Optional

default false. Prints debug logs.

transportReconnect

Boolean

Optional

default true. If transport dies during lifecycle of application, this field decides whether TrezorConnect tries to reestablish connection with transport layer.

pendingTransportEvent

Boolean

Optional

default true. Postpone emitting TRANSPORT.START event to the moment when connected device becomes available.

interactionTimeout

Number

Optional

default 600. Time in seconds after which popup automatically closes.

lazyLoad

Boolean

Optional

default false. Postpone iframe creation until TrezorConnect is called for the first time.

popup

Boolean

Optional

default true. Projects running on trusted domains (trezor.io) are not required to use popup. For other domains this option is ignored.

transports

Array<"BridgeTransport" | "WebUsbTransport" | "NodeUsbTransport">

Optional

Array of transports that should be use. If not provided, TrezorConnect will choose a reasonable default based on your environment.

coreMode

"auto" | "iframe" | "popup"

Optional

default auto.

If set to popup, webUSB transport would work cross-origin on the web. The disadvantage of this mode is that Connect popup does not retain a stateful connection to the device, which means for example that device events are not sent to the application when the popup is not open.

If set to iframe, TrezorConnect will use iframe with persistent connection for the communication between popup and 3rd party wallet.

In the default auto mode, TrezorConnect will automatically choose iframe if bridge transport is available and popup otherwise, to allow for webUSB use.

Result

TrezorConnect.init returns Promise<void>

getOwnershipProofrequestLogin