🔴stx_getAccounts

Your application can request to connect to the user’s Stacks wallet with the stx_getAccounts method, which prompts them to share their Stacks address.

Your app must have first connected to the wallet and obtained account read permissions.

No request parameters are required:

import { request } from "sats-connect";

try {

  const response = await request("stx_getAccounts", {});

    if (response.status === "success") {
      alert("Success getting accounts. Check console for results.");
      console.log("Accounts:", response.result);
    } else {
      alert("Error getting accounts. Check console for details.");
      console.error(response);
    }
}

The method returns a Promise that resolves to return GetAccountsResult: an array of the user’s wallet address objects, defined as:

address field	Description
address	the user’s connected Stacks wallet address
publicKey	A hex string representing the bytes of the public key of the account.
network	string - the network where the address is being used: mainnet for Stacks Mainnet testnet for Stacks Testnet
gaiaHubUrl	a string representing the user's Gaia hub URL. ℹ️ The Gaia storage system allows you to store private app data off the blockchain and still access it securely with Stacks applications. For more information about the Gaia storage system, see the Gaia protocol reference.
gaiaAppKey	a string representing the user's hex-encoded Gaia app key

You can use these addresses to make further Stacks requests such as signing a message, signing a transaction, etc.

If your app has not yet obtained account read permissions, the stx_getAccounts will prompt the user with a Connection Request in their wallet. The prompt will display:

• your app logo, if it is specified in your app manifest

• the Stacks wallet addresses that your app required

If the user declines the request or closes the pop-up, the promise will reject (throw when awaited).