algosdk 2.7.0 → 2.8.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.
@@ -13,20 +13,24 @@ export declare class Account extends BaseModel {
13
13
  */
14
14
  address: string;
15
15
  /**
16
- * (algo) total number of MicroAlgos in the account
16
+ * total number of MicroAlgos in the account
17
17
  */
18
18
  amount: number | bigint;
19
19
  /**
20
20
  * specifies the amount of MicroAlgos in the account, without the pending rewards.
21
21
  */
22
22
  amountWithoutPendingRewards: number | bigint;
23
+ /**
24
+ * MicroAlgo balance required by the account.
25
+ * The requirement grows based on asset and application usage.
26
+ */
27
+ minBalance: number | bigint;
23
28
  /**
24
29
  * amount of MicroAlgos of pending rewards in this account.
25
30
  */
26
31
  pendingRewards: number | bigint;
27
32
  /**
28
- * (ern) total rewards of MicroAlgos the account has received, including pending
29
- * rewards.
33
+ * total rewards of MicroAlgos the account has received, including pending rewards.
30
34
  */
31
35
  rewards: number | bigint;
32
36
  /**
@@ -34,7 +38,7 @@ export declare class Account extends BaseModel {
34
38
  */
35
39
  round: number | bigint;
36
40
  /**
37
- * (onl) delegation status of the account's MicroAlgos
41
+ * voting status of the account's MicroAlgos
38
42
  * * Offline - indicates that the associated account is delegated.
39
43
  * * Online - indicates that the associated account used as part of the delegation
40
44
  * pool.
@@ -71,29 +75,28 @@ export declare class Account extends BaseModel {
71
75
  */
72
76
  totalCreatedAssets: number | bigint;
73
77
  /**
74
- * (appl) applications local data stored in this account.
78
+ * application local data stored in this account.
75
79
  * Note the raw object uses `map[int] -> AppLocalState` for this type.
76
80
  */
77
81
  appsLocalState?: ApplicationLocalState[];
78
82
  /**
79
- * (teap) the sum of all extra application program pages for this account.
83
+ * the sum of all extra application program pages for this account.
80
84
  */
81
85
  appsTotalExtraPages?: number | bigint;
82
86
  /**
83
- * (tsch) stores the sum of all of the local schemas and global schemas in this
84
- * account.
87
+ * the sum of all of the local schemas and global schemas in this account.
85
88
  * Note: the raw account uses `StateSchema` for this type.
86
89
  */
87
90
  appsTotalSchema?: ApplicationStateSchema;
88
91
  /**
89
- * (asset) assets held by this account.
92
+ * assets held by this account.
90
93
  * Note the raw object uses `map[int] -> AssetHolding` for this type.
91
94
  */
92
95
  assets?: AssetHolding[];
93
96
  /**
94
- * (spend) the address against which signing should be checked. If empty, the
95
- * address of the current account is used. This field can be updated in any
96
- * transaction by setting the RekeyTo field.
97
+ * The address against which signing should be checked. If empty, the address of
98
+ * the current account is used. This field can be updated in any transaction by
99
+ * setting the RekeyTo field.
97
100
  */
98
101
  authAddr?: string;
99
102
  /**
@@ -101,13 +104,12 @@ export declare class Account extends BaseModel {
101
104
  */
102
105
  closedAtRound?: number | bigint;
103
106
  /**
104
- * (appp) parameters of applications created by this account including app global
105
- * data.
107
+ * parameters of applications created by this account including app global data.
106
108
  * Note: the raw account uses `map[int] -> AppParams` for this type.
107
109
  */
108
110
  createdApps?: Application[];
109
111
  /**
110
- * (apar) parameters of assets created by this account.
112
+ * parameters of assets created by this account.
111
113
  * Note: the raw account uses `map[int] -> Asset` for this type.
112
114
  */
113
115
  createdAssets?: Asset[];
@@ -119,18 +121,32 @@ export declare class Account extends BaseModel {
119
121
  * Whether or not this account is currently closed.
120
122
  */
121
123
  deleted?: boolean;
124
+ /**
125
+ * can the account receive block incentives if its balance is in range at proposal
126
+ * time.
127
+ */
128
+ incentiveEligible?: boolean;
129
+ /**
130
+ * The round in which this account last went online, or explicitly renewed their
131
+ * online status.
132
+ */
133
+ lastHeartbeat?: number | bigint;
134
+ /**
135
+ * The round in which this account last proposed the block.
136
+ */
137
+ lastProposed?: number | bigint;
122
138
  /**
123
139
  * AccountParticipation describes the parameters used by this account in consensus
124
140
  * protocol.
125
141
  */
126
142
  participation?: AccountParticipation;
127
143
  /**
128
- * (ebase) used as part of the rewards computation. Only applicable to accounts
129
- * which are participating.
144
+ * used as part of the rewards computation. Only applicable to accounts which are
145
+ * participating.
130
146
  */
131
147
  rewardBase?: number | bigint;
132
148
  /**
133
- * Indicates what type of signature is used by this account, must be one of:
149
+ * the type of signature used by this account, must be one of:
134
150
  * * sig
135
151
  * * msig
136
152
  * * lsig
@@ -140,13 +156,14 @@ export declare class Account extends BaseModel {
140
156
  /**
141
157
  * Creates a new `Account` object.
142
158
  * @param address - the account public key
143
- * @param amount - (algo) total number of MicroAlgos in the account
159
+ * @param amount - total number of MicroAlgos in the account
144
160
  * @param amountWithoutPendingRewards - specifies the amount of MicroAlgos in the account, without the pending rewards.
161
+ * @param minBalance - MicroAlgo balance required by the account.
162
+ * The requirement grows based on asset and application usage.
145
163
  * @param pendingRewards - amount of MicroAlgos of pending rewards in this account.
146
- * @param rewards - (ern) total rewards of MicroAlgos the account has received, including pending
147
- * rewards.
164
+ * @param rewards - total rewards of MicroAlgos the account has received, including pending rewards.
148
165
  * @param round - The round for which this information is relevant.
149
- * @param status - (onl) delegation status of the account's MicroAlgos
166
+ * @param status - voting status of the account's MicroAlgos
150
167
  * * Offline - indicates that the associated account is delegated.
151
168
  * * Online - indicates that the associated account used as part of the delegation
152
169
  * pool.
@@ -162,39 +179,43 @@ export declare class Account extends BaseModel {
162
179
  * application.
163
180
  * @param totalCreatedApps - The count of all apps (AppParams objects) created by this account.
164
181
  * @param totalCreatedAssets - The count of all assets (AssetParams objects) created by this account.
165
- * @param appsLocalState - (appl) applications local data stored in this account.
182
+ * @param appsLocalState - application local data stored in this account.
166
183
  * Note the raw object uses `map[int] -> AppLocalState` for this type.
167
- * @param appsTotalExtraPages - (teap) the sum of all extra application program pages for this account.
168
- * @param appsTotalSchema - (tsch) stores the sum of all of the local schemas and global schemas in this
169
- * account.
184
+ * @param appsTotalExtraPages - the sum of all extra application program pages for this account.
185
+ * @param appsTotalSchema - the sum of all of the local schemas and global schemas in this account.
170
186
  * Note: the raw account uses `StateSchema` for this type.
171
- * @param assets - (asset) assets held by this account.
187
+ * @param assets - assets held by this account.
172
188
  * Note the raw object uses `map[int] -> AssetHolding` for this type.
173
- * @param authAddr - (spend) the address against which signing should be checked. If empty, the
174
- * address of the current account is used. This field can be updated in any
175
- * transaction by setting the RekeyTo field.
189
+ * @param authAddr - The address against which signing should be checked. If empty, the address of
190
+ * the current account is used. This field can be updated in any transaction by
191
+ * setting the RekeyTo field.
176
192
  * @param closedAtRound - Round during which this account was most recently closed.
177
- * @param createdApps - (appp) parameters of applications created by this account including app global
178
- * data.
193
+ * @param createdApps - parameters of applications created by this account including app global data.
179
194
  * Note: the raw account uses `map[int] -> AppParams` for this type.
180
- * @param createdAssets - (apar) parameters of assets created by this account.
195
+ * @param createdAssets - parameters of assets created by this account.
181
196
  * Note: the raw account uses `map[int] -> Asset` for this type.
182
197
  * @param createdAtRound - Round during which this account first appeared in a transaction.
183
198
  * @param deleted - Whether or not this account is currently closed.
199
+ * @param incentiveEligible - can the account receive block incentives if its balance is in range at proposal
200
+ * time.
201
+ * @param lastHeartbeat - The round in which this account last went online, or explicitly renewed their
202
+ * online status.
203
+ * @param lastProposed - The round in which this account last proposed the block.
184
204
  * @param participation - AccountParticipation describes the parameters used by this account in consensus
185
205
  * protocol.
186
- * @param rewardBase - (ebase) used as part of the rewards computation. Only applicable to accounts
187
- * which are participating.
188
- * @param sigType - Indicates what type of signature is used by this account, must be one of:
206
+ * @param rewardBase - used as part of the rewards computation. Only applicable to accounts which are
207
+ * participating.
208
+ * @param sigType - the type of signature used by this account, must be one of:
189
209
  * * sig
190
210
  * * msig
191
211
  * * lsig
192
212
  * * or null if unknown
193
213
  */
194
- constructor({ address, amount, amountWithoutPendingRewards, pendingRewards, rewards, round, status, totalAppsOptedIn, totalAssetsOptedIn, totalBoxBytes, totalBoxes, totalCreatedApps, totalCreatedAssets, appsLocalState, appsTotalExtraPages, appsTotalSchema, assets, authAddr, closedAtRound, createdApps, createdAssets, createdAtRound, deleted, participation, rewardBase, sigType, }: {
214
+ constructor({ address, amount, amountWithoutPendingRewards, minBalance, pendingRewards, rewards, round, status, totalAppsOptedIn, totalAssetsOptedIn, totalBoxBytes, totalBoxes, totalCreatedApps, totalCreatedAssets, appsLocalState, appsTotalExtraPages, appsTotalSchema, assets, authAddr, closedAtRound, createdApps, createdAssets, createdAtRound, deleted, incentiveEligible, lastHeartbeat, lastProposed, participation, rewardBase, sigType, }: {
195
215
  address: string;
196
216
  amount: number | bigint;
197
217
  amountWithoutPendingRewards: number | bigint;
218
+ minBalance: number | bigint;
198
219
  pendingRewards: number | bigint;
199
220
  rewards: number | bigint;
200
221
  round: number | bigint;
@@ -215,6 +236,9 @@ export declare class Account extends BaseModel {
215
236
  createdAssets?: Asset[];
216
237
  createdAtRound?: number | bigint;
217
238
  deleted?: boolean;
239
+ incentiveEligible?: boolean;
240
+ lastHeartbeat?: number | bigint;
241
+ lastProposed?: number | bigint;
218
242
  participation?: AccountParticipation;
219
243
  rewardBase?: number | bigint;
220
244
  sigType?: string;
@@ -227,39 +251,37 @@ export declare class Account extends BaseModel {
227
251
  */
228
252
  export declare class AccountParticipation extends BaseModel {
229
253
  /**
230
- * (sel) Selection public key (if any) currently registered for this round.
254
+ * Selection public key (if any) currently registered for this round.
231
255
  */
232
256
  selectionParticipationKey: Uint8Array;
233
257
  /**
234
- * (voteFst) First round for which this participation is valid.
258
+ * First round for which this participation is valid.
235
259
  */
236
260
  voteFirstValid: number | bigint;
237
261
  /**
238
- * (voteKD) Number of subkeys in each batch of participation keys.
262
+ * Number of subkeys in each batch of participation keys.
239
263
  */
240
264
  voteKeyDilution: number | bigint;
241
265
  /**
242
- * (voteLst) Last round for which this participation is valid.
266
+ * Last round for which this participation is valid.
243
267
  */
244
268
  voteLastValid: number | bigint;
245
269
  /**
246
- * (vote) root participation public key (if any) currently registered for this
247
- * round.
270
+ * root participation public key (if any) currently registered for this round.
248
271
  */
249
272
  voteParticipationKey: Uint8Array;
250
273
  /**
251
- * (stprf) Root of the state proof key (if any)
274
+ * Root of the state proof key (if any)
252
275
  */
253
276
  stateProofKey?: Uint8Array;
254
277
  /**
255
278
  * Creates a new `AccountParticipation` object.
256
- * @param selectionParticipationKey - (sel) Selection public key (if any) currently registered for this round.
257
- * @param voteFirstValid - (voteFst) First round for which this participation is valid.
258
- * @param voteKeyDilution - (voteKD) Number of subkeys in each batch of participation keys.
259
- * @param voteLastValid - (voteLst) Last round for which this participation is valid.
260
- * @param voteParticipationKey - (vote) root participation public key (if any) currently registered for this
261
- * round.
262
- * @param stateProofKey - (stprf) Root of the state proof key (if any)
279
+ * @param selectionParticipationKey - Selection public key (if any) currently registered for this round.
280
+ * @param voteFirstValid - First round for which this participation is valid.
281
+ * @param voteKeyDilution - Number of subkeys in each batch of participation keys.
282
+ * @param voteLastValid - Last round for which this participation is valid.
283
+ * @param voteParticipationKey - root participation public key (if any) currently registered for this round.
284
+ * @param stateProofKey - Root of the state proof key (if any)
263
285
  */
264
286
  constructor({ selectionParticipationKey, voteFirstValid, voteKeyDilution, voteLastValid, voteParticipationKey, stateProofKey, }: {
265
287
  selectionParticipationKey: string | Uint8Array;
@@ -351,11 +373,11 @@ export declare class AccountsResponse extends BaseModel {
351
373
  */
352
374
  export declare class Application extends BaseModel {
353
375
  /**
354
- * (appidx) application index.
376
+ * application index.
355
377
  */
356
378
  id: number | bigint;
357
379
  /**
358
- * (appparams) application parameters.
380
+ * application parameters.
359
381
  */
360
382
  params: ApplicationParams;
361
383
  /**
@@ -372,8 +394,8 @@ export declare class Application extends BaseModel {
372
394
  deletedAtRound?: number | bigint;
373
395
  /**
374
396
  * Creates a new `Application` object.
375
- * @param id - (appidx) application index.
376
- * @param params - (appparams) application parameters.
397
+ * @param id - application index.
398
+ * @param params - application parameters.
377
399
  * @param createdAtRound - Round when this application was created.
378
400
  * @param deleted - Whether or not this application is currently deleted.
379
401
  * @param deletedAtRound - Round when this application was deleted.
@@ -396,7 +418,7 @@ export declare class ApplicationLocalState extends BaseModel {
396
418
  */
397
419
  id: number | bigint;
398
420
  /**
399
- * (hsch) schema.
421
+ * schema.
400
422
  */
401
423
  schema: ApplicationStateSchema;
402
424
  /**
@@ -409,7 +431,7 @@ export declare class ApplicationLocalState extends BaseModel {
409
431
  */
410
432
  deleted?: boolean;
411
433
  /**
412
- * (tkv) storage.
434
+ * storage.
413
435
  */
414
436
  keyValue?: TealKeyValue[];
415
437
  /**
@@ -419,11 +441,11 @@ export declare class ApplicationLocalState extends BaseModel {
419
441
  /**
420
442
  * Creates a new `ApplicationLocalState` object.
421
443
  * @param id - The application which this local state is for.
422
- * @param schema - (hsch) schema.
444
+ * @param schema - schema.
423
445
  * @param closedOutAtRound - Round when account closed out of the application.
424
446
  * @param deleted - Whether or not the application local state is currently deleted from its
425
447
  * account.
426
- * @param keyValue - (tkv) storage.
448
+ * @param keyValue - storage.
427
449
  * @param optedInAtRound - Round when the account opted into the application.
428
450
  */
429
451
  constructor({ id, schema, closedOutAtRound, deleted, keyValue, optedInAtRound, }: {
@@ -469,7 +491,7 @@ export declare class ApplicationLocalStatesResponse extends BaseModel {
469
491
  */
470
492
  export declare class ApplicationLogData extends BaseModel {
471
493
  /**
472
- * (lg) Logs for the application being executed by the transaction.
494
+ * Logs for the application being executed by the transaction.
473
495
  */
474
496
  logs: Uint8Array[];
475
497
  /**
@@ -478,7 +500,7 @@ export declare class ApplicationLogData extends BaseModel {
478
500
  txid: string;
479
501
  /**
480
502
  * Creates a new `ApplicationLogData` object.
481
- * @param logs - (lg) Logs for the application being executed by the transaction.
503
+ * @param logs - Logs for the application being executed by the transaction.
482
504
  * @param txid - Transaction ID
483
505
  */
484
506
  constructor({ logs, txid }: {
@@ -526,11 +548,11 @@ export declare class ApplicationLogsResponse extends BaseModel {
526
548
  */
527
549
  export declare class ApplicationParams extends BaseModel {
528
550
  /**
529
- * (approv) approval program.
551
+ * approval program.
530
552
  */
531
553
  approvalProgram: Uint8Array;
532
554
  /**
533
- * (clearp) approval program.
555
+ * clear state program.
534
556
  */
535
557
  clearStateProgram: Uint8Array;
536
558
  /**
@@ -539,31 +561,31 @@ export declare class ApplicationParams extends BaseModel {
539
561
  */
540
562
  creator?: string;
541
563
  /**
542
- * (epp) the amount of extra program pages available to this app.
564
+ * the number of extra program pages available to this app.
543
565
  */
544
566
  extraProgramPages?: number | bigint;
545
567
  /**
546
- * [\gs) global schema
568
+ * global state
547
569
  */
548
570
  globalState?: TealKeyValue[];
549
571
  /**
550
- * [\gsch) global schema
572
+ * global schema
551
573
  */
552
574
  globalStateSchema?: ApplicationStateSchema;
553
575
  /**
554
- * [\lsch) local schema
576
+ * local schema
555
577
  */
556
578
  localStateSchema?: ApplicationStateSchema;
557
579
  /**
558
580
  * Creates a new `ApplicationParams` object.
559
- * @param approvalProgram - (approv) approval program.
560
- * @param clearStateProgram - (clearp) approval program.
581
+ * @param approvalProgram - approval program.
582
+ * @param clearStateProgram - clear state program.
561
583
  * @param creator - The address that created this application. This is the address where the
562
584
  * parameters and global state for this application can be found.
563
- * @param extraProgramPages - (epp) the amount of extra program pages available to this app.
564
- * @param globalState - [\gs) global schema
565
- * @param globalStateSchema - [\gsch) global schema
566
- * @param localStateSchema - [\lsch) local schema
585
+ * @param extraProgramPages - the number of extra program pages available to this app.
586
+ * @param globalState - global state
587
+ * @param globalStateSchema - global schema
588
+ * @param localStateSchema - local schema
567
589
  */
568
590
  constructor({ approvalProgram, clearStateProgram, creator, extraProgramPages, globalState, globalStateSchema, localStateSchema, }: {
569
591
  approvalProgram: string | Uint8Array;
@@ -604,17 +626,17 @@ export declare class ApplicationResponse extends BaseModel {
604
626
  */
605
627
  export declare class ApplicationStateSchema extends BaseModel {
606
628
  /**
607
- * (nbs) num of byte slices.
629
+ * number of byte slices.
608
630
  */
609
631
  numByteSlice: number | bigint;
610
632
  /**
611
- * (nui) num of uints.
633
+ * number of uints.
612
634
  */
613
635
  numUint: number | bigint;
614
636
  /**
615
637
  * Creates a new `ApplicationStateSchema` object.
616
- * @param numByteSlice - (nbs) num of byte slices.
617
- * @param numUint - (nui) num of uints.
638
+ * @param numByteSlice - number of byte slices.
639
+ * @param numUint - number of uints.
618
640
  */
619
641
  constructor({ numByteSlice, numUint, }: {
620
642
  numByteSlice: number | bigint;
@@ -732,7 +754,7 @@ export declare class AssetBalancesResponse extends BaseModel {
732
754
  */
733
755
  export declare class AssetHolding extends BaseModel {
734
756
  /**
735
- * (a) number of units held.
757
+ * number of units held.
736
758
  */
737
759
  amount: number | bigint;
738
760
  /**
@@ -740,7 +762,7 @@ export declare class AssetHolding extends BaseModel {
740
762
  */
741
763
  assetId: number | bigint;
742
764
  /**
743
- * (f) whether or not the holding is frozen.
765
+ * whether or not the holding is frozen.
744
766
  */
745
767
  isFrozen: boolean;
746
768
  /**
@@ -757,9 +779,9 @@ export declare class AssetHolding extends BaseModel {
757
779
  optedOutAtRound?: number | bigint;
758
780
  /**
759
781
  * Creates a new `AssetHolding` object.
760
- * @param amount - (a) number of units held.
782
+ * @param amount - number of units held.
761
783
  * @param assetId - Asset ID of the holding.
762
- * @param isFrozen - (f) whether or not the holding is frozen.
784
+ * @param isFrozen - whether or not the holding is frozen.
763
785
  * @param deleted - Whether or not the asset holding is currently deleted from its account.
764
786
  * @param optedInAtRound - Round during which the account opted into this asset holding.
765
787
  * @param optedOutAtRound - Round during which the account opted out of this asset holding.
@@ -816,42 +838,42 @@ export declare class AssetParams extends BaseModel {
816
838
  */
817
839
  creator: string;
818
840
  /**
819
- * (dc) The number of digits to use after the decimal point when displaying this
820
- * asset. If 0, the asset is not divisible. If 1, the base unit of the asset is in
821
- * tenths. If 2, the base unit of the asset is in hundredths, and so on. This value
822
- * must be between 0 and 19 (inclusive).
841
+ * The number of digits to use after the decimal point when displaying this asset.
842
+ * If 0, the asset is not divisible. If 1, the base unit of the asset is in tenths.
843
+ * If 2, the base unit of the asset is in hundredths, and so on. This value must be
844
+ * between 0 and 19 (inclusive).
823
845
  */
824
846
  decimals: number | bigint;
825
847
  /**
826
- * (t) The total number of units of this asset.
848
+ * The total number of units of this asset.
827
849
  */
828
850
  total: number | bigint;
829
851
  /**
830
- * (c) Address of account used to clawback holdings of this asset. If empty,
831
- * clawback is not permitted.
852
+ * Address of account used to clawback holdings of this asset. If empty, clawback
853
+ * is not permitted.
832
854
  */
833
855
  clawback?: string;
834
856
  /**
835
- * (df) Whether holdings of this asset are frozen by default.
857
+ * Whether holdings of this asset are frozen by default.
836
858
  */
837
859
  defaultFrozen?: boolean;
838
860
  /**
839
- * (f) Address of account used to freeze holdings of this asset. If empty, freezing
840
- * is not permitted.
861
+ * Address of account used to freeze holdings of this asset. If empty, freezing is
862
+ * not permitted.
841
863
  */
842
864
  freeze?: string;
843
865
  /**
844
- * (m) Address of account used to manage the keys of this asset and to destroy it.
866
+ * Address of account used to manage the keys of this asset and to destroy it.
845
867
  */
846
868
  manager?: string;
847
869
  /**
848
- * (am) A commitment to some unspecified asset metadata. The format of this
849
- * metadata is up to the application.
870
+ * A commitment to some unspecified asset metadata. The format of this metadata is
871
+ * up to the application.
850
872
  */
851
873
  metadataHash?: Uint8Array;
852
874
  /**
853
- * (an) Name of this asset, as supplied by the creator. Included only when the
854
- * asset name is composed of printable utf-8 characters.
875
+ * Name of this asset, as supplied by the creator. Included only when the asset
876
+ * name is composed of printable utf-8 characters.
855
877
  */
856
878
  name?: string;
857
879
  /**
@@ -859,12 +881,12 @@ export declare class AssetParams extends BaseModel {
859
881
  */
860
882
  nameB64?: Uint8Array;
861
883
  /**
862
- * (r) Address of account holding reserve (non-minted) units of this asset.
884
+ * Address of account holding reserve (non-minted) units of this asset.
863
885
  */
864
886
  reserve?: string;
865
887
  /**
866
- * (un) Name of a unit of this asset, as supplied by the creator. Included only
867
- * when the name of a unit of this asset is composed of printable utf-8 characters.
888
+ * Name of a unit of this asset, as supplied by the creator. Included only when the
889
+ * name of a unit of this asset is composed of printable utf-8 characters.
868
890
  */
869
891
  unitName?: string;
870
892
  /**
@@ -872,8 +894,8 @@ export declare class AssetParams extends BaseModel {
872
894
  */
873
895
  unitNameB64?: Uint8Array;
874
896
  /**
875
- * (au) URL where more information about the asset can be retrieved. Included only
876
- * when the URL is composed of printable utf-8 characters.
897
+ * URL where more information about the asset can be retrieved. Included only when
898
+ * the URL is composed of printable utf-8 characters.
877
899
  */
878
900
  url?: string;
879
901
  /**
@@ -885,28 +907,28 @@ export declare class AssetParams extends BaseModel {
885
907
  * @param creator - The address that created this asset. This is the address where the parameters
886
908
  * for this asset can be found, and also the address where unwanted asset units can
887
909
  * be sent in the worst case.
888
- * @param decimals - (dc) The number of digits to use after the decimal point when displaying this
889
- * asset. If 0, the asset is not divisible. If 1, the base unit of the asset is in
890
- * tenths. If 2, the base unit of the asset is in hundredths, and so on. This value
891
- * must be between 0 and 19 (inclusive).
892
- * @param total - (t) The total number of units of this asset.
893
- * @param clawback - (c) Address of account used to clawback holdings of this asset. If empty,
894
- * clawback is not permitted.
895
- * @param defaultFrozen - (df) Whether holdings of this asset are frozen by default.
896
- * @param freeze - (f) Address of account used to freeze holdings of this asset. If empty, freezing
910
+ * @param decimals - The number of digits to use after the decimal point when displaying this asset.
911
+ * If 0, the asset is not divisible. If 1, the base unit of the asset is in tenths.
912
+ * If 2, the base unit of the asset is in hundredths, and so on. This value must be
913
+ * between 0 and 19 (inclusive).
914
+ * @param total - The total number of units of this asset.
915
+ * @param clawback - Address of account used to clawback holdings of this asset. If empty, clawback
897
916
  * is not permitted.
898
- * @param manager - (m) Address of account used to manage the keys of this asset and to destroy it.
899
- * @param metadataHash - (am) A commitment to some unspecified asset metadata. The format of this
900
- * metadata is up to the application.
901
- * @param name - (an) Name of this asset, as supplied by the creator. Included only when the
902
- * asset name is composed of printable utf-8 characters.
917
+ * @param defaultFrozen - Whether holdings of this asset are frozen by default.
918
+ * @param freeze - Address of account used to freeze holdings of this asset. If empty, freezing is
919
+ * not permitted.
920
+ * @param manager - Address of account used to manage the keys of this asset and to destroy it.
921
+ * @param metadataHash - A commitment to some unspecified asset metadata. The format of this metadata is
922
+ * up to the application.
923
+ * @param name - Name of this asset, as supplied by the creator. Included only when the asset
924
+ * name is composed of printable utf-8 characters.
903
925
  * @param nameB64 - Base64 encoded name of this asset, as supplied by the creator.
904
- * @param reserve - (r) Address of account holding reserve (non-minted) units of this asset.
905
- * @param unitName - (un) Name of a unit of this asset, as supplied by the creator. Included only
906
- * when the name of a unit of this asset is composed of printable utf-8 characters.
926
+ * @param reserve - Address of account holding reserve (non-minted) units of this asset.
927
+ * @param unitName - Name of a unit of this asset, as supplied by the creator. Included only when the
928
+ * name of a unit of this asset is composed of printable utf-8 characters.
907
929
  * @param unitNameB64 - Base64 encoded name of a unit of this asset, as supplied by the creator.
908
- * @param url - (au) URL where more information about the asset can be retrieved. Included only
909
- * when the URL is composed of printable utf-8 characters.
930
+ * @param url - URL where more information about the asset can be retrieved. Included only when
931
+ * the URL is composed of printable utf-8 characters.
910
932
  * @param urlB64 - Base64 encoded URL where more information about the asset can be retrieved.
911
933
  */
912
934
  constructor({ creator, decimals, total, clawback, defaultFrozen, freeze, manager, metadataHash, name, nameB64, reserve, unitName, unitNameB64, url, urlB64, }: {
@@ -1025,10 +1047,26 @@ export declare class Block extends BaseModel {
1025
1047
  * the SHA256 function exists.
1026
1048
  */
1027
1049
  transactionsRootSha256: Uint8Array;
1050
+ /**
1051
+ * the potential bonus payout for this block.
1052
+ */
1053
+ bonus?: number | bigint;
1054
+ /**
1055
+ * the sum of all fees paid by transactions in this block.
1056
+ */
1057
+ feesCollected?: number | bigint;
1028
1058
  /**
1029
1059
  * Participation account data that needs to be checked/acted on by the network.
1030
1060
  */
1031
1061
  participationUpdates?: ParticipationUpdates;
1062
+ /**
1063
+ * the proposer of this block.
1064
+ */
1065
+ proposer?: string;
1066
+ /**
1067
+ * the actual amount transferred to the proposer from the fee sink.
1068
+ */
1069
+ proposerPayout?: number | bigint;
1032
1070
  /**
1033
1071
  * Fields relating to rewards,
1034
1072
  */
@@ -1075,7 +1113,11 @@ export declare class Block extends BaseModel {
1075
1113
  * vector commitment instead of a merkle tree, and SHA256 hash function instead of
1076
1114
  * the default SHA512_256. This commitment can be used on environments where only
1077
1115
  * the SHA256 function exists.
1116
+ * @param bonus - the potential bonus payout for this block.
1117
+ * @param feesCollected - the sum of all fees paid by transactions in this block.
1078
1118
  * @param participationUpdates - Participation account data that needs to be checked/acted on by the network.
1119
+ * @param proposer - the proposer of this block.
1120
+ * @param proposerPayout - the actual amount transferred to the proposer from the fee sink.
1079
1121
  * @param rewards - Fields relating to rewards,
1080
1122
  * @param stateProofTracking - Tracks the status of state proofs.
1081
1123
  * @param transactions - (txns) list of transactions corresponding to a given round.
@@ -1087,7 +1129,7 @@ export declare class Block extends BaseModel {
1087
1129
  * @param upgradeState - Fields relating to a protocol upgrade.
1088
1130
  * @param upgradeVote - Fields relating to voting for a protocol upgrade.
1089
1131
  */
1090
- constructor({ genesisHash, genesisId, previousBlockHash, round, seed, timestamp, transactionsRoot, transactionsRootSha256, participationUpdates, rewards, stateProofTracking, transactions, txnCounter, upgradeState, upgradeVote, }: {
1132
+ constructor({ genesisHash, genesisId, previousBlockHash, round, seed, timestamp, transactionsRoot, transactionsRootSha256, bonus, feesCollected, participationUpdates, proposer, proposerPayout, rewards, stateProofTracking, transactions, txnCounter, upgradeState, upgradeVote, }: {
1091
1133
  genesisHash: string | Uint8Array;
1092
1134
  genesisId: string;
1093
1135
  previousBlockHash: string | Uint8Array;
@@ -1096,7 +1138,11 @@ export declare class Block extends BaseModel {
1096
1138
  timestamp: number | bigint;
1097
1139
  transactionsRoot: string | Uint8Array;
1098
1140
  transactionsRootSha256: string | Uint8Array;
1141
+ bonus?: number | bigint;
1142
+ feesCollected?: number | bigint;
1099
1143
  participationUpdates?: ParticipationUpdates;
1144
+ proposer?: string;
1145
+ proposerPayout?: number | bigint;
1100
1146
  rewards?: BlockRewards;
1101
1147
  stateProofTracking?: StateProofTracking[];
1102
1148
  transactions?: Transaction[];
@@ -1243,6 +1289,10 @@ export declare class Box extends BaseModel {
1243
1289
  * (name) box name, base64 encoded
1244
1290
  */
1245
1291
  name: Uint8Array;
1292
+ /**
1293
+ * The round for which this information is relevant
1294
+ */
1295
+ round: number | bigint;
1246
1296
  /**
1247
1297
  * (value) box value, base64 encoded.
1248
1298
  */
@@ -1250,10 +1300,12 @@ export declare class Box extends BaseModel {
1250
1300
  /**
1251
1301
  * Creates a new `Box` object.
1252
1302
  * @param name - (name) box name, base64 encoded
1303
+ * @param round - The round for which this information is relevant
1253
1304
  * @param value - (value) box value, base64 encoded.
1254
1305
  */
1255
- constructor({ name, value, }: {
1306
+ constructor({ name, round, value, }: {
1256
1307
  name: string | Uint8Array;
1308
+ round: number | bigint;
1257
1309
  value: string | Uint8Array;
1258
1310
  });
1259
1311
  static from_obj_for_encoding(data: Record<string, any>): Box;
@@ -1521,6 +1573,10 @@ export declare class MiniAssetHolding extends BaseModel {
1521
1573
  * Participation account data that needs to be checked/acted on by the network.
1522
1574
  */
1523
1575
  export declare class ParticipationUpdates extends BaseModel {
1576
+ /**
1577
+ * (partupabs) a list of online accounts that need to be suspended.
1578
+ */
1579
+ absentParticipationAccounts?: string[];
1524
1580
  /**
1525
1581
  * (partupdrmv) a list of online accounts that needs to be converted to offline
1526
1582
  * since their participation key expired.
@@ -1528,10 +1584,12 @@ export declare class ParticipationUpdates extends BaseModel {
1528
1584
  expiredParticipationAccounts?: string[];
1529
1585
  /**
1530
1586
  * Creates a new `ParticipationUpdates` object.
1587
+ * @param absentParticipationAccounts - (partupabs) a list of online accounts that need to be suspended.
1531
1588
  * @param expiredParticipationAccounts - (partupdrmv) a list of online accounts that needs to be converted to offline
1532
1589
  * since their participation key expired.
1533
1590
  */
1534
- constructor({ expiredParticipationAccounts, }: {
1591
+ constructor({ absentParticipationAccounts, expiredParticipationAccounts, }: {
1592
+ absentParticipationAccounts?: string[];
1535
1593
  expiredParticipationAccounts?: string[];
1536
1594
  });
1537
1595
  static from_obj_for_encoding(data: Record<string, any>): ParticipationUpdates;
@@ -1788,22 +1846,22 @@ export declare class TealKeyValue extends BaseModel {
1788
1846
  */
1789
1847
  export declare class TealValue extends BaseModel {
1790
1848
  /**
1791
- * (tb) bytes value.
1849
+ * bytes value.
1792
1850
  */
1793
1851
  bytes: string;
1794
1852
  /**
1795
- * (tt) value type. Value `1` refers to **bytes**, value `2` refers to **uint**
1853
+ * type of the value. Value `1` refers to **bytes**, value `2` refers to **uint**
1796
1854
  */
1797
1855
  type: number | bigint;
1798
1856
  /**
1799
- * (ui) uint value.
1857
+ * uint value.
1800
1858
  */
1801
1859
  uint: number | bigint;
1802
1860
  /**
1803
1861
  * Creates a new `TealValue` object.
1804
- * @param bytes - (tb) bytes value.
1805
- * @param type - (tt) value type. Value `1` refers to **bytes**, value `2` refers to **uint**
1806
- * @param uint - (ui) uint value.
1862
+ * @param bytes - bytes value.
1863
+ * @param type - type of the value. Value `1` refers to **bytes**, value `2` refers to **uint**
1864
+ * @param uint - uint value.
1807
1865
  */
1808
1866
  constructor({ bytes, type, uint, }: {
1809
1867
  bytes: string;
@@ -2322,7 +2380,7 @@ export declare class TransactionAssetTransfer extends BaseModel {
2322
2380
  */
2323
2381
  receiver: string;
2324
2382
  /**
2325
- * Number of assets transfered to the close-to account as part of the transaction.
2383
+ * Number of assets transferred to the close-to account as part of the transaction.
2326
2384
  */
2327
2385
  closeAmount?: number | bigint;
2328
2386
  /**
@@ -2343,7 +2401,7 @@ export declare class TransactionAssetTransfer extends BaseModel {
2343
2401
  * that asset in the account's Assets map.
2344
2402
  * @param assetId - (xaid) ID of the asset being transferred.
2345
2403
  * @param receiver - (arcv) Recipient address of the transfer.
2346
- * @param closeAmount - Number of assets transfered to the close-to account as part of the transaction.
2404
+ * @param closeAmount - Number of assets transferred to the close-to account as part of the transaction.
2347
2405
  * @param closeTo - (aclose) Indicates that the asset should be removed from the account's Assets
2348
2406
  * map, and specifies where the remaining asset holdings should be transferred.
2349
2407
  * It's always valid to transfer remaining asset holdings to the creator account.