Struct SolanaClientRpc

pub struct SolanaClientRpc {
    pub rpc_client: Arc<RpcClient>,
    pub limits: Vec<SolanaClientRateLimit>,
}

A single Solana RPC client. Includes its limits to calculate usage.

Fields

rpc_client: Arc<RpcClient>

limits: Vec<SolanaClientRateLimit>

The list of all limits applied to the RPC client. All limits must succeed in order to send a request.

Implementations

impl SolanaClientRpc

pub fn new(rpc_client: Arc<RpcClient>) -> Self

Creates a SolanaClientRpc without limits.

Examples found in repository

examples/genesysgo.rs (line 17)

async fn main() {
    let default_rpc = Arc::new(RpcClient::new(
        "https://api.mainnet-beta.solana.com".to_string(),
    ));
    let genesysgo_rpc = Arc::new(RpcClient::new("<your-genesysgo-rpc-url>".to_string()));
    let client = SolanaClient::new_with_default(default_rpc).add_rpc(
        SolanaClientRpc::new(genesysgo_rpc)
            // Requests per second limit.
            .add_limit(
                SolanaClientRateLimit::new(
                    1000, /* 1 second */
                    1,    /* 1 request per second */
                    1,    /* all requests count the same */
                )
                // Ignore GetMultipleAccounts requests here to track them in the next limit.
                .ignore_endpoint(RpcRequest::GetMultipleAccounts),
            )
            // Requests per second limit for GetMultipleAccounts.
            .add_limit(
                SolanaClientRateLimit::new(
                    60 * 1000, /* 1 minute */
                    6,         /* 6 request per minute */
                    1,         /* all requests count the same */
                )
                // Ignore all endpoints and include only GetMultipleAccounts requests here.
                .ignores_all_endpoints()
                .add_endpoint_amount(RpcRequest::GetMultipleAccounts, 1),
            ),
    );

    let version = client.get_version().await.unwrap();

    println!("Cluster version: {}", version.solana_core);
}

examples/quicknode.rs (line 18)

async fn main() {
    let default_rpc = Arc::new(RpcClient::new(
        "https://api.mainnet-beta.solana.com".to_string(),
    ));
    let quicknode_rpc = Arc::new(RpcClient::new("<your-quicknode-rpc-url>".to_string()));
    let client = SolanaClient::new_with_default(default_rpc).add_rpc(
        SolanaClientRpc::new(quicknode_rpc)
            // Credits / month limits.
            .add_limit(
                SolanaClientRateLimit::new(
                    30 * 24 * 60 * 60 * 1000, /* 30 days */
                    10_000_000,               /* credits per month */
                    1,                        /* default cost in credits for endpoints */
                )
                // List of all endpoints whose credits are different than the default value.
                .add_endpoint_amount(RpcRequest::GetAccountInfo, 2)
                .add_endpoint_amount(RpcRequest::GetBlockTime, 2)
                .add_endpoint_amount(RpcRequest::GetClusterNodes, 2)
                .add_endpoint_amount(RpcRequest::GetBlock, 23)
                .add_endpoint_amount(RpcRequest::GetEpochInfo, 2)
                .add_endpoint_amount(RpcRequest::GetFirstAvailableBlock, 3)
                .add_endpoint_amount(RpcRequest::GetHealth, 2)
                .add_endpoint_amount(RpcRequest::GetHighestSnapshotSlot, 2)
                .add_endpoint_amount(RpcRequest::GetInflationGovernor, 2)
                .add_endpoint_amount(RpcRequest::GetLatestBlockhash, 2)
                .add_endpoint_amount(RpcRequest::GetMinimumBalanceForRentExemption, 3)
                .add_endpoint_amount(RpcRequest::GetProgramAccounts, 35)
                .add_endpoint_amount(RpcRequest::GetRecentPerformanceSamples, 4)
                .add_endpoint_amount(RpcRequest::GetSignaturesForAddress, 3)
                .add_endpoint_amount(RpcRequest::GetTokenSupply, 2)
                .add_endpoint_amount(RpcRequest::GetTransaction, 3)
                .add_endpoint_amount(RpcRequest::GetVersion, 2)
                .add_endpoint_amount(RpcRequest::SimulateTransaction, 4)
                .add_endpoint_amount(RpcRequest::GetMultipleAccounts, 10)
                .add_endpoint_amount(RpcRequest::GetLargestAccounts, 259),
            )
            // Requests / second limit.
            .add_limit(SolanaClientRateLimit::new(
                1000, /* 1 second */
                25,   /* 25 requests per second */
                1,    /* all requests count the same */
            )),
    );

    let version = client.get_version().await.unwrap();

    println!("Cluster version: {}", version.solana_core);
}

