> ## Documentation Index
> Fetch the complete documentation index at: https://www.helius.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Read a Private Balance

> Guide to read a wallet's private balance from the indexer with a full code example.

1. Read fetches encrypted Private Solana Token Accounts from the indexer with dedicated RPC methods.
2. Only the user, or anyone the user authorizes, can decrypt balances with their viewing key.
3. Use it after a private balance changes and before a transfer.

```mermaid theme={"system"}
%%{init: {
  'theme': 'base',
  'themeVariables': {
    'lineColor':           '#FF6B35',
    'primaryTextColor':    '#737373',
    'primaryBorderColor':  '#9CA3AF',
    'actorBkg':            '#FFFFFF',
    'actorBorder':         '#9CA3AF',
    'actorTextColor':      '#737373',
    'signalColor':         '#FF6B35',
    'signalTextColor':     '#737373',
    'labelBoxBkgColor':    '#FF6B351F',
    'labelBoxBorderColor': '#FF6B35',
    'noteBkgColor':        '#F5F5F5',
    'noteTextColor':       '#737373',
    'noteBorderColor':     '#9CA3AF'
  }
}}%%
sequenceDiagram
    participant Wallet
    participant RPC as RPC Provider

    Wallet->>RPC: getShieldedTransactionsByTags
    RPC-->>Wallet: Encrypted transactions
    Note over Wallet: Decrypt
    Note over Wallet: Sum to private balances
```

> [accordion] Compare to getBalance / getAccount
>
> 1. `getBalance` returns public SOL. `getAccount` returns a public token account.
> 2. The RPC returns the public balance.
>
> ```mermaid theme={"system"}
> %%{init: {
>   'theme': 'base',
>   'themeVariables': {
>     'lineColor':           '#FF6B35',
>     'primaryTextColor':    '#737373',
>     'primaryBorderColor':  '#9CA3AF',
>     'actorBkg':            '#FFFFFF',
>     'actorBorder':         '#9CA3AF',
>     'actorTextColor':      '#737373',
>     'signalColor':         '#FF6B35',
>     'signalTextColor':     '#737373',
>     'labelBoxBkgColor':    '#FF6B351F',
>     'labelBoxBorderColor': '#FF6B35',
>     'noteBkgColor':        '#F5F5F5',
>     'noteTextColor':       '#737373',
>     'noteBorderColor':     '#9CA3AF'
>   }
> }}%%
> sequenceDiagram
>     participant Wallet
>     participant RPC
>
>     Wallet->>RPC: getBalance / getAccount
>     RPC-->>Wallet: Public SOL or token account
> ```

## Get Started

