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-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 ledger
import (
"testing"
"github.com/algorand/go-algorand/config"
"github.com/algorand/go-algorand/data/basics"
"github.com/algorand/go-algorand/data/bookkeeping"
"github.com/algorand/go-algorand/data/transactions"
"github.com/algorand/go-algorand/data/txntest"
"github.com/algorand/go-algorand/ledger/eval"
"github.com/algorand/go-algorand/ledger/ledgercore"
"github.com/algorand/go-algorand/protocol"
"github.com/stretchr/testify/require"
)
// DoubleLedger allows for easy "Double Entry bookkeeping" as a way to write
// fairly extensive ledger tests. In addition to simplifying the addition of
// txns and txgroups to a ledger (and then allowing for inspection of the
// created blocks), it also does a double check on correctness by marshalling
// the created blocks, evaluating the transactions in a ledger copy, and
// asserting that it comes out the same. During the insertion of those
// transactions, the validator ledger is not in `generate` mode - so it
// evaluates and validates, checking that the ApplyDatas that come from the
// first ledger match the ADs created by the second. The validator ledger is
// then temporarily placed in `generate` mode so that the entire block can be
// generated in the copy second ledger, and compared.
type DoubleLedger struct {
t testing.TB
generator *Ledger
validator *Ledger
eval *eval.BlockEvaluator
}
func (dl DoubleLedger) Close() {
dl.generator.Close()
dl.validator.Close()
}
// NewDoubleLedger creates a new DoubleLedger with the supplied balances and consensus version.
func NewDoubleLedger(t testing.TB, balances bookkeeping.GenesisBalances, cv protocol.ConsensusVersion, cfg config.Local, opts ...simpleLedgerOption) DoubleLedger {
g := newSimpleLedgerWithConsensusVersion(t, balances, cv, cfg, opts...)
v := newSimpleLedgerFull(t, balances, cv, g.GenesisHash(), cfg, opts...)
return DoubleLedger{t, g, v, nil}
}
func (dl *DoubleLedger) beginBlock() *eval.BlockEvaluator {
dl.eval = nextBlock(dl.t, dl.generator)
return dl.eval
}
func (dl *DoubleLedger) txn(tx *txntest.Txn, problem ...string) (stib *transactions.SignedTxnInBlock) {
dl.t.Helper()
if dl.eval == nil {
dl.beginBlock()
defer func() {
// only advance if the txn was supposed to succeed
if len(problem) > 0 {
dl.eval = nil
} else {
vb := dl.endBlock()
// It should have a stib, but don't panic here because of an earlier problem.
if len(vb.Block().Payset) > 0 {
stib = &vb.Block().Payset[0]
}
}
}()
}
txn(dl.t, dl.generator, dl.eval, tx, problem...)
return nil
}
func (dl *DoubleLedger) txns(txns ...*txntest.Txn) (payset []transactions.SignedTxnInBlock) {
dl.t.Helper()
if dl.eval == nil {
dl.beginBlock()
defer func() {
vb := dl.endBlock()
payset = vb.Block().Payset
}()
}
for _, tx := range txns {
dl.txn(tx)
}
return nil
}
func (dl *DoubleLedger) txgroup(problem string, txns ...*txntest.Txn) (payset []transactions.SignedTxnInBlock) {
dl.t.Helper()
if dl.eval == nil {
dl.beginBlock()
defer func() {
// only advance if the txgroup was supposed to succeed
if problem != "" {
dl.eval = nil
} else {
vb := dl.endBlock()
payset = vb.Block().Payset
}
}()
}
err := txgroup(dl.t, dl.generator, dl.eval, txns...)
if problem == "" {
require.NoError(dl.t, err)
} else {
require.Error(dl.t, err)
require.Contains(dl.t, err.Error(), problem)
}
return nil
}
func (dl *DoubleLedger) fullBlock(txs ...*txntest.Txn) *ledgercore.ValidatedBlock {
dl.t.Helper()
dl.beginBlock()
dl.txns(txs...)
return dl.endBlock()
}
func (dl *DoubleLedger) endBlock() *ledgercore.ValidatedBlock {
vb := endBlock(dl.t, dl.generator, dl.eval)
if dl.validator != nil { // Allows setting to nil while debugging, to simplify
checkBlock(dl.t, dl.validator, vb)
}
dl.eval = nil // Ensure it's not used again
return vb
}
func (dl *DoubleLedger) fundedApp(sender basics.Address, amount uint64, source string) basics.AppIndex {
createapp := txntest.Txn{
Type: "appl",
Sender: sender,
ApprovalProgram: source,
}
vb := dl.fullBlock(&createapp)
appIndex := vb.Block().Payset[0].ApplyData.ApplicationID
fund := txntest.Txn{
Type: "pay",
Sender: sender,
Receiver: appIndex.Address(),
Amount: amount,
}
dl.txn(&fund)
return appIndex
}
func (dl *DoubleLedger) reloadLedgers() {
require.NoError(dl.t, dl.generator.reloadLedger())
require.NoError(dl.t, dl.validator.reloadLedger())
}
func checkBlock(t testing.TB, checkLedger *Ledger, vb *ledgercore.ValidatedBlock) {
bl := vb.Block()
msg := bl.MarshalMsg(nil)
var reconstituted bookkeeping.Block
_, err := reconstituted.UnmarshalMsg(msg)
require.NoError(t, err)
check := nextCheckBlock(t, checkLedger, reconstituted.RewardsState)
var group []transactions.SignedTxnWithAD
for _, stib := range reconstituted.Payset {
stxn, ad, err := reconstituted.BlockHeader.DecodeSignedTxn(stib)
require.NoError(t, err)
stad := transactions.SignedTxnWithAD{SignedTxn: stxn, ApplyData: ad}
// If txn we're looking at belongs in the current group, append
if group == nil || (!stxn.Txn.Group.IsZero() && group[0].Txn.Group == stxn.Txn.Group) {
group = append(group, stad)
} else if group != nil {
err := check.TransactionGroup(group)
require.NoError(t, err)
group = []transactions.SignedTxnWithAD{stad}
}
}
if group != nil {
err := check.TransactionGroup(group)
require.NoError(t, err, "%+v", reconstituted.Payset)
}
check.SetGenerateForTesting(true)
cb := endBlock(t, checkLedger, check)
check.SetGenerateForTesting(false)
require.Equal(t, vb.Block(), cb.Block())
// vb.Delta() need not actually be Equal, in the sense of require.Equal
// because the order of the records in Accts is determined by the way the
// cb.sdeltas map (and then the maps in there) is iterated when the
// StateDelta is constructed by roundCowState.deltas(). They should be
// semantically equivalent, but those fields are not exported, so checking
// equivalence is hard. If vb.Delta() is, in fact, different, even though
// vb.Block() is the same, then there is something seriously broken going
// on, that is unlikely to have anything to do with these tests. So upshot:
// we skip trying a complicated equality check.
// This is the part of checking Delta() equality that wouldn't work right.
// require.Equal(t, vb.Delta().Accts, cb.Delta().Accts)
}
func nextCheckBlock(t testing.TB, ledger *Ledger, rs bookkeeping.RewardsState) *eval.BlockEvaluator {
rnd := ledger.Latest()
hdr, err := ledger.BlockHdr(rnd)
require.NoError(t, err)
nextHdr := bookkeeping.MakeBlock(hdr).BlockHeader
nextHdr.RewardsState = rs
// follow nextBlock, which does this for determinism
nextHdr.TimeStamp = hdr.TimeStamp + 1
eval, err := eval.StartEvaluator(ledger, nextHdr, eval.EvaluatorOptions{
Generate: false,
Validate: true, // Do the complete checks that a new txn would be subject to
})
require.NoError(t, err)
return eval
}
|
