API Reference for TUWA Satellite headless wallet connectivity and session state management.

SatelliteSiwxState

Defined in: packages/satellite-core/src/types.ts:162 

Unified Sign-In With X (SIWX) state interface for Satellite connection watchers. Centralizes SIWX state definitions across satellite-evm, satellite-solana, and satellite-react.

Properties

address?

optional address?: string

Defined in: packages/satellite-core/src/types.ts:174 

Active session wallet address (CAIP-10 or raw hex)

chainId?

optional chainId?: string

Defined in: packages/satellite-core/src/types.ts:176 

Active session chain identifier (CAIP-2 format, e.g. eip155:1 or solana:mainnet)

enabled?

optional enabled?: boolean

Defined in: packages/satellite-core/src/types.ts:164 

Flag indicating if SIWX authentication flow is enabled

isAuthenticated?

optional isAuthenticated?: boolean

Defined in: packages/satellite-core/src/types.ts:168 

Alias for isSignedIn (direct compatibility with useSiwxSession from @tuwaio/siwx-react)

isRejected?

optional isRejected?: boolean

Defined in: packages/satellite-core/src/types.ts:170 

Flag indicating if the SIWX signature request was rejected or errored

isSignedIn?

optional isSignedIn?: boolean

Defined in: packages/satellite-core/src/types.ts:166 

Flag indicating if the user is currently signed in via SIWX

session?

optional session?: { address?: string; chainId?: string; } | null

Defined in: packages/satellite-core/src/types.ts:178 

Session object (direct compatibility with useSiwxSession from @tuwaio/siwx-react)

status?

optional status?: string

Defined in: packages/satellite-core/src/types.ts:172 

Current status string from session store