> [tab] TypeScript Client
>
> **Step 1**
>
> ### Prerequisites
>
> > [!NOTE]
> >
> > The TypeScript examples require Node.js 24 or later, pnpm 11.18.0, and the Solana CLI.
>
> ```bash theme={"system"}
> pnpm add @heliuslabs/zolana@^0.5.0-alpha @solana/kit@^8.3.0
> ```
>
> Source: [sdk-libs/ts](https://github.com/helius-labs/zolana/tree/ts-sdk-v0.5.0-alpha/sdk-libs/ts)
>
> > [accordion] Connect to Endpoints
> >
> > > [tab] Devnet
> > >
> > > ```bash theme={"system"}
> > > pnpm install
> > > cp .env.example .env
> > > ```
> > >
> > > Add a [Helius API key](https://dashboard.helius.dev/):
> > >
> > > ```bash .env theme={"system"}
> > > API_KEY=YOUR_API_KEY
> > > ZOLANA_PAYER_KEYPAIR=~/.config/solana/id.json
> > > ```
> > >
> > > ```ts theme={"system"}
> > > import { createZolanaClient } from "@heliuslabs/zolana";
> > >
> > > const client = await createZolanaClient({
> > >   solanaRpcUrl: "https://devnet.helius-rpc.com/?api-key=YOUR_API_KEY",
> > > });
> > > ```
> > >
> > > The examples use the Solana CLI wallet as the payer by default. The payer must hold devnet SOL. See [How to Get Devnet SOL](https://www.helius.dev/docs/rpc/devnet-sol.md).
> >
> > > [tab] Localnet
> > >
> > > On localnet, the SDK starts the local test validator (`:8899`), Photon indexer (`:8784`), and prover (`:3001`), and the
> > > client connects to them automatically without needing endpoint configuration.
> > >
> > > ```bash theme={"system"}
> > > cargo install --git https://github.com/helius-labs/zolana --tag v0.5.0-alpha zolana-cli
> > > zolana dev start
> > > ```
> > >
> > > ```ts theme={"system"}
> > > import { createZolanaClient } from "@heliuslabs/zolana";
> > >
> > > const client = await createZolanaClient({});
> > > ```
>
> **Step 2**
>
> ### Derive the View Tag
>
> ```typescript theme={"system"}
> import { createZolanaClient } from "@heliuslabs/zolana";
>
> // The view tag is the sender's Solana public key in confidential rings.
> // Used by the indexer to fetch the sender's UTXOs.
> const senderViewTag =
>   senderAddress.confidentialViewTag();
> ```
>
> * `senderViewTag` is `senderAddress.confidentialViewTag()`, the sender's Solana public key in confidential rings. The indexer uses it to return matching encrypted outputs.
>
> **Step 3**
>
> ### Fetch Transaction Outputs from the Indexer
>
> ```typescript theme={"system"}
> import { atSlot } from "@heliuslabs/zolana/client";
>
> const depositResponse =
>   await client.getShieldedTransactionsByTags(
>     { tags: [senderViewTag] },
>     atSlot(depositTx.slot),
>   );
> ```
>
> * `getShieldedTransactionsByTags` fetches the encrypted outputs associated with `senderViewTag`.
> * `atSlot(depositTx.slot)` waits until the indexer has the deposit at that slot.
> * The indexer returns encrypted output data. It does not decrypt the private balance.
>
> **Step 4**
>
> ### Decrypt to a Private Balance
>
> ```typescript theme={"system"}
> import { SOL_MINT } from "@heliuslabs/zolana";
> import { decryptToBalances } from "@heliuslabs/zolana/transaction";
>
> const balancesAfterDeposit =
>   await decryptToBalances({
>     keypair: sender,
>     registry: assets,
>     transactions: depositResponse.transactions,
>   });
> const depositBalance =
>   balancesAfterDeposit.balance(SOL_MINT);
> ```
>
> * `sender` supplies the sender's viewing key for local decryption.
>
> * `decryptToBalances` decrypts matching outputs and returns the sender's private balances.
>
> * `balancesAfterDeposit.balance(SOL_MINT)` reads the private SOL balance.
>
> > [!NOTE]
> >
> > See [Private State and UTXOs](https://www.helius.dev/docs/privacy/concepts/utxo.md) for how owner tagging and Private Solana Token Accounts work.
>
> ### Full Code Example
>
> Clone and run the example:
>
> ```bash theme={"system"}
> git clone https://github.com/helius-labs/zolana-examples.git
> cd zolana-examples/typescript-client
> pnpm install
> pnpm example examples/sync_balance.ts
> ```
>
> > [!NOTE]
> >
> > The examples use a confidential Ring on local/devnet [here](https://github.com/helius-labs/zolana-examples/blob/main/typescript-client/examples/sync_balance.ts).

> [tab] Rust Client
>
> **Step 1**
>
> ### Prerequisites
>
> > [!NOTE]
> >
> > The Rust examples require Rust 1.98.1 and the Solana CLI v4.0.2. See the [Solana installation guide](https://solana.com/docs/intro/installation).
>
> ```toml Cargo.toml theme={"system"}
> [dependencies]
> zolana-client = { git = "https://github.com/helius-labs/zolana", tag = "v0.5.0-alpha", features = ["solana-rpc"] }
> zolana-interface = { git = "https://github.com/helius-labs/zolana", tag = "v0.5.0-alpha" }
> zolana-program = { git = "https://github.com/helius-labs/zolana", tag = "v0.5.0-alpha" }
> zolana-keypair = { git = "https://github.com/helius-labs/zolana", tag = "v0.5.0-alpha" }
> zolana-transaction = { git = "https://github.com/helius-labs/zolana", tag = "v0.5.0-alpha" }
> zolana-test-utils = { git = "https://github.com/helius-labs/zolana", tag = "v0.5.0-alpha" }
> ```
>
> Source: [sdk-libs/client](https://github.com/helius-labs/zolana/tree/v0.5.0-alpha/sdk-libs/client)
>
> > [accordion] Connect to Endpoints
> >
> > > [tab] Devnet
> > >
> > > Add a [Helius API key](https://dashboard.helius.dev/):
> > >
> > > ```bash .env theme={"system"}
> > > API_KEY=YOUR_API_KEY
> > > ZOLANA_PAYER_KEYPAIR=~/.config/solana/id.json
> > > ```
> > >
> > > ```rust theme={"system"}
> > > use zolana_client::{SolanaRpc, ZolanaClient};
> > > use zolana_interface::pda;
> > >
> > > let tree = pda::tree(0);
> > > let url = "https://devnet.helius-rpc.com/?api-key=YOUR_API_KEY";
> > > let client = ZolanaClient::from_urls(SolanaRpc::new(url), url, url)?;
> > > ```
> > >
> > > The examples use the Solana CLI wallet as the payer by default. The payer must hold devnet SOL. See [How to Get Devnet SOL](https://www.helius.dev/docs/rpc/devnet-sol.md).
> >
> > > [tab] Localnet
> > >
> > > ```bash theme={"system"}
> > > cargo install --git https://github.com/helius-labs/zolana --tag v0.5.0-alpha zolana-cli
> > > zolana dev start
> > > ```
> > >
> > > ```rust theme={"system"}
> > > use zolana_client::{SolanaRpc, ZolanaClient};
> > > use zolana_interface::pda;
> > >
> > > let tree = pda::tree(0);
> > > let client = ZolanaClient::from_urls(
> > >     SolanaRpc::new("http://127.0.0.1:8899"),
> > >     "http://127.0.0.1:8784",
> > >     "http://127.0.0.1:3001",
> > > )?;
> > > ```
>
> **Step 2**
>
> ### Derive the View Tag
>
> ```rust theme={"system"}
> use zolana_client::Rpc;
>
> let sender_tag = sender_shielded_address.confidential_view_tag()?;
> ```
>
> * `sender_tag` is `sender_shielded_address.confidential_view_tag()`, the sender's Solana public key in confidential rings. The indexer uses it to return matching encrypted outputs.
>
> **Step 3**
>
> ### Fetch Transaction Outputs from the Indexer
>
> ```rust theme={"system"}
> use zolana_client::{IndexerRpcConfig, Rpc};
>
> let response = client.get_shielded_transactions_by_tags(
>     vec![sender_tag],
>     None,
>     Some(50),
>     Some(IndexerRpcConfig::at_slot(slot)),
> )?;
> ```
>
> * `get_shielded_transactions_by_tags` fetches the encrypted outputs associated with `sender_tag`.
> * `IndexerRpcConfig::at_slot(slot)` waits until the indexer has the deposit at that slot.
> * The indexer returns encrypted output data. It does not decrypt the private balance.
>
> **Step 4**
>
> ### Decrypt to a Private Balance
>
> ```rust theme={"system"}
> use anyhow::anyhow;
> use zolana_transaction::{decrypt_spendable, SOL_MINT};
>
> let balances = decrypt_spendable(&sender, &response.transactions, &assets)
>     .map_err(|e| anyhow!("decrypt sender transactions: {e:?}"))?
>     .balances;
> let sender_balance = balances.get_balance(SOL_MINT);
> ```
>
> * `sender` supplies the sender's viewing key for local decryption.
> * `decrypt_spendable` decrypts and verifies matching outputs. Its `.balances` field contains the sender's balances for those outputs.
> * `get_balance(SOL_MINT)` reads the private SOL balance.
>
> ### Full Code Example
>
> Clone and run the example:
>
> ```bash theme={"system"}
> git clone https://github.com/helius-labs/zolana-examples.git
> cd zolana-examples/rust-client
> cargo run -p rust-client-example --example sync_balance
> ```
>
> > [!NOTE]
> >
> > The examples use a confidential Ring on local/devnet [here](https://github.com/helius-labs/zolana-examples/blob/main/rust-client/examples/sync_balance.rs).

## Related Guides

> [card] [Create a Private Wallet](https://www.helius.dev/docs/privacy/integration/wallet.md#create-private-wallet)

> [card] [Deposit](https://www.helius.dev/docs/privacy/guides/deposit.md)

> [card] [Transfer](https://www.helius.dev/docs/privacy/guides/transfer.md)

> [card] [Withdraw](https://www.helius.dev/docs/privacy/guides/withdraw.md)

> [card] [Read Private History](https://www.helius.dev/docs/privacy/guides/read-history.md)

## Didn't find what you were looking for?

Reach out! [Telegram](https://t.me/tilo_light) | [E-Mail](mailto:sales@helius.xyz) | [Contact](https://www.helius.dev/contact)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.