algosdk 2.7.0 → 2.9.0

package/dist/cjs/client/v2/indexer/models/types.js

@@ -20,13 +20,14 @@ class Account extends basemodel_1.default {
     /**
      * Creates a new `Account` object.
      * @param address - the account public key
-     * @param amount - (algo) total number of MicroAlgos in the account
+     * @param amount - total number of MicroAlgos in the account
      * @param amountWithoutPendingRewards - specifies the amount of MicroAlgos in the account, without the pending rewards.
+     * @param minBalance - MicroAlgo balance required by the account.
+     * The requirement grows based on asset and application usage.
      * @param pendingRewards - amount of MicroAlgos of pending rewards in this account.
-     * @param rewards - (ern) total rewards of MicroAlgos the account has received, including pending
-     * rewards.
+     * @param rewards - total rewards of MicroAlgos the account has received, including pending rewards.
      * @param round - The round for which this information is relevant.
-     * @param status - (onl) delegation status of the account's MicroAlgos
+     * @param status - voting status of the account's MicroAlgos
      * * Offline - indicates that the associated account is delegated.
      * * Online - indicates that the associated account used as part of the delegation
      * pool.
@@ -42,40 +43,44 @@ class Account extends basemodel_1.default {
      * application.
      * @param totalCreatedApps - The count of all apps (AppParams objects) created by this account.
      * @param totalCreatedAssets - The count of all assets (AssetParams objects) created by this account.
-     * @param appsLocalState - (appl) applications local data stored in this account.
+     * @param appsLocalState - application local data stored in this account.
      * Note the raw object uses `map[int] -> AppLocalState` for this type.
-     * @param appsTotalExtraPages - (teap) the sum of all extra application program pages for this account.
-     * @param appsTotalSchema - (tsch) stores the sum of all of the local schemas and global schemas in this
-     * account.
+     * @param appsTotalExtraPages - the sum of all extra application program pages for this account.
+     * @param appsTotalSchema - the sum of all of the local schemas and global schemas in this account.
      * Note: the raw account uses `StateSchema` for this type.
-     * @param assets - (asset) assets held by this account.
+     * @param assets - assets held by this account.
      * Note the raw object uses `map[int] -> AssetHolding` for this type.
-     * @param authAddr - (spend) the address against which signing should be checked. If empty, the
-     * address of the current account is used. This field can be updated in any
-     * transaction by setting the RekeyTo field.
+     * @param authAddr - The address against which signing should be checked. If empty, the address of
+     * the current account is used. This field can be updated in any transaction by
+     * setting the RekeyTo field.
      * @param closedAtRound - Round during which this account was most recently closed.
-     * @param createdApps - (appp) parameters of applications created by this account including app global
-     * data.
+     * @param createdApps - parameters of applications created by this account including app global data.
      * Note: the raw account uses `map[int] -> AppParams` for this type.
-     * @param createdAssets - (apar) parameters of assets created by this account.
+     * @param createdAssets - parameters of assets created by this account.
      * Note: the raw account uses `map[int] -> Asset` for this type.
      * @param createdAtRound - Round during which this account first appeared in a transaction.
      * @param deleted - Whether or not this account is currently closed.
+     * @param incentiveEligible - can the account receive block incentives if its balance is in range at proposal
+     * time.
+     * @param lastHeartbeat - The round in which this account last went online, or explicitly renewed their
+     * online status.
+     * @param lastProposed - The round in which this account last proposed the block.
      * @param participation - AccountParticipation describes the parameters used by this account in consensus
      * protocol.
-     * @param rewardBase - (ebase) used as part of the rewards computation. Only applicable to accounts
-     * which are participating.
-     * @param sigType - Indicates what type of signature is used by this account, must be one of:
+     * @param rewardBase - used as part of the rewards computation. Only applicable to accounts which are
+     * participating.
+     * @param sigType - the type of signature used by this account, must be one of:
      * * sig
      * * msig
      * * lsig
      * * or null if unknown
      */
-    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, }) {
+    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, }) {
         super();
         this.address = address;
         this.amount = amount;
         this.amountWithoutPendingRewards = amountWithoutPendingRewards;
+        this.minBalance = minBalance;
         this.pendingRewards = pendingRewards;
         this.rewards = rewards;
         this.round = round;
@@ -96,6 +101,9 @@ class Account extends basemodel_1.default {
         this.createdAssets = createdAssets;
         this.createdAtRound = createdAtRound;
         this.deleted = deleted;
+        this.incentiveEligible = incentiveEligible;
+        this.lastHeartbeat = lastHeartbeat;
+        this.lastProposed = lastProposed;
         this.participation = participation;
         this.rewardBase = rewardBase;
         this.sigType = sigType;
@@ -103,6 +111,7 @@ class Account extends basemodel_1.default {
             address: 'address',
             amount: 'amount',
             amountWithoutPendingRewards: 'amount-without-pending-rewards',
+            minBalance: 'min-balance',
             pendingRewards: 'pending-rewards',
             rewards: 'rewards',
             round: 'round',
@@ -123,6 +132,9 @@ class Account extends basemodel_1.default {
             createdAssets: 'created-assets',
             createdAtRound: 'created-at-round',
             deleted: 'deleted',
+            incentiveEligible: 'incentive-eligible',
+            lastHeartbeat: 'last-heartbeat',
+            lastProposed: 'last-proposed',
             participation: 'participation',
             rewardBase: 'reward-base',
             sigType: 'sig-type',
@@ -137,6 +149,8 @@ class Account extends basemodel_1.default {
             throw new Error(`Response is missing required field 'amount': ${data}`);
         if (typeof data['amount-without-pending-rewards'] === 'undefined')
             throw new Error(`Response is missing required field 'amount-without-pending-rewards': ${data}`);
+        if (typeof data['min-balance'] === 'undefined')
+            throw new Error(`Response is missing required field 'min-balance': ${data}`);
         if (typeof data['pending-rewards'] === 'undefined')
             throw new Error(`Response is missing required field 'pending-rewards': ${data}`);
         if (typeof data['rewards'] === 'undefined')
@@ -161,6 +175,7 @@ class Account extends basemodel_1.default {
             address: data['address'],
             amount: data['amount'],
             amountWithoutPendingRewards: data['amount-without-pending-rewards'],
+            minBalance: data['min-balance'],
             pendingRewards: data['pending-rewards'],
             rewards: data['rewards'],
             round: data['round'],
@@ -191,6 +206,9 @@ class Account extends basemodel_1.default {
                 : undefined,
             createdAtRound: data['created-at-round'],
             deleted: data['deleted'],
+            incentiveEligible: data['incentive-eligible'],
+            lastHeartbeat: data['last-heartbeat'],
+            lastProposed: data['last-proposed'],
             participation: typeof data['participation'] !== 'undefined'
                 ? AccountParticipation.from_obj_for_encoding(data['participation'])
                 : undefined,
@@ -208,13 +226,12 @@ exports.Account = Account;
 class AccountParticipation extends basemodel_1.default {
     /**
      * Creates a new `AccountParticipation` object.
-     * @param selectionParticipationKey - (sel) Selection public key (if any) currently registered for this round.
-     * @param voteFirstValid - (voteFst) First round for which this participation is valid.
-     * @param voteKeyDilution - (voteKD) Number of subkeys in each batch of participation keys.
-     * @param voteLastValid - (voteLst) Last round for which this participation is valid.
-     * @param voteParticipationKey - (vote) root participation public key (if any) currently registered for this
-     * round.
-     * @param stateProofKey - (stprf) Root of the state proof key (if any)
+     * @param selectionParticipationKey - Selection public key (if any) currently registered for this round.
+     * @param voteFirstValid - First round for which this participation is valid.
+     * @param voteKeyDilution - Number of subkeys in each batch of participation keys.
+     * @param voteLastValid - Last round for which this participation is valid.
+     * @param voteParticipationKey - root participation public key (if any) currently registered for this round.
+     * @param stateProofKey - Root of the state proof key (if any)
      */
     constructor({ selectionParticipationKey, voteFirstValid, voteKeyDilution, voteLastValid, voteParticipationKey, stateProofKey, }) {
         super();
@@ -379,8 +396,8 @@ exports.AccountsResponse = AccountsResponse;
 class Application extends basemodel_1.default {
     /**
      * Creates a new `Application` object.
-     * @param id - (appidx) application index.
-     * @param params - (appparams) application parameters.
+     * @param id - application index.
+     * @param params - application parameters.
      * @param createdAtRound - Round when this application was created.
      * @param deleted - Whether or not this application is currently deleted.
      * @param deletedAtRound - Round when this application was deleted.
@@ -425,11 +442,11 @@ class ApplicationLocalState extends basemodel_1.default {
     /**
      * Creates a new `ApplicationLocalState` object.
      * @param id - The application which this local state is for.
-     * @param schema - (hsch) schema.
+     * @param schema - schema.
      * @param closedOutAtRound - Round when account closed out of the application.
      * @param deleted - Whether or not the application local state is currently deleted from its
      * account.
-     * @param keyValue - (tkv) storage.
+     * @param keyValue - storage.
      * @param optedInAtRound - Round when the account opted into the application.
      */
     constructor({ id, schema, closedOutAtRound, deleted, keyValue, optedInAtRound, }) {
@@ -514,7 +531,7 @@ exports.ApplicationLocalStatesResponse = ApplicationLocalStatesResponse;
 class ApplicationLogData extends basemodel_1.default {
     /**
      * Creates a new `ApplicationLogData` object.
-     * @param logs - (lg) Logs for the application being executed by the transaction.
+     * @param logs - Logs for the application being executed by the transaction.
      * @param txid - Transaction ID
      */
     constructor({ logs, txid }) {
@@ -591,14 +608,14 @@ exports.ApplicationLogsResponse = ApplicationLogsResponse;
 class ApplicationParams extends basemodel_1.default {
     /**
      * Creates a new `ApplicationParams` object.
-     * @param approvalProgram - (approv) approval program.
-     * @param clearStateProgram - (clearp) approval program.
+     * @param approvalProgram - approval program.
+     * @param clearStateProgram - clear state program.
      * @param creator - The address that created this application. This is the address where the
      * parameters and global state for this application can be found.
-     * @param extraProgramPages - (epp) the amount of extra program pages available to this app.
-     * @param globalState - [\gs) global schema
-     * @param globalStateSchema - [\gsch) global schema
-     * @param localStateSchema - [\lsch) local schema
+     * @param extraProgramPages - the number of extra program pages available to this app.
+     * @param globalState - global state
+     * @param globalStateSchema - global schema
+     * @param localStateSchema - local schema
      */
     constructor({ approvalProgram, clearStateProgram, creator, extraProgramPages, globalState, globalStateSchema, localStateSchema, }) {
         super();
@@ -690,8 +707,8 @@ exports.ApplicationResponse = ApplicationResponse;
 class ApplicationStateSchema extends basemodel_1.default {
     /**
      * Creates a new `ApplicationStateSchema` object.
-     * @param numByteSlice - (nbs) num of byte slices.
-     * @param numUint - (nui) num of uints.
+     * @param numByteSlice - number of byte slices.
+     * @param numUint - number of uints.
      */
     constructor({ numByteSlice, numUint, }) {
         super();
@@ -849,9 +866,9 @@ exports.AssetBalancesResponse = AssetBalancesResponse;
 class AssetHolding extends basemodel_1.default {
     /**
      * Creates a new `AssetHolding` object.
-     * @param amount - (a) number of units held.
+     * @param amount - number of units held.
      * @param assetId - Asset ID of the holding.
-     * @param isFrozen - (f) whether or not the holding is frozen.
+     * @param isFrozen - whether or not the holding is frozen.
      * @param deleted - Whether or not the asset holding is currently deleted from its account.
      * @param optedInAtRound - Round during which the account opted into this asset holding.
      * @param optedOutAtRound - Round during which the account opted out of this asset holding.
@@ -944,28 +961,28 @@ class AssetParams extends basemodel_1.default {
      * @param creator - The address that created this asset. This is the address where the parameters
      * for this asset can be found, and also the address where unwanted asset units can
      * be sent in the worst case.
-     * @param decimals - (dc) The number of digits to use after the decimal point when displaying this
-     * asset. If 0, the asset is not divisible. If 1, the base unit of the asset is in
-     * tenths. If 2, the base unit of the asset is in hundredths, and so on. This value
-     * must be between 0 and 19 (inclusive).
-     * @param total - (t) The total number of units of this asset.
-     * @param clawback - (c) Address of account used to clawback holdings of this asset. If empty,
-     * clawback is not permitted.
-     * @param defaultFrozen - (df) Whether holdings of this asset are frozen by default.
-     * @param freeze - (f) Address of account used to freeze holdings of this asset. If empty, freezing
+     * @param decimals - The number of digits to use after the decimal point when displaying this asset.
+     * If 0, the asset is not divisible. If 1, the base unit of the asset is in tenths.
+     * If 2, the base unit of the asset is in hundredths, and so on. This value must be
+     * between 0 and 19 (inclusive).
+     * @param total - The total number of units of this asset.
+     * @param clawback - Address of account used to clawback holdings of this asset. If empty, clawback
      * is not permitted.
-     * @param manager - (m) Address of account used to manage the keys of this asset and to destroy it.
-     * @param metadataHash - (am) A commitment to some unspecified asset metadata. The format of this
-     * metadata is up to the application.
-     * @param name - (an) Name of this asset, as supplied by the creator. Included only when the
-     * asset name is composed of printable utf-8 characters.
+     * @param defaultFrozen - Whether holdings of this asset are frozen by default.
+     * @param freeze - Address of account used to freeze holdings of this asset. If empty, freezing is
+     * not permitted.
+     * @param manager - Address of account used to manage the keys of this asset and to destroy it.
+     * @param metadataHash - A commitment to some unspecified asset metadata. The format of this metadata is
+     * up to the application.
+     * @param name - Name of this asset, as supplied by the creator. Included only when the asset
+     * name is composed of printable utf-8 characters.
      * @param nameB64 - Base64 encoded name of this asset, as supplied by the creator.
-     * @param reserve - (r) Address of account holding reserve (non-minted) units of this asset.
-     * @param unitName - (un) Name of a unit of this asset, as supplied by the creator. Included only
-     * when the name of a unit of this asset is composed of printable utf-8 characters.
+     * @param reserve - Address of account holding reserve (non-minted) units of this asset.
+     * @param unitName - Name of a unit of this asset, as supplied by the creator. Included only when the
+     * name of a unit of this asset is composed of printable utf-8 characters.
      * @param unitNameB64 - Base64 encoded name of a unit of this asset, as supplied by the creator.
-     * @param url - (au) URL where more information about the asset can be retrieved. Included only
-     * when the URL is composed of printable utf-8 characters.
+     * @param url - URL where more information about the asset can be retrieved. Included only when
+     * the URL is composed of printable utf-8 characters.
      * @param urlB64 - Base64 encoded URL where more information about the asset can be retrieved.
      */
     constructor({ creator, decimals, total, clawback, defaultFrozen, freeze, manager, metadataHash, name, nameB64, reserve, unitName, unitNameB64, url, urlB64, }) {
@@ -1140,7 +1157,11 @@ class Block extends basemodel_1.default {
      * vector commitment instead of a merkle tree, and SHA256 hash function instead of
      * the default SHA512_256. This commitment can be used on environments where only
      * the SHA256 function exists.
+     * @param bonus - the potential bonus payout for this block.
+     * @param feesCollected - the sum of all fees paid by transactions in this block.
      * @param participationUpdates - Participation account data that needs to be checked/acted on by the network.
+     * @param proposer - the proposer of this block.
+     * @param proposerPayout - the actual amount transferred to the proposer from the fee sink.
      * @param rewards - Fields relating to rewards,
      * @param stateProofTracking - Tracks the status of state proofs.
      * @param transactions - (txns) list of transactions corresponding to a given round.
@@ -1152,7 +1173,7 @@ class Block extends basemodel_1.default {
      * @param upgradeState - Fields relating to a protocol upgrade.
      * @param upgradeVote - Fields relating to voting for a protocol upgrade.
      */
-    constructor({ genesisHash, genesisId, previousBlockHash, round, seed, timestamp, transactionsRoot, transactionsRootSha256, participationUpdates, rewards, stateProofTracking, transactions, txnCounter, upgradeState, upgradeVote, }) {
+    constructor({ genesisHash, genesisId, previousBlockHash, round, seed, timestamp, transactionsRoot, transactionsRootSha256, bonus, feesCollected, participationUpdates, proposer, proposerPayout, rewards, stateProofTracking, transactions, txnCounter, upgradeState, upgradeVote, }) {
         super();
         this.genesisHash =
             typeof genesisHash === 'string'
@@ -1177,7 +1198,11 @@ class Block extends basemodel_1.default {
             typeof transactionsRootSha256 === 'string'
                 ? new Uint8Array(buffer_1.Buffer.from(transactionsRootSha256, 'base64'))
                 : transactionsRootSha256;
+        this.bonus = bonus;
+        this.feesCollected = feesCollected;
         this.participationUpdates = participationUpdates;
+        this.proposer = proposer;
+        this.proposerPayout = proposerPayout;
         this.rewards = rewards;
         this.stateProofTracking = stateProofTracking;
         this.transactions = transactions;
@@ -1193,7 +1218,11 @@ class Block extends basemodel_1.default {
             timestamp: 'timestamp',
             transactionsRoot: 'transactions-root',
             transactionsRootSha256: 'transactions-root-sha256',
+            bonus: 'bonus',
+            feesCollected: 'fees-collected',
             participationUpdates: 'participation-updates',
+            proposer: 'proposer',
+            proposerPayout: 'proposer-payout',
             rewards: 'rewards',
             stateProofTracking: 'state-proof-tracking',
             transactions: 'transactions',
@@ -1230,9 +1259,13 @@ class Block extends basemodel_1.default {
             timestamp: data['timestamp'],
             transactionsRoot: data['transactions-root'],
             transactionsRootSha256: data['transactions-root-sha256'],
+            bonus: data['bonus'],
+            feesCollected: data['fees-collected'],
             participationUpdates: typeof data['participation-updates'] !== 'undefined'
                 ? ParticipationUpdates.from_obj_for_encoding(data['participation-updates'])
                 : undefined,
+            proposer: data['proposer'],
+            proposerPayout: data['proposer-payout'],
             rewards: typeof data['rewards'] !== 'undefined'
                 ? BlockRewards.from_obj_for_encoding(data['rewards'])
                 : undefined,
@@ -1400,20 +1433,23 @@ class Box extends basemodel_1.default {
     /**
      * Creates a new `Box` object.
      * @param name - (name) box name, base64 encoded
+     * @param round - The round for which this information is relevant
      * @param value - (value) box value, base64 encoded.
      */
-    constructor({ name, value, }) {
+    constructor({ name, round, value, }) {
         super();
         this.name =
             typeof name === 'string'
                 ? new Uint8Array(buffer_1.Buffer.from(name, 'base64'))
                 : name;
+        this.round = round;
         this.value =
             typeof value === 'string'
                 ? new Uint8Array(buffer_1.Buffer.from(value, 'base64'))
                 : value;
         this.attribute_map = {
             name: 'name',
+            round: 'round',
             value: 'value',
         };
     }
@@ -1422,10 +1458,13 @@ class Box extends basemodel_1.default {
         /* eslint-disable dot-notation */
         if (typeof data['name'] === 'undefined')
             throw new Error(`Response is missing required field 'name': ${data}`);
+        if (typeof data['round'] === 'undefined')
+            throw new Error(`Response is missing required field 'round': ${data}`);
         if (typeof data['value'] === 'undefined')
             throw new Error(`Response is missing required field 'value': ${data}`);
         return new Box({
             name: data['name'],
+            round: data['round'],
             value: data['value'],
         });
         /* eslint-enable dot-notation */
@@ -1813,13 +1852,16 @@ exports.MiniAssetHolding = MiniAssetHolding;
 class ParticipationUpdates extends basemodel_1.default {
     /**
      * Creates a new `ParticipationUpdates` object.
+     * @param absentParticipationAccounts - (partupabs) a list of online accounts that need to be suspended.
      * @param expiredParticipationAccounts - (partupdrmv) a list of online accounts that needs to be converted to offline
      * since their participation key expired.
      */
-    constructor({ expiredParticipationAccounts, }) {
+    constructor({ absentParticipationAccounts, expiredParticipationAccounts, }) {
         super();
+        this.absentParticipationAccounts = absentParticipationAccounts;
         this.expiredParticipationAccounts = expiredParticipationAccounts;
         this.attribute_map = {
+            absentParticipationAccounts: 'absent-participation-accounts',
             expiredParticipationAccounts: 'expired-participation-accounts',
         };
     }
@@ -1827,6 +1869,7 @@ class ParticipationUpdates extends basemodel_1.default {
     static from_obj_for_encoding(data) {
         /* eslint-disable dot-notation */
         return new ParticipationUpdates({
+            absentParticipationAccounts: data['absent-participation-accounts'],
             expiredParticipationAccounts: data['expired-participation-accounts'],
         });
         /* eslint-enable dot-notation */
@@ -2170,9 +2213,9 @@ exports.TealKeyValue = TealKeyValue;
 class TealValue extends basemodel_1.default {
     /**
      * Creates a new `TealValue` object.
-     * @param bytes - (tb) bytes value.
-     * @param type - (tt) value type. Value `1` refers to **bytes**, value `2` refers to **uint**
-     * @param uint - (ui) uint value.
+     * @param bytes - bytes value.
+     * @param type - type of the value. Value `1` refers to **bytes**, value `2` refers to **uint**
+     * @param uint - uint value.
      */
     constructor({ bytes, type, uint, }) {
         super();
@@ -2640,7 +2683,7 @@ class TransactionAssetTransfer extends basemodel_1.default {
      * that asset in the account's Assets map.
      * @param assetId - (xaid) ID of the asset being transferred.
      * @param receiver - (arcv) Recipient address of the transfer.
-     * @param closeAmount - Number of assets transfered to the close-to account as part of the transaction.
+     * @param closeAmount - Number of assets transferred to the close-to account as part of the transaction.
      * @param closeTo - (aclose) Indicates that the asset should be removed from the account's Assets
      * map, and specifies where the remaining asset holdings should be transferred.
      * It's always valid to transfer remaining asset holdings to the creator account.