Reference
Client options
Every option of WalletBridgeClient, with defaults and per-call timeout overrides.
Pass these to new WalletBridgeClient(options). All options are optional unless marked required. The React provider and the Vue composables accept the same options; see React and Next.js and Vue and Nuxt.
| Option | Type | Default | Description |
|---|---|---|---|
appCenterOrigin | string | string[] | none | Origin (or origins) of the host shell. When no transport is given, the client creates and owns a PostMessageTransport for it. |
transport | ITransport | none | Your own transport. Takes precedence over appCenterOrigin and is never destroyed for you. Required inside an iframe unless appCenterOrigin is set. |
handshakeTimeoutMs | number | 3000 | Maximum wait for the CLIENT_READY handshake. |
pingTimeoutMs | number | 3000 | Maximum wait for ping(). |
queryTimeoutMs | number | 15000 | Default timeout for wallet state queries. |
signingTimeoutMs | number | 120000 | Default timeout for signTx, submitTx and signData. |
autoConnect | boolean | false | Start the handshake from the constructor. Failures are only logged in debug mode. |
isIframeFn | () => boolean | built-in detection | Custom iframe detection, mainly for tests. |
debug | boolean | false | Emit warnings through the logger. See Logging and debugging. |
logger | Logger | console | Destination for debug output. |
Per-call timeouts
Queries take { timeoutMs } (QueryOptions) and signing calls take { timeoutMs } (SignOptions).
The default timeouts are also exported as TIERED_TIMEOUTS (HANDSHAKE, PING, QUERY, SIGNING).
Build-time constants
SDK_VERSION is exported from the root entry and always equals the version in package.json.
See also
- Transports for the origin and window options.
- Storage adapters for session storage.