Skip to main content

quicknode_sdk/admin/
api_credits.rs

1#[cfg(feature = "node")]
2use napi_derive::napi;
3#[cfg(feature = "python")]
4use pyo3::pyclass;
5#[cfg(feature = "python")]
6use pyo3_stub_gen::derive::gen_stub_pyclass;
7use serde::{Deserialize, Serialize};
8
9/// The API credit cost of a single RPC method on a chain.
10#[cfg_attr(feature = "python", gen_stub_pyclass)]
11#[cfg_attr(feature = "python", pyclass(get_all, set_all))]
12#[cfg_attr(feature = "node", napi(object))]
13#[derive(Debug, Clone, Serialize, Deserialize)]
14pub struct ApiCredit {
15    /// RPC method name (e.g. `eth_chainId`).
16    pub method: String,
17    /// Number of API credits the method costs.
18    pub credits: i64,
19}
20
21/// Response from `get_api_credits`.
22#[cfg_attr(feature = "python", gen_stub_pyclass)]
23#[cfg_attr(feature = "python", pyclass(get_all, set_all))]
24#[cfg_attr(feature = "node", napi(object))]
25#[derive(Debug, Clone, Serialize, Deserialize)]
26pub struct GetApiCreditsResponse {
27    /// Per-method API credit costs for the chain, when the request succeeded.
28    /// `None` for an unknown chain slug.
29    pub data: Option<Vec<ApiCredit>>,
30    /// Error message when the request did not succeed.
31    pub error: Option<String>,
32}