通过专用的 RPC 方法从索引器读取加密的私密 Solana 代币账户。
只有用户或用户授权的人可以用他们的查看密钥解密余额。
在私密余额变动后和转账前使用它。

与 getBalance / getAccount 比较

getBalance 返回公开的 SOL。getAccount 返回一个公开的代币账户。
RPC 返回公开的余额。

开始使用

TypeScript 客户端
Rust 客户端

前提条件

The TypeScript examples require Node.js 24 or later, pnpm 11.18.0, and the Solana CLI.

pnpm add @heliuslabs/zolana @solana/kit

Source: sdk-libs/ts

Connect to Endpoints

Devnet
Localnet

pnpm install
cp .env.example .env

Add a Helius API key:

.env

API_KEY=YOUR_API_KEY
ZOLANA_PAYER_KEYPAIR=~/.config/solana/id.json

import { createZolanaClient } from "@heliuslabs/zolana";

const client = await createZolanaClient({
  solanaRpcUrl: "https://devnet.helius-rpc.com/?api-key=YOUR_API_KEY",
  indexerUrl: "http://zolnet-devnet-1779374825.eu-north-1.elb.amazonaws.com",
  proverUrl: "http://zolnet-devnet-1779374825.eu-north-1.elb.amazonaws.com:3001",
  allowInsecureHttp: true,
});

The examples use the Solana CLI wallet as the payer by default. The payer must hold devnet SOL. See How to Get Devnet SOL.

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.

cargo install --git https://github.com/helius-labs/zolana --tag v0.1.0-alpha zolana-cli
zolana dev start

import { createZolanaClient } from "@heliuslabs/zolana";

const client = await createZolanaClient({});

导出查看标签

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 是 senderAddress.confidentialViewTag()，发送者在机密环中的 Solana 公钥。索引器使用它返回匹配的加密输出。

从索引器获取交易输出

import { atSlot } from "@heliuslabs/zolana/client";

const depositResponse =
  await client.getShieldedTransactionsByTags(
    { tags: [senderViewTag] },
    atSlot(depositTx.slot),
  );

getShieldedTransactionsByTags 获取与 senderViewTag 相关的加密输出。
atSlot(depositTx.slot) 等待索引器在该插槽中有存款。
索引器返回加密的输出数据。它不解密私密余额。

解密为私密余额

import { SOL_MINT } from "@heliuslabs/zolana";
import { decryptToBalances } from "@heliuslabs/zolana/transaction";

const balancesAfterDeposit =
  await decryptToBalances({
    keypair: senderKeypair,
    registry: assets,
    transactions: depositResponse.transactions,
  });
const depositBalance =
  balancesAfterDeposit.balance(SOL_MINT);

senderKeypair 提供发送者的查看密钥用于本地解密。
decryptToBalances 解密匹配的输出并返回发送者的私密余额。
balancesAfterDeposit.balance(SOL_MINT) 读取私密 SOL 余额。

请参阅概念了解所有者标记和私密 Solana 代币账户的工作原理。

完整代码示例

克隆并运行示例：

git clone https://github.com/helius-labs/zolana-examples.git
cd zolana-examples/typescript-client
pnpm install
pnpm example examples/deposit_transfer_withdraw.ts

这些示例在 local/devnet 上使用机密环这里。

前提条件

The Rust examples require the latest stable Rust toolchain and the Solana CLI v4.0.2. See the Solana installation guide.

Cargo.toml

[dependencies]
zolana-client = { git = "https://github.com/helius-labs/zolana", tag = "v0.1.0-alpha", features = ["indexer-api", "solana-rpc"] }
zolana-interface = { git = "https://github.com/helius-labs/zolana", tag = "v0.1.0-alpha", features = ["solana"] }
zolana-keypair = { git = "https://github.com/helius-labs/zolana", tag = "v0.1.0-alpha" }
zolana-transaction = { git = "https://github.com/helius-labs/zolana", tag = "v0.1.0-alpha" }

Source: sdk-libs/client

Connect to Endpoints

Devnet
Localnet

Add a Helius API key:

.env

API_KEY=YOUR_API_KEY
ZOLANA_PAYER_KEYPAIR=~/.config/solana/id.json

use solana_address::Address;
use zolana_client::{SolanaRpc, ZolanaClient};
use zolana_interface::DEFAULT_TREE_ADDRESS;

let tree: Address = DEFAULT_TREE_ADDRESS.parse()?;
let client = ZolanaClient::from_urls_allowing_insecure_http(
    SolanaRpc::new("https://devnet.helius-rpc.com/?api-key=YOUR_API_KEY"),
    "http://zolnet-devnet-1779374825.eu-north-1.elb.amazonaws.com",
    "http://zolnet-devnet-1779374825.eu-north-1.elb.amazonaws.com:3001",
    tree,
);

The examples use the Solana CLI wallet as the payer by default. The payer must hold devnet SOL. See How to Get Devnet SOL.

cargo install --git https://github.com/helius-labs/zolana --tag v0.1.0-alpha zolana-cli
zolana dev start

use solana_address::Address;
use zolana_client::{SolanaRpc, ZolanaClient};
use zolana_interface::DEFAULT_TREE_ADDRESS;

let tree: Address = DEFAULT_TREE_ADDRESS.parse()?;
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",
    tree,
)?;

导出查看标签

use zolana_client::Rpc;

let sender_tag = sender_shielded_address.confidential_view_tag()?;

sender_tag 是 sender_shielded_address.confidential_view_tag()，发送者在机密环中的 Solana 公钥。索引器使用它返回匹配的加密输出。

从索引器获取交易输出

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 获取与 sender_tag 相关的加密输出。
IndexerRpcConfig::at_slot(slot) 等待索引器在该插槽中有存款。
索引器返回加密的输出数据。它不解密私密余额。

解密为私密余额

use anyhow::anyhow;
use zolana_transaction::{decrypt_transactions, SOL_MINT};

let balances = decrypt_transactions(&sender, &response.transactions, &assets)
    .map_err(|e| anyhow!("decrypt sender transactions: {e:?}"))?;
let sender_balance = balances.get_balance(SOL_MINT);

sender 提供发送者的查看密钥用于本地解密。
decrypt_transactions 解密匹配的输出并返回发送者的私密余额。
get_balance(SOL_MINT) 读取私密 SOL 余额。

完整代码示例

克隆并运行示例：

git clone https://github.com/helius-labs/zolana-examples.git
cd zolana-examples/rust-client
cargo run -p rust-client-example --example deposit_transfer_withdraw

入门指南

数据流和事件监听

数据 API 和 RPC

交易

发送交易

钱包服务

隐私

指南

资源

读取私密余额

开始使用

前提条件

导出查看标签

从索引器获取交易输出

解密为私密余额

完整代码示例

前提条件

导出查看标签

从索引器获取交易输出

解密为私密余额

完整代码示例

相关指导

存款

转账

取款

读取私密历史

Didn’t find what you were looking for?

​开始使用

​前提条件

​导出查看标签

​从索引器获取交易输出

​解密为私密余额

​完整代码示例

​前提条件

​导出查看标签

​从索引器获取交易输出

​解密为私密余额

​完整代码示例

​相关指导

存款

转账

取款

读取私密历史

​Didn’t find what you were looking for?

开始使用

前提条件

导出查看标签

从索引器获取交易输出

解密为私密余额

完整代码示例

前提条件

导出查看标签

从索引器获取交易输出

解密为私密余额

完整代码示例

相关指导

Didn’t find what you were looking for?