Skip to main content

Interface: ConnectOptions

Defined in: types.ts:90

Options passed to BrowserSDK.connect.

Example

await sdk.connect({
metadata: {
appName: 'My DeFi App',
appUrl: 'https://mydefi.app',
imageUrl: 'https://mydefi.app/logo.png',
},
});

Properties

PropertyTypeDescriptionDefined in
metadata?Partial<AppMetadata>Optional metadata about the connecting dApp displayed on the wallet's consent screen (name, URL, icon). Remarks When omitted, appName and appUrl are automatically resolved from window.location. Providing an explicit imageUrl is recommended for a polished consent screen. The metadata fields are: - appId — unique identifier (defaults to window.location.origin) - appName — display name (defaults to hostname) - appUrl — canonical URL (defaults to window.location.origin) - imageUrl — logo/icon URL shown on the consent screen See BrowserSDK.connecttypes.ts:108