🗃️WalletManager API

Public methods and properties of the WalletManager class

The framework adapters abstract the WalletManager class and expose a similar API via the useWallet function/hook.

The following API is exposed via the WalletManager class instance:

class WalletManager {
  constructor({
    wallets: Array<T | WalletIdConfig<T>>,
    network?: NetworkId,
    algod?: NetworkConfig
  }: WalletManagerConstructor)
}

---

Public Methods

subscribe

subscribe(callback: (state: State) => void): (() => void)

Subscribes to state changes.

• callback: The function to be executed when state changes.

setActiveNetwork

setActiveNetwork(network: NetworkId): void

Sets the active network (BetaNet, TestNet, MainNet, or LocalNet).

• network: The network to be set as active.

getWallet

getWallet(walletId: WalletId): BaseWallet | undefined

Returns a wallet provider client by its WalletId.

• walletId: The ID of the wallet to be retrieved.

resumeSessions

resumeSessions(): Promise<void>

Re-initializes the connected wallet(s) from persisted storage when the app mounts. Framework adapters handle this automatically.

---

Public Properties

wallets

wallets: BaseWallet[]

An array of all initialized wallet provider clients.

activeNetwork

activeNetwork: NetworkId

The currently active network.

algodClient

algodClient: algosdk.Algodv2

The Algodv2 client for the active network.

activeWallet

activeWallet: BaseWallet | null

The currently active wallet provider client instance.

activeWalletAccounts

activeWalletAccounts: WalletAccount[] | null

An array of connected accounts for the currently active wallet provider.

activeWalletAddresses

activeWalletAddresses: string[] | null

An array of addresses of the currently active wallet provider's accounts.

activeAccount

activeAccount: WalletAccount | null

The currently active account, the default sender used to sign transactions

activeAddress

activeAddress: string | null

The address of the currently active account.

signTransactions

signTransactions: BaseWallet['signTransactions']

A getter that returns the signTransactions method of the currently active wallet provider. It is a function that signs transactions of an atomic transaction group.

Learn more...

transactionSigner

transactionSigner: BaseWallet['transactionSigner']

A getter that returns the transactionSigner method of the currently active wallet provider. It is a typed TransactionSigner function that signs transactions of an atomic transaction group.

Learn more...