algosdk 2.2.0 → 2.3.0

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

@@ -6,7 +6,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Version = exports.TransactionProofResponse = exports.TransactionParametersResponse = exports.TealValue = exports.TealKeyValue = exports.SupplyResponse = exports.StateProofMessage = exports.StateProof = exports.SimulateTransactionResult = exports.SimulateTransactionGroupResult = exports.SimulateResponse = exports.PostTransactionsResponse = exports.PendingTransactionsResponse = exports.PendingTransactionResponse = exports.NodeStatusResponse = exports.LightBlockHeaderProof = exports.EvalDeltaKeyValue = exports.EvalDelta = exports.ErrorResponse = exports.DryrunTxnResult = exports.DryrunState = exports.DryrunSource = exports.DryrunResponse = exports.DryrunRequest = exports.DisassembleResponse = exports.CompileResponse = exports.BuildVersion = exports.BoxesResponse = exports.BoxDescriptor = exports.Box = exports.BlockResponse = exports.BlockHashResponse = exports.AssetParams = exports.AssetHolding = exports.Asset = exports.ApplicationStateSchema = exports.ApplicationParams = exports.ApplicationLocalState = exports.Application = exports.AccountStateDelta = exports.AccountParticipation = exports.AccountAssetResponse = exports.AccountApplicationResponse = exports.Account = void 0;
+exports.Version = exports.TransactionProofResponse = exports.TransactionParametersResponse = exports.TealValue = exports.TealKeyValue = exports.SupplyResponse = exports.StateProofMessage = exports.StateProof = exports.SimulationEvalOverrides = exports.SimulateTransactionResult = exports.SimulateTransactionGroupResult = exports.SimulateResponse = exports.SimulateRequestTransactionGroup = exports.SimulateRequest = exports.PostTransactionsResponse = exports.PendingTransactionsResponse = exports.PendingTransactionResponse = exports.NodeStatusResponse = exports.LightBlockHeaderProof = exports.KvDelta = exports.GetSyncRoundResponse = exports.GetBlockTimeStampOffsetResponse = exports.EvalDeltaKeyValue = exports.EvalDelta = exports.ErrorResponse = exports.DryrunTxnResult = exports.DryrunState = exports.DryrunSource = exports.DryrunResponse = exports.DryrunRequest = exports.DisassembleResponse = exports.CompileResponse = exports.BuildVersion = exports.BoxesResponse = exports.BoxDescriptor = exports.Box = exports.BlockResponse = exports.BlockHashResponse = exports.AssetParams = exports.AssetHolding = exports.Asset = exports.ApplicationStateSchema = exports.ApplicationParams = exports.ApplicationLocalState = exports.Application = exports.AccountStateDelta = exports.AccountParticipation = exports.AccountAssetResponse = exports.AccountApplicationResponse = exports.Account = void 0;
 /* eslint-disable no-use-before-define */
 const buffer_1 = require("buffer");
 const basemodel_1 = __importDefault(require("../../basemodel"));
