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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
use borsh::maybestd::io::Write;
use std::slice::Iter;
use crate::{
addins::voter_weight::{
assert_is_valid_voter_weight, get_voter_weight_record_data_for_token_owner_record,
},
error::GovernanceError,
state::{
enums::GovernanceAccountType, governance::GovernanceConfig, legacy::TokenOwnerRecordV1,
realm::RealmV2, realm_config::get_realm_config_data_for_realm,
},
PROGRAM_AUTHORITY_SEED,
};
use borsh::{BorshDeserialize, BorshSchema, BorshSerialize};
use solana_program::{
account_info::{next_account_info, AccountInfo},
borsh::try_from_slice_unchecked,
program_error::ProgramError,
program_pack::IsInitialized,
pubkey::Pubkey,
};
use spl_governance_addin_api::voter_weight::VoterWeightAction;
use spl_governance_tools::account::{get_account_data, AccountMaxSize};
#[repr(C)]
#[derive(Clone, Debug, PartialEq, BorshDeserialize, BorshSerialize, BorshSchema)]
pub struct TokenOwnerRecordV2 {
pub account_type: GovernanceAccountType,
pub realm: Pubkey,
pub governing_token_mint: Pubkey,
pub governing_token_owner: Pubkey,
pub governing_token_deposit_amount: u64,
pub unrelinquished_votes_count: u32,
pub total_votes_count: u32,
pub outstanding_proposal_count: u8,
pub reserved: [u8; 7],
pub governance_delegate: Option<Pubkey>,
pub reserved_v2: [u8; 128],
}
impl AccountMaxSize for TokenOwnerRecordV2 {
fn get_max_size(&self) -> Option<usize> {
Some(282)
}
}
impl IsInitialized for TokenOwnerRecordV2 {
fn is_initialized(&self) -> bool {
self.account_type == GovernanceAccountType::TokenOwnerRecordV2
}
}
impl TokenOwnerRecordV2 {
pub fn assert_token_owner_or_delegate_is_signer(
&self,
governance_authority_info: &AccountInfo,
) -> Result<(), ProgramError> {
if governance_authority_info.is_signer {
if &self.governing_token_owner == governance_authority_info.key {
return Ok(());
}
if let Some(governance_delegate) = self.governance_delegate {
if &governance_delegate == governance_authority_info.key {
return Ok(());
}
};
}
Err(GovernanceError::GoverningTokenOwnerOrDelegateMustSign.into())
}
pub fn assert_can_create_proposal(
&self,
realm_data: &RealmV2,
config: &GovernanceConfig,
voter_weight: u64,
) -> Result<(), ProgramError> {
let min_weight_to_create_proposal =
if self.governing_token_mint == realm_data.community_mint {
config.min_community_weight_to_create_proposal
} else if Some(self.governing_token_mint) == realm_data.config.council_mint {
config.min_council_weight_to_create_proposal
} else {
return Err(GovernanceError::InvalidGoverningTokenMint.into());
};
if voter_weight < min_weight_to_create_proposal {
return Err(GovernanceError::NotEnoughTokensToCreateProposal.into());
}
if self.outstanding_proposal_count >= 10 {
return Err(GovernanceError::TooManyOutstandingProposals.into());
}
Ok(())
}
pub fn assert_can_create_governance(
&self,
realm_data: &RealmV2,
voter_weight: u64,
) -> Result<(), ProgramError> {
let min_weight_to_create_governance =
if self.governing_token_mint == realm_data.community_mint {
realm_data.config.min_community_weight_to_create_governance
} else if Some(self.governing_token_mint) == realm_data.config.council_mint {
1
} else {
return Err(GovernanceError::InvalidGoverningTokenMint.into());
};
if voter_weight < min_weight_to_create_governance {
return Err(GovernanceError::NotEnoughTokensToCreateGovernance.into());
}
Ok(())
}
pub fn assert_can_withdraw_governing_tokens(&self) -> Result<(), ProgramError> {
if self.unrelinquished_votes_count > 0 {
return Err(
GovernanceError::AllVotesMustBeRelinquishedToWithdrawGoverningTokens.into(),
);
}
if self.outstanding_proposal_count > 0 {
return Err(
GovernanceError::AllProposalsMustBeFinalisedToWithdrawGoverningTokens.into(),
);
}
Ok(())
}
pub fn decrease_outstanding_proposal_count(&mut self) {
if self.outstanding_proposal_count != 0 {
self.outstanding_proposal_count =
self.outstanding_proposal_count.checked_sub(1).unwrap();
}
}
#[allow(clippy::too_many_arguments)]
pub fn resolve_voter_weight(
&self,
program_id: &Pubkey,
realm_config_info: &AccountInfo,
account_info_iter: &mut Iter<AccountInfo>,
realm: &Pubkey,
realm_data: &RealmV2,
weight_action: VoterWeightAction,
weight_action_target: &Pubkey,
) -> Result<u64, ProgramError> {
if realm_data.config.use_community_voter_weight_addin
&& realm_data.community_mint == self.governing_token_mint
{
let voter_weight_record_info = next_account_info(account_info_iter)?;
let realm_config_data =
get_realm_config_data_for_realm(program_id, realm_config_info, realm)?;
let voter_weight_record_data = get_voter_weight_record_data_for_token_owner_record(
&realm_config_data.community_voter_weight_addin.unwrap(),
voter_weight_record_info,
self,
)?;
assert_is_valid_voter_weight(
&voter_weight_record_data,
weight_action,
weight_action_target,
)?;
Ok(voter_weight_record_data.voter_weight)
} else {
Ok(self.governing_token_deposit_amount)
}
}
pub fn serialize<W: Write>(self, writer: &mut W) -> Result<(), ProgramError> {
if self.account_type == GovernanceAccountType::TokenOwnerRecordV2 {
BorshSerialize::serialize(&self, writer)?
} else if self.account_type == GovernanceAccountType::TokenOwnerRecordV1 {
if self.reserved_v2 != [0; 128] {
panic!("Extended data not supported by TokenOwnerRecordV1")
}
let token_owner_record_data_v1 = TokenOwnerRecordV1 {
account_type: self.account_type,
realm: self.realm,
governing_token_mint: self.governing_token_mint,
governing_token_owner: self.governing_token_owner,
governing_token_deposit_amount: self.governing_token_deposit_amount,
unrelinquished_votes_count: self.unrelinquished_votes_count,
total_votes_count: self.total_votes_count,
outstanding_proposal_count: self.outstanding_proposal_count,
reserved: self.reserved,
governance_delegate: self.governance_delegate,
};
BorshSerialize::serialize(&token_owner_record_data_v1, writer)?;
}
Ok(())
}
}
pub fn get_token_owner_record_address(
program_id: &Pubkey,
realm: &Pubkey,
governing_token_mint: &Pubkey,
governing_token_owner: &Pubkey,
) -> Pubkey {
Pubkey::find_program_address(
&get_token_owner_record_address_seeds(realm, governing_token_mint, governing_token_owner),
program_id,
)
.0
}
pub fn get_token_owner_record_address_seeds<'a>(
realm: &'a Pubkey,
governing_token_mint: &'a Pubkey,
governing_token_owner: &'a Pubkey,
) -> [&'a [u8]; 4] {
[
PROGRAM_AUTHORITY_SEED,
realm.as_ref(),
governing_token_mint.as_ref(),
governing_token_owner.as_ref(),
]
}
pub fn get_token_owner_record_data(
program_id: &Pubkey,
token_owner_record_info: &AccountInfo,
) -> Result<TokenOwnerRecordV2, ProgramError> {
let account_type: GovernanceAccountType =
try_from_slice_unchecked(&token_owner_record_info.data.borrow())?;
if account_type == GovernanceAccountType::TokenOwnerRecordV1 {
let token_owner_record_data_v1 =
get_account_data::<TokenOwnerRecordV1>(program_id, token_owner_record_info)?;
return Ok(TokenOwnerRecordV2 {
account_type,
realm: token_owner_record_data_v1.realm,
governing_token_mint: token_owner_record_data_v1.governing_token_mint,
governing_token_owner: token_owner_record_data_v1.governing_token_owner,
governing_token_deposit_amount: token_owner_record_data_v1
.governing_token_deposit_amount,
unrelinquished_votes_count: token_owner_record_data_v1.unrelinquished_votes_count,
total_votes_count: token_owner_record_data_v1.total_votes_count,
outstanding_proposal_count: token_owner_record_data_v1.outstanding_proposal_count,
reserved: token_owner_record_data_v1.reserved,
governance_delegate: token_owner_record_data_v1.governance_delegate,
reserved_v2: [0; 128],
});
}
get_account_data::<TokenOwnerRecordV2>(program_id, token_owner_record_info)
}
pub fn get_token_owner_record_data_for_seeds(
program_id: &Pubkey,
token_owner_record_info: &AccountInfo,
token_owner_record_seeds: &[&[u8]],
) -> Result<TokenOwnerRecordV2, ProgramError> {
let (token_owner_record_address, _) =
Pubkey::find_program_address(token_owner_record_seeds, program_id);
if token_owner_record_address != *token_owner_record_info.key {
return Err(GovernanceError::InvalidTokenOwnerRecordAccountAddress.into());
}
get_token_owner_record_data(program_id, token_owner_record_info)
}
pub fn get_token_owner_record_data_for_realm(
program_id: &Pubkey,
token_owner_record_info: &AccountInfo,
realm: &Pubkey,
) -> Result<TokenOwnerRecordV2, ProgramError> {
let token_owner_record_data = get_token_owner_record_data(program_id, token_owner_record_info)?;
if token_owner_record_data.realm != *realm {
return Err(GovernanceError::InvalidRealmForTokenOwnerRecord.into());
}
Ok(token_owner_record_data)
}
pub fn get_token_owner_record_data_for_realm_and_governing_mint(
program_id: &Pubkey,
token_owner_record_info: &AccountInfo,
realm: &Pubkey,
governing_token_mint: &Pubkey,
) -> Result<TokenOwnerRecordV2, ProgramError> {
let token_owner_record_data =
get_token_owner_record_data_for_realm(program_id, token_owner_record_info, realm)?;
if token_owner_record_data.governing_token_mint != *governing_token_mint {
return Err(GovernanceError::InvalidGoverningMintForTokenOwnerRecord.into());
}
Ok(token_owner_record_data)
}
pub fn get_token_owner_record_data_for_proposal_owner(
program_id: &Pubkey,
token_owner_record_info: &AccountInfo,
proposal_owner: &Pubkey,
) -> Result<TokenOwnerRecordV2, ProgramError> {
if token_owner_record_info.key != proposal_owner {
return Err(GovernanceError::InvalidProposalOwnerAccount.into());
}
get_token_owner_record_data(program_id, token_owner_record_info)
}
#[cfg(test)]
mod test {
use solana_program::borsh::get_packed_len;
use super::*;
#[test]
fn test_max_size() {
let token_owner_record = TokenOwnerRecordV2 {
account_type: GovernanceAccountType::TokenOwnerRecordV2,
realm: Pubkey::new_unique(),
governing_token_mint: Pubkey::new_unique(),
governing_token_owner: Pubkey::new_unique(),
governing_token_deposit_amount: 10,
governance_delegate: Some(Pubkey::new_unique()),
unrelinquished_votes_count: 1,
total_votes_count: 1,
outstanding_proposal_count: 1,
reserved: [0; 7],
reserved_v2: [0; 128],
};
let size = get_packed_len::<TokenOwnerRecordV2>();
assert_eq!(token_owner_record.get_max_size(), Some(size));
}
}