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
|
// Copyright (C) 2019-2023 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 txntest
import (
"fmt"
"reflect"
"strings"
"github.com/algorand/go-algorand/config"
"github.com/algorand/go-algorand/crypto"
"github.com/algorand/go-algorand/crypto/stateproof"
"github.com/algorand/go-algorand/data/basics"
"github.com/algorand/go-algorand/data/stateproofmsg"
"github.com/algorand/go-algorand/data/transactions"
"github.com/algorand/go-algorand/data/transactions/logic"
"github.com/algorand/go-algorand/protocol"
)
// Txn exists to simplify writing tests where transaction.Transaction might be unwieldy.
// Txn simplifies testing in these ways:
// * Provides a flat structure to simplify object construction.
// * Defines convenience methods to help setup test state.
type Txn struct {
Type protocol.TxType
Sender basics.Address
Fee interface{} // basics.MicroAlgos, uint64, int, or nil
FirstValid basics.Round
LastValid basics.Round
Note []byte
GenesisID string
GenesisHash crypto.Digest
Group crypto.Digest
Lease [32]byte
RekeyTo basics.Address
VotePK crypto.OneTimeSignatureVerifier
SelectionPK crypto.VRFVerifier
VoteFirst basics.Round
VoteLast basics.Round
VoteKeyDilution uint64
Nonparticipation bool
Receiver basics.Address
Amount uint64
CloseRemainderTo basics.Address
ConfigAsset basics.AssetIndex
AssetParams basics.AssetParams
XferAsset basics.AssetIndex
AssetAmount uint64
AssetSender basics.Address
AssetReceiver basics.Address
AssetCloseTo basics.Address
FreezeAccount basics.Address
FreezeAsset basics.AssetIndex
AssetFrozen bool
ApplicationID basics.AppIndex
OnCompletion transactions.OnCompletion
ApplicationArgs [][]byte
Accounts []basics.Address
ForeignApps []basics.AppIndex
ForeignAssets []basics.AssetIndex
Boxes []transactions.BoxRef
LocalStateSchema basics.StateSchema
GlobalStateSchema basics.StateSchema
ApprovalProgram interface{} // string, nil, or []bytes if already compiled
ClearStateProgram interface{} // string, nil or []bytes if already compiled
ExtraProgramPages uint32
StateProofType protocol.StateProofType
StateProof stateproof.StateProof
StateProofMsg stateproofmsg.Message
}
// internalCopy "finishes" a shallow copy done by a simple Go assignment by
// copying all of the slice fields
func (tx *Txn) internalCopy() {
tx.Note = append([]byte(nil), tx.Note...)
if tx.ApplicationArgs != nil {
tx.ApplicationArgs = append([][]byte(nil), tx.ApplicationArgs...)
for i := range tx.ApplicationArgs {
tx.ApplicationArgs[i] = append([]byte(nil), tx.ApplicationArgs[i]...)
}
}
tx.Accounts = append([]basics.Address(nil), tx.Accounts...)
tx.ForeignApps = append([]basics.AppIndex(nil), tx.ForeignApps...)
tx.ForeignAssets = append([]basics.AssetIndex(nil), tx.ForeignAssets...)
tx.Boxes = append([]transactions.BoxRef(nil), tx.Boxes...)
for i := 0; i < len(tx.Boxes); i++ {
tx.Boxes[i].Name = append([]byte(nil), tx.Boxes[i].Name...)
}
// Programs may or may not actually be byte slices. The other
// possibilitiues don't require copies.
if program, ok := tx.ApprovalProgram.([]byte); ok {
tx.ApprovalProgram = append([]byte(nil), program...)
}
if program, ok := tx.ClearStateProgram.([]byte); ok {
tx.ClearStateProgram = append([]byte(nil), program...)
}
}
// Noted returns a new Txn with the given note field.
func (tx Txn) Noted(note string) *Txn {
tx.internalCopy()
tx.Note = []byte(note)
return &tx
}
// Args returns a new Txn with the given strings as app args
func (tx Txn) Args(strings ...string) *Txn {
tx.internalCopy()
bytes := make([][]byte, len(strings))
for i, s := range strings {
bytes[i] = []byte(s)
}
tx.ApplicationArgs = bytes
return &tx
}
// FillDefaults populates some obvious defaults from config params,
// unless they have already been set.
func (tx *Txn) FillDefaults(params config.ConsensusParams) {
if tx.Fee == nil {
tx.Fee = params.MinTxnFee
}
if tx.LastValid == 0 {
tx.LastValid = tx.FirstValid + basics.Round(params.MaxTxnLife)
}
if tx.Type == protocol.ApplicationCallTx &&
(tx.ApplicationID == 0 || tx.OnCompletion == transactions.UpdateApplicationOC) {
switch program := tx.ApprovalProgram.(type) {
case nil:
tx.ApprovalProgram = fmt.Sprintf("#pragma version %d\nint 1", params.LogicSigVersion)
case string:
if program != "" && !strings.Contains(program, "#pragma version") {
pragma := fmt.Sprintf("#pragma version %d\n", params.LogicSigVersion)
tx.ApprovalProgram = pragma + program
}
case []byte:
}
switch program := tx.ClearStateProgram.(type) {
case nil:
tx.ClearStateProgram = tx.ApprovalProgram
case string:
if program != "" && !strings.Contains(program, "#pragma version") {
pragma := fmt.Sprintf("#pragma version %d\n", params.LogicSigVersion)
tx.ClearStateProgram = pragma + program
}
case []byte:
}
}
}
func assemble(source interface{}) []byte {
switch program := source.(type) {
case string:
if program == "" {
return nil
}
ops, err := logic.AssembleString(program)
if err != nil {
panic(fmt.Sprintf("Bad program %v", ops.Errors))
}
return ops.Program
case []byte:
return program
case nil:
return nil
}
panic(reflect.TypeOf(source))
}
// Txn produces a transactions.Transaction from the fields in this Txn
func (tx Txn) Txn() transactions.Transaction {
switch fee := tx.Fee.(type) {
case basics.MicroAlgos:
// nothing, already have MicroAlgos
case uint64:
tx.Fee = basics.MicroAlgos{Raw: fee}
case int:
if fee >= 0 {
tx.Fee = basics.MicroAlgos{Raw: uint64(fee)}
}
case nil:
tx.Fee = basics.MicroAlgos{}
}
return transactions.Transaction{
Type: tx.Type,
Header: transactions.Header{
Sender: tx.Sender,
Fee: tx.Fee.(basics.MicroAlgos),
FirstValid: tx.FirstValid,
LastValid: tx.LastValid,
Note: tx.Note,
GenesisID: tx.GenesisID,
GenesisHash: tx.GenesisHash,
Group: tx.Group,
Lease: tx.Lease,
RekeyTo: tx.RekeyTo,
},
KeyregTxnFields: transactions.KeyregTxnFields{
VotePK: tx.VotePK,
SelectionPK: tx.SelectionPK,
VoteFirst: tx.VoteFirst,
VoteLast: tx.VoteLast,
VoteKeyDilution: tx.VoteKeyDilution,
Nonparticipation: tx.Nonparticipation,
},
PaymentTxnFields: transactions.PaymentTxnFields{
Receiver: tx.Receiver,
Amount: basics.MicroAlgos{Raw: tx.Amount},
CloseRemainderTo: tx.CloseRemainderTo,
},
AssetConfigTxnFields: transactions.AssetConfigTxnFields{
ConfigAsset: tx.ConfigAsset,
AssetParams: tx.AssetParams,
},
AssetTransferTxnFields: transactions.AssetTransferTxnFields{
XferAsset: tx.XferAsset,
AssetAmount: tx.AssetAmount,
AssetSender: tx.AssetSender,
AssetReceiver: tx.AssetReceiver,
AssetCloseTo: tx.AssetCloseTo,
},
AssetFreezeTxnFields: transactions.AssetFreezeTxnFields{
FreezeAccount: tx.FreezeAccount,
FreezeAsset: tx.FreezeAsset,
AssetFrozen: tx.AssetFrozen,
},
ApplicationCallTxnFields: transactions.ApplicationCallTxnFields{
ApplicationID: tx.ApplicationID,
OnCompletion: tx.OnCompletion,
ApplicationArgs: tx.ApplicationArgs,
Accounts: tx.Accounts,
ForeignApps: append([]basics.AppIndex(nil), tx.ForeignApps...),
ForeignAssets: append([]basics.AssetIndex(nil), tx.ForeignAssets...),
Boxes: tx.Boxes,
LocalStateSchema: tx.LocalStateSchema,
GlobalStateSchema: tx.GlobalStateSchema,
ApprovalProgram: assemble(tx.ApprovalProgram),
ClearStateProgram: assemble(tx.ClearStateProgram),
ExtraProgramPages: tx.ExtraProgramPages,
},
StateProofTxnFields: transactions.StateProofTxnFields{
StateProofType: tx.StateProofType,
StateProof: tx.StateProof,
Message: tx.StateProofMsg,
},
}
}
// SignedTxn produces a unsigned, transactions.SignedTransaction from
// the fields in this Txn. This seemingly pointless operation exists,
// again, for convenience when driving tests.
func (tx Txn) SignedTxn() transactions.SignedTxn {
return transactions.SignedTxn{Txn: tx.Txn()}
}
// SignedTxnWithAD produces unsigned, transactions.SignedTxnWithAD
// from the fields in this Txn. This seemingly pointless operation
// exists, again, for convenience when driving tests.
func (tx Txn) SignedTxnWithAD() transactions.SignedTxnWithAD {
return transactions.SignedTxnWithAD{SignedTxn: tx.SignedTxn()}
}
// Group turns a list of Txns into a slice of SignedTxns with
// GroupIDs set properly to make them a transaction group. The input
// Txns are modified with the calculated GroupID.
func Group(txns ...*Txn) []transactions.SignedTxn {
txgroup := transactions.TxGroup{
TxGroupHashes: make([]crypto.Digest, len(txns)),
}
stxns := make([]transactions.SignedTxn, len(txns))
for i, txn := range txns {
stxns[i] = txn.SignedTxn()
}
for i, txn := range stxns {
txn.Txn.Group = crypto.Digest{}
txgroup.TxGroupHashes[i] = crypto.Digest(txn.ID())
}
group := crypto.HashObj(txgroup)
for i, txn := range txns {
txn.Group = group
stxns[i].Txn.Group = group
}
return stxns
}
|