kaspa-rpc-core 0.15.0

Kaspa RPC core
Documentation
use borsh::{BorshDeserialize, BorshSerialize};
use serde::{Deserialize, Serialize};
use workflow_serializer::prelude::*;

#[derive(Clone, Copy, Debug, Serialize, Deserialize, BorshSerialize, BorshDeserialize)]
#[serde(rename_all = "camelCase")]
pub struct RpcFeerateBucket {
    /// The fee/mass ratio estimated to be required for inclusion time <= estimated_seconds
    pub feerate: f64,

    /// The estimated inclusion time for a transaction with fee/mass = feerate
    pub estimated_seconds: f64,
}

#[derive(Clone, Debug, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct RpcFeeEstimate {
    /// *Top-priority* feerate bucket. Provides an estimation of the feerate required for sub-second DAG inclusion.
    ///
    /// Note: for all buckets, feerate values represent fee/mass of a transaction in `sompi/gram` units.
    /// Given a feerate value recommendation, calculate the required fee by
    /// taking the transaction mass and multiplying it by feerate: `fee = feerate * mass(tx)`
    pub priority_bucket: RpcFeerateBucket,

    /// A vector of *normal* priority feerate values. The first value of this vector is guaranteed to exist and
    /// provide an estimation for sub-*minute* DAG inclusion. All other values will have shorter estimation
    /// times than all `low_bucket` values. Therefor by chaining `[priority] | normal | low` and interpolating
    /// between them, one can compose a complete feerate function on the client side. The API makes an effort
    /// to sample enough "interesting" points on the feerate-to-time curve, so that the interpolation is meaningful.
    pub normal_buckets: Vec<RpcFeerateBucket>,

    /// A vector of *low* priority feerate values. The first value of this vector is guaranteed to
    /// exist and provide an estimation for sub-*hour* DAG inclusion.
    pub low_buckets: Vec<RpcFeerateBucket>,
}

impl RpcFeeEstimate {
    pub fn ordered_buckets(&self) -> Vec<RpcFeerateBucket> {
        std::iter::once(self.priority_bucket)
            .chain(self.normal_buckets.iter().copied())
            .chain(self.low_buckets.iter().copied())
            .collect()
    }
}

impl Serializer for RpcFeeEstimate {
    fn serialize<W: std::io::Write>(&self, writer: &mut W) -> std::io::Result<()> {
        store!(u16, &1, writer)?;
        store!(RpcFeerateBucket, &self.priority_bucket, writer)?;
        store!(Vec<RpcFeerateBucket>, &self.normal_buckets, writer)?;
        store!(Vec<RpcFeerateBucket>, &self.low_buckets, writer)?;
        Ok(())
    }
}

impl Deserializer for RpcFeeEstimate {
    fn deserialize<R: std::io::Read>(reader: &mut R) -> std::io::Result<Self> {
        let _version = load!(u16, reader)?;
        let priority_bucket = load!(RpcFeerateBucket, reader)?;
        let normal_buckets = load!(Vec<RpcFeerateBucket>, reader)?;
        let low_buckets = load!(Vec<RpcFeerateBucket>, reader)?;
        Ok(Self { priority_bucket, normal_buckets, low_buckets })
    }
}

#[derive(Clone, Debug, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct RpcFeeEstimateVerboseExperimentalData {
    pub mempool_ready_transactions_count: u64,
    pub mempool_ready_transactions_total_mass: u64,
    pub network_mass_per_second: u64,

    pub next_block_template_feerate_min: f64,
    pub next_block_template_feerate_median: f64,
    pub next_block_template_feerate_max: f64,
}

impl Serializer for RpcFeeEstimateVerboseExperimentalData {
    fn serialize<W: std::io::Write>(&self, writer: &mut W) -> std::io::Result<()> {
        store!(u16, &1, writer)?;
        store!(u64, &self.mempool_ready_transactions_count, writer)?;
        store!(u64, &self.mempool_ready_transactions_total_mass, writer)?;
        store!(u64, &self.network_mass_per_second, writer)?;
        store!(f64, &self.next_block_template_feerate_min, writer)?;
        store!(f64, &self.next_block_template_feerate_median, writer)?;
        store!(f64, &self.next_block_template_feerate_max, writer)?;
        Ok(())
    }
}

impl Deserializer for RpcFeeEstimateVerboseExperimentalData {
    fn deserialize<R: std::io::Read>(reader: &mut R) -> std::io::Result<Self> {
        let _version = load!(u16, reader)?;
        let mempool_ready_transactions_count = load!(u64, reader)?;
        let mempool_ready_transactions_total_mass = load!(u64, reader)?;
        let network_mass_per_second = load!(u64, reader)?;
        let next_block_template_feerate_min = load!(f64, reader)?;
        let next_block_template_feerate_median = load!(f64, reader)?;
        let next_block_template_feerate_max = load!(f64, reader)?;
        Ok(Self {
            mempool_ready_transactions_count,
            mempool_ready_transactions_total_mass,
            network_mass_per_second,
            next_block_template_feerate_min,
            next_block_template_feerate_median,
            next_block_template_feerate_max,
        })
    }
}