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
|
// Copyright (C) 2019-2021 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 data
import (
"fmt"
"github.com/algorand/go-deadlock"
"github.com/algorand/go-algorand/config"
"github.com/algorand/go-algorand/crypto"
"github.com/algorand/go-algorand/data/account"
"github.com/algorand/go-algorand/data/basics"
"github.com/algorand/go-algorand/data/bookkeeping"
"github.com/algorand/go-algorand/logging"
"github.com/algorand/go-algorand/logging/telemetryspec"
"github.com/algorand/go-algorand/protocol"
)
// A ParticipationKeyIdentity defines the parameters that makes a pariticpation key unique.
type ParticipationKeyIdentity struct {
basics.Address // the address this participation key is used to vote for.
// FirstValid and LastValid are inclusive.
FirstValid basics.Round
LastValid basics.Round
VoteID crypto.OneTimeSignatureVerifier
SelectionID crypto.VrfPubkey
}
// AccountManager loads and manages accounts for the node
type AccountManager struct {
mu deadlock.Mutex
partKeys map[ParticipationKeyIdentity]account.PersistedParticipation
// Map to keep track of accounts for which we've sent
// AccountRegistered telemetry events
registeredAccounts map[string]bool
log logging.Logger
}
// MakeAccountManager creates a new AccountManager with a custom logger
func MakeAccountManager(log logging.Logger) *AccountManager {
manager := &AccountManager{}
manager.log = log
manager.partKeys = make(map[ParticipationKeyIdentity]account.PersistedParticipation)
manager.registeredAccounts = make(map[string]bool)
return manager
}
// Keys returns a list of Participation accounts.
func (manager *AccountManager) Keys(rnd basics.Round) (out []account.Participation) {
manager.mu.Lock()
defer manager.mu.Unlock()
for _, part := range manager.partKeys {
if part.OverlapsInterval(rnd, rnd) {
out = append(out, part.Participation)
}
}
return out
}
// HasLiveKeys returns true if we have any Participation
// keys valid for the specified round range (inclusive)
func (manager *AccountManager) HasLiveKeys(from, to basics.Round) bool {
manager.mu.Lock()
defer manager.mu.Unlock()
for _, part := range manager.partKeys {
if part.OverlapsInterval(from, to) {
return true
}
}
return false
}
// AddParticipation adds a new account.Participation to be managed.
// The return value indicates if the key has been added (true) or
// if this is a duplicate key (false).
func (manager *AccountManager) AddParticipation(participation account.PersistedParticipation) bool {
manager.mu.Lock()
defer manager.mu.Unlock()
address := participation.Address()
first, last := participation.ValidInterval()
partkeyID := ParticipationKeyIdentity{
Address: address,
FirstValid: first,
LastValid: last,
VoteID: participation.Voting.OneTimeSignatureVerifier,
SelectionID: participation.VRF.PK,
}
// Check if we already have participation keys for this address in this interval
_, alreadyPresent := manager.partKeys[partkeyID]
if alreadyPresent {
return false
}
manager.partKeys[partkeyID] = participation
addressString := address.String()
manager.log.EventWithDetails(telemetryspec.Accounts, telemetryspec.PartKeyRegisteredEvent, telemetryspec.PartKeyRegisteredEventDetails{
Address: addressString,
FirstValid: uint64(first),
LastValid: uint64(last),
})
_, has := manager.registeredAccounts[addressString]
if !has {
manager.registeredAccounts[addressString] = true
manager.log.EventWithDetails(telemetryspec.Accounts, telemetryspec.AccountRegisteredEvent, telemetryspec.AccountRegisteredEventDetails{
Address: addressString,
})
}
return true
}
// DeleteOldKeys deletes all accounts' ephemeral keys strictly older than the
// next round needed for each account.
func (manager *AccountManager) DeleteOldKeys(latestHdr bookkeeping.BlockHeader, ccSigs map[basics.Address]basics.Round, agreementProto config.ConsensusParams) {
latestProto := config.Consensus[latestHdr.CurrentProtocol]
manager.mu.Lock()
pendingItems := make(map[string]<-chan error, len(manager.partKeys))
func() {
defer manager.mu.Unlock()
for _, part := range manager.partKeys {
// We need a key for round r+1 for agreement.
nextRound := latestHdr.Round + 1
if latestHdr.CompactCert[protocol.CompactCertBasic].CompactCertNextRound > 0 {
// We need a key for the next compact cert round.
// This would be CompactCertNextRound+1 (+1 because compact
// cert code uses the next round's ephemeral key), except
// if we already used that key to produce a signature (as
// reported in ccSigs).
nextCC := latestHdr.CompactCert[protocol.CompactCertBasic].CompactCertNextRound + 1
if ccSigs[part.Parent] >= nextCC {
nextCC = ccSigs[part.Parent] + basics.Round(latestProto.CompactCertRounds) + 1
}
if nextCC < nextRound {
nextRound = nextCC
}
}
// we pre-create the reported error string here, so that we won't need to have the participation key object if error is detected.
first, last := part.ValidInterval()
errString := fmt.Sprintf("AccountManager.DeleteOldKeys(): key for %s (%d-%d), nextRound %d",
part.Address().String(), first, last, nextRound)
errCh := part.DeleteOldKeys(nextRound, agreementProto)
pendingItems[errString] = errCh
}
}()
// wait all all disk flushes, and report errors as they appear.
for errString, errCh := range pendingItems {
err := <-errCh
if err != nil {
logging.Base().Warnf("%s: %v", errString, err)
}
}
}
|
