Rust API 参考

surfpool-sdk crate 提供了以 Surfnet 结构体为核心的精简接口。本页列出所有公共项目；如需了解使用说明，请参阅从概述开始的指南。

Crate 根导出

项目	类型	说明
`Surfnet`	结构体	运行中的 Surfnet 实例 — RPC/WS 端点、付款方、作弊码
`SurfnetBuilder`	结构体	供 `Surfnet::builder()` 使用的链式构建器
`Cheatcodes<'_>`	结构体	由 `Surfnet::cheatcodes()` 返回的借用作弊码辅助器
`SurfnetError`	枚举	SDK 返回的所有错误变体
`SurfnetResult<T>`	类型别名	`Result<T, SurfnetError>`
`Keypair`	重导出	`solana_keypair::Keypair`
`Pubkey`	重导出	`solana_pubkey::Pubkey`
`Signer`	重导出	`solana_signer::Signer`
`RpcClient`	重导出	`solana_rpc_client::rpc_client::RpcClient`
`BlockProductionMode`	重导出	`surfpool_types::BlockProductionMode`
`SimnetCommand`	重导出	`surfpool_types::SimnetCommand`
`SimnetEvent`	重导出	`surfpool_types::SimnetEvent`
`SvmFeatureConfig`	重导出	`surfpool_types::SvmFeatureConfig`

Surfnet

pub struct Surfnet { /* private */ }

构造函数

impl Surfnet {
    pub async fn start() -> SurfnetResult<Self>;
    pub fn builder() -> SurfnetBuilder;
}

访问器

impl Surfnet {
    pub fn rpc_url(&self) -> &str;
    pub fn ws_url(&self) -> &str;
    pub fn payer(&self) -> &Keypair;
    pub fn instance_id(&self) -> &str;
    pub fn rpc_client(&self) -> RpcClient;
    pub fn cheatcodes(&self) -> Cheatcodes<'_>;
    pub fn events(&self) -> &crossbeam_channel::Receiver<SimnetEvent>;
    pub fn send_command(&self, cmd: SimnetCommand) -> SurfnetResult<()>;
}

生命周期

impl Surfnet {
    pub fn stop(&mut self) -> SurfnetResult<()>;
}

impl Drop for Surfnet { /* calls stop() if not already stopped */ }

stop 最多等待五秒，等待运行时释放其端口。Drop 期间的失败会被静默忽略；显式调用 stop 时的失败则返回 SurfnetError::Runtime。

SurfnetBuilder

pub struct SurfnetBuilder { /* private */ }

每个 setter 均返回 Self，因此可以链式调用。终止调用为 start().await。

impl SurfnetBuilder {
    pub fn offline(self, offline: bool) -> Self;
    pub fn remote_rpc_url(self, url: impl Into<String>) -> Self;
    pub fn block_production_mode(self, mode: BlockProductionMode) -> Self;
    pub fn slot_time_ms(self, ms: u64) -> Self;
    pub fn airdrop_addresses(self, addrs: Vec<Pubkey>) -> Self;
    pub fn airdrop_sol(self, lamports: u64) -> Self;
    pub fn skip_blockhash_check(self, skip: bool) -> Self;
    pub fn payer(self, payer: Keypair) -> Self;
    pub fn enable_feature(self, feature_id: Pubkey) -> Self;
    pub fn disable_feature(self, feature_id: Pubkey) -> Self;
    pub fn feature_config(self, config: SvmFeatureConfig) -> Self;
    pub async fn start(self) -> SurfnetResult<Surfnet>;
}

作弊码

pub struct Cheatcodes<'a> { /* private */ }

SOL 资金充值

impl<'a> Cheatcodes<'a> {
    pub fn fund_sol(&self, address: &Pubkey, lamports: u64) -> SurfnetResult<()>;
    pub fn fund_sol_many(&self, accounts: &[(&Pubkey, u64)]) -> SurfnetResult<()>;
}

代币资金充值

impl<'a> Cheatcodes<'a> {
    pub fn fund_token(
        &self,
        owner: &Pubkey,
        mint: &Pubkey,
        amount: u64,
        token_program: Option<&Pubkey>,
    ) -> SurfnetResult<()>;

    pub fn fund_token_many(
        &self,
        owners: &[&Pubkey],
        mint: &Pubkey,
        amount: u64,
        token_program: Option<&Pubkey>,
    ) -> SurfnetResult<()>;

