Struct SolanaClientRateLimit

pub struct SolanaClientRateLimit {
    pub endpoint_amounts: HashMap<RpcRequest, u64>,
    pub ignore_endpoints: HashSet<RpcRequest>,
    pub last_datetime: i64,
    pub interval: i64,
    pub consumed_amount: u64,
    pub maximum_amount: u64,
    pub default_amount_per_endpoint: u64,
}

Limit for rates like requests per second or compute units per interval.

Fields

endpoint_amounts: HashMap<RpcRequest, u64>

Map that contains the amount given to each endpoint.

ignore_endpoints: HashSet<RpcRequest>

Set of endpoints ignored by this limit.

last_datetime: i64

The last date this limit was updated.

interval: i64

Interval between rate resets expressed in milliseconds.

consumed_amount: u64

The number of requests or compute units already consumed in the current interval.

maximum_amount: u64

The maximum number of requests or compute units allowed per interval.

default_amount_per_endpoint: u64

The default amount for each endpoint if not specified in endpoint_amounts.

Implementations

impl SolanaClientRateLimit

pub fn new( interval: u64, maximum_amount: u64, default_amount_per_endpoint: u64, ) -> Self

Examples found in repository

examples/genesysgo.rs (lines 20-24)

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 21-25)

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_endpoint_amount(self, endpoint: RpcRequest, amount: u64) -> Self

Adds a RpcRequest to the map of endpoints to their amounts.

Examples found in repository

examples/genesysgo.rs (line 37)

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 27)

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 ignore_endpoint(self, endpoint: RpcRequest) -> Self

Adds a RpcRequest to the list of ignored endpoints.

Examples found in repository

examples/genesysgo.rs (line 26)

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);
}

pub fn ignores_all_endpoints(self) -> Self

Adds all RpcRequest to the list of ignored endpoints.

Examples found in repository

examples/genesysgo.rs (line 36)

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);
}

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

Checks whether the endpoint can be executed according to the current limits.

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

Checks whether the endpoints can be executed according to the current limits.

pub fn apply_endpoint(&mut self, endpoint: RpcRequest)

Applies the changes of executing the endpoint.

pub fn apply_endpoints(&mut self, endpoints: &[RpcRequest])

Applies the changes of executing the endpoints.

Trait Implementations

impl Debug for SolanaClientRateLimit

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.