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
|
// 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 participation
import (
"path/filepath"
"runtime"
"testing"
"time"
"github.com/stretchr/testify/require"
"github.com/algorand/go-algorand/config"
"github.com/algorand/go-algorand/data/basics"
"github.com/algorand/go-algorand/protocol"
"github.com/algorand/go-algorand/test/e2e-go/globals"
"github.com/algorand/go-algorand/test/framework/fixtures"
"github.com/algorand/go-algorand/test/partitiontest"
)
func TestParticipationKeyOnlyAccountParticipatesCorrectly(t *testing.T) {
partitiontest.PartitionTest(t)
defer fixtures.ShutdownSynchronizedTest(t)
t.Parallel()
a := require.New(fixtures.SynchronizedTest(t))
var fixture fixtures.RestClientFixture
fixture.Setup(t, filepath.Join("nettemplates", "TwoNodesPartialPartkeyOnlyWallets.json"))
defer fixture.Shutdown()
client := fixture.LibGoalClient
accountList, err := fixture.GetWalletsSortedByBalance()
a.NoError(err, "fixture should be able to get wallet list")
// partkeyonly_account is pre-created by template, marked ParticipationOnly: true. already has some stake
// verify both accounts got rewards
richAccount := accountList[0].Address // 30% stake
partAccounts := fixture.GetParticipationOnlyAccounts(client)
a.NotEmpty(partAccounts)
partkeyOnlyAccount := partAccounts[0].Address().String() // 20% stake
// allow "a few" rounds to pass so accounts can participate
// the below window controls the likelihood a block will be proposed by the account under test
// since block proposer selection is probabilistic, it is not guaranteed that the account will be chosen
// it is a trade-off between test flakiness and test duration
proposalWindow := 50 // arbitrary
blockWasProposedByPartkeyOnlyAccountRecently := waitForAccountToProposeBlock(a, &fixture, partkeyOnlyAccount, proposalWindow)
a.True(blockWasProposedByPartkeyOnlyAccountRecently, "partkey-only account should be proposing blocks")
// verify partkeyonly_account cannot spend
transactionFee := uint64(3) // arbitrary
amountToSend := uint64(10000) // arbitrary
wh, err := client.GetUnencryptedWalletHandle()
a.NoError(err, "should get unencrypted wallet handle")
_, err = client.SendPaymentFromWallet(wh, nil, partkeyOnlyAccount, richAccount, amountToSend, transactionFee, nil, "", basics.Round(0), basics.Round(0))
a.Error(err, "attempt to send money from partkey-only account should be treated as though wallet is not controlled")
// partkeyonly_account attempts to go offline, should fail (no rootkey to sign txn with)
goOfflineUTx, err := client.MakeUnsignedGoOfflineTx(partkeyOnlyAccount, 0, 0, transactionFee, [32]byte{})
a.NoError(err, "should be able to make go offline tx")
wh, err = client.GetUnencryptedWalletHandle()
a.NoError(err, "should get unencrypted wallet handle")
_, err = client.SignAndBroadcastTransaction(wh, nil, goOfflineUTx)
a.Error(err, "partkey only account should fail to go offline")
}
func waitForAccountToProposeBlock(a *require.Assertions, fixture *fixtures.RestClientFixture, account string, window int) bool {
client := fixture.AlgodClient
curStatus, err := client.Status()
a.NoError(err)
curRound := curStatus.LastRound
// the below window controls the likelihood a block will be proposed by the account under test
// since block proposer selection is probabilistic, it is not guaranteed that the account will be chosen
// it is a trade-off between test flakiness and test duration
for window > 0 {
window--
curRound++
err := fixture.WaitForRoundWithTimeout(curRound)
a.NoErrorf(err, "fixture failed waiting for round %d", curRound)
// See if account was participating by looking at block proposers
blockWasProposed := fixture.VerifyBlockProposed(account, 1)
if blockWasProposed {
return blockWasProposed
}
}
return false
}
// TestNewAccountCanGoOnlineAndParticipate tests two behaviors:
// - When the account does not have enough stake, or after receivning algos, but before the lookback rounds,
// it should not be proposing blocks
// - When the account balance receives enough stake, it should be proposing after lookback rounds
func TestNewAccountCanGoOnlineAndParticipate(t *testing.T) {
partitiontest.PartitionTest(t)
defer fixtures.ShutdownSynchronizedTest(t)
if testing.Short() {
t.Skip()
}
t.Parallel()
a := require.New(fixtures.SynchronizedTest(t))
// Make the seed lookback shorter, otherwise will wait for 320 rounds
consensus := make(config.ConsensusProtocols)
shortPartKeysProtocol := config.Consensus[protocol.ConsensusCurrentVersion]
shortPartKeysProtocol.ApprovedUpgrades = map[protocol.ConsensusVersion]uint64{}
shortPartKeysProtocol.SeedLookback = 2
shortPartKeysProtocol.SeedRefreshInterval = 8
if runtime.GOARCH == "amd64" {
// amd64 platforms are generally quite capable, so accelerate the round times to make the test run faster.
shortPartKeysProtocol.AgreementFilterTimeoutPeriod0 = 1 * time.Second
shortPartKeysProtocol.AgreementFilterTimeout = 1 * time.Second
}
consensus[protocol.ConsensusVersion("shortpartkeysprotocol")] = shortPartKeysProtocol
var fixture fixtures.RestClientFixture
fixture.SetConsensus(consensus)
fixture.SetupNoStart(t, filepath.Join("nettemplates", "OneNode.json"))
// update the config file by setting the ParticipationKeysRefreshInterval to 5 second.
nodeDirectory, err := fixture.GetNodeDir("Primary")
a.NoError(err)
cfg, err := config.LoadConfigFromDisk(nodeDirectory)
a.NoError(err)
cfg.ParticipationKeysRefreshInterval = 5 * time.Second
cfg.SaveToDisk(nodeDirectory)
fixture.Start()
defer fixture.Shutdown()
client := fixture.LibGoalClient
// account is newly created
wh, err := client.GetUnencryptedWalletHandle()
a.NoError(err)
newAccount, err := client.GenerateAddress(wh)
a.NoError(err)
// send money to new account from some other account in the template, so that account can go online
accountList, err := fixture.GetWalletsSortedByBalance()
a.NoError(err, "fixture should be able to get wallet list")
richAccount := accountList[0].Address // 30% stake
richBalance, initialRound := fixture.GetBalanceAndRound(richAccount)
minTxnFee, minAcctBalance, err := fixture.MinFeeAndBalance(initialRound)
a.NoError(err)
transactionFee := minTxnFee
amountToSendInitial := 5 * minAcctBalance
fixture.SendMoneyAndWait(initialRound, amountToSendInitial, transactionFee, richAccount, newAccount, "")
amt, err := client.GetBalance(newAccount)
a.NoError(err)
nodeStatus, err := client.Status()
a.NoError(err)
seededRound := nodeStatus.LastRound
a.Equal(amountToSendInitial, amt, "new account should be funded with the amount the rich account sent")
// account adds part key
partKeyFirstValid := uint64(0)
partKeyValidityPeriod := uint64(10000)
partKeyLastValid := partKeyFirstValid + partKeyValidityPeriod
partkeyResponse, _, err := client.GenParticipationKeys(newAccount, partKeyFirstValid, partKeyLastValid, 0)
a.NoError(err, "rest client should be able to add participation key to new account")
a.Equal(newAccount, partkeyResponse.Parent.String(), "partkey response should echo queried account")
// account uses part key to go online
goOnlineTx, err := client.MakeUnsignedGoOnlineTx(newAccount, &partkeyResponse, 0, 0, transactionFee, [32]byte{})
a.NoError(err, "should be able to make go online tx")
a.Equal(newAccount, goOnlineTx.Src().String(), "go online response should echo queried account")
onlineTxID, err := client.SignAndBroadcastTransaction(wh, nil, goOnlineTx)
a.NoError(err, "new account with new partkey should be able to go online")
fixture.AssertValidTxid(onlineTxID)
maxRoundsToWaitForTxnConfirm := uint64(5)
fixture.WaitForTxnConfirmation(seededRound+maxRoundsToWaitForTxnConfirm, newAccount, onlineTxID)
nodeStatus, _ = client.Status()
onlineRound := nodeStatus.LastRound
newAccountStatus, err := client.AccountInformation(newAccount)
a.NoError(err, "client should be able to get information about new account")
a.Equal(basics.Online.String(), newAccountStatus.Status, "new account should be online")
// transfer the funds and close to the new account
amountToSend := richBalance - 3*transactionFee - amountToSendInitial - minAcctBalance
txn := fixture.SendMoneyAndWait(onlineRound, amountToSend, transactionFee, richAccount, newAccount, newAccount)
fundedRound := txn.ConfirmedRound
nodeStatus, _ = client.Status()
params, err := client.ConsensusParams(nodeStatus.LastRound)
a.NoError(err)
accountProposesStarting := balanceRoundOf(basics.Round(fundedRound), params)
// Need to wait for funding to take effect on selection, then we can see if we're participating
// Stop before the account should become eligible for selection so we can ensure it wasn't
err = fixture.ClientWaitForRound(fixture.AlgodClient, uint64(accountProposesStarting-1),
time.Duration(uint64(globals.MaxTimePerRound)*uint64(accountProposesStarting-1)))
a.NoError(err)
// Check if the account did not propose any blocks up to this round
blockWasProposed := fixture.VerifyBlockProposedRange(newAccount, int(accountProposesStarting)-1,
int(accountProposesStarting)-1)
a.False(blockWasProposed, "account should not be selected until BalLookback (round %d) passes", int(accountProposesStarting-1))
// Now wait until the round where the funded account will be used.
err = fixture.ClientWaitForRound(fixture.AlgodClient, uint64(accountProposesStarting), 10*globals.MaxTimePerRound)
a.NoError(err)
blockWasProposedByNewAccountRecently := fixture.VerifyBlockProposedRange(newAccount, int(accountProposesStarting), 1)
a.True(blockWasProposedByNewAccountRecently, "newly online account should be proposing blocks")
}
// Returns the earliest round which will have the balanceRound equal to r
func balanceRoundOf(r basics.Round, cparams config.ConsensusParams) basics.Round {
return basics.Round(2*cparams.SeedRefreshInterval*cparams.SeedLookback) + r
}
|
