Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.startale.com/llms.txt

Use this file to discover all available pages before exploring further.

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, 1946],
})

​
Signature

function createStartaleAccountSDK(options: CreateProviderOptions): {
  getProvider(): ProviderInterface
  subAccount: {
    /* sub-account helpers */
  }
}

​
Options

​
appName
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.
​
appLogoUrl
string
HTTPS URL to a square logo. Shown in the connection popup. Must be reachable.
​
appChainIds
number[]
Chain IDs your app supports. Defaults to [] if omitted; recommended to pass at minimum 1868 (Soneium Mainnet) or 1946 (Soneium Minato).
​
preference
Preference
Optional. Filters auth methods, requires linked EOA, sets the wallet popup URL.
​
paymasterOptions
Record<chainId, { url, id }>
Optional. Use a custom paymaster instead of the default Startale sponsorship. See Custom paymaster.
​
subAccounts
SubAccountOptions
Optional sub-account configuration. See Sub-accounts.

​
Returns

​
getProvider
() => ProviderInterface
Returns the EIP-1193 provider. Use it directly or wrap it in a wagmi connector.
​
subAccount
object
Helper methods for managing sub-accounts. See Sub-accounts for the full surface.