Rust APIリファレンス

surfpool-sdk クレートは、Surfnet 構造体を中心とした小さなサーフェスを公開しています。このページではすべてのパブリックアイテムを一覧表示しています。使用方法のガイドについては、概要から始まるガイドを参照してください。

クレートルートのエクスポート

アイテム	種類	備考
`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 はランタイムがポートを解放するまで最大5秒間待機します。Drop 中の失敗はサイレントです。明示的な stop 中の失敗は SurfnetError::Runtime を返します。

SurfnetBuilder

pub struct SurfnetBuilder { /* private */ }

すべてのセッターは 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 トレイト

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`	ランタイムスレッドがパニックまたは予期せず終了しました。
`Cheatcode`	チートコードの JSON-RPC 呼び出しがエラーを返しました。
`Aborted`	起動中にランタイムがシャットダウンまたはキャンセルされました。

このクレートは std::error::Error および Display を SurfnetError に実装しているため、? および anyhow とすぐに連携できます。

目次