surfpool-sdk 1.3.1

SDK for embedding Surfpool in Rust integration tests
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

use solana_pubkey::Pubkey;

use crate::cheatcodes::builders::CheatcodeBuilder;

/// Builder for `surfnet_streamAccount`.
///
/// This builder starts with the required account address and can be extended
/// with optional streaming configuration before execution.
///
/// ```rust
/// use surfpool_sdk::{Pubkey, Surfnet};
/// use surfpool_sdk::cheatcodes::builders::StreamAccount;
///
/// # async fn example() {
/// let surfnet = Surfnet::start().await.unwrap();
/// let cheats = surfnet.cheatcodes();
/// let address = Pubkey::new_unique();
///
/// cheats
///     .execute(StreamAccount::new(address).include_owned_accounts(true))
///     .unwrap();
/// # }
/// ```
pub struct StreamAccount {
    address: Pubkey,
    include_owned_accounts: Option<bool>,
}

impl StreamAccount {
    /// Create a stream-account builder for the given address.
    pub fn new(address: Pubkey) -> Self {
        Self {
            address,
            include_owned_accounts: None,
        }
    }

    /// Include owned accounts when registering the streamed account.
    pub fn include_owned_accounts(mut self, include_owned_accounts: bool) -> Self {
        self.include_owned_accounts = Some(include_owned_accounts);
        self
    }
}

impl CheatcodeBuilder for StreamAccount {
    const METHOD: &'static str = "surfnet_streamAccount";

    /// Build the JSON-RPC parameter array for `surfnet_streamAccount`.
    fn build(self) -> serde_json::Value {
        let mut params = vec![self.address.to_string().into()];

        if let Some(include_owned_accounts) = self.include_owned_accounts {
            params.push(serde_json::json!({
                "includeOwnedAccounts": include_owned_accounts
            }));
        }

        serde_json::Value::Array(params)
    }
}