createStartaleAccountSDK

Creates an SDK instance and returns helpers for working with it.

import { createStartaleAccountSDK } from '@startale/app-sdk'

const sdk = createStartaleAccountSDK({
  appName: 'My App',
  appLogoUrl: 'https://my-app.com/logo.png',
  appChainIds: [1868],
})

Signature

function createStartaleAccountSDK(options: CreateProviderOptions): {
  getProvider(): ProviderInterface
}

Options

string

The display name shown in the connection popup. Defaults to 'App' if omitted; recommended to set. Maximum length is unconstrained but keep it under 32 characters for readability.

string

HTTPS URL to a square logo. Shown in the connection popup. Must be reachable.

number[]

Chain IDs your app supports. Defaults to [] if omitted. Pass 1868 for Soneium Mainnet. See Networks.

Preference

Optional. Filters auth methods, requires linked EOA, sets the wallet popup URL.

Show Preference fields

string

Override the wallet popup URL. Defaults to https://app.startale.com. Useful for staging.

'google' | 'line' | 'apple'

Limit which sign-in methods are offered. Omit to allow all.

boolean

Force the user to link a MetaMask wallet during connection. Default false.

boolean

Enable or disable SDK telemetry. Default true.

Record<chainId, { url, id }>

Optional. The ERC-7677 paymaster service that sponsors gas for a standalone application, keyed by chain id. Only url is transmitted, and only on wallet_sendCalls. Ignored inside the Startale App, where the host sponsors. See Gas in a standalone application.

Returns

() => ProviderInterface

Returns the EIP-1193 provider. Use it directly or wrap it in a wagmi connector.

startaleConnector, the wagmi connector that wraps this SDK.
Initialization, guidance on which mode to use.

Entry points

RPC methods

Reference

Signature

Options

Returns

​Signature

​Options

​Returns

​Related

Signature

Options

Returns

Related