/
state.rs
1462 lines (1330 loc) · 52.4 KB
/
state.rs
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
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
//! State transition types
use {
crate::{
big_vec::BigVec, error::StakePoolError, MAX_WITHDRAWAL_FEE_INCREASE,
WITHDRAWAL_BASELINE_FEE,
},
borsh::{BorshDeserialize, BorshSchema, BorshSerialize},
bytemuck::{Pod, Zeroable},
num_derive::{FromPrimitive, ToPrimitive},
num_traits::{FromPrimitive, ToPrimitive},
solana_program::{
account_info::AccountInfo,
borsh0_10::get_instance_packed_len,
msg,
program_error::ProgramError,
program_memory::sol_memcmp,
program_pack::{Pack, Sealed},
pubkey::{Pubkey, PUBKEY_BYTES},
stake::state::Lockup,
},
spl_pod::primitives::{PodU32, PodU64},
spl_token_2022::{
extension::{BaseStateWithExtensions, ExtensionType, StateWithExtensions},
state::{Account, AccountState, Mint},
},
std::{borrow::Borrow, convert::TryFrom, fmt, matches},
};
/// Enum representing the account type managed by the program
#[derive(Clone, Debug, Default, PartialEq, BorshDeserialize, BorshSerialize, BorshSchema)]
pub enum AccountType {
/// If the account has not been initialized, the enum will be 0
#[default]
Uninitialized,
/// Stake pool
StakePool,
/// Validator stake list
ValidatorList,
}
/// Initialized program details.
#[repr(C)]
#[derive(Clone, Debug, Default, PartialEq, BorshDeserialize, BorshSerialize, BorshSchema)]
pub struct StakePool {
/// Account type, must be StakePool currently
pub account_type: AccountType,
/// Manager authority, allows for updating the staker, manager, and fee
/// account
pub manager: Pubkey,
/// Staker authority, allows for adding and removing validators, and
/// managing stake distribution
pub staker: Pubkey,
/// Stake deposit authority
///
/// If a depositor pubkey is specified on initialization, then deposits must
/// be signed by this authority. If no deposit authority is specified,
/// then the stake pool will default to the result of:
/// `Pubkey::find_program_address(
/// &[&stake_pool_address.as_ref(), b"deposit"],
/// program_id,
/// )`
pub stake_deposit_authority: Pubkey,
/// Stake withdrawal authority bump seed
/// for `create_program_address(&[state::StakePool account, "withdrawal"])`
pub stake_withdraw_bump_seed: u8,
/// Validator stake list storage account
pub validator_list: Pubkey,
/// Reserve stake account, holds deactivated stake
pub reserve_stake: Pubkey,
/// Pool Mint
pub pool_mint: Pubkey,
/// Manager fee account
pub manager_fee_account: Pubkey,
/// Pool token program id
pub token_program_id: Pubkey,
/// Total stake under management.
/// Note that if `last_update_epoch` does not match the current epoch then
/// this field may not be accurate
pub total_lamports: u64,
/// Total supply of pool tokens (should always match the supply in the Pool
/// Mint)
pub pool_token_supply: u64,
/// Last epoch the `total_lamports` field was updated
pub last_update_epoch: u64,
/// Lockup that all stakes in the pool must have
pub lockup: Lockup,
/// Fee taken as a proportion of rewards each epoch
pub epoch_fee: Fee,
/// Fee for next epoch
pub next_epoch_fee: FutureEpoch<Fee>,
/// Preferred deposit validator vote account pubkey
pub preferred_deposit_validator_vote_address: Option<Pubkey>,
/// Preferred withdraw validator vote account pubkey
pub preferred_withdraw_validator_vote_address: Option<Pubkey>,
/// Fee assessed on stake deposits
pub stake_deposit_fee: Fee,
/// Fee assessed on withdrawals
pub stake_withdrawal_fee: Fee,
/// Future stake withdrawal fee, to be set for the following epoch
pub next_stake_withdrawal_fee: FutureEpoch<Fee>,
/// Fees paid out to referrers on referred stake deposits.
/// Expressed as a percentage (0 - 100) of deposit fees.
/// i.e. `stake_deposit_fee`% of stake deposited is collected as deposit
/// fees for every deposit and `stake_referral_fee`% of the collected
/// stake deposit fees is paid out to the referrer
pub stake_referral_fee: u8,
/// Toggles whether the `DepositSol` instruction requires a signature from
/// this `sol_deposit_authority`
pub sol_deposit_authority: Option<Pubkey>,
/// Fee assessed on SOL deposits
pub sol_deposit_fee: Fee,
/// Fees paid out to referrers on referred SOL deposits.
/// Expressed as a percentage (0 - 100) of SOL deposit fees.
/// i.e. `sol_deposit_fee`% of SOL deposited is collected as deposit fees
/// for every deposit and `sol_referral_fee`% of the collected SOL
/// deposit fees is paid out to the referrer
pub sol_referral_fee: u8,
/// Toggles whether the `WithdrawSol` instruction requires a signature from
/// the `deposit_authority`
pub sol_withdraw_authority: Option<Pubkey>,
/// Fee assessed on SOL withdrawals
pub sol_withdrawal_fee: Fee,
/// Future SOL withdrawal fee, to be set for the following epoch
pub next_sol_withdrawal_fee: FutureEpoch<Fee>,
/// Last epoch's total pool tokens, used only for APR estimation
pub last_epoch_pool_token_supply: u64,
/// Last epoch's total lamports, used only for APR estimation
pub last_epoch_total_lamports: u64,
}
impl StakePool {
/// calculate the pool tokens that should be minted for a deposit of
/// `stake_lamports`
#[inline]
pub fn calc_pool_tokens_for_deposit(&self, stake_lamports: u64) -> Option<u64> {
if self.total_lamports == 0 || self.pool_token_supply == 0 {
return Some(stake_lamports);
}
u64::try_from(
(stake_lamports as u128)
.checked_mul(self.pool_token_supply as u128)?
.checked_div(self.total_lamports as u128)?,
)
.ok()
}
/// calculate lamports amount on withdrawal
#[inline]
pub fn calc_lamports_withdraw_amount(&self, pool_tokens: u64) -> Option<u64> {
// `checked_div` returns `None` for a 0 quotient result, but in this
// case, a return of 0 is valid for small amounts of pool tokens. So
// we check for that separately
let numerator = (pool_tokens as u128).checked_mul(self.total_lamports as u128)?;
let denominator = self.pool_token_supply as u128;
if numerator < denominator || denominator == 0 {
Some(0)
} else {
u64::try_from(numerator.checked_div(denominator)?).ok()
}
}
/// calculate pool tokens to be deducted as withdrawal fees
#[inline]
pub fn calc_pool_tokens_stake_withdrawal_fee(&self, pool_tokens: u64) -> Option<u64> {
u64::try_from(self.stake_withdrawal_fee.apply(pool_tokens)?).ok()
}
/// calculate pool tokens to be deducted as withdrawal fees
#[inline]
pub fn calc_pool_tokens_sol_withdrawal_fee(&self, pool_tokens: u64) -> Option<u64> {
u64::try_from(self.sol_withdrawal_fee.apply(pool_tokens)?).ok()
}
/// calculate pool tokens to be deducted as stake deposit fees
#[inline]
pub fn calc_pool_tokens_stake_deposit_fee(&self, pool_tokens_minted: u64) -> Option<u64> {
u64::try_from(self.stake_deposit_fee.apply(pool_tokens_minted)?).ok()
}
/// calculate pool tokens to be deducted from deposit fees as referral fees
#[inline]
pub fn calc_pool_tokens_stake_referral_fee(&self, stake_deposit_fee: u64) -> Option<u64> {
u64::try_from(
(stake_deposit_fee as u128)
.checked_mul(self.stake_referral_fee as u128)?
.checked_div(100u128)?,
)
.ok()
}
/// calculate pool tokens to be deducted as SOL deposit fees
#[inline]
pub fn calc_pool_tokens_sol_deposit_fee(&self, pool_tokens_minted: u64) -> Option<u64> {
u64::try_from(self.sol_deposit_fee.apply(pool_tokens_minted)?).ok()
}
/// calculate pool tokens to be deducted from SOL deposit fees as referral
/// fees
#[inline]
pub fn calc_pool_tokens_sol_referral_fee(&self, sol_deposit_fee: u64) -> Option<u64> {
u64::try_from(
(sol_deposit_fee as u128)
.checked_mul(self.sol_referral_fee as u128)?
.checked_div(100u128)?,
)
.ok()
}
/// Calculate the fee in pool tokens that goes to the manager
///
/// This function assumes that `reward_lamports` has not already been added
/// to the stake pool's `total_lamports`
#[inline]
pub fn calc_epoch_fee_amount(&self, reward_lamports: u64) -> Option<u64> {
if reward_lamports == 0 {
return Some(0);
}
let total_lamports = (self.total_lamports as u128).checked_add(reward_lamports as u128)?;
let fee_lamports = self.epoch_fee.apply(reward_lamports)?;
if total_lamports == fee_lamports || self.pool_token_supply == 0 {
Some(reward_lamports)
} else {
u64::try_from(
(self.pool_token_supply as u128)
.checked_mul(fee_lamports)?
.checked_div(total_lamports.checked_sub(fee_lamports)?)?,
)
.ok()
}
}
/// Get the current value of pool tokens, rounded up
#[inline]
pub fn get_lamports_per_pool_token(&self) -> Option<u64> {
self.total_lamports
.checked_add(self.pool_token_supply)?
.checked_sub(1)?
.checked_div(self.pool_token_supply)
}
/// Checks that the withdraw or deposit authority is valid
fn check_program_derived_authority(
authority_address: &Pubkey,
program_id: &Pubkey,
stake_pool_address: &Pubkey,
authority_seed: &[u8],
bump_seed: u8,
) -> Result<(), ProgramError> {
let expected_address = Pubkey::create_program_address(
&[stake_pool_address.as_ref(), authority_seed, &[bump_seed]],
program_id,
)?;
if *authority_address == expected_address {
Ok(())
} else {
msg!(
"Incorrect authority provided, expected {}, received {}",
expected_address,
authority_address
);
Err(StakePoolError::InvalidProgramAddress.into())
}
}
/// Check if the manager fee info is a valid token program account
/// capable of receiving tokens from the mint.
pub(crate) fn check_manager_fee_info(
&self,
manager_fee_info: &AccountInfo,
) -> Result<(), ProgramError> {
let account_data = manager_fee_info.try_borrow_data()?;
let token_account = StateWithExtensions::<Account>::unpack(&account_data)?;
if manager_fee_info.owner != &self.token_program_id
|| token_account.base.state != AccountState::Initialized
|| token_account.base.mint != self.pool_mint
{
msg!("Manager fee account is not owned by token program, is not initialized, or does not match stake pool's mint");
return Err(StakePoolError::InvalidFeeAccount.into());
}
let extensions = token_account.get_extension_types()?;
if extensions
.iter()
.any(|x| !is_extension_supported_for_fee_account(x))
{
return Err(StakePoolError::UnsupportedFeeAccountExtension.into());
}
Ok(())
}
/// Checks that the withdraw authority is valid
#[inline]
pub(crate) fn check_authority_withdraw(
&self,
withdraw_authority: &Pubkey,
program_id: &Pubkey,
stake_pool_address: &Pubkey,
) -> Result<(), ProgramError> {
Self::check_program_derived_authority(
withdraw_authority,
program_id,
stake_pool_address,
crate::AUTHORITY_WITHDRAW,
self.stake_withdraw_bump_seed,
)
}
/// Checks that the deposit authority is valid
#[inline]
pub(crate) fn check_stake_deposit_authority(
&self,
stake_deposit_authority: &Pubkey,
) -> Result<(), ProgramError> {
if self.stake_deposit_authority == *stake_deposit_authority {
Ok(())
} else {
Err(StakePoolError::InvalidStakeDepositAuthority.into())
}
}
/// Checks that the deposit authority is valid
/// Does nothing if `sol_deposit_authority` is currently not set
#[inline]
pub(crate) fn check_sol_deposit_authority(
&self,
maybe_sol_deposit_authority: Result<&AccountInfo, ProgramError>,
) -> Result<(), ProgramError> {
if let Some(auth) = self.sol_deposit_authority {
let sol_deposit_authority = maybe_sol_deposit_authority?;
if auth != *sol_deposit_authority.key {
msg!("Expected {}, received {}", auth, sol_deposit_authority.key);
return Err(StakePoolError::InvalidSolDepositAuthority.into());
}
if !sol_deposit_authority.is_signer {
msg!("SOL Deposit authority signature missing");
return Err(StakePoolError::SignatureMissing.into());
}
}
Ok(())
}
/// Checks that the sol withdraw authority is valid
/// Does nothing if `sol_withdraw_authority` is currently not set
#[inline]
pub(crate) fn check_sol_withdraw_authority(
&self,
maybe_sol_withdraw_authority: Result<&AccountInfo, ProgramError>,
) -> Result<(), ProgramError> {
if let Some(auth) = self.sol_withdraw_authority {
let sol_withdraw_authority = maybe_sol_withdraw_authority?;
if auth != *sol_withdraw_authority.key {
return Err(StakePoolError::InvalidSolWithdrawAuthority.into());
}
if !sol_withdraw_authority.is_signer {
msg!("SOL withdraw authority signature missing");
return Err(StakePoolError::SignatureMissing.into());
}
}
Ok(())
}
/// Check mint is correct
#[inline]
pub(crate) fn check_mint(&self, mint_info: &AccountInfo) -> Result<u8, ProgramError> {
if *mint_info.key != self.pool_mint {
Err(StakePoolError::WrongPoolMint.into())
} else {
let mint_data = mint_info.try_borrow_data()?;
let mint = StateWithExtensions::<Mint>::unpack(&mint_data)?;
Ok(mint.base.decimals)
}
}
/// Check manager validity and signature
pub(crate) fn check_manager(&self, manager_info: &AccountInfo) -> Result<(), ProgramError> {
if *manager_info.key != self.manager {
msg!(
"Incorrect manager provided, expected {}, received {}",
self.manager,
manager_info.key
);
return Err(StakePoolError::WrongManager.into());
}
if !manager_info.is_signer {
msg!("Manager signature missing");
return Err(StakePoolError::SignatureMissing.into());
}
Ok(())
}
/// Check staker validity and signature
pub(crate) fn check_staker(&self, staker_info: &AccountInfo) -> Result<(), ProgramError> {
if *staker_info.key != self.staker {
msg!(
"Incorrect staker provided, expected {}, received {}",
self.staker,
staker_info.key
);
return Err(StakePoolError::WrongStaker.into());
}
if !staker_info.is_signer {
msg!("Staker signature missing");
return Err(StakePoolError::SignatureMissing.into());
}
Ok(())
}
/// Check the validator list is valid
pub fn check_validator_list(
&self,
validator_list_info: &AccountInfo,
) -> Result<(), ProgramError> {
if *validator_list_info.key != self.validator_list {
msg!(
"Invalid validator list provided, expected {}, received {}",
self.validator_list,
validator_list_info.key
);
Err(StakePoolError::InvalidValidatorStakeList.into())
} else {
Ok(())
}
}
/// Check the reserve stake is valid
pub fn check_reserve_stake(
&self,
reserve_stake_info: &AccountInfo,
) -> Result<(), ProgramError> {
if *reserve_stake_info.key != self.reserve_stake {
msg!(
"Invalid reserve stake provided, expected {}, received {}",
self.reserve_stake,
reserve_stake_info.key
);
Err(StakePoolError::InvalidProgramAddress.into())
} else {
Ok(())
}
}
/// Check if StakePool is actually initialized as a stake pool
pub fn is_valid(&self) -> bool {
self.account_type == AccountType::StakePool
}
/// Check if StakePool is currently uninitialized
pub fn is_uninitialized(&self) -> bool {
self.account_type == AccountType::Uninitialized
}
/// Updates one of the StakePool's fees.
pub fn update_fee(&mut self, fee: &FeeType) -> Result<(), StakePoolError> {
match fee {
FeeType::SolReferral(new_fee) => self.sol_referral_fee = *new_fee,
FeeType::StakeReferral(new_fee) => self.stake_referral_fee = *new_fee,
FeeType::Epoch(new_fee) => self.next_epoch_fee = FutureEpoch::new(*new_fee),
FeeType::StakeWithdrawal(new_fee) => {
new_fee.check_withdrawal(&self.stake_withdrawal_fee)?;
self.next_stake_withdrawal_fee = FutureEpoch::new(*new_fee)
}
FeeType::SolWithdrawal(new_fee) => {
new_fee.check_withdrawal(&self.sol_withdrawal_fee)?;
self.next_sol_withdrawal_fee = FutureEpoch::new(*new_fee)
}
FeeType::SolDeposit(new_fee) => self.sol_deposit_fee = *new_fee,
FeeType::StakeDeposit(new_fee) => self.stake_deposit_fee = *new_fee,
};
Ok(())
}
}
/// Checks if the given extension is supported for the stake pool mint
pub fn is_extension_supported_for_mint(extension_type: &ExtensionType) -> bool {
const SUPPORTED_EXTENSIONS: [ExtensionType; 8] = [
ExtensionType::Uninitialized,
ExtensionType::TransferFeeConfig,
ExtensionType::ConfidentialTransferMint,
ExtensionType::ConfidentialTransferFeeConfig,
ExtensionType::DefaultAccountState, // ok, but a freeze authority is not
ExtensionType::InterestBearingConfig,
ExtensionType::MetadataPointer,
ExtensionType::TokenMetadata,
];
if !SUPPORTED_EXTENSIONS.contains(extension_type) {
msg!(
"Stake pool mint account cannot have the {:?} extension",
extension_type
);
false
} else {
true
}
}
/// Checks if the given extension is supported for the stake pool's fee account
pub fn is_extension_supported_for_fee_account(extension_type: &ExtensionType) -> bool {
// Note: this does not include the `ConfidentialTransferAccount` extension
// because it is possible to block non-confidential transfers with the
// extension enabled.
const SUPPORTED_EXTENSIONS: [ExtensionType; 4] = [
ExtensionType::Uninitialized,
ExtensionType::TransferFeeAmount,
ExtensionType::ImmutableOwner,
ExtensionType::CpiGuard,
];
if !SUPPORTED_EXTENSIONS.contains(extension_type) {
msg!("Fee account cannot have the {:?} extension", extension_type);
false
} else {
true
}
}
/// Storage list for all validator stake accounts in the pool.
#[repr(C)]
#[derive(Clone, Debug, Default, PartialEq, BorshDeserialize, BorshSerialize, BorshSchema)]
pub struct ValidatorList {
/// Data outside of the validator list, separated out for cheaper
/// deserializations
pub header: ValidatorListHeader,
/// List of stake info for each validator in the pool
pub validators: Vec<ValidatorStakeInfo>,
}
/// Helper type to deserialize just the start of a ValidatorList
#[repr(C)]
#[derive(Clone, Debug, Default, PartialEq, BorshDeserialize, BorshSerialize, BorshSchema)]
pub struct ValidatorListHeader {
/// Account type, must be ValidatorList currently
pub account_type: AccountType,
/// Maximum allowable number of validators
pub max_validators: u32,
}
/// Status of the stake account in the validator list, for accounting
#[derive(
ToPrimitive,
FromPrimitive,
Copy,
Clone,
Debug,
PartialEq,
BorshDeserialize,
BorshSerialize,
BorshSchema,
)]
pub enum StakeStatus {
/// Stake account is active, there may be a transient stake as well
Active,
/// Only transient stake account exists, when a transient stake is
/// deactivating during validator removal
DeactivatingTransient,
/// No more validator stake accounts exist, entry ready for removal during
/// `UpdateStakePoolBalance`
ReadyForRemoval,
/// Only the validator stake account is deactivating, no transient stake
/// account exists
DeactivatingValidator,
/// Both the transient and validator stake account are deactivating, when
/// a validator is removed with a transient stake active
DeactivatingAll,
}
impl Default for StakeStatus {
fn default() -> Self {
Self::Active
}
}
/// Wrapper struct that can be `Pod`, containing a byte that *should* be a valid
/// `StakeStatus` underneath.
#[repr(transparent)]
#[derive(
Clone,
Copy,
Debug,
Default,
PartialEq,
Pod,
Zeroable,
BorshDeserialize,
BorshSerialize,
BorshSchema,
)]
pub struct PodStakeStatus(u8);
impl PodStakeStatus {
/// Downgrade the status towards ready for removal by removing the validator
/// stake
pub fn remove_validator_stake(&mut self) -> Result<(), ProgramError> {
let status = StakeStatus::try_from(*self)?;
let new_self = match status {
StakeStatus::Active
| StakeStatus::DeactivatingTransient
| StakeStatus::ReadyForRemoval => status,
StakeStatus::DeactivatingAll => StakeStatus::DeactivatingTransient,
StakeStatus::DeactivatingValidator => StakeStatus::ReadyForRemoval,
};
*self = new_self.into();
Ok(())
}
/// Downgrade the status towards ready for removal by removing the transient
/// stake
pub fn remove_transient_stake(&mut self) -> Result<(), ProgramError> {
let status = StakeStatus::try_from(*self)?;
let new_self = match status {
StakeStatus::Active
| StakeStatus::DeactivatingValidator
| StakeStatus::ReadyForRemoval => status,
StakeStatus::DeactivatingAll => StakeStatus::DeactivatingValidator,
StakeStatus::DeactivatingTransient => StakeStatus::ReadyForRemoval,
};
*self = new_self.into();
Ok(())
}
}
impl TryFrom<PodStakeStatus> for StakeStatus {
type Error = ProgramError;
fn try_from(pod: PodStakeStatus) -> Result<Self, Self::Error> {
FromPrimitive::from_u8(pod.0).ok_or(ProgramError::InvalidAccountData)
}
}
impl From<StakeStatus> for PodStakeStatus {
fn from(status: StakeStatus) -> Self {
// unwrap is safe here because the variants of `StakeStatus` fit very
// comfortably within a `u8`
PodStakeStatus(status.to_u8().unwrap())
}
}
/// Withdrawal type, figured out during process_withdraw_stake
#[derive(Debug, PartialEq)]
pub(crate) enum StakeWithdrawSource {
/// Some of an active stake account, but not all
Active,
/// Some of a transient stake account
Transient,
/// Take a whole validator stake account
ValidatorRemoval,
}
/// Information about a validator in the pool
///
/// NOTE: ORDER IS VERY IMPORTANT HERE, PLEASE DO NOT RE-ORDER THE FIELDS UNLESS
/// THERE'S AN EXTREMELY GOOD REASON.
///
/// To save on BPF instructions, the serialized bytes are reinterpreted with a
/// bytemuck transmute, which means that this structure cannot have any
/// undeclared alignment-padding in its representation.
#[repr(C)]
#[derive(
Clone,
Copy,
Debug,
Default,
PartialEq,
Pod,
Zeroable,
BorshDeserialize,
BorshSerialize,
BorshSchema,
)]
pub struct ValidatorStakeInfo {
/// Amount of lamports on the validator stake account, including rent
///
/// Note that if `last_update_epoch` does not match the current epoch then
/// this field may not be accurate
pub active_stake_lamports: PodU64,
/// Amount of transient stake delegated to this validator
///
/// Note that if `last_update_epoch` does not match the current epoch then
/// this field may not be accurate
pub transient_stake_lamports: PodU64,
/// Last epoch the active and transient stake lamports fields were updated
pub last_update_epoch: PodU64,
/// Transient account seed suffix, used to derive the transient stake
/// account address
pub transient_seed_suffix: PodU64,
/// Unused space, initially meant to specify the end of seed suffixes
pub unused: PodU32,
/// Validator account seed suffix
pub validator_seed_suffix: PodU32, // really `Option<NonZeroU32>` so 0 is `None`
/// Status of the validator stake account
pub status: PodStakeStatus,
/// Validator vote account address
pub vote_account_address: Pubkey,
}
impl ValidatorStakeInfo {
/// Get the total lamports on this validator (active and transient)
pub fn stake_lamports(&self) -> Result<u64, StakePoolError> {
u64::from(self.active_stake_lamports)
.checked_add(self.transient_stake_lamports.into())
.ok_or(StakePoolError::CalculationFailure)
}
/// Performs a very cheap comparison, for checking if this validator stake
/// info matches the vote account address
pub fn memcmp_pubkey(data: &[u8], vote_address: &Pubkey) -> bool {
sol_memcmp(
&data[41..41_usize.saturating_add(PUBKEY_BYTES)],
vote_address.as_ref(),
PUBKEY_BYTES,
) == 0
}
/// Performs a comparison, used to check if this validator stake
/// info has more active lamports than some limit
pub fn active_lamports_greater_than(data: &[u8], lamports: &u64) -> bool {
// without this unwrap, compute usage goes up significantly
u64::try_from_slice(&data[0..8]).unwrap() > *lamports
}
/// Performs a comparison, used to check if this validator stake
/// info has more transient lamports than some limit
pub fn transient_lamports_greater_than(data: &[u8], lamports: &u64) -> bool {
// without this unwrap, compute usage goes up significantly
u64::try_from_slice(&data[8..16]).unwrap() > *lamports
}
/// Check that the validator stake info is valid
pub fn is_not_removed(data: &[u8]) -> bool {
FromPrimitive::from_u8(data[40]) != Some(StakeStatus::ReadyForRemoval)
}
}
impl Sealed for ValidatorStakeInfo {}
impl Pack for ValidatorStakeInfo {
const LEN: usize = 73;
fn pack_into_slice(&self, data: &mut [u8]) {
let mut data = data;
// Removing this unwrap would require changing from `Pack` to some other
// trait or `bytemuck`, so it stays in for now
borsh::to_writer(&mut data, self).unwrap();
}
fn unpack_from_slice(src: &[u8]) -> Result<Self, ProgramError> {
let unpacked = Self::try_from_slice(src)?;
Ok(unpacked)
}
}
impl ValidatorList {
/// Create an empty instance containing space for `max_validators` and
/// preferred validator keys
pub fn new(max_validators: u32) -> Self {
Self {
header: ValidatorListHeader {
account_type: AccountType::ValidatorList,
max_validators,
},
validators: vec![ValidatorStakeInfo::default(); max_validators as usize],
}
}
/// Calculate the number of validator entries that fit in the provided
/// length
pub fn calculate_max_validators(buffer_length: usize) -> usize {
let header_size = ValidatorListHeader::LEN.saturating_add(4);
buffer_length
.saturating_sub(header_size)
.saturating_div(ValidatorStakeInfo::LEN)
}
/// Check if contains validator with particular pubkey
pub fn contains(&self, vote_account_address: &Pubkey) -> bool {
self.validators
.iter()
.any(|x| x.vote_account_address == *vote_account_address)
}
/// Check if contains validator with particular pubkey
pub fn find_mut(&mut self, vote_account_address: &Pubkey) -> Option<&mut ValidatorStakeInfo> {
self.validators
.iter_mut()
.find(|x| x.vote_account_address == *vote_account_address)
}
/// Check if contains validator with particular pubkey
pub fn find(&self, vote_account_address: &Pubkey) -> Option<&ValidatorStakeInfo> {
self.validators
.iter()
.find(|x| x.vote_account_address == *vote_account_address)
}
/// Check if the list has any active stake
pub fn has_active_stake(&self) -> bool {
self.validators
.iter()
.any(|x| u64::from(x.active_stake_lamports) > 0)
}
}
impl ValidatorListHeader {
const LEN: usize = 1 + 4;
/// Check if validator stake list is actually initialized as a validator
/// stake list
pub fn is_valid(&self) -> bool {
self.account_type == AccountType::ValidatorList
}
/// Check if the validator stake list is uninitialized
pub fn is_uninitialized(&self) -> bool {
self.account_type == AccountType::Uninitialized
}
/// Extracts a slice of ValidatorStakeInfo types from the vec part
/// of the ValidatorList
pub fn deserialize_mut_slice<'a>(
big_vec: &'a mut BigVec,
skip: usize,
len: usize,
) -> Result<&'a mut [ValidatorStakeInfo], ProgramError> {
big_vec.deserialize_mut_slice::<ValidatorStakeInfo>(skip, len)
}
/// Extracts the validator list into its header and internal BigVec
pub fn deserialize_vec(data: &mut [u8]) -> Result<(Self, BigVec), ProgramError> {
let mut data_mut = data.borrow();
let header = ValidatorListHeader::deserialize(&mut data_mut)?;
let length = get_instance_packed_len(&header)?;
let big_vec = BigVec {
data: &mut data[length..],
};
Ok((header, big_vec))
}
}
/// Wrapper type that "counts down" epochs, which is Borsh-compatible with the
/// native `Option`
#[repr(C)]
#[derive(Clone, Copy, Debug, PartialEq, BorshSerialize, BorshDeserialize, BorshSchema)]
pub enum FutureEpoch<T> {
/// Nothing is set
None,
/// Value is ready after the next epoch boundary
One(T),
/// Value is ready after two epoch boundaries
Two(T),
}
impl<T> Default for FutureEpoch<T> {
fn default() -> Self {
Self::None
}
}
impl<T> FutureEpoch<T> {
/// Create a new value to be unlocked in a two epochs
pub fn new(value: T) -> Self {
Self::Two(value)
}
}
impl<T: Clone> FutureEpoch<T> {
/// Update the epoch, to be done after `get`ting the underlying value
pub fn update_epoch(&mut self) {
match self {
Self::None => {}
Self::One(_) => {
// The value has waited its last epoch
*self = Self::None;
}
// The value still has to wait one more epoch after this
Self::Two(v) => {
*self = Self::One(v.clone());
}
}
}
/// Get the value if it's ready, which is only at `One` epoch remaining
pub fn get(&self) -> Option<&T> {
match self {
Self::None | Self::Two(_) => None,
Self::One(v) => Some(v),
}
}
}
impl<T> From<FutureEpoch<T>> for Option<T> {
fn from(v: FutureEpoch<T>) -> Option<T> {
match v {
FutureEpoch::None => None,
FutureEpoch::One(inner) | FutureEpoch::Two(inner) => Some(inner),
}
}
}
/// Fee rate as a ratio, minted on `UpdateStakePoolBalance` as a proportion of
/// the rewards
/// If either the numerator or the denominator is 0, the fee is considered to be
/// 0
#[repr(C)]
#[derive(Clone, Copy, Debug, Default, PartialEq, BorshSerialize, BorshDeserialize, BorshSchema)]
pub struct Fee {
/// denominator of the fee ratio
pub denominator: u64,
/// numerator of the fee ratio
pub numerator: u64,
}
impl Fee {
/// Applies the Fee's rates to a given amount, `amt`
/// returning the amount to be subtracted from it as fees
/// (0 if denominator is 0 or amt is 0),
/// or None if overflow occurs
#[inline]
pub fn apply(&self, amt: u64) -> Option<u128> {
if self.denominator == 0 {
return Some(0);
}
(amt as u128)
.checked_mul(self.numerator as u128)?
.checked_div(self.denominator as u128)
}
/// Withdrawal fees have some additional restrictions,
/// this fn checks if those are met, returning an error if not.
/// Does nothing and returns Ok if fee type is not withdrawal
pub fn check_withdrawal(&self, old_withdrawal_fee: &Fee) -> Result<(), StakePoolError> {
// If the previous withdrawal fee was 0, we allow the fee to be set to a
// maximum of (WITHDRAWAL_BASELINE_FEE * MAX_WITHDRAWAL_FEE_INCREASE)
let (old_num, old_denom) =
if old_withdrawal_fee.denominator == 0 || old_withdrawal_fee.numerator == 0 {
(
WITHDRAWAL_BASELINE_FEE.numerator,
WITHDRAWAL_BASELINE_FEE.denominator,
)
} else {
(old_withdrawal_fee.numerator, old_withdrawal_fee.denominator)
};
// Check that new_fee / old_fee <= MAX_WITHDRAWAL_FEE_INCREASE
// Program fails if provided numerator or denominator is too large, resulting in
// overflow
if (old_num as u128)
.checked_mul(self.denominator as u128)
.map(|x| x.checked_mul(MAX_WITHDRAWAL_FEE_INCREASE.numerator as u128))
.ok_or(StakePoolError::CalculationFailure)?
< (self.numerator as u128)
.checked_mul(old_denom as u128)
.map(|x| x.checked_mul(MAX_WITHDRAWAL_FEE_INCREASE.denominator as u128))
.ok_or(StakePoolError::CalculationFailure)?
{
msg!(
"Fee increase exceeds maximum allowed, proposed increase factor ({} / {})",
self.numerator.saturating_mul(old_denom),
old_num.saturating_mul(self.denominator),
);
return Err(StakePoolError::FeeIncreaseTooHigh);
}
Ok(())
}
}
impl fmt::Display for Fee {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
if self.numerator > 0 && self.denominator > 0 {
write!(f, "{}/{}", self.numerator, self.denominator)
} else {
write!(f, "none")
}
}
}
/// The type of fees that can be set on the stake pool
#[derive(Clone, Debug, PartialEq, BorshDeserialize, BorshSerialize, BorshSchema)]