Networks and sessions

Use client = createArksatClient(provider). Example variables are supplied by the application.

getCapabilities

Returns protocol versions, methods, events, networks, and signature types. Parameters

// No parameters

Returns

Promise<ArksatCapabilities>

Example

const capabilities = await client.getCapabilities()

Returns connection, unlock, account, and network state. Parameters

// No parameters

Returns

Promise<ArksatProviderState>

Example

const state = await client.getProviderState()

Returns the current network and Arkade service information. Parameters

// No parameters

Returns

Promise<ArksatNetworkInfo>

Example

const network = await client.getNetwork()

Returns an atomic public session. Read the Bitcoin boarding address from boardingAddress. Parameters

// No parameters

Returns

Promise<ArksatWalletSession>

Example

const session = await client.getWalletSession()

Requests a network switch. Reload state after completion. Switching to the current network is a no-op. Parameters

{ network: 'mainnet' | 'mutinynet' }

Returns

Promise<void>

Example

await client.switchNetwork({ network: 'mutinynet' })

Supported operations accept expectedAddress, expectedNetwork, and expectedSessionId. Session lifecycle. Errors · Type definitions