PostMessageTransportOptions
Defined in: src/web/postMessageTransport.ts:12
Options for creating a PostMessageTransport.
Properties
Section titled “Properties”closeOnEstablishTimeout?
Section titled “closeOnEstablishTimeout?”
optionalcloseOnEstablishTimeout?:boolean
Defined in: src/web/postMessageTransport.ts:63
Close the signer window if the heartbeat handshake times out.
Default
Section titled “Default”truecloseOnPendingTimeout?
Section titled “closeOnPendingTimeout?”
optionalcloseOnPendingTimeout?:boolean
Defined in: src/web/postMessageTransport.ts:68
Close the signer window if it stays in “pending” status too long.
Default
Section titled “Default”truecrypto?
Section titled “crypto?”
optionalcrypto?:Pick<Crypto,"randomUUID">
Defined in: src/web/postMessageTransport.ts:51
Source of random UUIDs for heartbeat request IDs.
Default
Section titled “Default”globalThis.cryptodetectNonClickEstablishment?
Section titled “detectNonClickEstablishment?”
optionaldetectNonClickEstablishment?:boolean
Defined in: src/web/postMessageTransport.ts:75
Detect and reject attempts to open the signer window outside a click handler. Browsers like Safari block popups opened without user interaction.
Default
Section titled “Default”truedisconnectTimeout?
Section titled “disconnectTimeout?”
optionaldisconnectTimeout?:number
Defined in: src/web/postMessageTransport.ts:41
Time in milliseconds without a heartbeat response after which the channel is considered disconnected.
Default
Section titled “Default”2000establishTimeout?
Section titled “establishTimeout?”
optionalestablishTimeout?:number
Defined in: src/web/postMessageTransport.ts:29
Time in milliseconds to wait for the ICRC-29 heartbeat handshake to complete.
Default
Section titled “Default”120000manageFocus?
Section titled “manageFocus?”
optionalmanageFocus?:boolean
Defined in: src/web/postMessageTransport.ts:58
Manage focus between the relying party and signer windows. When true, the signer window is focused on send and the relying party window is focused on close.
Default
Section titled “Default”truependingTimeout?
Section titled “pendingTimeout?”
optionalpendingTimeout?:number
Defined in: src/web/postMessageTransport.ts:35
Time in milliseconds the channel can remain in “pending” status before the connection is considered failed.
Default
Section titled “Default”300000statusPollingRate?
Section titled “statusPollingRate?”
optionalstatusPollingRate?:number
Defined in: src/web/postMessageTransport.ts:46
Interval in milliseconds between ICRC-29 heartbeat status polls.
Default
Section titled “Default”300url:
string
Defined in: src/web/postMessageTransport.ts:14
The signer’s RPC URL. Must be a secure context (HTTPS, localhost, or 127.0.0.1).
window?
Section titled “window?”
optionalwindow?:Window
Defined in: src/web/postMessageTransport.ts:24
The relying party window, used to listen for incoming postMessage events.
Default
Section titled “Default”globalThis.windowwindowOpenerFeatures?
Section titled “windowOpenerFeatures?”
optionalwindowOpenerFeatures?:string
Defined in: src/web/postMessageTransport.ts:19
Window features string passed to window.open().
Example
Section titled “Example”"toolbar=0,location=0,menubar=0,width=500,height=500,left=100,top=100"