pub fn add_limit(self, limit: SolanaClientRateLimit) -> Self

Adds a SolanaClientRateLimit to the list of limits.

Examples found in repository

examples/genesysgo.rs (lines 19-27)

async fn main() {
    let default_rpc = Arc::new(RpcClient::new(
        "https://api.mainnet-beta.solana.com".to_string(),
    ));
    let genesysgo_rpc = Arc::new(RpcClient::new("<your-genesysgo-rpc-url>".to_string()));
    let client = SolanaClient::new_with_default(default_rpc).add_rpc(
        SolanaClientRpc::new(genesysgo_rpc)
            // Requests per second limit.
            .add_limit(
                SolanaClientRateLimit::new(
                    1000, /* 1 second */
                    1,    /* 1 request per second */
                    1,    /* all requests count the same */
                )
                // Ignore GetMultipleAccounts requests here to track them in the next limit.
                .ignore_endpoint(RpcRequest::GetMultipleAccounts),
            )
            // Requests per second limit for GetMultipleAccounts.
            .add_limit(
                SolanaClientRateLimit::new(
                    60 * 1000, /* 1 minute */
                    6,         /* 6 request per minute */
                    1,         /* all requests count the same */
                )
                // Ignore all endpoints and include only GetMultipleAccounts requests here.
                .ignores_all_endpoints()
                .add_endpoint_amount(RpcRequest::GetMultipleAccounts, 1),
            ),
    );

    let version = client.get_version().await.unwrap();

    println!("Cluster version: {}", version.solana_core);
}

examples/quicknode.rs (lines 20-47)

async fn main() {
    let default_rpc = Arc::new(RpcClient::new(
        "https://api.mainnet-beta.solana.com".to_string(),
    ));
    let quicknode_rpc = Arc::new(RpcClient::new("<your-quicknode-rpc-url>".to_string()));
    let client = SolanaClient::new_with_default(default_rpc).add_rpc(
        SolanaClientRpc::new(quicknode_rpc)
            // Credits / month limits.
            .add_limit(
                SolanaClientRateLimit::new(
                    30 * 24 * 60 * 60 * 1000, /* 30 days */
                    10_000_000,               /* credits per month */
                    1,                        /* default cost in credits for endpoints */
                )
                // List of all endpoints whose credits are different than the default value.
                .add_endpoint_amount(RpcRequest::GetAccountInfo, 2)
                .add_endpoint_amount(RpcRequest::GetBlockTime, 2)
                .add_endpoint_amount(RpcRequest::GetClusterNodes, 2)
                .add_endpoint_amount(RpcRequest::GetBlock, 23)
                .add_endpoint_amount(RpcRequest::GetEpochInfo, 2)
                .add_endpoint_amount(RpcRequest::GetFirstAvailableBlock, 3)
                .add_endpoint_amount(RpcRequest::GetHealth, 2)
                .add_endpoint_amount(RpcRequest::GetHighestSnapshotSlot, 2)
                .add_endpoint_amount(RpcRequest::GetInflationGovernor, 2)
                .add_endpoint_amount(RpcRequest::GetLatestBlockhash, 2)
                .add_endpoint_amount(RpcRequest::GetMinimumBalanceForRentExemption, 3)
                .add_endpoint_amount(RpcRequest::GetProgramAccounts, 35)
                .add_endpoint_amount(RpcRequest::GetRecentPerformanceSamples, 4)
                .add_endpoint_amount(RpcRequest::GetSignaturesForAddress, 3)
                .add_endpoint_amount(RpcRequest::GetTokenSupply, 2)
                .add_endpoint_amount(RpcRequest::GetTransaction, 3)
                .add_endpoint_amount(RpcRequest::GetVersion, 2)
                .add_endpoint_amount(RpcRequest::SimulateTransaction, 4)
                .add_endpoint_amount(RpcRequest::GetMultipleAccounts, 10)
                .add_endpoint_amount(RpcRequest::GetLargestAccounts, 259),
            )
            // Requests / second limit.
            .add_limit(SolanaClientRateLimit::new(
                1000, /* 1 second */
                25,   /* 25 requests per second */
                1,    /* all requests count the same */
            )),
    );

    let version = client.get_version().await.unwrap();

    println!("Cluster version: {}", version.solana_core);
}

pub fn execute_endpoint(&mut self, endpoint: RpcRequest) -> bool

Process the execution of a Solana RPC endpoint.

pub fn execute_endpoints(&mut self, endpoints: &[RpcRequest]) -> bool

Process the execution of a Solana RPC endpoints.