solana-sysvar 4.1.0

Solana sysvar account types
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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112

//! Current cluster fees.
//!
//! The _fees sysvar_ provides access to the [`Fees`] type, which contains the
//! current [`FeeCalculator`].
//!
//! [`Fees`] implements [`crate::Sysvar::get`] and can be loaded efficiently without
//! passing the sysvar account ID to the program.
//!
//! This sysvar is deprecated and will not be available in the future.
//! Transaction fees should be determined with the [`getFeeForMessage`] RPC
//! method. For additional context see the [Comprehensive Compute Fees
//! proposal][ccf].
//!
//! [`getFeeForMessage`]: https://solana.com/docs/rpc/http/getfeeformessage
//! [ccf]: https://docs.solanalabs.com/proposals/comprehensive-compute-fees
//!
//! See also the Solana [documentation on the fees sysvar][sdoc].
//!
//! [sdoc]: https://docs.solanalabs.com/runtime/sysvars#fees

#![allow(deprecated)]

#[cfg(feature = "bincode")]
use crate::SysvarSerialize;
#[cfg(feature = "serde")]
use serde_derive::{Deserialize, Serialize};
pub use solana_sdk_ids::sysvar::fees::{check_id, id, ID};
#[cfg(target_os = "solana")]
use {solana_define_syscall::definitions, solana_program_entrypoint::SUCCESS};
use {
    solana_fee_calculator::FeeCalculator, solana_get_sysvar::GetSysvar,
    solana_sdk_macro::CloneZeroed, solana_sysvar_id::impl_deprecated_sysvar_id,
};

impl_deprecated_sysvar_id!(Fees);

/// Transaction fees.
#[deprecated(
    since = "1.9.0",
    note = "Please do not use, will no longer be available in the future"
)]
#[repr(C)]
#[cfg_attr(feature = "serde", derive(Deserialize, Serialize))]
#[cfg_attr(feature = "wincode", derive(wincode::SchemaWrite, wincode::SchemaRead))]
#[derive(Debug, CloneZeroed, Default, PartialEq, Eq)]
pub struct Fees {
    pub fee_calculator: FeeCalculator,
}

/// Serialized size of `Fees` sysvar account.
pub const SIZE: usize = size_of::<Fees>();
const _: () = assert!(SIZE == 8);

impl Fees {
    pub fn new(fee_calculator: &FeeCalculator) -> Self {
        #[allow(deprecated)]
        Self {
            fee_calculator: *fee_calculator,
        }
    }
}

// DEPRECATED: This impl is only for the deprecated Fees sysvar and should be
// removed once Fees is no longer in use. It uses the old-style direct syscall
// approach instead of the new sol_get_sysvar syscall.
impl GetSysvar for Fees {
    fn get() -> Result<Self, solana_program_error::ProgramError> {
        #[cfg(target_os = "solana")]
        {
            let mut fees = Self::default();
            let fees_addr = &mut fees as *mut _ as *mut u8;
            let result = unsafe { definitions::sol_get_fees_sysvar(fees_addr) };

            match result {
                SUCCESS => Ok(fees),
                _ => Err(solana_program_error::ProgramError::UnsupportedSysvar),
            }
        }

        #[cfg(not(target_os = "solana"))]
        {
            Err(solana_program_error::ProgramError::UnsupportedSysvar)
        }
    }
}

#[cfg(feature = "bincode")]
impl SysvarSerialize for Fees {}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_size_of() {
        assert_eq!(
            wincode::serialized_size(&Fees::default()).unwrap() as usize,
            SIZE,
        );
    }

    #[test]
    fn test_clone() {
        let fees = Fees {
            fee_calculator: FeeCalculator {
                lamports_per_signature: 1,
            },
        };
        let cloned_fees = fees.clone();
        assert_eq!(cloned_fees, fees);
    }
}