MinimalSatelliteConnection

Defined in: siwx-react/src/satelliteHelpers.ts:9 

Duck-typed subset of an active Satellite Connect connection, so @tuwaio/siwx-react does not depend on @tuwaio/satellite-core. Only address, chainId, signMessage and connector are read by the helpers.

Properties

address?

optional address?: string

Defined in: siwx-react/src/satelliteHelpers.ts:13 

Connected account, as a plain address or a CAIP-10 account ID.

chainId?

optional chainId?: string | number

Defined in: siwx-react/src/satelliteHelpers.ts:15 

Connected chain: an EVM chain ID number, a chain reference or a CAIP-2 ID.

connectedAccount?

optional connectedAccount?: unknown

Defined in: siwx-react/src/satelliteHelpers.ts:24 

Connected account object of the wallet library. Not read by the helpers.

connectedWallet?

optional connectedWallet?: unknown

Defined in: siwx-react/src/satelliteHelpers.ts:26 

Connected wallet object of the wallet library. Not read by the helpers.

connector?

optional connector?: object

Defined in: siwx-react/src/satelliteHelpers.ts:19 

EVM connector. Its presence marks the connection as EVM in getSatelliteSiwxFields.

getWalletClient?

optional getWalletClient?: () => Promise<unknown>

Returns the wallet client of the connector. Not read by the helpers.

Returns

Promise<unknown>

isConnected?

optional isConnected?: boolean

Defined in: siwx-react/src/satelliteHelpers.ts:11 

Whether the wallet is connected. Not read by the helpers.

signMessage?

optional signMessage?: (message) => Promise<string>

Defined in: siwx-react/src/satelliteHelpers.ts:17 

Signs a message with the connected wallet. Returned by createSatelliteSiwxSigner.

Parameters

message

string

Returns

Promise<string>