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
use borsh::maybestd::io::Write;
use crate::{
error::GovernanceError,
state::{
enums::{GovernanceAccountType, VoteThresholdPercentage, VoteTipping},
legacy::{is_governance_v1_account_type, GovernanceV1},
realm::assert_is_valid_realm,
},
};
use borsh::{BorshDeserialize, BorshSchema, BorshSerialize};
use solana_program::{
account_info::AccountInfo, borsh::try_from_slice_unchecked, program_error::ProgramError,
program_pack::IsInitialized, pubkey::Pubkey,
};
use spl_governance_tools::{
account::{assert_is_valid_account_of_types, get_account_data, AccountMaxSize},
error::GovernanceToolsError,
};
#[repr(C)]
#[derive(Clone, Debug, PartialEq, BorshDeserialize, BorshSerialize, BorshSchema)]
pub struct GovernanceConfig {
pub vote_threshold_percentage: VoteThresholdPercentage,
pub min_community_weight_to_create_proposal: u64,
pub min_transaction_hold_up_time: u32,
pub max_voting_time: u32,
pub vote_tipping: VoteTipping,
pub proposal_cool_off_time: u32,
pub min_council_weight_to_create_proposal: u64,
}
#[repr(C)]
#[derive(Clone, Debug, PartialEq, BorshDeserialize, BorshSerialize, BorshSchema)]
pub struct GovernanceV2 {
pub account_type: GovernanceAccountType,
pub realm: Pubkey,
pub governed_account: Pubkey,
pub proposals_count: u32,
pub config: GovernanceConfig,
pub reserved: [u8; 6],
pub voting_proposal_count: u16,
pub reserved_v2: [u8; 128],
}
impl AccountMaxSize for GovernanceV2 {}
pub fn is_governance_v2_account_type(account_type: &GovernanceAccountType) -> bool {
match account_type {
GovernanceAccountType::GovernanceV2
| GovernanceAccountType::ProgramGovernanceV2
| GovernanceAccountType::MintGovernanceV2
| GovernanceAccountType::TokenGovernanceV2 => true,
GovernanceAccountType::Uninitialized
| GovernanceAccountType::RealmV1
| GovernanceAccountType::RealmV2
| GovernanceAccountType::RealmConfig
| GovernanceAccountType::TokenOwnerRecordV1
| GovernanceAccountType::TokenOwnerRecordV2
| GovernanceAccountType::GovernanceV1
| GovernanceAccountType::ProgramGovernanceV1
| GovernanceAccountType::MintGovernanceV1
| GovernanceAccountType::TokenGovernanceV1
| GovernanceAccountType::ProposalV1
| GovernanceAccountType::ProposalV2
| GovernanceAccountType::SignatoryRecordV1
| GovernanceAccountType::SignatoryRecordV2
| GovernanceAccountType::ProposalInstructionV1
| GovernanceAccountType::ProposalTransactionV2
| GovernanceAccountType::VoteRecordV1
| GovernanceAccountType::VoteRecordV2
| GovernanceAccountType::ProgramMetadata => false,
}
}
pub fn is_governance_account_type(account_type: &GovernanceAccountType) -> bool {
is_governance_v1_account_type(account_type) || is_governance_v2_account_type(account_type)
}
impl IsInitialized for GovernanceV2 {
fn is_initialized(&self) -> bool {
is_governance_v2_account_type(&self.account_type)
}
}
impl GovernanceV2 {
pub fn get_governance_address_seeds(&self) -> Result<[&[u8]; 3], ProgramError> {
let seeds = match self.account_type {
GovernanceAccountType::GovernanceV1 | GovernanceAccountType::GovernanceV2 => {
get_governance_address_seeds(&self.realm, &self.governed_account)
}
GovernanceAccountType::ProgramGovernanceV1
| GovernanceAccountType::ProgramGovernanceV2 => {
get_program_governance_address_seeds(&self.realm, &self.governed_account)
}
GovernanceAccountType::MintGovernanceV1 | GovernanceAccountType::MintGovernanceV2 => {
get_mint_governance_address_seeds(&self.realm, &self.governed_account)
}
GovernanceAccountType::TokenGovernanceV1 | GovernanceAccountType::TokenGovernanceV2 => {
get_token_governance_address_seeds(&self.realm, &self.governed_account)
}
GovernanceAccountType::Uninitialized
| GovernanceAccountType::RealmV1
| GovernanceAccountType::TokenOwnerRecordV1
| GovernanceAccountType::ProposalV1
| GovernanceAccountType::SignatoryRecordV1
| GovernanceAccountType::VoteRecordV1
| GovernanceAccountType::ProposalInstructionV1
| GovernanceAccountType::RealmConfig
| GovernanceAccountType::VoteRecordV2
| GovernanceAccountType::ProposalTransactionV2
| GovernanceAccountType::ProposalV2
| GovernanceAccountType::ProgramMetadata
| GovernanceAccountType::RealmV2
| GovernanceAccountType::TokenOwnerRecordV2
| GovernanceAccountType::SignatoryRecordV2 => {
return Err(GovernanceToolsError::InvalidAccountType.into())
}
};
Ok(seeds)
}
pub fn serialize<W: Write>(self, writer: &mut W) -> Result<(), ProgramError> {
if is_governance_v2_account_type(&self.account_type) {
BorshSerialize::serialize(&self, writer)?
} else if is_governance_v1_account_type(&self.account_type) {
if self.reserved_v2 != [0; 128] {
panic!("Extended data not supported by GovernanceV1")
}
let governance_data_v1 = GovernanceV1 {
account_type: self.account_type,
realm: self.realm,
governed_account: self.governed_account,
proposals_count: self.proposals_count,
config: self.config,
reserved: self.reserved,
voting_proposal_count: self.voting_proposal_count,
};
BorshSerialize::serialize(&governance_data_v1, writer)?;
}
Ok(())
}
}
pub fn get_governance_data(
program_id: &Pubkey,
governance_info: &AccountInfo,
) -> Result<GovernanceV2, ProgramError> {
if governance_info.data_is_empty() {
return Err(GovernanceToolsError::AccountDoesNotExist.into());
}
let account_type: GovernanceAccountType =
try_from_slice_unchecked(&governance_info.data.borrow())?;
if is_governance_v1_account_type(&account_type) {
let governance_data_v1 = get_account_data::<GovernanceV1>(program_id, governance_info)?;
return Ok(GovernanceV2 {
account_type,
realm: governance_data_v1.realm,
governed_account: governance_data_v1.governed_account,
proposals_count: governance_data_v1.proposals_count,
config: governance_data_v1.config,
reserved: governance_data_v1.reserved,
voting_proposal_count: governance_data_v1.voting_proposal_count,
reserved_v2: [0; 128],
});
}
get_account_data::<GovernanceV2>(program_id, governance_info)
}
pub fn get_governance_data_for_realm(
program_id: &Pubkey,
governance_info: &AccountInfo,
realm: &Pubkey,
) -> Result<GovernanceV2, ProgramError> {
let governance_data = get_governance_data(program_id, governance_info)?;
if governance_data.realm != *realm {
return Err(GovernanceError::InvalidRealmForGovernance.into());
}
Ok(governance_data)
}
pub fn assert_governance_for_realm(
program_id: &Pubkey,
governance_info: &AccountInfo,
realm: &Pubkey,
) -> Result<(), ProgramError> {
get_governance_data_for_realm(program_id, governance_info, realm)?;
Ok(())
}
pub fn get_program_governance_address_seeds<'a>(
realm: &'a Pubkey,
governed_program: &'a Pubkey,
) -> [&'a [u8]; 3] {
[
b"program-governance",
realm.as_ref(),
governed_program.as_ref(),
]
}
pub fn get_program_governance_address<'a>(
program_id: &Pubkey,
realm: &'a Pubkey,
governed_program: &'a Pubkey,
) -> Pubkey {
Pubkey::find_program_address(
&get_program_governance_address_seeds(realm, governed_program),
program_id,
)
.0
}
pub fn get_mint_governance_address_seeds<'a>(
realm: &'a Pubkey,
governed_mint: &'a Pubkey,
) -> [&'a [u8]; 3] {
[b"mint-governance", realm.as_ref(), governed_mint.as_ref()]
}
pub fn get_mint_governance_address<'a>(
program_id: &Pubkey,
realm: &'a Pubkey,
governed_mint: &'a Pubkey,
) -> Pubkey {
Pubkey::find_program_address(
&get_mint_governance_address_seeds(realm, governed_mint),
program_id,
)
.0
}
pub fn get_token_governance_address_seeds<'a>(
realm: &'a Pubkey,
governed_token: &'a Pubkey,
) -> [&'a [u8]; 3] {
[b"token-governance", realm.as_ref(), governed_token.as_ref()]
}
pub fn get_token_governance_address<'a>(
program_id: &Pubkey,
realm: &'a Pubkey,
governed_token: &'a Pubkey,
) -> Pubkey {
Pubkey::find_program_address(
&get_token_governance_address_seeds(realm, governed_token),
program_id,
)
.0
}
pub fn get_governance_address_seeds<'a>(
realm: &'a Pubkey,
governed_account: &'a Pubkey,
) -> [&'a [u8]; 3] {
[
b"account-governance",
realm.as_ref(),
governed_account.as_ref(),
]
}
pub fn get_governance_address<'a>(
program_id: &Pubkey,
realm: &'a Pubkey,
governed_account: &'a Pubkey,
) -> Pubkey {
Pubkey::find_program_address(
&get_governance_address_seeds(realm, governed_account),
program_id,
)
.0
}
pub fn assert_is_valid_governance(
program_id: &Pubkey,
governance_info: &AccountInfo,
) -> Result<(), ProgramError> {
assert_is_valid_account_of_types(program_id, governance_info, is_governance_account_type)
}
pub fn assert_valid_create_governance_args(
program_id: &Pubkey,
governance_config: &GovernanceConfig,
realm_info: &AccountInfo,
) -> Result<(), ProgramError> {
assert_is_valid_realm(program_id, realm_info)?;
assert_is_valid_governance_config(governance_config)?;
Ok(())
}
pub fn assert_is_valid_governance_config(
governance_config: &GovernanceConfig,
) -> Result<(), ProgramError> {
match governance_config.vote_threshold_percentage {
VoteThresholdPercentage::YesVote(yes_vote_threshold_percentage) => {
if !(1..=100).contains(&yes_vote_threshold_percentage) {
return Err(GovernanceError::InvalidVoteThresholdPercentage.into());
}
}
_ => {
return Err(GovernanceError::VoteThresholdPercentageTypeNotSupported.into());
}
}
if governance_config.proposal_cool_off_time > 0 {
return Err(GovernanceError::ProposalCoolOffTimeNotSupported.into());
}
Ok(())
}