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
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
|
// 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 logic
import (
"fmt"
"github.com/algorand/go-algorand/data/transactions"
"github.com/algorand/go-algorand/protocol"
)
//go:generate stringer -type=TxnField,GlobalField,AssetParamsField,AppParamsField,AcctParamsField,AssetHoldingField,OnCompletionConstType,EcdsaCurve,EcGroup,Base64Encoding,JSONRefType,VrfStandard,BlockField -output=fields_string.go
// FieldSpec unifies the various specs for assembly, disassembly, and doc generation.
type FieldSpec interface {
Field() byte
Type() StackType
OpVersion() uint64
Note() string
Version() uint64
}
// fieldSpecMap is something that yields a FieldSpec, given a name for the field
type fieldSpecMap interface {
get(name string) (FieldSpec, bool)
}
// FieldGroup binds all the info for a field (names, int value, spec access) so
// they can be attached to opcodes and used by doc generation
type FieldGroup struct {
Name string
Doc string
Names []string
specs fieldSpecMap
}
// SpecByName returns a FieldsSpec for a name, respecting the "sparseness" of
// the Names array to hide some names
func (fg *FieldGroup) SpecByName(name string) (FieldSpec, bool) {
if fs, ok := fg.specs.get(name); ok {
if fg.Names[fs.Field()] != "" {
return fs, true
}
}
return nil, false
}
// TxnField is an enum type for `txn` and `gtxn`
type TxnField int
const (
// Sender Transaction.Sender
Sender TxnField = iota
// Fee Transaction.Fee
Fee
// FirstValid Transaction.FirstValid
FirstValid
// FirstValidTime timestamp of block(FirstValid-1)
FirstValidTime
// LastValid Transaction.LastValid
LastValid
// Note Transaction.Note
Note
// Lease Transaction.Lease
Lease
// Receiver Transaction.Receiver
Receiver
// Amount Transaction.Amount
Amount
// CloseRemainderTo Transaction.CloseRemainderTo
CloseRemainderTo
// VotePK Transaction.VotePK
VotePK
// SelectionPK Transaction.SelectionPK
SelectionPK
// VoteFirst Transaction.VoteFirst
VoteFirst
// VoteLast Transaction.VoteLast
VoteLast
// VoteKeyDilution Transaction.VoteKeyDilution
VoteKeyDilution
// Type Transaction.Type
Type
// TypeEnum int(Transaction.Type)
TypeEnum
// XferAsset Transaction.XferAsset
XferAsset
// AssetAmount Transaction.AssetAmount
AssetAmount
// AssetSender Transaction.AssetSender
AssetSender
// AssetReceiver Transaction.AssetReceiver
AssetReceiver
// AssetCloseTo Transaction.AssetCloseTo
AssetCloseTo
// GroupIndex i for txngroup[i] == Txn
GroupIndex
// TxID Transaction.ID()
TxID
// ApplicationID basics.AppIndex
ApplicationID
// OnCompletion OnCompletion
OnCompletion
// ApplicationArgs [][]byte
ApplicationArgs
// NumAppArgs len(ApplicationArgs)
NumAppArgs
// Accounts []basics.Address
Accounts
// NumAccounts len(Accounts)
NumAccounts
// ApprovalProgram []byte
ApprovalProgram
// ClearStateProgram []byte
ClearStateProgram
// RekeyTo basics.Address
RekeyTo
// ConfigAsset basics.AssetIndex
ConfigAsset
// ConfigAssetTotal AssetParams.Total
ConfigAssetTotal
// ConfigAssetDecimals AssetParams.Decimals
ConfigAssetDecimals
// ConfigAssetDefaultFrozen AssetParams.AssetDefaultFrozen
ConfigAssetDefaultFrozen
// ConfigAssetUnitName AssetParams.UnitName
ConfigAssetUnitName
// ConfigAssetName AssetParams.AssetName
ConfigAssetName
// ConfigAssetURL AssetParams.URL
ConfigAssetURL
// ConfigAssetMetadataHash AssetParams.MetadataHash
ConfigAssetMetadataHash
// ConfigAssetManager AssetParams.Manager
ConfigAssetManager
// ConfigAssetReserve AssetParams.Reserve
ConfigAssetReserve
// ConfigAssetFreeze AssetParams.Freeze
ConfigAssetFreeze
// ConfigAssetClawback AssetParams.Clawback
ConfigAssetClawback
//FreezeAsset basics.AssetIndex
FreezeAsset
// FreezeAssetAccount basics.Address
FreezeAssetAccount
// FreezeAssetFrozen bool
FreezeAssetFrozen
// Assets []basics.AssetIndex
Assets
// NumAssets len(ForeignAssets)
NumAssets
// Applications []basics.AppIndex
Applications
// NumApplications len(ForeignApps)
NumApplications
// GlobalNumUint uint64
GlobalNumUint
// GlobalNumByteSlice uint64
GlobalNumByteSlice
// LocalNumUint uint64
LocalNumUint
// LocalNumByteSlice uint64
LocalNumByteSlice
// ExtraProgramPages AppParams.ExtraProgramPages
ExtraProgramPages
// Nonparticipation Transaction.Nonparticipation
Nonparticipation
// Logs Transaction.ApplyData.EvalDelta.Logs
Logs
// NumLogs len(Logs)
NumLogs
// CreatedAssetID Transaction.ApplyData.EvalDelta.ConfigAsset
CreatedAssetID
// CreatedApplicationID Transaction.ApplyData.EvalDelta.ApplicationID
CreatedApplicationID
// LastLog Logs[len(Logs)-1]
LastLog
// StateProofPK Transaction.StateProofPK
StateProofPK
// ApprovalProgramPages [][]byte
ApprovalProgramPages
// NumApprovalProgramPages = len(ApprovalProgramPages) // 4096
NumApprovalProgramPages
// ClearStateProgramPages [][]byte
ClearStateProgramPages
// NumClearStateProgramPages = len(ClearStateProgramPages) // 4096
NumClearStateProgramPages
invalidTxnField // compile-time constant for number of fields
)
func txnFieldSpecByField(f TxnField) (txnFieldSpec, bool) {
if int(f) >= len(txnFieldSpecs) {
return txnFieldSpec{}, false
}
return txnFieldSpecs[f], true
}
// TxnFieldNames are arguments to the 'txn' family of opcodes.
var TxnFieldNames [invalidTxnField]string
var txnFieldSpecByName = make(tfNameSpecMap, len(TxnFieldNames))
// simple interface used by doc generator for fields versioning
type tfNameSpecMap map[string]txnFieldSpec
func (s tfNameSpecMap) get(name string) (FieldSpec, bool) {
fs, ok := s[name]
return fs, ok
}
type txnFieldSpec struct {
field TxnField
ftype StackType
array bool // Is this an array field?
version uint64 // When this field become available to txn/gtxn. 0=always
itxVersion uint64 // When this field become available to itxn_field. 0=never
effects bool // Is this a field on the "effects"? That is, something in ApplyData
doc string
}
func (fs txnFieldSpec) Field() byte {
return byte(fs.field)
}
func (fs txnFieldSpec) Type() StackType {
return fs.ftype
}
func (fs txnFieldSpec) OpVersion() uint64 {
return 0
}
func (fs txnFieldSpec) Version() uint64 {
return fs.version
}
func (fs txnFieldSpec) Note() string {
note := fs.doc
if fs.effects {
note = addExtra(note, "Application mode only")
}
return note
}
var txnFieldSpecs = [...]txnFieldSpec{
{Sender, StackAddress, false, 0, 5, false, "32 byte address"},
{Fee, StackUint64, false, 0, 5, false, "microalgos"},
{FirstValid, StackUint64, false, 0, 0, false, "round number"},
{FirstValidTime, StackUint64, false, randomnessVersion, 0, false, "UNIX timestamp of block before txn.FirstValid. Fails if negative"},
{LastValid, StackUint64, false, 0, 0, false, "round number"},
{Note, StackBytes, false, 0, 6, false, "Any data up to 1024 bytes"},
{Lease, StackBytes32, false, 0, 0, false, "32 byte lease value"},
{Receiver, StackAddress, false, 0, 5, false, "32 byte address"},
{Amount, StackUint64, false, 0, 5, false, "microalgos"},
{CloseRemainderTo, StackAddress, false, 0, 5, false, "32 byte address"},
{VotePK, StackBytes32, false, 0, 6, false, "32 byte address"},
{SelectionPK, StackBytes32, false, 0, 6, false, "32 byte address"},
{VoteFirst, StackUint64, false, 0, 6, false, "The first round that the participation key is valid."},
{VoteLast, StackUint64, false, 0, 6, false, "The last round that the participation key is valid."},
{VoteKeyDilution, StackUint64, false, 0, 6, false, "Dilution for the 2-level participation key"},
{Type, StackBytes, false, 0, 5, false, "Transaction type as bytes"},
{TypeEnum, StackUint64, false, 0, 5, false, "Transaction type as integer"},
{XferAsset, StackUint64, false, 0, 5, false, "Asset ID"},
{AssetAmount, StackUint64, false, 0, 5, false, "value in Asset's units"},
{AssetSender, StackAddress, false, 0, 5, false,
"32 byte address. Source of assets if Sender is the Asset's Clawback address."},
{AssetReceiver, StackAddress, false, 0, 5, false, "32 byte address"},
{AssetCloseTo, StackAddress, false, 0, 5, false, "32 byte address"},
{GroupIndex, StackUint64, false, 0, 0, false,
"Position of this transaction within an atomic transaction group. A stand-alone transaction is implicitly element 0 in a group of 1"},
{TxID, StackBytes32, false, 0, 0, false, "The computed ID for this transaction. 32 bytes."},
{ApplicationID, StackUint64, false, 2, 6, false, "ApplicationID from ApplicationCall transaction"},
{OnCompletion, StackUint64, false, 2, 6, false, "ApplicationCall transaction on completion action"},
{ApplicationArgs, StackBytes, true, 2, 6, false,
"Arguments passed to the application in the ApplicationCall transaction"},
{NumAppArgs, StackUint64, false, 2, 0, false, "Number of ApplicationArgs"},
{Accounts, StackAddress, true, 2, 6, false, "Accounts listed in the ApplicationCall transaction"},
{NumAccounts, StackUint64, false, 2, 0, false, "Number of Accounts"},
{ApprovalProgram, StackBytes, false, 2, 6, false, "Approval program"},
{ClearStateProgram, StackBytes, false, 2, 6, false, "Clear state program"},
{RekeyTo, StackAddress, false, 2, 6, false, "32 byte Sender's new AuthAddr"},
{ConfigAsset, StackUint64, false, 2, 5, false, "Asset ID in asset config transaction"},
{ConfigAssetTotal, StackUint64, false, 2, 5, false, "Total number of units of this asset created"},
{ConfigAssetDecimals, StackUint64, false, 2, 5, false,
"Number of digits to display after the decimal place when displaying the asset"},
{ConfigAssetDefaultFrozen, StackBoolean, false, 2, 5, false,
"Whether the asset's slots are frozen by default or not, 0 or 1"},
{ConfigAssetUnitName, StackBytes, false, 2, 5, false, "Unit name of the asset"},
{ConfigAssetName, StackBytes, false, 2, 5, false, "The asset name"},
{ConfigAssetURL, StackBytes, false, 2, 5, false, "URL"},
{ConfigAssetMetadataHash, StackBytes32, false, 2, 5, false,
"32 byte commitment to unspecified asset metadata"},
{ConfigAssetManager, StackAddress, false, 2, 5, false, "32 byte address"},
{ConfigAssetReserve, StackAddress, false, 2, 5, false, "32 byte address"},
{ConfigAssetFreeze, StackAddress, false, 2, 5, false, "32 byte address"},
{ConfigAssetClawback, StackAddress, false, 2, 5, false, "32 byte address"},
{FreezeAsset, StackUint64, false, 2, 5, false, "Asset ID being frozen or un-frozen"},
{FreezeAssetAccount, StackAddress, false, 2, 5, false,
"32 byte address of the account whose asset slot is being frozen or un-frozen"},
{FreezeAssetFrozen, StackBoolean, false, 2, 5, false, "The new frozen value, 0 or 1"},
{Assets, StackUint64, true, 3, 6, false, "Foreign Assets listed in the ApplicationCall transaction"},
{NumAssets, StackUint64, false, 3, 0, false, "Number of Assets"},
{Applications, StackUint64, true, 3, 6, false, "Foreign Apps listed in the ApplicationCall transaction"},
{NumApplications, StackUint64, false, 3, 0, false, "Number of Applications"},
{GlobalNumUint, StackUint64, false, 3, 6, false, "Number of global state integers in ApplicationCall"},
{GlobalNumByteSlice, StackUint64, false, 3, 6, false, "Number of global state byteslices in ApplicationCall"},
{LocalNumUint, StackUint64, false, 3, 6, false, "Number of local state integers in ApplicationCall"},
{LocalNumByteSlice, StackUint64, false, 3, 6, false, "Number of local state byteslices in ApplicationCall"},
{ExtraProgramPages, StackUint64, false, 4, 6, false,
"Number of additional pages for each of the application's approval and clear state programs. An ExtraProgramPages of 1 means 2048 more total bytes, or 1024 for each program."},
{Nonparticipation, StackBoolean, false, 5, 6, false, "Marks an account nonparticipating for rewards"},
// "Effects" Last two things are always going to: 0, true
{Logs, StackBytes, true, 5, 0, true, "Log messages emitted by an application call (only with `itxn` in v5)"},
{NumLogs, StackUint64, false, 5, 0, true, "Number of Logs (only with `itxn` in v5)"},
{CreatedAssetID, StackUint64, false, 5, 0, true,
"Asset ID allocated by the creation of an ASA (only with `itxn` in v5)"},
{CreatedApplicationID, StackUint64, false, 5, 0, true,
"ApplicationID allocated by the creation of an application (only with `itxn` in v5)"},
{LastLog, StackBytes, false, 6, 0, true, "The last message emitted. Empty bytes if none were emitted"},
// Not an effect. Just added after the effects fields.
{StateProofPK, StackBytes, false, 6, 6, false, "64 byte state proof public key"},
// Pseudo-fields to aid access to large programs (bigger than TEAL values)
// reading in a txn seems not *super* useful, but setting in `itxn` is critical to inner app factories
{ApprovalProgramPages, StackBytes, true, 7, 7, false, "Approval Program as an array of pages"},
{NumApprovalProgramPages, StackUint64, false, 7, 0, false, "Number of Approval Program pages"},
{ClearStateProgramPages, StackBytes, true, 7, 7, false, "ClearState Program as an array of pages"},
{NumClearStateProgramPages, StackUint64, false, 7, 0, false, "Number of ClearState Program pages"},
}
// TxnFields contains info on the arguments to the txn* family of opcodes
var TxnFields = FieldGroup{
"txn", "",
TxnFieldNames[:],
txnFieldSpecByName,
}
// TxnScalarFields narrows TxnFields to only have the names of scalar fetching opcodes
var TxnScalarFields = FieldGroup{
"txn", "Fields (see [transaction reference](https://developer.algorand.org/docs/reference/transactions/))",
txnScalarFieldNames(),
txnFieldSpecByName,
}
// txnScalarFieldNames are txn field names that return scalars. Return value is
// a "sparse" slice, the names appear at their usual index, array slots are set
// to "". They are laid out this way so that it is possible to get the name
// from the index value.
func txnScalarFieldNames() []string {
names := make([]string, len(txnFieldSpecs))
for i, fs := range txnFieldSpecs {
if fs.array {
names[i] = ""
} else {
names[i] = fs.field.String()
}
}
return names
}
// TxnArrayFields narows TxnFields to only have the names of array fetching opcodes
var TxnArrayFields = FieldGroup{
"txna", "Fields (see [transaction reference](https://developer.algorand.org/docs/reference/transactions/))",
txnaFieldNames(),
txnFieldSpecByName,
}
// txnaFieldNames are txn field names that return arrays. Return value is a
// "sparse" slice, the names appear at their usual index, non-array slots are
// set to "". They are laid out this way so that it is possible to get the name
// from the index value.
func txnaFieldNames() []string {
names := make([]string, len(txnFieldSpecs))
for i, fs := range txnFieldSpecs {
if fs.array {
names[i] = fs.field.String()
} else {
names[i] = ""
}
}
return names
}
// ItxnSettableFields collects info for itxn_field opcode
var ItxnSettableFields = FieldGroup{
"itxn_field", "",
itxnSettableFieldNames(),
txnFieldSpecByName,
}
// itxnSettableFieldNames are txn field names that can be set by
// itxn_field. Return value is a "sparse" slice, the names appear at their usual
// index, unsettable slots are set to "". They are laid out this way so that it is
// possible to get the name from the index value.
func itxnSettableFieldNames() []string {
names := make([]string, len(txnFieldSpecs))
for i, fs := range txnFieldSpecs {
if fs.itxVersion == 0 {
names[i] = ""
} else {
names[i] = fs.field.String()
}
}
return names
}
var innerTxnTypes = map[string]uint64{
string(protocol.PaymentTx): 5,
string(protocol.KeyRegistrationTx): 6,
string(protocol.AssetTransferTx): 5,
string(protocol.AssetConfigTx): 5,
string(protocol.AssetFreezeTx): 5,
string(protocol.ApplicationCallTx): 6,
}
// TxnTypeNames is the values of Txn.Type in enum order
var TxnTypeNames = [...]string{
string(protocol.UnknownTx),
string(protocol.PaymentTx),
string(protocol.KeyRegistrationTx),
string(protocol.AssetConfigTx),
string(protocol.AssetTransferTx),
string(protocol.AssetFreezeTx),
string(protocol.ApplicationCallTx),
}
// map txn type names (long and short) to index/enum value
var txnTypeMap = make(map[string]uint64)
// OnCompletionConstType is the same as transactions.OnCompletion
type OnCompletionConstType transactions.OnCompletion
const (
// NoOp = transactions.NoOpOC
NoOp = OnCompletionConstType(transactions.NoOpOC)
// OptIn = transactions.OptInOC
OptIn = OnCompletionConstType(transactions.OptInOC)
// CloseOut = transactions.CloseOutOC
CloseOut = OnCompletionConstType(transactions.CloseOutOC)
// ClearState = transactions.ClearStateOC
ClearState = OnCompletionConstType(transactions.ClearStateOC)
// UpdateApplication = transactions.UpdateApplicationOC
UpdateApplication = OnCompletionConstType(transactions.UpdateApplicationOC)
// DeleteApplication = transactions.DeleteApplicationOC
DeleteApplication = OnCompletionConstType(transactions.DeleteApplicationOC)
// end of constants
invalidOnCompletionConst = DeleteApplication + 1
)
// OnCompletionNames is the string names of Txn.OnCompletion, array index is the const value
var OnCompletionNames [invalidOnCompletionConst]string
// onCompletionMap maps symbolic name to uint64 for assembleInt
var onCompletionMap map[string]uint64
// GlobalField is an enum for `global` opcode
type GlobalField uint64
const (
// MinTxnFee ConsensusParams.MinTxnFee
MinTxnFee GlobalField = iota
// MinBalance ConsensusParams.MinBalance
MinBalance
// MaxTxnLife ConsensusParams.MaxTxnLife
MaxTxnLife
// ZeroAddress [32]byte{0...}
ZeroAddress
// GroupSize len(txn group)
GroupSize
// v2
// LogicSigVersion ConsensusParams.LogicSigVersion
LogicSigVersion
// Round basics.Round
Round
// LatestTimestamp uint64
LatestTimestamp
// CurrentApplicationID uint64
CurrentApplicationID
// v3
// CreatorAddress [32]byte
CreatorAddress
// v5
// CurrentApplicationAddress [32]byte
CurrentApplicationAddress
// GroupID [32]byte
GroupID
// v6
// OpcodeBudget The remaining budget available for execution
OpcodeBudget
// CallerApplicationID The ID of the caller app, else 0
CallerApplicationID
// CallerApplicationAddress The Address of the caller app, else ZeroAddress
CallerApplicationAddress
// AssetCreateMinBalance is the additional minimum balance required to
// create an asset (which also opts an account into that asset)
AssetCreateMinBalance
// AssetOptInMinBalance is the additional minimum balance required to opt in to an asset
AssetOptInMinBalance
// GenesisHash is the genesis hash for the network
GenesisHash
invalidGlobalField // compile-time constant for number of fields
)
// GlobalFieldNames are arguments to the 'global' opcode
var GlobalFieldNames [invalidGlobalField]string
type globalFieldSpec struct {
field GlobalField
ftype StackType
mode RunMode
version uint64
doc string
}
func (fs globalFieldSpec) Field() byte {
return byte(fs.field)
}
func (fs globalFieldSpec) Type() StackType {
return fs.ftype
}
func (fs globalFieldSpec) OpVersion() uint64 {
return 0
}
func (fs globalFieldSpec) Version() uint64 {
return fs.version
}
func (fs globalFieldSpec) Note() string {
note := fs.doc
if fs.mode == ModeApp {
note = addExtra(note, "Application mode only.")
}
// There are no Signature mode only globals
return note
}
var globalFieldSpecs = [...]globalFieldSpec{
// version 0 is the same as v1 (initial release)
{MinTxnFee, StackUint64, modeAny, 0, "microalgos"},
{MinBalance, StackUint64, modeAny, 0, "microalgos"},
{MaxTxnLife, StackUint64, modeAny, 0, "rounds"},
{ZeroAddress, StackAddress, modeAny, 0, "32 byte address of all zero bytes"},
{GroupSize, StackUint64, modeAny, 0,
"Number of transactions in this atomic transaction group. At least 1"},
{LogicSigVersion, StackUint64, modeAny, 2, "Maximum supported version"},
{Round, StackUint64, ModeApp, 2, "Current round number"},
{LatestTimestamp, StackUint64, ModeApp, 2,
"Last confirmed block UNIX timestamp. Fails if negative"},
{CurrentApplicationID, StackUint64, ModeApp, 2, "ID of current application executing"},
{CreatorAddress, StackAddress, ModeApp, 3,
"Address of the creator of the current application"},
{CurrentApplicationAddress, StackAddress, ModeApp, 5,
"Address that the current application controls"},
{GroupID, StackBytes32, modeAny, 5,
"ID of the transaction group. 32 zero bytes if the transaction is not part of a group."},
{OpcodeBudget, StackUint64, modeAny, 6,
"The remaining cost that can be spent by opcodes in this program."},
{CallerApplicationID, StackUint64, ModeApp, 6,
"The application ID of the application that called this application. 0 if this application is at the top-level."},
{CallerApplicationAddress, StackAddress, ModeApp, 6,
"The application address of the application that called this application. ZeroAddress if this application is at the top-level."},
{AssetCreateMinBalance, StackUint64, modeAny, 10,
"The additional minimum balance required to create (and opt-in to) an asset."},
{AssetOptInMinBalance, StackUint64, modeAny, 10,
"The additional minimum balance required to opt-in to an asset."},
{GenesisHash, StackBytes32, modeAny, 10, "The Genesis Hash for the network."},
}
func globalFieldSpecByField(f GlobalField) (globalFieldSpec, bool) {
if int(f) >= len(globalFieldSpecs) {
return globalFieldSpec{}, false
}
return globalFieldSpecs[f], true
}
var globalFieldSpecByName = make(gfNameSpecMap, len(GlobalFieldNames))
type gfNameSpecMap map[string]globalFieldSpec
func (s gfNameSpecMap) get(name string) (FieldSpec, bool) {
fs, ok := s[name]
return fs, ok
}
// GlobalFields has info on the global opcode's immediate
var GlobalFields = FieldGroup{
"global", "Fields",
GlobalFieldNames[:],
globalFieldSpecByName,
}
// EcdsaCurve is an enum for `ecdsa_` opcodes
type EcdsaCurve int
const (
// Secp256k1 curve for bitcoin/ethereum
Secp256k1 EcdsaCurve = iota
// Secp256r1 curve
Secp256r1
invalidEcdsaCurve // compile-time constant for number of fields
)
var ecdsaCurveNames [invalidEcdsaCurve]string
type ecdsaCurveSpec struct {
field EcdsaCurve
version uint64
doc string
}
func (fs ecdsaCurveSpec) Field() byte {
return byte(fs.field)
}
func (fs ecdsaCurveSpec) Type() StackType {
return StackNone // Will not show, since all are untyped
}
func (fs ecdsaCurveSpec) OpVersion() uint64 {
return 5
}
func (fs ecdsaCurveSpec) Version() uint64 {
return fs.version
}
func (fs ecdsaCurveSpec) Note() string {
return fs.doc
}
var ecdsaCurveSpecs = [...]ecdsaCurveSpec{
{Secp256k1, 5, "secp256k1 curve, used in Bitcoin"},
{Secp256r1, fidoVersion, "secp256r1 curve, NIST standard"},
}
func ecdsaCurveSpecByField(c EcdsaCurve) (ecdsaCurveSpec, bool) {
if int(c) >= len(ecdsaCurveSpecs) {
return ecdsaCurveSpec{}, false
}
return ecdsaCurveSpecs[c], true
}
var ecdsaCurveSpecByName = make(ecdsaCurveNameSpecMap, len(ecdsaCurveNames))
type ecdsaCurveNameSpecMap map[string]ecdsaCurveSpec
func (s ecdsaCurveNameSpecMap) get(name string) (FieldSpec, bool) {
fs, ok := s[name]
return fs, ok
}
// EcdsaCurves collects details about the constants used to describe EcdsaCurves
var EcdsaCurves = FieldGroup{
"ECDSA", "Curves",
ecdsaCurveNames[:],
ecdsaCurveSpecByName,
}
// EcGroup is an enum for `ec_` opcodes
type EcGroup int
const (
// BN254g1 is the G1 group of BN254
BN254g1 EcGroup = iota
// BN254g2 is the G2 group of BN254
BN254g2
// BLS12_381g1 specifies the G1 group of BLS 12-381
BLS12_381g1
// BLS12_381g2 specifies the G2 group of BLS 12-381
BLS12_381g2
invalidEcGroup // compile-time constant for number of fields
)
var ecGroupNames [invalidEcGroup]string
type ecGroupSpec struct {
field EcGroup
doc string
}
func (fs ecGroupSpec) Field() byte {
return byte(fs.field)
}
func (fs ecGroupSpec) Type() StackType {
return StackNone // Will not show, since all are untyped
}
func (fs ecGroupSpec) OpVersion() uint64 {
return pairingVersion
}
func (fs ecGroupSpec) Version() uint64 {
return pairingVersion
}
func (fs ecGroupSpec) Note() string {
return fs.doc
}
var ecGroupSpecs = [...]ecGroupSpec{
{BN254g1, "G1 of the BN254 curve. Points encoded as 32 byte X following by 32 byte Y"},
{BN254g2, "G2 of the BN254 curve. Points encoded as 64 byte X following by 64 byte Y"},
{BLS12_381g1, "G1 of the BLS 12-381 curve. Points encoded as 48 byte X following by 48 byte Y"},
{BLS12_381g2, "G2 of the BLS 12-381 curve. Points encoded as 96 byte X following by 96 byte Y"},
}
func ecGroupSpecByField(c EcGroup) (ecGroupSpec, bool) {
if int(c) >= len(ecGroupSpecs) {
return ecGroupSpec{}, false
}
return ecGroupSpecs[c], true
}
var ecGroupSpecByName = make(ecGroupNameSpecMap, len(ecGroupNames))
type ecGroupNameSpecMap map[string]ecGroupSpec
func (s ecGroupNameSpecMap) get(name string) (FieldSpec, bool) {
fs, ok := s[name]
return fs, ok
}
// EcGroups collects details about the constants used to describe EcGroups
var EcGroups = FieldGroup{
"EC", "Groups",
ecGroupNames[:],
ecGroupSpecByName,
}
// Base64Encoding is an enum for the `base64decode` opcode
type Base64Encoding int
const (
// URLEncoding represents the base64url encoding defined in https://www.rfc-editor.org/rfc/rfc4648.html
URLEncoding Base64Encoding = iota
// StdEncoding represents the standard encoding of the RFC
StdEncoding
invalidBase64Encoding // compile-time constant for number of fields
)
var base64EncodingNames [invalidBase64Encoding]string
type base64EncodingSpec struct {
field Base64Encoding
version uint64
}
var base64EncodingSpecs = [...]base64EncodingSpec{
{URLEncoding, 6},
{StdEncoding, 6},
}
func base64EncodingSpecByField(e Base64Encoding) (base64EncodingSpec, bool) {
if int(e) >= len(base64EncodingSpecs) {
return base64EncodingSpec{}, false
}
return base64EncodingSpecs[e], true
}
var base64EncodingSpecByName = make(base64EncodingSpecMap, len(base64EncodingNames))
type base64EncodingSpecMap map[string]base64EncodingSpec
func (fs base64EncodingSpec) Field() byte {
return byte(fs.field)
}
func (fs base64EncodingSpec) Type() StackType {
return StackAny // Will not show in docs, since all are untyped
}
func (fs base64EncodingSpec) OpVersion() uint64 {
return 6
}
func (fs base64EncodingSpec) Version() uint64 {
return fs.version
}
func (fs base64EncodingSpec) Note() string {
note := "" // no doc list?
return note
}
func (s base64EncodingSpecMap) get(name string) (FieldSpec, bool) {
fs, ok := s[name]
return fs, ok
}
// Base64Encodings describes the base64_encode immediate
var Base64Encodings = FieldGroup{
"base64", "Encodings",
base64EncodingNames[:],
base64EncodingSpecByName,
}
// JSONRefType is an enum for the `json_ref` opcode
type JSONRefType int
const (
// JSONString represents string json value
JSONString JSONRefType = iota
// JSONUint64 represents uint64 json value
JSONUint64
// JSONObject represents json object
JSONObject
invalidJSONRefType // compile-time constant for number of fields
)
var jsonRefTypeNames [invalidJSONRefType]string
type jsonRefSpec struct {
field JSONRefType
ftype StackType
version uint64
}
var jsonRefSpecs = [...]jsonRefSpec{
{JSONString, StackBytes, fidoVersion},
{JSONUint64, StackUint64, fidoVersion},
{JSONObject, StackBytes, fidoVersion},
}
func jsonRefSpecByField(r JSONRefType) (jsonRefSpec, bool) {
if int(r) >= len(jsonRefSpecs) {
return jsonRefSpec{}, false
}
return jsonRefSpecs[r], true
}
var jsonRefSpecByName = make(jsonRefSpecMap, len(jsonRefTypeNames))
type jsonRefSpecMap map[string]jsonRefSpec
func (fs jsonRefSpec) Field() byte {
return byte(fs.field)
}
func (fs jsonRefSpec) Type() StackType {
return fs.ftype
}
func (fs jsonRefSpec) OpVersion() uint64 {
return fidoVersion
}
func (fs jsonRefSpec) Version() uint64 {
return fs.version
}
func (fs jsonRefSpec) Note() string {
note := "" // no doc list?
return note
}
func (s jsonRefSpecMap) get(name string) (FieldSpec, bool) {
fs, ok := s[name]
return fs, ok
}
// JSONRefTypes describes the json_ref immediate
var JSONRefTypes = FieldGroup{
"json_ref", "Types",
jsonRefTypeNames[:],
jsonRefSpecByName,
}
// VrfStandard is an enum for the `vrf_verify` opcode
type VrfStandard int
const (
// VrfAlgorand is the built-in VRF of the Algorand chain
VrfAlgorand VrfStandard = iota
invalidVrfStandard // compile-time constant for number of fields
)
var vrfStandardNames [invalidVrfStandard]string
type vrfStandardSpec struct {
field VrfStandard
version uint64
}
var vrfStandardSpecs = [...]vrfStandardSpec{
{VrfAlgorand, randomnessVersion},
}
func vrfStandardSpecByField(r VrfStandard) (vrfStandardSpec, bool) {
if int(r) >= len(vrfStandardSpecs) {
return vrfStandardSpec{}, false
}
return vrfStandardSpecs[r], true
}
var vrfStandardSpecByName = make(vrfStandardSpecMap, len(vrfStandardNames))
type vrfStandardSpecMap map[string]vrfStandardSpec
func (s vrfStandardSpecMap) get(name string) (FieldSpec, bool) {
fs, ok := s[name]
return fs, ok
}
func (fs vrfStandardSpec) Field() byte {
return byte(fs.field)
}
func (fs vrfStandardSpec) Type() StackType {
return StackNone // Will not show, since all are the same
}
func (fs vrfStandardSpec) OpVersion() uint64 {
return randomnessVersion
}
func (fs vrfStandardSpec) Version() uint64 {
return fs.version
}
func (fs vrfStandardSpec) Note() string {
note := "" // no doc list?
return note
}
func (s vrfStandardSpecMap) SpecByName(name string) FieldSpec {
return s[name]
}
// VrfStandards describes the json_ref immediate
var VrfStandards = FieldGroup{
"vrf_verify", "Standards",
vrfStandardNames[:],
vrfStandardSpecByName,
}
// BlockField is an enum for the `block` opcode
type BlockField int
const (
// BlkSeed is the Block's vrf seed
BlkSeed BlockField = iota
// BlkTimestamp is the Block's timestamp, seconds from epoch
BlkTimestamp
invalidBlockField // compile-time constant for number of fields
)
var blockFieldNames [invalidBlockField]string
type blockFieldSpec struct {
field BlockField
ftype StackType
version uint64
}
var blockFieldSpecs = [...]blockFieldSpec{
{BlkSeed, StackBytes, randomnessVersion},
{BlkTimestamp, StackUint64, randomnessVersion},
}
func blockFieldSpecByField(r BlockField) (blockFieldSpec, bool) {
if int(r) >= len(blockFieldSpecs) {
return blockFieldSpec{}, false
}
return blockFieldSpecs[r], true
}
var blockFieldSpecByName = make(blockFieldSpecMap, len(blockFieldNames))
type blockFieldSpecMap map[string]blockFieldSpec
func (s blockFieldSpecMap) get(name string) (FieldSpec, bool) {
fs, ok := s[name]
return fs, ok
}
func (fs blockFieldSpec) Field() byte {
return byte(fs.field)
}
func (fs blockFieldSpec) Type() StackType {
return fs.ftype
}
func (fs blockFieldSpec) OpVersion() uint64 {
return randomnessVersion
}
func (fs blockFieldSpec) Version() uint64 {
return fs.version
}
func (fs blockFieldSpec) Note() string {
return ""
}
func (s blockFieldSpecMap) SpecByName(name string) FieldSpec {
return s[name]
}
// BlockFields describes the json_ref immediate
var BlockFields = FieldGroup{
"block", "Fields",
blockFieldNames[:],
blockFieldSpecByName,
}
// AssetHoldingField is an enum for `asset_holding_get` opcode
type AssetHoldingField int
const (
// AssetBalance AssetHolding.Amount
AssetBalance AssetHoldingField = iota
// AssetFrozen AssetHolding.Frozen
AssetFrozen
invalidAssetHoldingField // compile-time constant for number of fields
)
var assetHoldingFieldNames [invalidAssetHoldingField]string
type assetHoldingFieldSpec struct {
field AssetHoldingField
ftype StackType
version uint64
doc string
}
func (fs assetHoldingFieldSpec) Field() byte {
return byte(fs.field)
}
func (fs assetHoldingFieldSpec) Type() StackType {
return fs.ftype
}
func (fs assetHoldingFieldSpec) OpVersion() uint64 {
return 2
}
func (fs assetHoldingFieldSpec) Version() uint64 {
return fs.version
}
func (fs assetHoldingFieldSpec) Note() string {
return fs.doc
}
var assetHoldingFieldSpecs = [...]assetHoldingFieldSpec{
{AssetBalance, StackUint64, 2, "Amount of the asset unit held by this account"},
{AssetFrozen, StackBoolean, 2, "Is the asset frozen or not"},
}
func assetHoldingFieldSpecByField(f AssetHoldingField) (assetHoldingFieldSpec, bool) {
if int(f) >= len(assetHoldingFieldSpecs) {
return assetHoldingFieldSpec{}, false
}
return assetHoldingFieldSpecs[f], true
}
var assetHoldingFieldSpecByName = make(ahfNameSpecMap, len(assetHoldingFieldNames))
type ahfNameSpecMap map[string]assetHoldingFieldSpec
func (s ahfNameSpecMap) get(name string) (FieldSpec, bool) {
fs, ok := s[name]
return fs, ok
}
// AssetHoldingFields describes asset_holding_get's immediates
var AssetHoldingFields = FieldGroup{
"asset_holding", "Fields",
assetHoldingFieldNames[:],
assetHoldingFieldSpecByName,
}
// AssetParamsField is an enum for `asset_params_get` opcode
type AssetParamsField int
const (
// AssetTotal AssetParams.Total
AssetTotal AssetParamsField = iota
// AssetDecimals AssetParams.Decimals
AssetDecimals
// AssetDefaultFrozen AssetParams.AssetDefaultFrozen
AssetDefaultFrozen
// AssetUnitName AssetParams.UnitName
AssetUnitName
// AssetName AssetParams.AssetName
AssetName
// AssetURL AssetParams.URL
AssetURL
// AssetMetadataHash AssetParams.MetadataHash
AssetMetadataHash
// AssetManager AssetParams.Manager
AssetManager
// AssetReserve AssetParams.Reserve
AssetReserve
// AssetFreeze AssetParams.Freeze
AssetFreeze
// AssetClawback AssetParams.Clawback
AssetClawback
// AssetCreator is not *in* the Params, but it is uniquely determined.
AssetCreator
invalidAssetParamsField // compile-time constant for number of fields
)
var assetParamsFieldNames [invalidAssetParamsField]string
type assetParamsFieldSpec struct {
field AssetParamsField
ftype StackType
version uint64
doc string
}
func (fs assetParamsFieldSpec) Field() byte {
return byte(fs.field)
}
func (fs assetParamsFieldSpec) Type() StackType {
return fs.ftype
}
func (fs assetParamsFieldSpec) OpVersion() uint64 {
return 2
}
func (fs assetParamsFieldSpec) Version() uint64 {
return fs.version
}
func (fs assetParamsFieldSpec) Note() string {
return fs.doc
}
var assetParamsFieldSpecs = [...]assetParamsFieldSpec{
{AssetTotal, StackUint64, 2, "Total number of units of this asset"},
{AssetDecimals, StackUint64, 2, "See AssetParams.Decimals"},
{AssetDefaultFrozen, StackBoolean, 2, "Frozen by default or not"},
{AssetUnitName, StackBytes, 2, "Asset unit name"},
{AssetName, StackBytes, 2, "Asset name"},
{AssetURL, StackBytes, 2, "URL with additional info about the asset"},
{AssetMetadataHash, StackBytes32, 2, "Arbitrary commitment"},
{AssetManager, StackAddress, 2, "Manager address"},
{AssetReserve, StackAddress, 2, "Reserve address"},
{AssetFreeze, StackAddress, 2, "Freeze address"},
{AssetClawback, StackAddress, 2, "Clawback address"},
{AssetCreator, StackAddress, 5, "Creator address"},
}
func assetParamsFieldSpecByField(f AssetParamsField) (assetParamsFieldSpec, bool) {
if int(f) >= len(assetParamsFieldSpecs) {
return assetParamsFieldSpec{}, false
}
return assetParamsFieldSpecs[f], true
}
var assetParamsFieldSpecByName = make(apfNameSpecMap, len(assetParamsFieldNames))
type apfNameSpecMap map[string]assetParamsFieldSpec
func (s apfNameSpecMap) get(name string) (FieldSpec, bool) {
fs, ok := s[name]
return fs, ok
}
// AssetParamsFields describes asset_params_get's immediates
var AssetParamsFields = FieldGroup{
"asset_params", "Fields",
assetParamsFieldNames[:],
assetParamsFieldSpecByName,
}
// AppParamsField is an enum for `app_params_get` opcode
type AppParamsField int
const (
// AppApprovalProgram AppParams.ApprovalProgram
AppApprovalProgram AppParamsField = iota
// AppClearStateProgram AppParams.ClearStateProgram
AppClearStateProgram
// AppGlobalNumUint AppParams.StateSchemas.GlobalStateSchema.NumUint
AppGlobalNumUint
// AppGlobalNumByteSlice AppParams.StateSchemas.GlobalStateSchema.NumByteSlice
AppGlobalNumByteSlice
// AppLocalNumUint AppParams.StateSchemas.LocalStateSchema.NumUint
AppLocalNumUint
// AppLocalNumByteSlice AppParams.StateSchemas.LocalStateSchema.NumByteSlice
AppLocalNumByteSlice
// AppExtraProgramPages AppParams.ExtraProgramPages
AppExtraProgramPages
// AppCreator is not *in* the Params, but it is uniquely determined.
AppCreator
// AppAddress is also not *in* the Params, but can be derived
AppAddress
invalidAppParamsField // compile-time constant for number of fields
)
var appParamsFieldNames [invalidAppParamsField]string
type appParamsFieldSpec struct {
field AppParamsField
ftype StackType
version uint64
doc string
}
func (fs appParamsFieldSpec) Field() byte {
return byte(fs.field)
}
func (fs appParamsFieldSpec) Type() StackType {
return fs.ftype
}
func (fs appParamsFieldSpec) OpVersion() uint64 {
return 5
}
func (fs appParamsFieldSpec) Version() uint64 {
return fs.version
}
func (fs appParamsFieldSpec) Note() string {
return fs.doc
}
var appParamsFieldSpecs = [...]appParamsFieldSpec{
{AppApprovalProgram, StackBytes, 5, "Bytecode of Approval Program"},
{AppClearStateProgram, StackBytes, 5, "Bytecode of Clear State Program"},
{AppGlobalNumUint, StackUint64, 5, "Number of uint64 values allowed in Global State"},
{AppGlobalNumByteSlice, StackUint64, 5, "Number of byte array values allowed in Global State"},
{AppLocalNumUint, StackUint64, 5, "Number of uint64 values allowed in Local State"},
{AppLocalNumByteSlice, StackUint64, 5, "Number of byte array values allowed in Local State"},
{AppExtraProgramPages, StackUint64, 5, "Number of Extra Program Pages of code space"},
{AppCreator, StackAddress, 5, "Creator address"},
{AppAddress, StackAddress, 5, "Address for which this application has authority"},
}
func appParamsFieldSpecByField(f AppParamsField) (appParamsFieldSpec, bool) {
if int(f) >= len(appParamsFieldSpecs) {
return appParamsFieldSpec{}, false
}
return appParamsFieldSpecs[f], true
}
var appParamsFieldSpecByName = make(appNameSpecMap, len(appParamsFieldNames))
// simple interface used by doc generator for fields versioning
type appNameSpecMap map[string]appParamsFieldSpec
func (s appNameSpecMap) get(name string) (FieldSpec, bool) {
fs, ok := s[name]
return fs, ok
}
// AppParamsFields describes app_params_get's immediates
var AppParamsFields = FieldGroup{
"app_params", "Fields",
appParamsFieldNames[:],
appParamsFieldSpecByName,
}
// AcctParamsField is an enum for `acct_params_get` opcode
type AcctParamsField int
const (
// AcctBalance is the balance, with pending rewards
AcctBalance AcctParamsField = iota
// AcctMinBalance is algos needed for this accounts apps and assets
AcctMinBalance
// AcctAuthAddr is the rekeyed address if any, else ZeroAddress
AcctAuthAddr
// AcctTotalNumUint is the count of all uints from created global apps or opted in locals
AcctTotalNumUint
// AcctTotalNumByteSlice is the count of all byte slices from created global apps or opted in locals
AcctTotalNumByteSlice
// AcctTotalExtraAppPages is the extra code pages across all apps
AcctTotalExtraAppPages
// AcctTotalAppsCreated is the number of apps created by this account
AcctTotalAppsCreated
// AcctTotalAppsOptedIn is the number of apps opted in by this account
AcctTotalAppsOptedIn
// AcctTotalAssetsCreated is the number of ASAs created by this account
AcctTotalAssetsCreated
// AcctTotalAssets is the number of ASAs opted in by this account (always includes AcctTotalAssetsCreated)
AcctTotalAssets
// AcctTotalBoxes is the number of boxes created by the app this account is associated with
AcctTotalBoxes
// AcctTotalBoxBytes is the number of bytes in all boxes of this app account
AcctTotalBoxBytes
// AcctTotalAppSchema - consider how to expose
invalidAcctParamsField // compile-time constant for number of fields
)
var acctParamsFieldNames [invalidAcctParamsField]string
type acctParamsFieldSpec struct {
field AcctParamsField
ftype StackType
version uint64
doc string
}
func (fs acctParamsFieldSpec) Field() byte {
return byte(fs.field)
}
func (fs acctParamsFieldSpec) Type() StackType {
return fs.ftype
}
func (fs acctParamsFieldSpec) OpVersion() uint64 {
return 6
}
func (fs acctParamsFieldSpec) Version() uint64 {
return fs.version
}
func (fs acctParamsFieldSpec) Note() string {
return fs.doc
}
var acctParamsFieldSpecs = [...]acctParamsFieldSpec{
{AcctBalance, StackUint64, 6, "Account balance in microalgos"},
{AcctMinBalance, StackUint64, 6, "Minimum required balance for account, in microalgos"},
{AcctAuthAddr, StackAddress, 6, "Address the account is rekeyed to."},
{AcctTotalNumUint, StackUint64, 8, "The total number of uint64 values allocated by this account in Global and Local States."},
{AcctTotalNumByteSlice, StackUint64, 8, "The total number of byte array values allocated by this account in Global and Local States."},
{AcctTotalExtraAppPages, StackUint64, 8, "The number of extra app code pages used by this account."},
{AcctTotalAppsCreated, StackUint64, 8, "The number of existing apps created by this account."},
{AcctTotalAppsOptedIn, StackUint64, 8, "The number of apps this account is opted into."},
{AcctTotalAssetsCreated, StackUint64, 8, "The number of existing ASAs created by this account."},
{AcctTotalAssets, StackUint64, 8, "The numbers of ASAs held by this account (including ASAs this account created)."},
{AcctTotalBoxes, StackUint64, boxVersion, "The number of existing boxes created by this account's app."},
{AcctTotalBoxBytes, StackUint64, boxVersion, "The total number of bytes used by this account's app's box keys and values."},
}
func acctParamsFieldSpecByField(f AcctParamsField) (acctParamsFieldSpec, bool) {
if int(f) >= len(acctParamsFieldSpecs) {
return acctParamsFieldSpec{}, false
}
return acctParamsFieldSpecs[f], true
}
var acctParamsFieldSpecByName = make(acctNameSpecMap, len(acctParamsFieldNames))
type acctNameSpecMap map[string]acctParamsFieldSpec
func (s acctNameSpecMap) get(name string) (FieldSpec, bool) {
fs, ok := s[name]
return fs, ok
}
// AcctParamsFields describes acct_params_get's immediates
var AcctParamsFields = FieldGroup{
"acct_params", "Fields",
acctParamsFieldNames[:],
acctParamsFieldSpecByName,
}
func init() {
equal := func(x int, y int) {
if x != y {
panic(fmt.Sprintf("%d != %d", x, y))
}
}
equal(len(txnFieldSpecs), len(TxnFieldNames))
for i, s := range txnFieldSpecs {
equal(int(s.field), i)
TxnFieldNames[s.field] = s.field.String()
txnFieldSpecByName[s.field.String()] = s
}
equal(len(globalFieldSpecs), len(GlobalFieldNames))
for i, s := range globalFieldSpecs {
equal(int(s.field), i)
GlobalFieldNames[s.field] = s.field.String()
globalFieldSpecByName[s.field.String()] = s
}
equal(len(ecdsaCurveSpecs), len(ecdsaCurveNames))
for i, s := range ecdsaCurveSpecs {
equal(int(s.field), i)
ecdsaCurveNames[s.field] = s.field.String()
ecdsaCurveSpecByName[s.field.String()] = s
}
equal(len(ecGroupSpecs), len(ecGroupNames))
for i, s := range ecGroupSpecs {
equal(int(s.field), i)
ecGroupNames[s.field] = s.field.String()
ecGroupSpecByName[s.field.String()] = s
}
equal(len(base64EncodingSpecs), len(base64EncodingNames))
for i, s := range base64EncodingSpecs {
equal(int(s.field), i)
base64EncodingNames[i] = s.field.String()
base64EncodingSpecByName[s.field.String()] = s
}
equal(len(jsonRefSpecs), len(jsonRefTypeNames))
for i, s := range jsonRefSpecs {
equal(int(s.field), i)
jsonRefTypeNames[i] = s.field.String()
jsonRefSpecByName[s.field.String()] = s
}
equal(len(vrfStandardSpecs), len(vrfStandardNames))
for i, s := range vrfStandardSpecs {
equal(int(s.field), i)
vrfStandardNames[i] = s.field.String()
vrfStandardSpecByName[s.field.String()] = s
}
equal(len(blockFieldSpecs), len(blockFieldNames))
for i, s := range blockFieldSpecs {
equal(int(s.field), i)
blockFieldNames[i] = s.field.String()
blockFieldSpecByName[s.field.String()] = s
}
equal(len(assetHoldingFieldSpecs), len(assetHoldingFieldNames))
for i, s := range assetHoldingFieldSpecs {
equal(int(s.field), i)
assetHoldingFieldNames[i] = s.field.String()
assetHoldingFieldSpecByName[s.field.String()] = s
}
equal(len(assetParamsFieldSpecs), len(assetParamsFieldNames))
for i, s := range assetParamsFieldSpecs {
equal(int(s.field), i)
assetParamsFieldNames[i] = s.field.String()
assetParamsFieldSpecByName[s.field.String()] = s
}
equal(len(appParamsFieldSpecs), len(appParamsFieldNames))
for i, s := range appParamsFieldSpecs {
equal(int(s.field), i)
appParamsFieldNames[i] = s.field.String()
appParamsFieldSpecByName[s.field.String()] = s
}
equal(len(acctParamsFieldSpecs), len(acctParamsFieldNames))
for i, s := range acctParamsFieldSpecs {
equal(int(s.field), i)
acctParamsFieldNames[i] = s.field.String()
acctParamsFieldSpecByName[s.field.String()] = s
}
txnTypeMap = make(map[string]uint64)
for i, tt := range TxnTypeNames {
txnTypeMap[tt] = uint64(i)
}
for k, v := range TypeNameDescriptions {
txnTypeMap[v] = txnTypeMap[k]
}
onCompletionMap = make(map[string]uint64, len(OnCompletionNames))
for oc := NoOp; oc < invalidOnCompletionConst; oc++ {
symbol := oc.String()
OnCompletionNames[oc] = symbol
onCompletionMap[symbol] = uint64(oc)
}
}
|