Wallet

Unique identifier of the wallet

For example, MetaMask wallet id is "io.metamask"

type id = TWalletId;

const wallet = createWallet("io.metamask");
console.log(wallet.id); // "io.metamask"

Subscribe to wallet for certain events like chainChanged , accountChanged , disconnect , etc.

type subscribe = WalletEmitter<TWalletId>["subscribe"];

wallet.subscribe("chainChanged", (chain) => {
  console.log("wallet is now connected to network:", chain);
});
 
wallet.subscribe("accountChanged", (account) => {
  console.log("wallet is now connected to account:", account);
});
 
wallet.subscribe("disconnect", () => {
  console.log("wallet is disconnected");
});

Re-connect the wallet automatically without prompting the user for connection.

This is useful to automatically connect the wallet if it was already connected in the past to reconnect wallet when user re-visits the website after some time or refreshes the page.

function autoConnect(
  options: WalletAutoConnectionOption<TWalletId>,
): Promise<Account>;

let options: WalletAutoConnectionOption<TWalletId>;

let returnType: Promise<Account>;

Prompt the user to connect the wallet.

function connect(
  options: WalletConnectionOption<TWalletId>,
): Promise<Account>;

let options: WalletConnectionOption<TWalletId>;

let returnType: Promise<Account>;

Disconnect the wallet

function disconnect(): Promise<void>;

let returnType: Promise<void>;

Get the Account object that the wallet is currently connected to. If the wallet is not connected, it returns undefined .

Refer to Account vs Wallet to understand the difference between Account and Wallet interface

const account = wallet.getAccount();

function getAccount(): undefined | Account;

let returnType: undefined | Account;

Get the Chain object of the network that the wallet is currently connected to. If the wallet is not connected, it returns undefined .

const chain = wallet.getChain();

function getChain():
  | undefined
  | Readonly<ChainOptions & { rpc: string }>;

let returnType: undefined | Readonly<ChainOptions & { rpc: string }>;

Switch the wallet to a different network by passing the Chain object of the network

function switchChain(
  chain: Readonly<ChainOptions & { rpc: string }>,
): Promise<void>;

let chain: Readonly<ChainOptions & { rpc: string }>;

let returnType: Promise<void>;