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
|
// Copyright (C) 2019-2024 Algorand, Inc.
// This file is part of go-algorand
//
// go-algorand is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
//
// go-algorand is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with go-algorand. If not, see <https://www.gnu.org/licenses/>.
package ledgercore
import (
"github.com/algorand/go-algorand/config"
"github.com/algorand/go-algorand/data/basics"
"github.com/algorand/go-algorand/logging"
"github.com/algorand/go-algorand/protocol"
)
// AlgoCount represents a total of algos of a certain class
// of accounts (split up by their Status value).
type AlgoCount struct {
_struct struct{} `codec:",omitempty,omitemptyarray"`
// Sum of algos of all accounts in this class.
Money basics.MicroAlgos `codec:"mon"`
// Total number of whole reward units in accounts.
RewardUnits uint64 `codec:"rwd"`
}
func (ac *AlgoCount) applyRewards(rewardsPerUnit uint64, ot *basics.OverflowTracker) {
rewardsGottenThisRound := basics.MicroAlgos{Raw: ot.Mul(ac.RewardUnits, rewardsPerUnit)}
ac.Money = ot.AddA(ac.Money, rewardsGottenThisRound)
}
// AccountTotals represents the totals of algos in the system
// grouped by different account status values.
type AccountTotals struct {
_struct struct{} `codec:",omitempty,omitemptyarray"`
Online AlgoCount `codec:"online"`
Offline AlgoCount `codec:"offline"`
NotParticipating AlgoCount `codec:"notpart"`
// Total number of algos received per reward unit since genesis
RewardsLevel uint64 `codec:"rwdlvl"`
}
// OnlineRoundParamsData keeps track of parameters needed for agreement from maxBalLookback ago
type OnlineRoundParamsData struct {
_struct struct{} `codec:",omitempty,omitemptyarray"`
OnlineSupply uint64 `codec:"online"`
RewardsLevel uint64 `codec:"rwdlvl"`
CurrentProtocol protocol.ConsensusVersion `codec:"proto"`
}
func (at *AccountTotals) statusField(status basics.Status) *AlgoCount {
switch status {
case basics.Online:
return &at.Online
case basics.Offline:
return &at.Offline
case basics.NotParticipating:
return &at.NotParticipating
default:
logging.Base().Panicf("AccountTotals: unknown status %v", status)
// Go's compiler does not know that Panicf() will not return.
return nil
}
}
// AddAccount adds an account algos from the total money
func (at *AccountTotals) AddAccount(proto config.ConsensusParams, data AccountData, ot *basics.OverflowTracker) {
sum := at.statusField(data.Status)
algos, _ := data.Money(proto, at.RewardsLevel)
sum.Money = ot.AddA(sum.Money, algos)
sum.RewardUnits = ot.Add(sum.RewardUnits, data.MicroAlgos.RewardUnits(proto))
}
// DelAccount removes an account algos from the total money
func (at *AccountTotals) DelAccount(proto config.ConsensusParams, data AccountData, ot *basics.OverflowTracker) {
sum := at.statusField(data.Status)
algos, _ := data.Money(proto, at.RewardsLevel)
sum.Money = ot.SubA(sum.Money, algos)
sum.RewardUnits = ot.Sub(sum.RewardUnits, data.MicroAlgos.RewardUnits(proto))
}
// ApplyRewards adds the reward to the account totals based on the new rewards level
func (at *AccountTotals) ApplyRewards(rewardsLevel uint64, ot *basics.OverflowTracker) {
rewardsPerUnit := ot.Sub(rewardsLevel, at.RewardsLevel)
at.RewardsLevel = rewardsLevel
at.Online.applyRewards(rewardsPerUnit, ot)
at.Offline.applyRewards(rewardsPerUnit, ot)
}
// All returns the sum of algos held under all different status values.
func (at *AccountTotals) All() basics.MicroAlgos {
participating := at.Participating()
res, overflowed := basics.OAddA(at.NotParticipating.Money, participating)
if overflowed {
logging.Base().Panicf("AccountTotals.All(): overflow %v + %v", at.NotParticipating, participating)
}
return res
}
// Participating returns the sum of algos held under “participating”
// account status values (Online and Offline). It excludes MicroAlgos held
// by NotParticipating accounts.
func (at *AccountTotals) Participating() basics.MicroAlgos {
res, overflowed := basics.OAddA(at.Online.Money, at.Offline.Money)
if overflowed {
logging.Base().Panicf("AccountTotals.Participating(): overflow %v + %v", at.Online, at.Offline)
}
return res
}
// RewardUnits returns the sum of reward units held under “participating”
// account status values (Online and Offline). It excludes units held
// by NotParticipating accounts.
func (at *AccountTotals) RewardUnits() uint64 {
res, overflowed := basics.OAdd(at.Online.RewardUnits, at.Offline.RewardUnits)
if overflowed {
logging.Base().Panicf("AccountTotals.RewardUnits(): overflow %v + %v", at.Online, at.Offline)
}
return res
}
|
