MinimalSatelliteConnection

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

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:20 

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

chainId?

optional chainId?: string | number

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

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:31 

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

connectedWallet?

optional connectedWallet?: unknown

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

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

connector?

optional connector?: object

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

EVM connector, for example the wagmi Connector of an EVMConnection from @tuwaio/satellite-evm. Only its presence is read: it marks the connection as EVM in getSatelliteSiwxFields.

isConnected?

optional isConnected?: boolean

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

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

signMessage?

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

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

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

Parameters

message

string

Returns

Promise<string>