spl-governance 4.0.0

Solana Program Library Governance Program
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
113
114
115
116
117
118
119

//! Proposal deposit account

use {
    crate::{error::GovernanceError, state::enums::GovernanceAccountType},
    borsh::{BorshDeserialize, BorshSchema, BorshSerialize},
    solana_program::{
        account_info::AccountInfo, program_error::ProgramError, program_pack::IsInitialized,
        pubkey::Pubkey,
    },
    spl_governance_tools::account::{get_account_data, AccountMaxSize},
};

/// Proposal deposit account
/// The account is used to limit spam of proposals
#[derive(Clone, Debug, PartialEq, BorshDeserialize, BorshSerialize, BorshSchema)]
pub struct ProposalDeposit {
    /// Governance account type
    pub account_type: GovernanceAccountType,

    /// The Proposal the deposit belongs to
    pub proposal: Pubkey,

    /// The account which payed for the deposit
    pub deposit_payer: Pubkey,

    /// Reserved
    pub reserved: [u8; 64],
}

impl AccountMaxSize for ProposalDeposit {
    fn get_max_size(&self) -> Option<usize> {
        Some(1 + 32 + 32 + 64)
    }
}

impl IsInitialized for ProposalDeposit {
    fn is_initialized(&self) -> bool {
        self.account_type == GovernanceAccountType::ProposalDeposit
    }
}

/// Returns ProposalDeposit PDA seeds
pub fn get_proposal_deposit_address_seeds<'a>(
    proposal: &'a Pubkey,
    proposal_deposit_payer: &'a Pubkey,
) -> [&'a [u8]; 3] {
    [
        b"proposal-deposit",
        proposal.as_ref(),
        proposal_deposit_payer.as_ref(),
    ]
}

/// Returns ProposalDeposit PDA address
pub fn get_proposal_deposit_address(
    program_id: &Pubkey,
    proposal: &Pubkey,
    proposal_deposit_payer: &Pubkey,
) -> Pubkey {
    Pubkey::find_program_address(
        &get_proposal_deposit_address_seeds(proposal, proposal_deposit_payer),
        program_id,
    )
    .0
}

/// Deserializes ProposalDeposit account and checks owner program and account
/// type
pub fn get_proposal_deposit_data(
    program_id: &Pubkey,
    proposal_deposit_info: &AccountInfo,
) -> Result<ProposalDeposit, ProgramError> {
    get_account_data::<ProposalDeposit>(program_id, proposal_deposit_info)
}

/// Deserializes ProposalDeposit account
/// 1) Checks owner program and account type
/// 2) Asserts it belongs to the given Proposal and deposit Payer
pub fn get_proposal_deposit_data_for_proposal_and_deposit_payer(
    program_id: &Pubkey,
    proposal_deposit_info: &AccountInfo,
    proposal: &Pubkey,
    proposal_deposit_payer: &Pubkey,
) -> Result<ProposalDeposit, ProgramError> {
    let proposal_deposit_data = get_proposal_deposit_data(program_id, proposal_deposit_info)?;

    if proposal_deposit_data.proposal != *proposal {
        return Err(GovernanceError::InvalidProposalForProposalDeposit.into());
    }

    if proposal_deposit_data.deposit_payer != *proposal_deposit_payer {
        return Err(GovernanceError::InvalidDepositPayerForProposalDeposit.into());
    }

    Ok(proposal_deposit_data)
}

#[cfg(test)]
mod test {

    use super::*;

    #[test]
    fn test_max_size() {
        // Arrange
        let proposal_deposit_data = ProposalDeposit {
            account_type: GovernanceAccountType::ProposalDeposit,
            proposal: Pubkey::new_unique(),
            deposit_payer: Pubkey::new_unique(),
            reserved: [0; 64],
        };

        // Act
        let size = proposal_deposit_data.try_to_vec().unwrap().len();

        // Assert
        assert_eq!(proposal_deposit_data.get_max_size(), Some(size));
    }
}