    pub fn set_token_balance(
        &self,
        owner: &Pubkey,
        mint: &Pubkey,
        amount: u64,
        token_program: Option<&Pubkey>,
    ) -> SurfnetResult<()>;

    pub fn get_ata(
        &self,
        owner: &Pubkey,
        mint: &Pubkey,
        token_program: Option<&Pubkey>,
    ) -> Pubkey;
}

账户变更

impl<'a> Cheatcodes<'a> {
    pub fn set_account(
        &self,
        address: &Pubkey,
        lamports: u64,
        data: &[u8],
        owner: &Pubkey,
    ) -> SurfnetResult<()>;

    pub fn execute<B: CheatcodeBuilder>(&self, builder: B) -> SurfnetResult<()>;
}

时间旅行

impl<'a> Cheatcodes<'a> {
    pub fn time_travel_to_slot(&self, slot: u64) -> SurfnetResult<EpochInfo>;
    pub fn time_travel_to_epoch(&self, epoch: u64) -> SurfnetResult<EpochInfo>;
    pub fn time_travel_to_timestamp(&self, timestamp_ms: u64) -> SurfnetResult<EpochInfo>;
}

程序部署

impl<'a> Cheatcodes<'a> {
    pub fn deploy_program(&self, program_name: &str) -> SurfnetResult<Pubkey>;
    pub fn deploy(&self, builder: DeployProgram) -> SurfnetResult<Pubkey>;
}

CheatcodeBuilder Trait

pub trait CheatcodeBuilder {
    const METHOD: &'static str;
    fn build(self) -> serde_json::Value;
}

为尚未由类型化构建器封装的自定义 JSON-RPC 作弊码实现此接口。

构建器

所有构建器均位于 surfpool_sdk::cheatcodes::builders 中。

SetAccount

pub struct SetAccount { /* private */ }

impl SetAccount {
    pub fn new(address: Pubkey) -> Self;
    pub fn lamports(self, lamports: u64) -> Self;
    pub fn data(self, data: Vec<u8>) -> Self;
    pub fn owner(self, owner: Pubkey) -> Self;
    pub fn rent_epoch(self, epoch: u64) -> Self;
    pub fn executable(self, executable: bool) -> Self;
}

SetTokenAccount

pub struct SetTokenAccount { /* private */ }

impl SetTokenAccount {
    pub fn new(owner: Pubkey, mint: Pubkey) -> Self;
    pub fn amount(self, amount: u64) -> Self;
    pub fn delegate(self, delegate: Pubkey) -> Self;
    pub fn clear_delegate(self) -> Self;
    pub fn state(self, state: impl Into<String>) -> Self;
    pub fn delegated_amount(self, amount: u64) -> Self;
    pub fn close_authority(self, authority: Pubkey) -> Self;
    pub fn clear_close_authority(self) -> Self;
    pub fn token_program(self, program: Pubkey) -> Self;
}

ResetAccount

pub struct ResetAccount { /* private */ }

impl ResetAccount {
    pub fn new(address: Pubkey) -> Self;
    pub fn include_owned_accounts(self, include: bool) -> Self;
}

StreamAccount

pub struct StreamAccount { /* private */ }

impl StreamAccount {
    pub fn new(address: Pubkey) -> Self;
    pub fn include_owned_accounts(self, include: bool) -> Self;
}

DeployProgram

pub struct DeployProgram { /* private */ }

impl DeployProgram {
    pub fn new(program_id: Pubkey) -> Self;
    pub fn from_keypair_path(path: impl AsRef<Path>) -> SurfnetResult<Self>;
    pub fn so_path(self, path: impl Into<PathBuf>) -> Self;
    pub fn so_bytes(self, bytes: Vec<u8>) -> Self;
    pub fn idl_path(self, path: impl Into<PathBuf>) -> Self;
}

SurfnetError

#[derive(Debug)]
pub enum SurfnetError {
    PortAllocation(String),
    Startup(String),
    Runtime(String),
    Cheatcode(String),
    Aborted(String),
}

变体	原因
`PortAllocation`	无法绑定到可用的 RPC 或 WebSocket 端口。
`Startup`	运行时初始化失败。
`Runtime`	运行时线程发生 panic 或意外退出。
`Cheatcode`	作弊码 JSON-RPC 调用返回错误。
`Aborted`	运行时在启动期间被关闭或取消。

该 crate 在 SurfnetError 上实现了 std::error::Error 和 Display，因此可开箱即用地与 ? 和 anyhow 配合使用。

Table of Contents