@@ -459,9 +459,9 @@ class ApplicationParams extends basemodel_1.default {
      * @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 globalState - (gs) global state
+     * @param globalStateSchema - (gsch) global schema
+     * @param localStateSchema - (lsch) local schema
      */
     constructor({ approvalProgram, clearStateProgram, creator, extraProgramPages, globalState, globalStateSchema, localStateSchema, }) {
         super();
@@ -1390,6 +1390,96 @@ class EvalDeltaKeyValue extends basemodel_1.default {
     }
 }
 exports.EvalDeltaKeyValue = EvalDeltaKeyValue;
+/**
+ * Response containing the timestamp offset in seconds
+ */
+class GetBlockTimeStampOffsetResponse extends basemodel_1.default {
+    /**
+     * Creates a new `GetBlockTimeStampOffsetResponse` object.
+     * @param offset - Timestamp offset in seconds.
+     */
+    constructor({ offset }) {
+        super();
+        this.offset = offset;
+        this.attribute_map = {
+            offset: 'offset',
+        };
+    }
+    // eslint-disable-next-line camelcase
+    static from_obj_for_encoding(data) {
+        /* eslint-disable dot-notation */
+        if (typeof data['offset'] === 'undefined')
+            throw new Error(`Response is missing required field 'offset': ${data}`);
+        return new GetBlockTimeStampOffsetResponse({
+            offset: data['offset'],
+        });
+        /* eslint-enable dot-notation */
+    }
+}
+exports.GetBlockTimeStampOffsetResponse = GetBlockTimeStampOffsetResponse;
+/**
+ * Response containing the ledger's minimum sync round
+ */
+class GetSyncRoundResponse extends basemodel_1.default {
+    /**
+     * Creates a new `GetSyncRoundResponse` object.
+     * @param round - The minimum sync round for the ledger.
+     */
+    constructor({ round }) {
+        super();
+        this.round = round;
+        this.attribute_map = {
+            round: 'round',
+        };
+    }
+    // eslint-disable-next-line camelcase
+    static from_obj_for_encoding(data) {
+        /* eslint-disable dot-notation */
+        if (typeof data['round'] === 'undefined')
+            throw new Error(`Response is missing required field 'round': ${data}`);
+        return new GetSyncRoundResponse({
+            round: data['round'],
+        });
+        /* eslint-enable dot-notation */
+    }
+}
+exports.GetSyncRoundResponse = GetSyncRoundResponse;
+/**
+ * A single Delta containing the key, the previous value and the current value for
+ * a single round.
+ */
+class KvDelta extends basemodel_1.default {
+    /**
+     * Creates a new `KvDelta` object.
+     * @param key - The key, base64 encoded.
+     * @param value - The new value of the KV store entry, base64 encoded.
+     */
+    constructor({ key, value, }) {
+        super();
+        this.key =
+            typeof key === 'string'
+                ? new Uint8Array(buffer_1.Buffer.from(key, 'base64'))
+                : key;
+        this.value =
+            typeof value === 'string'
+                ? new Uint8Array(buffer_1.Buffer.from(value, 'base64'))
+                : value;
+        this.attribute_map = {
+            key: 'key',
+            value: 'value',
+        };
+    }
+    // eslint-disable-next-line camelcase
+    static from_obj_for_encoding(data) {
+        /* eslint-disable dot-notation */
+        return new KvDelta({
+            key: data['key'],
+            value: data['value'],
+        });
+        /* eslint-enable dot-notation */
+    }
+}
+exports.KvDelta = KvDelta;
 /**
  * Proof of membership and position of a light block header.
  */
@@ -1465,8 +1555,16 @@ class NodeStatusResponse extends basemodel_1.default {
      * @param catchpointVerifiedKvs - The number of key-values (KVs) from the current catchpoint that have been
      * verified so far as part of the catchup
      * @param lastCatchpoint - The last catchpoint seen by the node
+     * @param upgradeDelay - Upgrade delay
+     * @param upgradeNextProtocolVoteBefore - Next protocol round
+     * @param upgradeNoVotes - No votes cast for consensus upgrade
+     * @param upgradeNodeVote - This node's upgrade vote
+     * @param upgradeVoteRounds - Total voting rounds for current upgrade
+     * @param upgradeVotes - Total votes cast for consensus upgrade
+     * @param upgradeVotesRequired - Yes votes required for consensus upgrade
+     * @param upgradeYesVotes - Yes votes cast for consensus upgrade
      */
-    constructor({ catchupTime, lastRound, lastVersion, nextVersion, nextVersionRound, nextVersionSupported, stoppedAtUnsupportedRound, timeSinceLastRound, catchpoint, catchpointAcquiredBlocks, catchpointProcessedAccounts, catchpointProcessedKvs, catchpointTotalAccounts, catchpointTotalBlocks, catchpointTotalKvs, catchpointVerifiedAccounts, catchpointVerifiedKvs, lastCatchpoint, }) {
+    constructor({ catchupTime, lastRound, lastVersion, nextVersion, nextVersionRound, nextVersionSupported, stoppedAtUnsupportedRound, timeSinceLastRound, catchpoint, catchpointAcquiredBlocks, catchpointProcessedAccounts, catchpointProcessedKvs, catchpointTotalAccounts, catchpointTotalBlocks, catchpointTotalKvs, catchpointVerifiedAccounts, catchpointVerifiedKvs, lastCatchpoint, upgradeDelay, upgradeNextProtocolVoteBefore, upgradeNoVotes, upgradeNodeVote, upgradeVoteRounds, upgradeVotes, upgradeVotesRequired, upgradeYesVotes, }) {
         super();
         this.catchupTime = catchupTime;
         this.lastRound = lastRound;
@@ -1486,6 +1584,14 @@ class NodeStatusResponse extends basemodel_1.default {
         this.catchpointVerifiedAccounts = catchpointVerifiedAccounts;
         this.catchpointVerifiedKvs = catchpointVerifiedKvs;
         this.lastCatchpoint = lastCatchpoint;
+        this.upgradeDelay = upgradeDelay;
+        this.upgradeNextProtocolVoteBefore = upgradeNextProtocolVoteBefore;
+        this.upgradeNoVotes = upgradeNoVotes;
+        this.upgradeNodeVote = upgradeNodeVote;
+        this.upgradeVoteRounds = upgradeVoteRounds;
+        this.upgradeVotes = upgradeVotes;
+        this.upgradeVotesRequired = upgradeVotesRequired;
+        this.upgradeYesVotes = upgradeYesVotes;
         this.attribute_map = {
             catchupTime: 'catchup-time',
             lastRound: 'last-round',
@@ -1505,6 +1611,14 @@ class NodeStatusResponse extends basemodel_1.default {
             catchpointVerifiedAccounts: 'catchpoint-verified-accounts',
             catchpointVerifiedKvs: 'catchpoint-verified-kvs',
             lastCatchpoint: 'last-catchpoint',
+            upgradeDelay: 'upgrade-delay',
+            upgradeNextProtocolVoteBefore: 'upgrade-next-protocol-vote-before',
+            upgradeNoVotes: 'upgrade-no-votes',
+            upgradeNodeVote: 'upgrade-node-vote',
+            upgradeVoteRounds: 'upgrade-vote-rounds',
+            upgradeVotes: 'upgrade-votes',
+            upgradeVotesRequired: 'upgrade-votes-required',
+            upgradeYesVotes: 'upgrade-yes-votes',
         };
     }
     // eslint-disable-next-line camelcase
@@ -1545,6 +1659,14 @@ class NodeStatusResponse extends basemodel_1.default {
             catchpointVerifiedAccounts: data['catchpoint-verified-accounts'],
             catchpointVerifiedKvs: data['catchpoint-verified-kvs'],
             lastCatchpoint: data['last-catchpoint'],
+            upgradeDelay: data['upgrade-delay'],
+            upgradeNextProtocolVoteBefore: data['upgrade-next-protocol-vote-before'],
+            upgradeNoVotes: data['upgrade-no-votes'],
+            upgradeNodeVote: data['upgrade-node-vote'],
+            upgradeVoteRounds: data['upgrade-vote-rounds'],
+            upgradeVotes: data['upgrade-votes'],
+            upgradeVotesRequired: data['upgrade-votes-required'],
+            upgradeYesVotes: data['upgrade-yes-votes'],
         });
         /* eslint-enable dot-notation */
     }
@@ -1568,12 +1690,12 @@ class PendingTransactionResponse extends basemodel_1.default {
      * @param closeRewards - Rewards in microalgos applied to the close remainder to account.
      * @param closingAmount - Closing amount for the transaction.
      * @param confirmedRound - The round where this transaction was confirmed, if present.
-     * @param globalStateDelta - (gd) Global state key/value changes for the application being executed by this
+     * @param globalStateDelta - Global state key/value changes for the application being executed by this
      * transaction.
      * @param innerTxns - Inner transactions produced by application execution.
-     * @param localStateDelta - (ld) Local state key/value changes for the application being executed by this
+     * @param localStateDelta - Local state key/value changes for the application being executed by this
      * transaction.
-     * @param logs - (lg) Logs for the application being executed by this transaction.
+     * @param logs - Logs for the application being executed by this transaction.
      * @param receiverRewards - Rewards in microalgos applied to the receiver account.
      * @param senderRewards - Rewards in microalgos applied to the sender account.
      */
@@ -1705,6 +1827,69 @@ class PostTransactionsResponse extends basemodel_1.default {
     }
 }
 exports.PostTransactionsResponse = PostTransactionsResponse;
+/**
+ * Request type for simulation endpoint.
+ */
+class SimulateRequest extends basemodel_1.default {
+    /**
+     * Creates a new `SimulateRequest` object.
+     * @param txnGroups - The transaction groups to simulate.
+     * @param allowEmptySignatures - Allow transactions without signatures to be simulated as if they had correct
+     * signatures.
+     * @param allowMoreLogging - Lifts limits on log opcode usage during simulation.
+     */
+    constructor({ txnGroups, allowEmptySignatures, allowMoreLogging, }) {
+        super();
+        this.txnGroups = txnGroups;
+        this.allowEmptySignatures = allowEmptySignatures;
+        this.allowMoreLogging = allowMoreLogging;
+        this.attribute_map = {
+            txnGroups: 'txn-groups',
+            allowEmptySignatures: 'allow-empty-signatures',
+            allowMoreLogging: 'allow-more-logging',
+        };
+    }
+    // eslint-disable-next-line camelcase
+    static from_obj_for_encoding(data) {
+        /* eslint-disable dot-notation */
+        if (!Array.isArray(data['txn-groups']))
+            throw new Error(`Response is missing required array field 'txn-groups': ${data}`);
+        return new SimulateRequest({
+            txnGroups: data['txn-groups'].map(SimulateRequestTransactionGroup.from_obj_for_encoding),
+            allowEmptySignatures: data['allow-empty-signatures'],
+            allowMoreLogging: data['allow-more-logging'],
+        });
+        /* eslint-enable dot-notation */
+    }
+}
+exports.SimulateRequest = SimulateRequest;
+/**
+ * A transaction group to simulate.
+ */
+class SimulateRequestTransactionGroup extends basemodel_1.default {
+    /**
+     * Creates a new `SimulateRequestTransactionGroup` object.
+     * @param txns - An atomic transaction group.
+     */
+    constructor({ txns }) {
+        super();
+        this.txns = txns;
+        this.attribute_map = {
+            txns: 'txns',
+        };
+    }
+    // eslint-disable-next-line camelcase
+    static from_obj_for_encoding(data) {
+        /* eslint-disable dot-notation */
+        if (!Array.isArray(data['txns']))
+            throw new Error(`Response is missing required array field 'txns': ${data}`);
+        return new SimulateRequestTransactionGroup({
+            txns: data['txns'],
+        });
+        /* eslint-enable dot-notation */
+    }
+}
+exports.SimulateRequestTransactionGroup = SimulateRequestTransactionGroup;
 /**
  * Result of a transaction group simulation.
  */
@@ -1715,21 +1900,21 @@ class SimulateResponse extends basemodel_1.default {
      * round were used to run this simulation.
      * @param txnGroups - A result object for each transaction group that was simulated.
      * @param version - The version of this response object.
-     * @param wouldSucceed - Indicates whether the simulated transactions would have succeeded during an
-     * actual submission. If any transaction fails or is missing a signature, this will
-     * be false.
+     * @param evalOverrides - The set of parameters and limits override during simulation. If this set of
+     * parameters is present, then evaluation parameters may differ from standard
+     * evaluation in certain ways.
      */
-    constructor({ lastRound, txnGroups, version, wouldSucceed, }) {
+    constructor({ lastRound, txnGroups, version, evalOverrides, }) {
         super();
         this.lastRound = lastRound;
         this.txnGroups = txnGroups;
         this.version = version;
-        this.wouldSucceed = wouldSucceed;
+        this.evalOverrides = evalOverrides;
         this.attribute_map = {
             lastRound: 'last-round',
             txnGroups: 'txn-groups',
             version: 'version',
-            wouldSucceed: 'would-succeed',
+            evalOverrides: 'eval-overrides',
         };
     }
     // eslint-disable-next-line camelcase
@@ -1741,13 +1926,13 @@ class SimulateResponse extends basemodel_1.default {
             throw new Error(`Response is missing required array field 'txn-groups': ${data}`);
         if (typeof data['version'] === 'undefined')
             throw new Error(`Response is missing required field 'version': ${data}`);
-        if (typeof data['would-succeed'] === 'undefined')
-            throw new Error(`Response is missing required field 'would-succeed': ${data}`);
         return new SimulateResponse({
             lastRound: data['last-round'],
             txnGroups: data['txn-groups'].map(SimulateTransactionGroupResult.from_obj_for_encoding),
             version: data['version'],
-            wouldSucceed: data['would-succeed'],
+            evalOverrides: typeof data['eval-overrides'] !== 'undefined'
+                ? SimulationEvalOverrides.from_obj_for_encoding(data['eval-overrides'])
+                : undefined,
         });
         /* eslint-enable dot-notation */
     }
@@ -1760,6 +1945,8 @@ class SimulateTransactionGroupResult extends basemodel_1.default {
     /**
      * Creates a new `SimulateTransactionGroupResult` object.
      * @param txnResults - Simulation result for individual transactions
+     * @param appBudgetAdded - Total budget added during execution of app calls in the transaction group.
+     * @param appBudgetConsumed - Total budget consumed during execution of app calls in the transaction group.
      * @param failedAt - If present, indicates which transaction in this group caused the failure. This
      * array represents the path to the failing transaction. Indexes are zero based,
      * the first element indicates the top-level transaction, and successive elements
@@ -1767,13 +1954,17 @@ class SimulateTransactionGroupResult extends basemodel_1.default {
      * @param failureMessage - If present, indicates that the transaction group failed and specifies why that
      * happened
      */
-    constructor({ txnResults, failedAt, failureMessage, }) {
+    constructor({ txnResults, appBudgetAdded, appBudgetConsumed, failedAt, failureMessage, }) {
         super();
         this.txnResults = txnResults;
+        this.appBudgetAdded = appBudgetAdded;
+        this.appBudgetConsumed = appBudgetConsumed;
         this.failedAt = failedAt;
         this.failureMessage = failureMessage;
         this.attribute_map = {
             txnResults: 'txn-results',
+            appBudgetAdded: 'app-budget-added',
+            appBudgetConsumed: 'app-budget-consumed',
             failedAt: 'failed-at',
             failureMessage: 'failure-message',
         };
@@ -1785,6 +1976,8 @@ class SimulateTransactionGroupResult extends basemodel_1.default {
             throw new Error(`Response is missing required array field 'txn-results': ${data}`);
         return new SimulateTransactionGroupResult({
             txnResults: data['txn-results'].map(SimulateTransactionResult.from_obj_for_encoding),
+            appBudgetAdded: data['app-budget-added'],
+            appBudgetConsumed: data['app-budget-consumed'],
             failedAt: data['failed-at'],
             failureMessage: data['failure-message'],
         });
@@ -1800,15 +1993,19 @@ class SimulateTransactionResult extends basemodel_1.default {
      * Creates a new `SimulateTransactionResult` object.
      * @param txnResult - Details about a pending transaction. If the transaction was recently confirmed,
      * includes confirmation details like the round and reward details.
-     * @param missingSignature - A boolean indicating whether this transaction is missing signatures
+     * @param appBudgetConsumed - Budget used during execution of an app call transaction. This value includes
+     * budged used by inner app calls spawned by this transaction.
+     * @param logicSigBudgetConsumed - Budget used during execution of a logic sig transaction.
      */
-    constructor({ txnResult, missingSignature, }) {
+    constructor({ txnResult, appBudgetConsumed, logicSigBudgetConsumed, }) {
         super();
         this.txnResult = txnResult;
-        this.missingSignature = missingSignature;
+        this.appBudgetConsumed = appBudgetConsumed;
+        this.logicSigBudgetConsumed = logicSigBudgetConsumed;
         this.attribute_map = {
             txnResult: 'txn-result',
-            missingSignature: 'missing-signature',
+            appBudgetConsumed: 'app-budget-consumed',
+            logicSigBudgetConsumed: 'logic-sig-budget-consumed',
         };
     }
     // eslint-disable-next-line camelcase
@@ -1818,12 +2015,49 @@ class SimulateTransactionResult extends basemodel_1.default {
             throw new Error(`Response is missing required field 'txn-result': ${data}`);
         return new SimulateTransactionResult({
             txnResult: PendingTransactionResponse.from_obj_for_encoding(data['txn-result']),
-            missingSignature: data['missing-signature'],
+            appBudgetConsumed: data['app-budget-consumed'],
+            logicSigBudgetConsumed: data['logic-sig-budget-consumed'],
         });
         /* eslint-enable dot-notation */
     }
 }
 exports.SimulateTransactionResult = SimulateTransactionResult;
+/**
+ * The set of parameters and limits override during simulation. If this set of
+ * parameters is present, then evaluation parameters may differ from standard
+ * evaluation in certain ways.
+ */
+class SimulationEvalOverrides extends basemodel_1.default {
+    /**
+     * Creates a new `SimulationEvalOverrides` object.
+     * @param allowEmptySignatures - If true, transactions without signatures are allowed and simulated as if they
+     * were properly signed.
+     * @param maxLogCalls - The maximum log calls one can make during simulation
+     * @param maxLogSize - The maximum byte number to log during simulation
+     */
+    constructor({ allowEmptySignatures, maxLogCalls, maxLogSize, }) {
+        super();
+        this.allowEmptySignatures = allowEmptySignatures;
+        this.maxLogCalls = maxLogCalls;
+        this.maxLogSize = maxLogSize;
+        this.attribute_map = {
+            allowEmptySignatures: 'allow-empty-signatures',
+            maxLogCalls: 'max-log-calls',
+            maxLogSize: 'max-log-size',
+        };
+    }
+    // eslint-disable-next-line camelcase
+    static from_obj_for_encoding(data) {
+        /* eslint-disable dot-notation */
+        return new SimulationEvalOverrides({
+            allowEmptySignatures: data['allow-empty-signatures'],
+            maxLogCalls: data['max-log-calls'],
+            maxLogSize: data['max-log-size'],
+        });
+        /* eslint-enable dot-notation */
+    }
+}
+exports.SimulationEvalOverrides = SimulationEvalOverrides;
 /**
  * Represents a state proof and its corresponding message
  */