solana-account 4.5.0

Solana Account type
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

#![cfg_attr(feature = "frozen-abi", feature(min_specialization))]
#![cfg_attr(docsrs, feature(doc_cfg))]
//! The Solana [`Account`] type.

#[cfg(feature = "frozen-abi")]
use solana_frozen_abi_macro::{frozen_abi, AbiExample, StableAbi, StableAbiSample};
use {solana_clock::Epoch, solana_pubkey::Pubkey, std::sync::Arc};

mod account;
pub use account::*;

#[cfg(feature = "serde")]
mod serde;

#[cfg(any(feature = "bincode", feature = "wincode"))]
pub mod state_traits;

// wincode config used by the `state_traits::wincode` trait. The wire format matches
// bincode byte-for-byte; the only deliberate difference is raising the preallocation
// guard to the max account data length so valid accounts are never rejected. This gates
// only the prealloc check, not the encoded bytes.
//
// Mirrors `solana_system_interface::MAX_PERMITTED_DATA_LENGTH` (kept in sync by the
// assertion below) so `solana-system-interface` stays a dev-only dependency.
#[cfg(feature = "wincode")]
const WINCODE_PREALLOC_LIMIT: usize = 10 * 1024 * 1024;
#[cfg(all(test, feature = "wincode"))]
const _: () =
    assert!(WINCODE_PREALLOC_LIMIT as u64 == solana_system_interface::MAX_PERMITTED_DATA_LENGTH);
#[cfg(feature = "wincode")]
pub(crate) type WincodeConfig = wincode::config::Configuration<true, WINCODE_PREALLOC_LIMIT>;
#[cfg(feature = "wincode")]
pub(crate) const WINCODE_CONFIG: WincodeConfig = wincode::config::Configuration::default()
    .with_preallocation_size_limit::<WINCODE_PREALLOC_LIMIT>(
);

// NOTE: `Account` and `AccountSharedData` are defined here, in the crate root, on
// purpose. The frozen-abi digest of any downstream struct that has an
// `Account`/`AccountSharedData` field hashes that field's fully-qualified
// `std::any::type_name`, so the definitions must stay at `solana_account::*` to keep
// `type_name` (and therefore those digests) stable. Everything else (impls, traits,
// helpers) lives in the `account` module.

/// An Account with data that is stored on chain
#[repr(C)]
#[cfg_attr(
    feature = "frozen-abi",
    derive(AbiExample, StableAbi, StableAbiSample),
    frozen_abi(
        api_digest = "62EqVoynUFvuui7DVfqWCvZP7bxKGJGioeSBnWrdjRME",
        abi_digest = "G4phLpfhujMpk4wS1WswCe4HqnQjCBPWjrXjvDZ6iUw8"
    )
)]
#[cfg_attr(
    feature = "serde",
    derive(serde_derive::Deserialize),
    serde(rename_all = "camelCase")
)]
#[cfg_attr(feature = "wincode", derive(wincode::SchemaRead, wincode::SchemaWrite))]
#[derive(PartialEq, Eq, Clone, Default)]
pub struct Account {
    /// lamports in the account
    pub lamports: u64,
    /// data held in this account
    #[cfg_attr(feature = "serde", serde(with = "serde_bytes"))]
    #[cfg_attr(
        feature = "frozen-abi",
        stable_abi_sample(
            with = "(0..rng.random_range(0..=1000)).map(|_| rng.random()).collect()"
        )
    )]
    pub data: Vec<u8>,
    /// the program that owns this account. If executable, the program that loads this account.
    pub owner: Pubkey,
    /// this account's data contains a loaded program (and is now read-only)
    pub executable: bool,
    /// the epoch at which this account will next owe rent
    pub rent_epoch: Epoch,
}

/// An Account with data that is stored on chain
/// This will be the in-memory representation of the 'Account' struct data.
/// The existing 'Account' structure cannot easily change due to downstream projects.
#[cfg_attr(feature = "frozen-abi", derive(AbiExample, StableAbi, StableAbiSample))]
#[cfg_attr(
    feature = "serde",
    derive(serde_derive::Deserialize),
    serde(from = "Account")
)]
#[cfg_attr(feature = "wincode", derive(wincode::SchemaRead, wincode::SchemaWrite))]
#[derive(PartialEq, Eq, Clone, Default)]
pub struct AccountSharedData {
    /// lamports in the account
    lamports: u64,
    /// data held in this account
    data: Arc<Vec<u8>>,
    /// the program that owns this account. If executable, the program that loads this account.
    owner: Pubkey,
    /// this account's data contains a loaded program (and is now read-only)
    executable: bool,
    /// the epoch at which this account will next owe rent
    rent_epoch: Epoch,
}