Skip to content

useAccounts

Provides access to the connected user's accounts

Import

ts
import { useAccounts } from "@midl-xyz/midl-js-react";

Example

tsx
function Page() {
  const { accounts, isConnected } = useAccounts();

  return (
    <div>
      {isConnected && (
        <div>
          <h2>Accounts</h2>
          <ul>
            {accounts.map(account => (
              <li key={account}>{account}</li>
            ))}
          </ul>
        </div>
      )}
    </div>
  );
}

Returns

NameTypeDescription
accountsAccount[] | nullThe list of user accounts
ordinalsAccountAccount | undefinedThe ordinals account (p2tr)
paymentAccountAccount | undefinedThe payment account (p2wpkh)
connectorConnector | undefinedThe current connection
isConnectingbooleanIndicates if a connection is in progress
isConnectedbooleanIndicates if the connection has been established
statusstringThe current connection status
networkBitcoinNetwork | undefinedThe connected network
...restAdditional query state provided by useQuery