跳转到主要内容

Documentation Index

Fetch the complete documentation index at: https://docs.orbitflare.com/llms.txt

Use this file to discover all available pages before exploring further.

​
安装

cargo add orbitflare-sdk
默认启用 rpc 特性。

​
构建客户端

以下示例启用全部选项： 
use orbitflare_sdk::{RpcClientBuilder, RetryPolicy, Result};
use std::time::Duration;

let client = RpcClientBuilder::new()
    .url("http://ny.rpc.orbitflare.com")
    .fallback_url("http://fra.rpc.orbitflare.com")
    .fallback_url("http://ams.rpc.orbitflare.com")
    .api_key("ORBIT-XXXXXX-NNNNNN-NNNNNN")
    .commitment("confirmed")
    .retry(RetryPolicy {
        initial_delay: Duration::from_millis(100),
        max_delay: Duration::from_secs(30),
        multiplier: 2.0,
        max_attempts: 5,
    })
    .timeout(Duration::from_secs(30))
    .build()?;
大多数选项都有合理默认值。最简配置： 
let client = RpcClientBuilder::new()
    .url("http://ny.rpc.orbitflare.com")
    .build()?;

​
构建器方法

.url(url) — 发送请求的主端点。若未设置，SDK 会读取环境变量 ORBITFLARE_RPC_URL。 
.url("http://ny.rpc.orbitflare.com")
.urls(&[...]) — 一次设置主端点与所有备用端点。第一个元素为主端点，其余为备用。 
.urls(&["http://ny.rpc.orbitflare.com", "http://fra.rpc.orbitflare.com", "http://ams.rpc.orbitflare.com"])
.fallback_url(url) — 添加单个备用端点。可多次调用以添加多个。主端点失败时，SDK 按顺序尝试备用端点。 
.fallback_url("http://fra.rpc.orbitflare.com")
.fallback_url("http://ams.rpc.orbitflare.com")
.fallback_urls(&[...]) — 与 fallback_url 相同，但接受切片。 
.fallback_urls(&["http://fra.rpc.orbitflare.com", "http://ams.rpc.orbitflare.com"])
.api_key(key) — OrbitFlare 许可证密钥。若未设置，SDK 从环境读取 ORBITFLARE_LICENSE_KEY。密钥在请求时注入 URL，不会存储在端点字符串中。 
.api_key("ORBIT-XXXXXX-NNNNNN-NNNNNN")
.commitment(level) — 所有类型化辅助方法的默认承诺级别。可选："processed"、"confirmed"、"finalized"。默认为 "confirmed"。 
.commitment("finalized")
.retry(policy) — 控制失败请求的重试策略。initial_delay 为首次重试前等待时间。multiplier 为每次尝试的延迟倍数。max_delay 为上退避上限。max_attempts 限制每个端点的总重试次数（0 表示无限）。默认：初始 100ms、最大 30s、2 倍乘数、无限次尝试。 
use orbitflare_sdk::RetryPolicy;
use std::time::Duration;

.retry(RetryPolicy {
    initial_delay: Duration::from_millis(200),
    max_delay: Duration::from_secs(15),
    multiplier: 2.0,
    max_attempts: 5,
})
.timeout(duration) — 单次 HTTP 请求超时。默认 30 秒。 
.timeout(Duration::from_secs(10))

​
可用 RPC 方法

​
get_slot()

返回当前槽位号。 
let slot: u64 = client.get_slot().await?;

​
get_balance(address)

返回账户余额（lamports）。 
let lamports: u64 = client.get_balance("So11111111111111111111111111111111111111112").await?;
let sol = lamports as f64 / 1_000_000_000.0;

​
get_account_info(address)

返回完整账户数据；若账户不存在则返回 None。数据为 base64 编码。 
let account: Option<serde_json::Value> = client.get_account_info("EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v").await?;
if let Some(info) = account {
    println!("owner: {}", info["owner"]);
    println!("lamports: {}", info["lamports"]);
    println!("data length: {}", info["data"][0].as_str().unwrap_or("").len());
}

​
get_multiple_accounts(addresses)

一次调用获取多个账户。自动按每批 100 个地址分块（Solana 单次请求限制），因此可传入任意数量地址。 
let accounts: Vec<Option<serde_json::Value>> = client
    .get_multiple_accounts(&["addr1", "addr2", "addr3"])
    .await?;

for (i, acct) in accounts.iter().enumerate() {
    match acct {
        Some(info) => println!("account {i}: {} lamports", info["lamports"]),
        None => println!("account {i}: not found"),
    }
}

​
get_latest_blockhash()

返回最新区块哈希及其有效截止的最后区块高度。 
let (blockhash, last_valid_block_height): (String, u64) = client.get_latest_blockhash().await?;

​
get_transaction(signature)

按签名拉取已确认交易。返回含元数据的完整交易。 
let tx: serde_json::Value = client.get_transaction("5K8F2j...").await?;
println!("slot: {}", tx["slot"]);
println!("fee: {}", tx["meta"]["fee"]);

​
get_signatures_for_address(address, limit)

返回某地址的最近交易签名，按时间从新到旧。 
let sigs: Vec<serde_json::Value> = client
    .get_signatures_for_address("So111...", 10)
    .await?;

for sig in &sigs {
    println!("{} at slot {}", sig["signature"], sig["slot"]);
}

​
get_program_accounts(program_id)

返回某程序拥有的全部账户。可能返回大量数据。 
let accounts: Vec<serde_json::Value> = client
    .get_program_accounts("TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA")
    .await?;

