algosdk 2.7.0 → 2.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (40) hide show
  1. package/README.md +4 -4
  2. package/dist/browser/algosdk.min.js +1 -1
  3. package/dist/browser/algosdk.min.js.map +1 -1
  4. package/dist/cjs/abi/contract.js +2 -0
  5. package/dist/cjs/abi/contract.js.map +1 -1
  6. package/dist/cjs/abi/event.js +3 -0
  7. package/dist/cjs/abi/event.js.map +1 -0
  8. package/dist/cjs/abi/method.js +4 -0
  9. package/dist/cjs/abi/method.js.map +1 -1
  10. package/dist/cjs/client/v2/algod/models/types.js +194 -7
  11. package/dist/cjs/client/v2/algod/models/types.js.map +1 -1
  12. package/dist/cjs/client/v2/indexer/models/types.js +110 -67
  13. package/dist/cjs/client/v2/indexer/models/types.js.map +1 -1
  14. package/dist/cjs/makeTxn.js +26 -0
  15. package/dist/cjs/makeTxn.js.map +1 -1
  16. package/dist/esm/abi/contract.js +2 -0
  17. package/dist/esm/abi/contract.js.map +1 -1
  18. package/dist/esm/abi/event.js +2 -0
  19. package/dist/esm/abi/event.js.map +1 -0
  20. package/dist/esm/abi/method.js +4 -0
  21. package/dist/esm/abi/method.js.map +1 -1
  22. package/dist/esm/client/v2/algod/models/types.js +188 -5
  23. package/dist/esm/client/v2/algod/models/types.js.map +1 -1
  24. package/dist/esm/client/v2/indexer/models/types.js +110 -67
  25. package/dist/esm/client/v2/indexer/models/types.js.map +1 -1
  26. package/dist/esm/makeTxn.js +26 -0
  27. package/dist/esm/makeTxn.js.map +1 -1
  28. package/dist/types/abi/contract.d.ts +4 -0
  29. package/dist/types/abi/event.d.ts +16 -0
  30. package/dist/types/abi/method.d.ts +7 -0
  31. package/dist/types/client/v2/algod/models/types.d.ts +175 -5
  32. package/dist/types/client/v2/indexer/models/types.d.ts +189 -131
  33. package/dist/types/makeTxn.d.ts +29 -1
  34. package/package.json +2 -2
  35. package/src/abi/contract.ts +6 -0
  36. package/src/abi/event.ts +16 -0
  37. package/src/abi/method.ts +12 -0
  38. package/src/client/v2/algod/models/types.ts +337 -0
  39. package/src/client/v2/indexer/models/types.ts +241 -127
  40. package/src/makeTxn.ts +29 -1