​
get_recent_prioritization_fees(addresses)

返回一组账户的近期优先费用样本。可用于估算计算单元定价。 
let fees: Vec<serde_json::Value> = client
    .get_recent_prioritization_fees(&["6EF8rrecthR5Dkzon8Nwu78hRvfCKubJ14M5uBEwF6P"])
    .await?;

for fee in &fees {
    println!("slot {}: {} micro-lamports", fee["slot"], fee["prioritizationFee"]);
}

​
send_transaction(tx_base64)

向网络提交已签名交易。参数为 base64 序列化交易。返回交易签名。 
let signature: String = client.send_transaction(tx_base64).await?;
println!("sent: {signature}");

​
simulate_transaction(tx_base64)

模拟交易而不提交。返回日志、消耗的计算单元及任何错误。 
let result: serde_json::Value = client.simulate_transaction(tx_base64).await?;
if let Some(err) = result["err"].as_str() {
    println!("simulation failed: {err}");
} else {
    println!("compute units: {}", result["unitsConsumed"]);
}

​
get_token_accounts_by_owner(owner, mint, program_id)

返回钱包的代币账户。可传入特定 mint 或代币程序 ID。若两者均为 None，默认使用 SPL Token 程序。 
let tokens: Vec<serde_json::Value> = client
    .get_token_accounts_by_owner("wallet_address", None, None)
    .await?;

for token in &tokens {
    let info = &token["account"]["data"]["parsed"]["info"];
    println!("mint: {} balance: {}",
        info["mint"],
        info["tokenAmount"]["uiAmountString"],
    );
}

​
get_transactions_for_address(address, options)

OrbitFlare 特有方法：将 getSignaturesForAddress 与 getTransaction 合并为一次调用。返回 GetTransactionsResult，包含 data 数组及用于下一页的可选 pagination_token。 支持四种详情级别（signatures、none、accounts、full）、双向排序、时间/槽位过滤、状态过滤及代币账户包含选项。 
use orbitflare_sdk::{GetTransactionsOptions, GetTransactionsFilters, RangeFilter};

let result = client.get_transactions_for_address(
    "address",
    GetTransactionsOptions::new()
        .transaction_details("full")
        .limit(100)
        .sort_order("asc")
        .filters(
            GetTransactionsFilters::new()
                .token_accounts("all")
                .status("succeeded")
                .block_time(RangeFilter {
                    gte: Some(1704067200),
                    lte: Some(1706745600),
                    ..Default::default()
                })
        ),
).await?;

for tx in &result.data {
    println!("slot {}", tx["slot"]);
}

if let Some(token) = result.pagination_token {
    // fetch next page using .pagination_token(&token)
}

​
request(method, params)

按名称调用任意 RPC 方法。SDK 构建 JSON-RPC 信封，处理重试与故障转移，并返回 result 字段。 
use serde_json::json;

let epoch = client.request("getEpochInfo", json!([])).await?;
let inflation = client.request("getInflationRate", json!([])).await?;
let supply = client.request("getSupply", json!([])).await?;

​
request_raw(body)

发送原始 JSON-RPC 请求体字符串。重试与故障转移行为与其他方法相同。 
let result = client
    .request_raw(r#"{"jsonrpc":"2.0","id":1,"method":"getHealth","params":[]}"#)
    .await?;

​
完整示例

以下脚本检查网络状态、查询钱包 SOL 余额与代币持仓，并查看最近交易。 
use orbitflare_sdk::{RpcClientBuilder, Result};

#[tokio::main]
async fn main() -> Result<()> {
    let client = RpcClientBuilder::new()
        .url("http://ny.rpc.orbitflare.com")
        .fallback_url("http://fra.rpc.orbitflare.com")
        .commitment("confirmed")
        .build()?;

    let wallet = "CKs1E69a2e9TmH4mKKLrXFF8kD3ZnwKjoEuXa6sz9WqX";

    let slot = client.get_slot().await?;
    let (blockhash, _) = client.get_latest_blockhash().await?;
    println!("network slot: {slot}");
    println!("blockhash: {blockhash}");

    let balance = client.get_balance(wallet).await?;
    println!("\n{wallet}");
    println!("  SOL: {:.4}", balance as f64 / 1_000_000_000.0);

    let tokens = client.get_token_accounts_by_owner(wallet, None, None).await?;
    for token in &tokens {
        let info = &token["account"]["data"]["parsed"]["info"];
        let mint = info["mint"].as_str().unwrap_or("unknown");
        let amount = info["tokenAmount"]["uiAmountString"].as_str().unwrap_or("0");
        if amount != "0" {
            println!("  {mint}: {amount}");
        }
    }

    let sigs = client.get_signatures_for_address(wallet, 5).await?;
    println!("\nrecent transactions:");
    for sig in &sigs {
        let signature = sig["signature"].as_str().unwrap_or("?");
        let slot = sig["slot"].as_u64().unwrap_or(0);
        let err = if sig["err"].is_null() { "ok" } else { "failed" };
        println!("  {slot} {err} {}", &signature[..20]);
    }

    let fees = client
        .get_recent_prioritization_fees(&[wallet])
        .await?;
    let avg: f64 = fees.iter()
        .filter_map(|f| f["prioritizationFee"].as_f64())
        .sum::<f64>() / fees.len().max(1) as f64;
    println!("\navg priority fee: {avg:.0} micro-lamports");

    Ok(())
}