@@ -18,7 +18,7 @@ export class Account extends BaseModel {
18
18
  public address: string;
19
19
 
20
20
  /**
21
- * (algo) total number of MicroAlgos in the account
21
+ * total number of MicroAlgos in the account
22
22
  */
23
23
  public amount: number | bigint;
24
24
 
@@ -27,14 +27,19 @@ export class Account extends BaseModel {
27
27
  */
28
28
  public amountWithoutPendingRewards: number | bigint;
29
29
 
30
+ /**
31
+ * MicroAlgo balance required by the account.
32
+ * The requirement grows based on asset and application usage.
33
+ */
34
+ public minBalance: number | bigint;
35
+
30
36
  /**
31
37
  * amount of MicroAlgos of pending rewards in this account.
32
38
  */
33
39
  public pendingRewards: number | bigint;
34
40
 
35
41
  /**
36
- * (ern) total rewards of MicroAlgos the account has received, including pending
37
- * rewards.
42
+ * total rewards of MicroAlgos the account has received, including pending rewards.
38
43
  */
39
44
  public rewards: number | bigint;
40
45
 
@@ -44,7 +49,7 @@ export class Account extends BaseModel {
44
49
  public round: number | bigint;
45
50
 
46
51
  /**
47
- * (onl) delegation status of the account's MicroAlgos
52
+ * voting status of the account's MicroAlgos
48
53
  * * Offline - indicates that the associated account is delegated.
49
54
  * * Online - indicates that the associated account used as part of the delegation
50
55
  * pool.
@@ -88,33 +93,32 @@ export class Account extends BaseModel {
88
93
  public totalCreatedAssets: number | bigint;
89
94
 
90
95
  /**
91
- * (appl) applications local data stored in this account.
96
+ * application local data stored in this account.
92
97
  * Note the raw object uses `map[int] -> AppLocalState` for this type.
93
98
  */
94
99
  public appsLocalState?: ApplicationLocalState[];
95
100
 
96
101
  /**
97
- * (teap) the sum of all extra application program pages for this account.
102
+ * the sum of all extra application program pages for this account.
98
103
  */
99
104
  public appsTotalExtraPages?: number | bigint;
100
105
 
101
106
  /**
102
- * (tsch) stores the sum of all of the local schemas and global schemas in this
103
- * account.
107
+ * the sum of all of the local schemas and global schemas in this account.
104
108
  * Note: the raw account uses `StateSchema` for this type.
105
109
  */
106
110
  public appsTotalSchema?: ApplicationStateSchema;
107
111
 
108
112
  /**
109
- * (asset) assets held by this account.
113
+ * assets held by this account.
110
114
  * Note the raw object uses `map[int] -> AssetHolding` for this type.
111
115
  */
112
116
  public assets?: AssetHolding[];
113
117
 
114
118
  /**
115
- * (spend) the address against which signing should be checked. If empty, the
116
- * address of the current account is used. This field can be updated in any
117
- * transaction by setting the RekeyTo field.
119
+ * The address against which signing should be checked. If empty, the address of
120
+ * the current account is used. This field can be updated in any transaction by
121
+ * setting the RekeyTo field.
118
122
  */
119
123
  public authAddr?: string;
120
124
 
@@ -124,14 +128,13 @@ export class Account extends BaseModel {
124
128
  public closedAtRound?: number | bigint;
125
129
 
126
130
  /**
127
- * (appp) parameters of applications created by this account including app global
128
- * data.
131
+ * parameters of applications created by this account including app global data.
129
132
  * Note: the raw account uses `map[int] -> AppParams` for this type.
130
133
  */
131
134
  public createdApps?: Application[];
132
135
 
133
136
  /**
134
- * (apar) parameters of assets created by this account.
137
+ * parameters of assets created by this account.
135
138
  * Note: the raw account uses `map[int] -> Asset` for this type.
136
139
  */
137
140
  public createdAssets?: Asset[];
@@ -146,6 +149,23 @@ export class Account extends BaseModel {
146
149
  */
147
150
  public deleted?: boolean;
148
151
 
152
+ /**
153
+ * can the account receive block incentives if its balance is in range at proposal
154
+ * time.
155
+ */
156
+ public incentiveEligible?: boolean;
157
+
158
+ /**
159
+ * The round in which this account last went online, or explicitly renewed their
160
+ * online status.
161
+ */
162
+ public lastHeartbeat?: number | bigint;
163
+
164
+ /**
165
+ * The round in which this account last proposed the block.
166
+ */
167
+ public lastProposed?: number | bigint;
168
+
149
169
  /**
150
170
  * AccountParticipation describes the parameters used by this account in consensus
151
171
  * protocol.
@@ -153,13 +173,13 @@ export class Account extends BaseModel {
153
173
  public participation?: AccountParticipation;
154
174
 
155
175
  /**
156
- * (ebase) used as part of the rewards computation. Only applicable to accounts
157
- * which are participating.
176
+ * used as part of the rewards computation. Only applicable to accounts which are
177
+ * participating.
158
178
  */
159
179
  public rewardBase?: number | bigint;
160
180
 
161
181
  /**
162
- * Indicates what type of signature is used by this account, must be one of:
182
+ * the type of signature used by this account, must be one of:
163
183
  * * sig
164
184
  * * msig
165
185
  * * lsig
@@ -170,13 +190,14 @@ export class Account extends BaseModel {
170
190
  /**
171
191
  * Creates a new `Account` object.
172
192
  * @param address - the account public key
173
- * @param amount - (algo) total number of MicroAlgos in the account
193
+ * @param amount - total number of MicroAlgos in the account
174
194
  * @param amountWithoutPendingRewards - specifies the amount of MicroAlgos in the account, without the pending rewards.
195
+ * @param minBalance - MicroAlgo balance required by the account.
196
+ * The requirement grows based on asset and application usage.
175
197
  * @param pendingRewards - amount of MicroAlgos of pending rewards in this account.
176
- * @param rewards - (ern) total rewards of MicroAlgos the account has received, including pending
177
- * rewards.
198
+ * @param rewards - total rewards of MicroAlgos the account has received, including pending rewards.
178
199
  * @param round - The round for which this information is relevant.
179
- * @param status - (onl) delegation status of the account's MicroAlgos
200
+ * @param status - voting status of the account's MicroAlgos
180
201
  * * Offline - indicates that the associated account is delegated.
181
202
  * * Online - indicates that the associated account used as part of the delegation
182
203
  * pool.
@@ -192,30 +213,33 @@ export class Account extends BaseModel {
192
213
  * application.
193
214
  * @param totalCreatedApps - The count of all apps (AppParams objects) created by this account.
194
215
  * @param totalCreatedAssets - The count of all assets (AssetParams objects) created by this account.
195
- * @param appsLocalState - (appl) applications local data stored in this account.
216
+ * @param appsLocalState - application local data stored in this account.
196
217
  * Note the raw object uses `map[int] -> AppLocalState` for this type.
197
- * @param appsTotalExtraPages - (teap) the sum of all extra application program pages for this account.
198
- * @param appsTotalSchema - (tsch) stores the sum of all of the local schemas and global schemas in this
199
- * account.
218
+ * @param appsTotalExtraPages - the sum of all extra application program pages for this account.
219
+ * @param appsTotalSchema - the sum of all of the local schemas and global schemas in this account.
200
220
  * Note: the raw account uses `StateSchema` for this type.
201
- * @param assets - (asset) assets held by this account.
221
+ * @param assets - assets held by this account.
202
222
  * Note the raw object uses `map[int] -> AssetHolding` for this type.
203
- * @param authAddr - (spend) the address against which signing should be checked. If empty, the
204
- * address of the current account is used. This field can be updated in any
205
- * transaction by setting the RekeyTo field.
223
+ * @param authAddr - The address against which signing should be checked. If empty, the address of
224
+ * the current account is used. This field can be updated in any transaction by
225
+ * setting the RekeyTo field.
206
226
  * @param closedAtRound - Round during which this account was most recently closed.
207
- * @param createdApps - (appp) parameters of applications created by this account including app global
208
- * data.
227
+ * @param createdApps - parameters of applications created by this account including app global data.
209
228
  * Note: the raw account uses `map[int] -> AppParams` for this type.
210
- * @param createdAssets - (apar) parameters of assets created by this account.
229
+ * @param createdAssets - parameters of assets created by this account.
211
230
  * Note: the raw account uses `map[int] -> Asset` for this type.
212
231
  * @param createdAtRound - Round during which this account first appeared in a transaction.
213
232
  * @param deleted - Whether or not this account is currently closed.
233
+ * @param incentiveEligible - can the account receive block incentives if its balance is in range at proposal
234
+ * time.
235
+ * @param lastHeartbeat - The round in which this account last went online, or explicitly renewed their
236
+ * online status.
237
+ * @param lastProposed - The round in which this account last proposed the block.
214
238
  * @param participation - AccountParticipation describes the parameters used by this account in consensus
215
239
  * protocol.
216
- * @param rewardBase - (ebase) used as part of the rewards computation. Only applicable to accounts
217
- * which are participating.
218
- * @param sigType - Indicates what type of signature is used by this account, must be one of:
240
+ * @param rewardBase - used as part of the rewards computation. Only applicable to accounts which are
241
+ * participating.
242
+ * @param sigType - the type of signature used by this account, must be one of:
219
243
  * * sig
220
244
  * * msig
221
245
  * * lsig
@@ -225,6 +249,7 @@ export class Account extends BaseModel {
225
249
  address,
226
250
  amount,
227
251
  amountWithoutPendingRewards,
252
+ minBalance,
228
253
  pendingRewards,
229
254
  rewards,
230
255
  round,
@@ -245,6 +270,9 @@ export class Account extends BaseModel {
245
270
  createdAssets,
246
271
  createdAtRound,
247
272
  deleted,
273
+ incentiveEligible,
274
+ lastHeartbeat,
275
+ lastProposed,
248
276
  participation,
249
277
  rewardBase,
250
278
  sigType,
@@ -252,6 +280,7 @@ export class Account extends BaseModel {
252
280
  address: string;
253
281
  amount: number | bigint;
254
282
  amountWithoutPendingRewards: number | bigint;
283
+ minBalance: number | bigint;
255
284
  pendingRewards: number | bigint;
256
285
  rewards: number | bigint;
257
286
  round: number | bigint;
@@ -272,6 +301,9 @@ export class Account extends BaseModel {
272
301
  createdAssets?: Asset[];
273
302
  createdAtRound?: number | bigint;
274
303
  deleted?: boolean;
304
+ incentiveEligible?: boolean;
305
+ lastHeartbeat?: number | bigint;
306
+ lastProposed?: number | bigint;
275
307
  participation?: AccountParticipation;
276
308
  rewardBase?: number | bigint;
277
309
  sigType?: string;
@@ -280,6 +312,7 @@ export class Account extends BaseModel {
280
312
  this.address = address;
281
313
  this.amount = amount;
282
314
  this.amountWithoutPendingRewards = amountWithoutPendingRewards;
315
+ this.minBalance = minBalance;
283
316
  this.pendingRewards = pendingRewards;
284
317
  this.rewards = rewards;
285
318
  this.round = round;
@@ -300,6 +333,9 @@ export class Account extends BaseModel {
300
333
  this.createdAssets = createdAssets;
301
334
  this.createdAtRound = createdAtRound;
302
335
  this.deleted = deleted;
336
+ this.incentiveEligible = incentiveEligible;
337
+ this.lastHeartbeat = lastHeartbeat;
338
+ this.lastProposed = lastProposed;
303
339
  this.participation = participation;
304
340
  this.rewardBase = rewardBase;
305
341
  this.sigType = sigType;
@@ -308,6 +344,7 @@ export class Account extends BaseModel {
308
344
  address: 'address',
309
345
  amount: 'amount',
310
346
  amountWithoutPendingRewards: 'amount-without-pending-rewards',
347
+ minBalance: 'min-balance',
311
348
  pendingRewards: 'pending-rewards',
312
349
  rewards: 'rewards',
313
350
  round: 'round',
@@ -328,6 +365,9 @@ export class Account extends BaseModel {
328
365
  createdAssets: 'created-assets',
329
366
  createdAtRound: 'created-at-round',
330
367
  deleted: 'deleted',
368
+ incentiveEligible: 'incentive-eligible',
369
+ lastHeartbeat: 'last-heartbeat',
370
+ lastProposed: 'last-proposed',
331
371
  participation: 'participation',
332
372
  rewardBase: 'reward-base',
333
373
  sigType: 'sig-type',
@@ -345,6 +385,10 @@ export class Account extends BaseModel {
345
385
  throw new Error(
346
386
  `Response is missing required field 'amount-without-pending-rewards': ${data}`
347
387
  );
388
+ if (typeof data['min-balance'] === 'undefined')
389
+ throw new Error(
390
+ `Response is missing required field 'min-balance': ${data}`
391
+ );
348
392
  if (typeof data['pending-rewards'] === 'undefined')
349
393
  throw new Error(
350
394
  `Response is missing required field 'pending-rewards': ${data}`
@@ -383,6 +427,7 @@ export class Account extends BaseModel {
383
427
  address: data['address'],
384
428
  amount: data['amount'],
385
429
  amountWithoutPendingRewards: data['amount-without-pending-rewards'],
430
+ minBalance: data['min-balance'],
386
431
  pendingRewards: data['pending-rewards'],
387
432
  rewards: data['rewards'],
388
433
  round: data['round'],
@@ -422,6 +467,9 @@ export class Account extends BaseModel {
422
467
  : undefined,
423
468
  createdAtRound: data['created-at-round'],
424
469
  deleted: data['deleted'],
470
+ incentiveEligible: data['incentive-eligible'],
471
+ lastHeartbeat: data['last-heartbeat'],
472
+ lastProposed: data['last-proposed'],
425
473
  participation:
426
474
  typeof data['participation'] !== 'undefined'
427
475
  ? AccountParticipation.from_obj_for_encoding(data['participation'])
@@ -439,45 +487,43 @@ export class Account extends BaseModel {
439
487
  */
440
488
  export class AccountParticipation extends BaseModel {
441
489
  /**
442
- * (sel) Selection public key (if any) currently registered for this round.
490
+ * Selection public key (if any) currently registered for this round.
443
491
  */
444
492
  public selectionParticipationKey: Uint8Array;
445
493
 
446
494
  /**
447
- * (voteFst) First round for which this participation is valid.
495
+ * First round for which this participation is valid.
448
496
  */
449
497
  public voteFirstValid: number | bigint;
450
498
 
451
499
  /**
452
- * (voteKD) Number of subkeys in each batch of participation keys.
500
+ * Number of subkeys in each batch of participation keys.
453
501
  */
454
502
  public voteKeyDilution: number | bigint;
455
503
 
456
504
  /**
457
- * (voteLst) Last round for which this participation is valid.
505
+ * Last round for which this participation is valid.
458
506
  */
459
507
  public voteLastValid: number | bigint;
460
508
 
461
509
  /**
462
- * (vote) root participation public key (if any) currently registered for this
463
- * round.
510
+ * root participation public key (if any) currently registered for this round.
464
511
  */
465
512
  public voteParticipationKey: Uint8Array;
466
513
 
467
514
  /**
468
- * (stprf) Root of the state proof key (if any)
515
+ * Root of the state proof key (if any)
469
516
  */
470
517
  public stateProofKey?: Uint8Array;
471
518
 
472
519
  /**
473
520
  * Creates a new `AccountParticipation` object.
474
- * @param selectionParticipationKey - (sel) Selection public key (if any) currently registered for this round.
475
- * @param voteFirstValid - (voteFst) First round for which this participation is valid.
476
- * @param voteKeyDilution - (voteKD) Number of subkeys in each batch of participation keys.
477
- * @param voteLastValid - (voteLst) Last round for which this participation is valid.
478
- * @param voteParticipationKey - (vote) root participation public key (if any) currently registered for this
479
- * round.
480
- * @param stateProofKey - (stprf) Root of the state proof key (if any)
521
+ * @param selectionParticipationKey - Selection public key (if any) currently registered for this round.
522
+ * @param voteFirstValid - First round for which this participation is valid.
523
+ * @param voteKeyDilution - Number of subkeys in each batch of participation keys.
524
+ * @param voteLastValid - Last round for which this participation is valid.
525
+ * @param voteParticipationKey - root participation public key (if any) currently registered for this round.
526
+ * @param stateProofKey - Root of the state proof key (if any)
481
527
  */
482
528
  constructor({
483
529
  selectionParticipationKey,
@@ -735,12 +781,12 @@ export class AccountsResponse extends BaseModel {
735
781
  */
736
782
  export class Application extends BaseModel {
737
783
  /**
738
- * (appidx) application index.
784
+ * application index.
739
785
  */
740
786
  public id: number | bigint;
741
787
 
742
788
  /**
743
- * (appparams) application parameters.
789
+ * application parameters.
744
790
  */
745
791
  public params: ApplicationParams;
746
792
 
@@ -761,8 +807,8 @@ export class Application extends BaseModel {
761
807
 
762
808
  /**
763
809
  * Creates a new `Application` object.
764
- * @param id - (appidx) application index.
765
- * @param params - (appparams) application parameters.
810
+ * @param id - application index.
811
+ * @param params - application parameters.
766
812
  * @param createdAtRound - Round when this application was created.
767
813
  * @param deleted - Whether or not this application is currently deleted.
768
814
  * @param deletedAtRound - Round when this application was deleted.
@@ -824,7 +870,7 @@ export class ApplicationLocalState extends BaseModel {
824
870
  public id: number | bigint;
825
871
 
826
872
  /**
827
- * (hsch) schema.
873
+ * schema.
828
874
  */
829
875
  public schema: ApplicationStateSchema;
830
876
 
@@ -840,7 +886,7 @@ export class ApplicationLocalState extends BaseModel {
840
886
  public deleted?: boolean;
841
887
 
842
888
  /**
843
- * (tkv) storage.
889
+ * storage.
844
890
  */
845
891
  public keyValue?: TealKeyValue[];
846
892
 
@@ -852,11 +898,11 @@ export class ApplicationLocalState extends BaseModel {
852
898
  /**
853
899
  * Creates a new `ApplicationLocalState` object.
854
900
  * @param id - The application which this local state is for.
855
- * @param schema - (hsch) schema.
901
+ * @param schema - schema.
856
902
  * @param closedOutAtRound - Round when account closed out of the application.
857
903
  * @param deleted - Whether or not the application local state is currently deleted from its
858
904
  * account.
859
- * @param keyValue - (tkv) storage.
905
+ * @param keyValue - storage.
860
906
  * @param optedInAtRound - Round when the account opted into the application.
861
907
  */
862
908
  constructor({
@@ -990,7 +1036,7 @@ export class ApplicationLocalStatesResponse extends BaseModel {
990
1036
  */
991
1037
  export class ApplicationLogData extends BaseModel {
992
1038
  /**
993
- * (lg) Logs for the application being executed by the transaction.
1039
+ * Logs for the application being executed by the transaction.
994
1040
  */
995
1041
  public logs: Uint8Array[];
996
1042
 
@@ -1001,7 +1047,7 @@ export class ApplicationLogData extends BaseModel {
1001
1047
 
1002
1048
  /**
1003
1049
  * Creates a new `ApplicationLogData` object.
1004
- * @param logs - (lg) Logs for the application being executed by the transaction.
1050
+ * @param logs - Logs for the application being executed by the transaction.
1005
1051
  * @param txid - Transaction ID
1006
1052
  */
1007
1053
  constructor({ logs, txid }: { logs: Uint8Array[]; txid: string }) {
@@ -1118,12 +1164,12 @@ export class ApplicationLogsResponse extends BaseModel {
1118
1164
  */
1119
1165
  export class ApplicationParams extends BaseModel {
1120
1166
  /**
1121
- * (approv) approval program.
1167
+ * approval program.
1122
1168
  */
1123
1169
  public approvalProgram: Uint8Array;
1124
1170
 
1125
1171
  /**
1126
- * (clearp) approval program.
1172
+ * clear state program.
1127
1173
  */
1128
1174
  public clearStateProgram: Uint8Array;
1129
1175
 
@@ -1134,35 +1180,35 @@ export class ApplicationParams extends BaseModel {
1134
1180
  public creator?: string;
1135
1181
 
1136
1182
  /**
1137
- * (epp) the amount of extra program pages available to this app.
1183
+ * the number of extra program pages available to this app.
1138
1184
  */
1139
1185
  public extraProgramPages?: number | bigint;
1140
1186
 
1141
1187
  /**
1142
- * [\gs) global schema
1188
+ * global state
1143
1189
  */
1144
1190
  public globalState?: TealKeyValue[];
1145
1191
 
1146
1192
  /**
1147
- * [\gsch) global schema
1193
+ * global schema
1148
1194
  */
1149
1195
  public globalStateSchema?: ApplicationStateSchema;
1150
1196
 
1151
1197
  /**
1152
- * [\lsch) local schema
1198
+ * local schema
1153
1199
  */
1154
1200
  public localStateSchema?: ApplicationStateSchema;
1155
1201
 
1156
1202
  /**
1157
1203
  * Creates a new `ApplicationParams` object.
1158
- * @param approvalProgram - (approv) approval program.
1159
- * @param clearStateProgram - (clearp) approval program.
1204
+ * @param approvalProgram - approval program.
1205
+ * @param clearStateProgram - clear state program.
1160
1206
  * @param creator - The address that created this application. This is the address where the
1161
1207
  * parameters and global state for this application can be found.
1162
- * @param extraProgramPages - (epp) the amount of extra program pages available to this app.
1163
- * @param globalState - [\gs) global schema
1164
- * @param globalStateSchema - [\gsch) global schema
1165
- * @param localStateSchema - [\lsch) local schema
1208
+ * @param extraProgramPages - the number of extra program pages available to this app.
1209
+ * @param globalState - global state
1210
+ * @param globalStateSchema - global schema
1211
+ * @param localStateSchema - local schema
1166
1212
  */
1167
1213
  constructor({
1168
1214
  approvalProgram,
@@ -1303,19 +1349,19 @@ export class ApplicationResponse extends BaseModel {
1303
1349
  */
1304
1350
  export class ApplicationStateSchema extends BaseModel {
1305
1351
  /**
1306
- * (nbs) num of byte slices.
1352
+ * number of byte slices.
1307
1353
  */
1308
1354
  public numByteSlice: number | bigint;
1309
1355
 
1310
1356
  /**
1311
- * (nui) num of uints.
1357
+ * number of uints.
1312
1358
  */
1313
1359
  public numUint: number | bigint;
1314
1360
 
1315
1361
  /**
1316
1362
  * Creates a new `ApplicationStateSchema` object.
1317
- * @param numByteSlice - (nbs) num of byte slices.
1318
- * @param numUint - (nui) num of uints.
1363
+ * @param numByteSlice - number of byte slices.
1364
+ * @param numUint - number of uints.
1319
1365
  */
1320
1366
  constructor({
1321
1367
  numByteSlice,
@@ -1584,7 +1630,7 @@ export class AssetBalancesResponse extends BaseModel {
1584
1630
  */
1585
1631
  export class AssetHolding extends BaseModel {
1586
1632
  /**
1587
- * (a) number of units held.
1633
+ * number of units held.
1588
1634
  */
1589
1635
  public amount: number | bigint;
1590
1636
 
@@ -1594,7 +1640,7 @@ export class AssetHolding extends BaseModel {
1594
1640
  public assetId: number | bigint;
1595
1641
 
1596
1642
  /**
1597
- * (f) whether or not the holding is frozen.
1643
+ * whether or not the holding is frozen.
1598
1644
  */
1599
1645
  public isFrozen: boolean;
1600
1646
 
@@ -1615,9 +1661,9 @@ export class AssetHolding extends BaseModel {
1615
1661
 
1616
1662
  /**
1617
1663
  * Creates a new `AssetHolding` object.
1618
- * @param amount - (a) number of units held.
1664
+ * @param amount - number of units held.
1619
1665
  * @param assetId - Asset ID of the holding.
1620
- * @param isFrozen - (f) whether or not the holding is frozen.
1666
+ * @param isFrozen - whether or not the holding is frozen.
1621
1667
  * @param deleted - Whether or not the asset holding is currently deleted from its account.
1622
1668
  * @param optedInAtRound - Round during which the account opted into this asset holding.
1623
1669
  * @param optedOutAtRound - Round during which the account opted out of this asset holding.
@@ -1760,49 +1806,49 @@ export class AssetParams extends BaseModel {
1760
1806
  public creator: string;
1761
1807
 
1762
1808
  /**
1763
- * (dc) The number of digits to use after the decimal point when displaying this
1764
- * asset. If 0, the asset is not divisible. If 1, the base unit of the asset is in
1765
- * tenths. If 2, the base unit of the asset is in hundredths, and so on. This value
1766
- * must be between 0 and 19 (inclusive).
1809
+ * The number of digits to use after the decimal point when displaying this asset.
1810
+ * If 0, the asset is not divisible. If 1, the base unit of the asset is in tenths.
1811
+ * If 2, the base unit of the asset is in hundredths, and so on. This value must be
1812
+ * between 0 and 19 (inclusive).
1767
1813
  */
1768
1814
  public decimals: number | bigint;
1769
1815
 
1770
1816
  /**
1771
- * (t) The total number of units of this asset.
1817
+ * The total number of units of this asset.
1772
1818
  */
1773
1819
  public total: number | bigint;
1774
1820
 
1775
1821
  /**
1776
- * (c) Address of account used to clawback holdings of this asset. If empty,
1777
- * clawback is not permitted.
1822
+ * Address of account used to clawback holdings of this asset. If empty, clawback
1823
+ * is not permitted.
1778
1824
  */
1779
1825
  public clawback?: string;
1780
1826
 
1781
1827
  /**
1782
- * (df) Whether holdings of this asset are frozen by default.
1828
+ * Whether holdings of this asset are frozen by default.
1783
1829
  */
1784
1830
  public defaultFrozen?: boolean;
1785
1831
 
1786
1832
  /**
1787
- * (f) Address of account used to freeze holdings of this asset. If empty, freezing
1788
- * is not permitted.
1833
+ * Address of account used to freeze holdings of this asset. If empty, freezing is
1834
+ * not permitted.
1789
1835
  */
1790
1836
  public freeze?: string;
1791
1837
 
1792
1838
  /**
1793
- * (m) Address of account used to manage the keys of this asset and to destroy it.
1839
+ * Address of account used to manage the keys of this asset and to destroy it.
1794
1840
  */
1795
1841
  public manager?: string;
1796
1842
 
1797
1843
  /**
1798
- * (am) A commitment to some unspecified asset metadata. The format of this
1799
- * metadata is up to the application.
1844
+ * A commitment to some unspecified asset metadata. The format of this metadata is
1845
+ * up to the application.
1800
1846
  */
1801
1847
  public metadataHash?: Uint8Array;
1802
1848
 
1803
1849
  /**
1804
- * (an) Name of this asset, as supplied by the creator. Included only when the
1805
- * asset name is composed of printable utf-8 characters.
1850
+ * Name of this asset, as supplied by the creator. Included only when the asset
1851
+ * name is composed of printable utf-8 characters.
1806
1852
  */
1807
1853
  public name?: string;
1808
1854
 
@@ -1812,13 +1858,13 @@ export class AssetParams extends BaseModel {
1812
1858
  public nameB64?: Uint8Array;
1813
1859
 
1814
1860
  /**
1815
- * (r) Address of account holding reserve (non-minted) units of this asset.
1861
+ * Address of account holding reserve (non-minted) units of this asset.
1816
1862
  */
1817
1863
  public reserve?: string;
1818
1864
 
1819
1865
  /**
1820
- * (un) Name of a unit of this asset, as supplied by the creator. Included only
1821
- * when the name of a unit of this asset is composed of printable utf-8 characters.
1866
+ * Name of a unit of this asset, as supplied by the creator. Included only when the
1867
+ * name of a unit of this asset is composed of printable utf-8 characters.
1822
1868
  */
1823
1869
  public unitName?: string;
1824
1870
 
@@ -1828,8 +1874,8 @@ export class AssetParams extends BaseModel {
1828
1874
  public unitNameB64?: Uint8Array;
1829
1875
 
1830
1876
  /**
1831
- * (au) URL where more information about the asset can be retrieved. Included only
1832
- * when the URL is composed of printable utf-8 characters.
1877
+ * URL where more information about the asset can be retrieved. Included only when
1878
+ * the URL is composed of printable utf-8 characters.
1833
1879
  */
1834
1880
  public url?: string;
1835
1881
 
@@ -1843,28 +1889,28 @@ export class AssetParams extends BaseModel {
1843
1889
  * @param creator - The address that created this asset. This is the address where the parameters
1844
1890
  * for this asset can be found, and also the address where unwanted asset units can
1845
1891
  * be sent in the worst case.
1846
- * @param decimals - (dc) The number of digits to use after the decimal point when displaying this
1847
- * asset. If 0, the asset is not divisible. If 1, the base unit of the asset is in
1848
- * tenths. If 2, the base unit of the asset is in hundredths, and so on. This value
1849
- * must be between 0 and 19 (inclusive).
1850
- * @param total - (t) The total number of units of this asset.
1851
- * @param clawback - (c) Address of account used to clawback holdings of this asset. If empty,
1852
- * clawback is not permitted.
1853
- * @param defaultFrozen - (df) Whether holdings of this asset are frozen by default.
1854
- * @param freeze - (f) Address of account used to freeze holdings of this asset. If empty, freezing
1892
+ * @param decimals - The number of digits to use after the decimal point when displaying this asset.
1893
+ * If 0, the asset is not divisible. If 1, the base unit of the asset is in tenths.
1894
+ * If 2, the base unit of the asset is in hundredths, and so on. This value must be
1895
+ * between 0 and 19 (inclusive).
1896
+ * @param total - The total number of units of this asset.
1897
+ * @param clawback - Address of account used to clawback holdings of this asset. If empty, clawback
1855
1898
  * is not permitted.
1856
- * @param manager - (m) Address of account used to manage the keys of this asset and to destroy it.
1857
- * @param metadataHash - (am) A commitment to some unspecified asset metadata. The format of this
1858
- * metadata is up to the application.
1859
- * @param name - (an) Name of this asset, as supplied by the creator. Included only when the
1860
- * asset name is composed of printable utf-8 characters.
1899
+ * @param defaultFrozen - Whether holdings of this asset are frozen by default.
1900
+ * @param freeze - Address of account used to freeze holdings of this asset. If empty, freezing is
1901
+ * not permitted.
1902
+ * @param manager - Address of account used to manage the keys of this asset and to destroy it.
1903
+ * @param metadataHash - A commitment to some unspecified asset metadata. The format of this metadata is
1904
+ * up to the application.
1905
+ * @param name - Name of this asset, as supplied by the creator. Included only when the asset
1906
+ * name is composed of printable utf-8 characters.
1861
1907
  * @param nameB64 - Base64 encoded name of this asset, as supplied by the creator.
1862
- * @param reserve - (r) Address of account holding reserve (non-minted) units of this asset.
1863
- * @param unitName - (un) Name of a unit of this asset, as supplied by the creator. Included only
1864
- * when the name of a unit of this asset is composed of printable utf-8 characters.
1908
+ * @param reserve - Address of account holding reserve (non-minted) units of this asset.
1909
+ * @param unitName - Name of a unit of this asset, as supplied by the creator. Included only when the
1910
+ * name of a unit of this asset is composed of printable utf-8 characters.
1865
1911
  * @param unitNameB64 - Base64 encoded name of a unit of this asset, as supplied by the creator.
1866
- * @param url - (au) URL where more information about the asset can be retrieved. Included only
1867
- * when the URL is composed of printable utf-8 characters.
1912
+ * @param url - URL where more information about the asset can be retrieved. Included only when
1913
+ * the URL is composed of printable utf-8 characters.
1868
1914
  * @param urlB64 - Base64 encoded URL where more information about the asset can be retrieved.
1869
1915
  */
1870
1916
  constructor({
@@ -2150,11 +2196,31 @@ export class Block extends BaseModel {
2150
2196
  */
2151
2197
  public transactionsRootSha256: Uint8Array;
2152
2198
 
2199
+ /**
2200
+ * the potential bonus payout for this block.
2201
+ */
2202
+ public bonus?: number | bigint;
2203
+
2204
+ /**
2205
+ * the sum of all fees paid by transactions in this block.
2206
+ */
2207
+ public feesCollected?: number | bigint;
2208
+
2153
2209
  /**
2154
2210
  * Participation account data that needs to be checked/acted on by the network.
2155
2211
  */
2156
2212
  public participationUpdates?: ParticipationUpdates;
2157
2213
 
2214
+ /**
2215
+ * the proposer of this block.
2216
+ */
2217
+ public proposer?: string;
2218
+
2219
+ /**
2220
+ * the actual amount transferred to the proposer from the fee sink.
2221
+ */
2222
+ public proposerPayout?: number | bigint;
2223
+
2158
2224
  /**
2159
2225
  * Fields relating to rewards,
2160
2226
  */
@@ -2207,7 +2273,11 @@ export class Block extends BaseModel {
2207
2273
  * vector commitment instead of a merkle tree, and SHA256 hash function instead of
2208
2274
  * the default SHA512_256. This commitment can be used on environments where only
2209
2275
  * the SHA256 function exists.
2276
+ * @param bonus - the potential bonus payout for this block.
2277
+ * @param feesCollected - the sum of all fees paid by transactions in this block.
2210
2278
  * @param participationUpdates - Participation account data that needs to be checked/acted on by the network.
2279
+ * @param proposer - the proposer of this block.
2280
+ * @param proposerPayout - the actual amount transferred to the proposer from the fee sink.
2211
2281
  * @param rewards - Fields relating to rewards,
2212
2282
  * @param stateProofTracking - Tracks the status of state proofs.
2213
2283
  * @param transactions - (txns) list of transactions corresponding to a given round.
@@ -2228,7 +2298,11 @@ export class Block extends BaseModel {
2228
2298
  timestamp,
2229
2299
  transactionsRoot,
2230
2300
  transactionsRootSha256,
2301
+ bonus,
2302
+ feesCollected,
2231
2303
  participationUpdates,
2304
+ proposer,
2305
+ proposerPayout,
2232
2306
  rewards,
2233
2307
  stateProofTracking,
2234
2308
  transactions,
@@ -2244,7 +2318,11 @@ export class Block extends BaseModel {
2244
2318
  timestamp: number | bigint;
2245
2319
  transactionsRoot: string | Uint8Array;
2246
2320
  transactionsRootSha256: string | Uint8Array;
2321
+ bonus?: number | bigint;
2322
+ feesCollected?: number | bigint;
2247
2323
  participationUpdates?: ParticipationUpdates;
2324
+ proposer?: string;
2325
+ proposerPayout?: number | bigint;
2248
2326
  rewards?: BlockRewards;
2249
2327
  stateProofTracking?: StateProofTracking[];
2250
2328
  transactions?: Transaction[];
@@ -2276,7 +2354,11 @@ export class Block extends BaseModel {
2276
2354
  typeof transactionsRootSha256 === 'string'
2277
2355
  ? new Uint8Array(Buffer.from(transactionsRootSha256, 'base64'))
2278
2356
  : transactionsRootSha256;
2357
+ this.bonus = bonus;
2358
+ this.feesCollected = feesCollected;
2279
2359
  this.participationUpdates = participationUpdates;
2360
+ this.proposer = proposer;
2361
+ this.proposerPayout = proposerPayout;
2280
2362
  this.rewards = rewards;
2281
2363
  this.stateProofTracking = stateProofTracking;
2282
2364
  this.transactions = transactions;
@@ -2293,7 +2375,11 @@ export class Block extends BaseModel {
2293
2375
  timestamp: 'timestamp',
2294
2376
  transactionsRoot: 'transactions-root',
2295
2377
  transactionsRootSha256: 'transactions-root-sha256',
2378
+ bonus: 'bonus',
2379
+ feesCollected: 'fees-collected',
2296
2380
  participationUpdates: 'participation-updates',
2381
+ proposer: 'proposer',
2382
+ proposerPayout: 'proposer-payout',
2297
2383
  rewards: 'rewards',
2298
2384
  stateProofTracking: 'state-proof-tracking',
2299
2385
  transactions: 'transactions',
@@ -2343,12 +2429,16 @@ export class Block extends BaseModel {
2343
2429
  timestamp: data['timestamp'],
2344
2430
  transactionsRoot: data['transactions-root'],
2345
2431
  transactionsRootSha256: data['transactions-root-sha256'],
2432
+ bonus: data['bonus'],
2433
+ feesCollected: data['fees-collected'],
2346
2434
  participationUpdates:
2347
2435
  typeof data['participation-updates'] !== 'undefined'
2348
2436
  ? ParticipationUpdates.from_obj_for_encoding(
2349
2437
  data['participation-updates']
2350
2438
  )
2351
2439
  : undefined,
2440
+ proposer: data['proposer'],
2441
+ proposerPayout: data['proposer-payout'],
2352
2442
  rewards:
2353
2443
  typeof data['rewards'] !== 'undefined'
2354
2444
  ? BlockRewards.from_obj_for_encoding(data['rewards'])
@@ -2653,6 +2743,11 @@ export class Box extends BaseModel {
2653
2743
  */
2654
2744
  public name: Uint8Array;
2655
2745
 
2746
+ /**
2747
+ * The round for which this information is relevant
2748
+ */
2749
+ public round: number | bigint;
2750
+
2656
2751
  /**
2657
2752
  * (value) box value, base64 encoded.
2658
2753
  */
@@ -2661,13 +2756,16 @@ export class Box extends BaseModel {
2661
2756
  /**
2662
2757
  * Creates a new `Box` object.
2663
2758
  * @param name - (name) box name, base64 encoded
2759
+ * @param round - The round for which this information is relevant
2664
2760
  * @param value - (value) box value, base64 encoded.
2665
2761
  */
2666
2762
  constructor({
2667
2763
  name,
2764
+ round,
2668
2765
  value,
2669
2766
  }: {
2670
2767
  name: string | Uint8Array;
2768
+ round: number | bigint;
2671
2769
  value: string | Uint8Array;
2672
2770
  }) {
2673
2771
  super();
@@ -2675,6 +2773,7 @@ export class Box extends BaseModel {
2675
2773
  typeof name === 'string'
2676
2774
  ? new Uint8Array(Buffer.from(name, 'base64'))
2677
2775
  : name;
2776
+ this.round = round;
2678
2777
  this.value =
2679
2778
  typeof value === 'string'
2680
2779
  ? new Uint8Array(Buffer.from(value, 'base64'))
@@ -2682,6 +2781,7 @@ export class Box extends BaseModel {
2682
2781
 
2683
2782
  this.attribute_map = {
2684
2783
  name: 'name',
2784
+ round: 'round',
2685
2785
  value: 'value',
2686
2786
  };
2687
2787
  }
@@ -2691,10 +2791,13 @@ export class Box extends BaseModel {
2691
2791
  /* eslint-disable dot-notation */
2692
2792
  if (typeof data['name'] === 'undefined')
2693
2793
  throw new Error(`Response is missing required field 'name': ${data}`);
2794
+ if (typeof data['round'] === 'undefined')
2795
+ throw new Error(`Response is missing required field 'round': ${data}`);
2694
2796
  if (typeof data['value'] === 'undefined')
2695
2797
  throw new Error(`Response is missing required field 'value': ${data}`);
2696
2798
  return new Box({
2697
2799
  name: data['name'],
2800
+ round: data['round'],
2698
2801
  value: data['value'],
2699
2802
  });
2700
2803
  /* eslint-enable dot-notation */
@@ -3309,6 +3412,11 @@ export class MiniAssetHolding extends BaseModel {
3309
3412
  * Participation account data that needs to be checked/acted on by the network.
3310
3413
  */
3311
3414
  export class ParticipationUpdates extends BaseModel {
3415
+ /**
3416
+ * (partupabs) a list of online accounts that need to be suspended.
3417
+ */
3418
+ public absentParticipationAccounts?: string[];
3419
+
3312
3420
  /**
3313
3421
  * (partupdrmv) a list of online accounts that needs to be converted to offline
3314
3422
  * since their participation key expired.
@@ -3317,18 +3425,23 @@ export class ParticipationUpdates extends BaseModel {
3317
3425
 
3318
3426
  /**
3319
3427
  * Creates a new `ParticipationUpdates` object.
3428
+ * @param absentParticipationAccounts - (partupabs) a list of online accounts that need to be suspended.
3320
3429
  * @param expiredParticipationAccounts - (partupdrmv) a list of online accounts that needs to be converted to offline
3321
3430
  * since their participation key expired.
3322
3431
  */
3323
3432
  constructor({
3433
+ absentParticipationAccounts,
3324
3434
  expiredParticipationAccounts,
3325
3435
  }: {
3436
+ absentParticipationAccounts?: string[];
3326
3437
  expiredParticipationAccounts?: string[];
3327
3438
  }) {
3328
3439
  super();
3440
+ this.absentParticipationAccounts = absentParticipationAccounts;
3329
3441
  this.expiredParticipationAccounts = expiredParticipationAccounts;
3330
3442
 
3331
3443
  this.attribute_map = {
3444
+ absentParticipationAccounts: 'absent-participation-accounts',
3332
3445
  expiredParticipationAccounts: 'expired-participation-accounts',
3333
3446
  };
3334
3447
  }
@@ -3339,6 +3452,7 @@ export class ParticipationUpdates extends BaseModel {
3339
3452
  ): ParticipationUpdates {
3340
3453
  /* eslint-disable dot-notation */
3341
3454
  return new ParticipationUpdates({
3455
+ absentParticipationAccounts: data['absent-participation-accounts'],
3342
3456
  expiredParticipationAccounts: data['expired-participation-accounts'],
3343
3457
  });
3344
3458
  /* eslint-enable dot-notation */
@@ -3908,25 +4022,25 @@ export class TealKeyValue extends BaseModel {
3908
4022
  */
3909
4023
  export class TealValue extends BaseModel {
3910
4024
  /**
3911
- * (tb) bytes value.
4025
+ * bytes value.
3912
4026
  */
3913
4027
  public bytes: string;
3914
4028
 
3915
4029
  /**
3916
- * (tt) value type. Value `1` refers to **bytes**, value `2` refers to **uint**
4030
+ * type of the value. Value `1` refers to **bytes**, value `2` refers to **uint**
3917
4031
  */
3918
4032
  public type: number | bigint;
3919
4033
 
3920
4034
  /**
3921
- * (ui) uint value.
4035
+ * uint value.
3922
4036
  */
3923
4037
  public uint: number | bigint;
3924
4038
 
3925
4039
  /**
3926
4040
  * Creates a new `TealValue` object.
3927
- * @param bytes - (tb) bytes value.
3928
- * @param type - (tt) value type. Value `1` refers to **bytes**, value `2` refers to **uint**
3929
- * @param uint - (ui) uint value.
4041
+ * @param bytes - bytes value.
4042
+ * @param type - type of the value. Value `1` refers to **bytes**, value `2` refers to **uint**
4043
+ * @param uint - uint value.
3930
4044
  */
3931
4045
  constructor({
3932
4046
  bytes,
@@ -4892,7 +5006,7 @@ export class TransactionAssetTransfer extends BaseModel {
4892
5006
  public receiver: string;
4893
5007
 
4894
5008
  /**
4895
- * Number of assets transfered to the close-to account as part of the transaction.
5009
+ * Number of assets transferred to the close-to account as part of the transaction.
4896
5010
  */
4897
5011
  public closeAmount?: number | bigint;
4898
5012
 
@@ -4916,7 +5030,7 @@ export class TransactionAssetTransfer extends BaseModel {
4916
5030
  * that asset in the account's Assets map.
4917
5031
  * @param assetId - (xaid) ID of the asset being transferred.
4918
5032
  * @param receiver - (arcv) Recipient address of the transfer.
4919
- * @param closeAmount - Number of assets transfered to the close-to account as part of the transaction.
5033
+ * @param closeAmount - Number of assets transferred to the close-to account as part of the transaction.
4920
5034
  * @param closeTo - (aclose) Indicates that the asset should be removed from the account's Assets
4921
5035
  * map, and specifies where the remaining asset holdings should be transferred.
4922
5036
  * It's always valid to transfer remaining asset holdings to the creator account.