algosdk 3.6.0 → 3.7.0

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

@@ -4,7 +4,7 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.StateProofVerifier = exports.StateProofTracking = exports.StateProofSignature = exports.StateProofSigSlot = exports.StateProofReveal = exports.StateProofParticipant = exports.StateProofFields = exports.ResourceRef = exports.ParticipationUpdates = exports.MiniAssetHolding = exports.MerkleArrayProof = exports.LocalsRef = exports.IndexerStateProofMessage = exports.HoldingRef = exports.HealthCheck = exports.HbProofFields = exports.HashFactory = exports.EvalDeltaKeyValue = exports.EvalDelta = exports.ErrorResponse = exports.BoxesResponse = exports.BoxReference = exports.BoxDescriptor = exports.Box = exports.BlockUpgradeVote = exports.BlockUpgradeState = exports.BlockRewards = exports.BlockHeadersResponse = exports.Block = exports.AssetsResponse = exports.AssetResponse = exports.AssetParams = exports.AssetHoldingsResponse = exports.AssetHolding = exports.AssetBalancesResponse = exports.Asset = exports.ApplicationsResponse = exports.ApplicationStateSchema = exports.ApplicationResponse = exports.ApplicationParams = exports.ApplicationLogsResponse = exports.ApplicationLogData = exports.ApplicationLocalStatesResponse = exports.ApplicationLocalState = exports.Application = exports.AccountsResponse = exports.AccountStateDelta = exports.AccountResponse = exports.AccountParticipation = exports.Account = void 0;
-exports.TransactionsResponse = exports.TransactionStateProof = exports.TransactionSignatureMultisigSubsignature = exports.TransactionSignatureMultisig = exports.TransactionSignatureLogicsig = exports.TransactionSignature = exports.TransactionResponse = exports.TransactionPayment = exports.TransactionKeyreg = exports.TransactionHeartbeat = exports.TransactionAssetTransfer = exports.TransactionAssetFreeze = exports.TransactionAssetConfig = exports.TransactionApplication = exports.Transaction = exports.TealValue = exports.TealKeyValue = exports.StateSchema = void 0;
+exports.TransactionsResponse = exports.TransactionStateProof = exports.TransactionSignaturePQsig = exports.TransactionSignatureMultisigSubsignature = exports.TransactionSignatureMultisig = exports.TransactionSignatureLogicsig = exports.TransactionSignature = exports.TransactionResponse = exports.TransactionPayment = exports.TransactionKeyreg = exports.TransactionHeartbeat = exports.TransactionAssetTransfer = exports.TransactionAssetFreeze = exports.TransactionAssetConfig = exports.TransactionApplication = exports.Transaction = exports.TealValue = exports.TealKeyValue = exports.StateSchema = void 0;
 /* eslint-disable no-use-before-define */
 const utils_js_1 = require("../../../../utils/utils.js");
 const index_js_1 = require("../../../../encoding/schema/index.js");
@@ -180,6 +180,7 @@ class Account {
      * * sig
      * * msig
      * * lsig
+     * * pqsig
      * * or null if unknown
      */
     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, }) {
@@ -1818,10 +1819,18 @@ class Block {
                 key: 'bonus',
                 valueSchema: new index_js_1.OptionalSchema(new index_js_1.Uint64Schema()),
                 omitEmpty: true,
+            }, {
+                key: 'congestion-tax',
+                valueSchema: new index_js_1.OptionalSchema(new index_js_1.Uint64Schema()),
+                omitEmpty: true,
             }, {
                 key: 'fees-collected',
                 valueSchema: new index_js_1.OptionalSchema(new index_js_1.Uint64Schema()),
                 omitEmpty: true,
+            }, {
+                key: 'load',
+                valueSchema: new index_js_1.OptionalSchema(new index_js_1.Uint64Schema()),
+                omitEmpty: true,
             }, {
                 key: 'participation-updates',
                 valueSchema: new index_js_1.OptionalSchema(ParticipationUpdates.encodingSchema),
@@ -1889,7 +1898,12 @@ class Block {
      * 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 congestionTax - the fee required, beyond the minimum fee, for "normal" transactions in this
+     * block.
      * @param feesCollected - the sum of all fees paid by transactions in this block.
+     * @param load - the degree to which this block is full, based on the number of bytes in the
+     * final block compared to the maximum allowed. Expressed as a fixed-point integer
+     * with 6 digits of precision, so 1,000,000 is a completely full block.
      * @param participationUpdates - Participation account data that needs to be checked/acted on by the network.
      * @param previousBlockHash512 - (prev512) Previous block hash, using SHA-512.
      * @param proposer - the proposer of this block.
@@ -1908,7 +1922,7 @@ class Block {
      * @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, bonus, feesCollected, participationUpdates, previousBlockHash512, proposer, proposerPayout, rewards, stateProofTracking, transactions, transactionsRootSha512, txnCounter, upgradeState, upgradeVote, }) {
+    constructor({ genesisHash, genesisId, previousBlockHash, round, seed, timestamp, transactionsRoot, transactionsRootSha256, bonus, congestionTax, feesCollected, load, participationUpdates, previousBlockHash512, proposer, proposerPayout, rewards, stateProofTracking, transactions, transactionsRootSha512, txnCounter, upgradeState, upgradeVote, }) {
         this.genesisHash =
             typeof genesisHash === 'string'
                 ? (0, binarydata_js_1.base64ToBytes)(genesisHash)
@@ -1931,10 +1945,16 @@ class Block {
                 : transactionsRootSha256;
         this.bonus =
             typeof bonus === 'undefined' ? undefined : (0, utils_js_1.ensureSafeInteger)(bonus);
+        this.congestionTax =
+            typeof congestionTax === 'undefined'
+                ? undefined
+                : (0, utils_js_1.ensureSafeInteger)(congestionTax);
         this.feesCollected =
             typeof feesCollected === 'undefined'
                 ? undefined
                 : (0, utils_js_1.ensureSafeInteger)(feesCollected);
+        this.load =
+            typeof load === 'undefined' ? undefined : (0, utils_js_1.ensureSafeInteger)(load);
         this.participationUpdates = participationUpdates;
         this.previousBlockHash512 =
             typeof previousBlockHash512 === 'string'
@@ -1975,7 +1995,9 @@ class Block {
             ['transactions-root', this.transactionsRoot],
             ['transactions-root-sha256', this.transactionsRootSha256],
             ['bonus', this.bonus],
+            ['congestion-tax', this.congestionTax],
             ['fees-collected', this.feesCollected],
+            ['load', this.load],
             [
                 'participation-updates',
                 typeof this.participationUpdates !== 'undefined'
@@ -2038,7 +2060,9 @@ class Block {
             transactionsRoot: data.get('transactions-root'),
             transactionsRootSha256: data.get('transactions-root-sha256'),
             bonus: data.get('bonus'),
+            congestionTax: data.get('congestion-tax'),
             feesCollected: data.get('fees-collected'),
+            load: data.get('load'),
             participationUpdates: typeof data.get('participation-updates') !== 'undefined'
                 ? ParticipationUpdates.fromEncodingData(data.get('participation-updates'))
                 : undefined,
@@ -2399,15 +2423,15 @@ class Box {
 }
 exports.Box = Box;
 /**
- * Box descriptor describes an app box without a value.
+ * Box descriptor describes an app box.
  */
 class BoxDescriptor {
     static get encodingSchema() {
         if (!this.encodingSchemaValue) {
             this.encodingSchemaValue = new index_js_1.NamedMapSchema([]);
-            this.encodingSchemaValue.pushEntries({
-                key: 'name',
-                valueSchema: new index_js_1.ByteArraySchema(),
+            this.encodingSchemaValue.pushEntries({ key: 'name', valueSchema: new index_js_1.ByteArraySchema(), omitEmpty: true }, {
+                key: 'value',
+                valueSchema: new index_js_1.OptionalSchema(new index_js_1.ByteArraySchema()),
                 omitEmpty: true,
             });
         }
@@ -2416,16 +2440,22 @@ class BoxDescriptor {
     /**
      * Creates a new `BoxDescriptor` object.
      * @param name - Base64 encoded box name
+     * @param value - Base64 encoded box value. Present only when the `values` query parameter is set
+     * to true.
      */
-    constructor({ name }) {
+    constructor({ name, value, }) {
         this.name = typeof name === 'string' ? (0, binarydata_js_1.base64ToBytes)(name) : name;
+        this.value = typeof value === 'string' ? (0, binarydata_js_1.base64ToBytes)(value) : value;
     }
     // eslint-disable-next-line class-methods-use-this
     getEncodingSchema() {
         return BoxDescriptor.encodingSchema;
     }
     toEncodingData() {
-        return new Map([['name', this.name]]);
+        return new Map([
+            ['name', this.name],
+            ['value', this.value],
+        ]);
     }
     static fromEncodingData(data) {
         if (!(data instanceof Map)) {
@@ -2433,6 +2463,7 @@ class BoxDescriptor {
         }
         return new BoxDescriptor({
             name: data.get('name'),
+            value: data.get('value'),
         });
     }
 }
@@ -2498,6 +2529,10 @@ class BoxesResponse {
                 key: 'next-token',
                 valueSchema: new index_js_1.OptionalSchema(new index_js_1.StringSchema()),
                 omitEmpty: true,
+            }, {
+                key: 'round',
+                valueSchema: new index_js_1.OptionalSchema(new index_js_1.Uint64Schema()),
+                omitEmpty: true,
             });
         }
         return this.encodingSchemaValue;
@@ -2508,11 +2543,14 @@ class BoxesResponse {
      * @param boxes -
      * @param nextToken - Used for pagination, when making another request provide this token with the
      * next parameter.
+     * @param round - The round for which this information is relevant.
      */
-    constructor({ applicationId, boxes, nextToken, }) {
+    constructor({ applicationId, boxes, nextToken, round, }) {
         this.applicationId = (0, utils_js_1.ensureBigInt)(applicationId);
         this.boxes = boxes;
         this.nextToken = nextToken;
+        this.round =
+            typeof round === 'undefined' ? undefined : (0, utils_js_1.ensureSafeInteger)(round);
     }
     // eslint-disable-next-line class-methods-use-this
     getEncodingSchema() {
@@ -2523,6 +2561,7 @@ class BoxesResponse {
             ['application-id', this.applicationId],
             ['boxes', this.boxes.map((v) => v.toEncodingData())],
             ['next-token', this.nextToken],
+            ['round', this.round],
         ]);
     }
     static fromEncodingData(data) {
@@ -2533,6 +2572,7 @@ class BoxesResponse {
             applicationId: data.get('application-id'),
             boxes: (data.get('boxes') ?? []).map((v) => BoxDescriptor.fromEncodingData(v)),
             nextToken: data.get('next-token'),
+            round: data.get('round'),
         });
     }
 }
@@ -4921,6 +4961,10 @@ class TransactionHeartbeat {
                 key: 'hb-vote-id',
                 valueSchema: new index_js_1.ByteArraySchema(),
                 omitEmpty: true,
+            }, {
+                key: 'hb-challenge-discount',
+                valueSchema: new index_js_1.OptionalSchema(new index_js_1.BooleanSchema()),
+                omitEmpty: true,
             });
         }
         return this.encodingSchemaValue;
@@ -4934,14 +4978,18 @@ class TransactionHeartbeat {
      * @param hbSeed - (hbsd) HbSeed must be the block seed for the this transaction's firstValid
      * block.
      * @param hbVoteId - (hbvid) HbVoteID must match the HbAddress account's current VoteID.
+     * @param hbChallengeDiscount - (hbc) HbChallengeDiscount requests the challenge fee discount, reducing the
+     * required fee by one min fee. It is a request, not an assertion: it is granted
+     * only if HbAddress is actually under challenge.
      */
-    constructor({ hbAddress, hbKeyDilution, hbProof, hbSeed, hbVoteId, }) {
+    constructor({ hbAddress, hbKeyDilution, hbProof, hbSeed, hbVoteId, hbChallengeDiscount, }) {
         this.hbAddress = hbAddress;
         this.hbKeyDilution = (0, utils_js_1.ensureBigInt)(hbKeyDilution);
         this.hbProof = hbProof;
         this.hbSeed = typeof hbSeed === 'string' ? (0, binarydata_js_1.base64ToBytes)(hbSeed) : hbSeed;
         this.hbVoteId =
             typeof hbVoteId === 'string' ? (0, binarydata_js_1.base64ToBytes)(hbVoteId) : hbVoteId;
+        this.hbChallengeDiscount = hbChallengeDiscount;
     }
     // eslint-disable-next-line class-methods-use-this
     getEncodingSchema() {
@@ -4954,6 +5002,7 @@ class TransactionHeartbeat {
             ['hb-proof', this.hbProof.toEncodingData()],
             ['hb-seed', this.hbSeed],
             ['hb-vote-id', this.hbVoteId],
+            ['hb-challenge-discount', this.hbChallengeDiscount],
         ]);
     }
     static fromEncodingData(data) {
@@ -4966,6 +5015,7 @@ class TransactionHeartbeat {
             hbProof: HbProofFields.fromEncodingData(data.get('hb-proof') ?? new Map()),
             hbSeed: data.get('hb-seed'),
             hbVoteId: data.get('hb-vote-id'),
+            hbChallengeDiscount: data.get('hb-challenge-discount'),
         });
     }
 }
@@ -5213,6 +5263,10 @@ class TransactionSignature {
                 key: 'multisig',
                 valueSchema: new index_js_1.OptionalSchema(TransactionSignatureMultisig.encodingSchema),
                 omitEmpty: true,
+            }, {
+                key: 'pqsig',
+                valueSchema: new index_js_1.OptionalSchema(TransactionSignaturePQsig.encodingSchema),
+                omitEmpty: true,
             }, {
                 key: 'sig',
                 valueSchema: new index_js_1.OptionalSchema(new index_js_1.ByteArraySchema()),
@@ -5229,11 +5283,15 @@ class TransactionSignature {
      * @param multisig - structure holding multiple subsignatures.
      * Definition:
      * crypto/multisig.go : MultisigSig
+     * @param pqsig - structure holding a post-quantum signature.
+     * Definition:
+     * data/transactions/pqsig.go : PQSig
      * @param sig - (sig) Standard ed25519 signature.
      */
-    constructor({ logicsig, multisig, sig, }) {
+    constructor({ logicsig, multisig, pqsig, sig, }) {
         this.logicsig = logicsig;
         this.multisig = multisig;
+        this.pqsig = pqsig;
         this.sig = typeof sig === 'string' ? (0, binarydata_js_1.base64ToBytes)(sig) : sig;
     }
     // eslint-disable-next-line class-methods-use-this
@@ -5254,6 +5312,12 @@ class TransactionSignature {
                     ? this.multisig.toEncodingData()
                     : undefined,
             ],
+            [
+                'pqsig',
+                typeof this.pqsig !== 'undefined'
+                    ? this.pqsig.toEncodingData()
+                    : undefined,
+            ],
             ['sig', this.sig],
         ]);
     }
@@ -5268,6 +5332,9 @@ class TransactionSignature {
             multisig: typeof data.get('multisig') !== 'undefined'
                 ? TransactionSignatureMultisig.fromEncodingData(data.get('multisig'))
                 : undefined,
+            pqsig: typeof data.get('pqsig') !== 'undefined'
+                ? TransactionSignaturePQsig.fromEncodingData(data.get('pqsig'))
+                : undefined,
             sig: data.get('sig'),
         });
     }
@@ -5294,6 +5361,10 @@ class TransactionSignatureLogicsig {
                 key: 'multisig-signature',
                 valueSchema: new index_js_1.OptionalSchema(TransactionSignatureMultisig.encodingSchema),
                 omitEmpty: true,
+            }, {
+                key: 'pqsig',
+                valueSchema: new index_js_1.OptionalSchema(TransactionSignaturePQsig.encodingSchema),
+                omitEmpty: true,
             }, {
                 key: 'signature',
                 valueSchema: new index_js_1.OptionalSchema(new index_js_1.ByteArraySchema()),
@@ -5313,13 +5384,17 @@ class TransactionSignatureLogicsig {
      * @param multisigSignature - structure holding multiple subsignatures.
      * Definition:
      * crypto/multisig.go : MultisigSig
+     * @param pqsig - structure holding a post-quantum signature.
+     * Definition:
+     * data/transactions/pqsig.go : PQSig
      * @param signature - (sig) ed25519 signature.
      */
-    constructor({ logic, args, logicMultisigSignature, multisigSignature, signature, }) {
+    constructor({ logic, args, logicMultisigSignature, multisigSignature, pqsig, signature, }) {
         this.logic = typeof logic === 'string' ? (0, binarydata_js_1.base64ToBytes)(logic) : logic;
         this.args = args;
         this.logicMultisigSignature = logicMultisigSignature;
         this.multisigSignature = multisigSignature;
+        this.pqsig = pqsig;
         this.signature =
             typeof signature === 'string' ? (0, binarydata_js_1.base64ToBytes)(signature) : signature;
     }
@@ -5343,6 +5418,12 @@ class TransactionSignatureLogicsig {
                     ? this.multisigSignature.toEncodingData()
                     : undefined,
             ],
+            [
+                'pqsig',
+                typeof this.pqsig !== 'undefined'
+                    ? this.pqsig.toEncodingData()
+                    : undefined,
+            ],
             ['signature', this.signature],
         ]);
     }
@@ -5359,6 +5440,9 @@ class TransactionSignatureLogicsig {
             multisigSignature: typeof data.get('multisig-signature') !== 'undefined'
                 ? TransactionSignatureMultisig.fromEncodingData(data.get('multisig-signature'))
                 : undefined,
+            pqsig: typeof data.get('pqsig') !== 'undefined'
+                ? TransactionSignaturePQsig.fromEncodingData(data.get('pqsig'))
+                : undefined,
             signature: data.get('signature'),
         });
     }
@@ -5484,6 +5568,73 @@ class TransactionSignatureMultisigSubsignature {
     }
 }
 exports.TransactionSignatureMultisigSubsignature = TransactionSignatureMultisigSubsignature;
+/**
+ * structure holding a post-quantum signature.
+ * Definition:
+ * data/transactions/pqsig.go : PQSig
+ */
+class TransactionSignaturePQsig {
+    static get encodingSchema() {
+        if (!this.encodingSchemaValue) {
+            this.encodingSchemaValue = new index_js_1.NamedMapSchema([]);
+            this.encodingSchemaValue.pushEntries({
+                key: 'public-key',
+                valueSchema: new index_js_1.ByteArraySchema(),
+                omitEmpty: true,
+            }, { key: 'scheme', valueSchema: new index_js_1.StringSchema(), omitEmpty: true }, {
+                key: 'signature',
+                valueSchema: new index_js_1.ByteArraySchema(),
+                omitEmpty: true,
+            }, {
+                key: 'salt',
+                valueSchema: new index_js_1.OptionalSchema(new index_js_1.Uint64Schema()),
+                omitEmpty: true,
+            });
+        }
+        return this.encodingSchemaValue;
+    }
+    /**
+     * Creates a new `TransactionSignaturePQsig` object.
+     * @param publicKey - (pk)
+     * @param scheme - (sch) identifies the internal signature scheme.
+     * @param signature - (sig)
+     * @param salt - (slt) a single byte, added to ensure the hashed address is not an Ed25519 curve
+     * point
+     */
+    constructor({ publicKey, scheme, signature, salt, }) {
+        this.publicKey =
+            typeof publicKey === 'string' ? (0, binarydata_js_1.base64ToBytes)(publicKey) : publicKey;
+        this.scheme = scheme;
+        this.signature =
+            typeof signature === 'string' ? (0, binarydata_js_1.base64ToBytes)(signature) : signature;
+        this.salt =
+            typeof salt === 'undefined' ? undefined : (0, utils_js_1.ensureSafeInteger)(salt);
+    }
+    // eslint-disable-next-line class-methods-use-this
+    getEncodingSchema() {
+        return TransactionSignaturePQsig.encodingSchema;
+    }
+    toEncodingData() {
+        return new Map([
+            ['public-key', this.publicKey],
+            ['scheme', this.scheme],
+            ['signature', this.signature],
+            ['salt', this.salt],
+        ]);
+    }
+    static fromEncodingData(data) {
+        if (!(data instanceof Map)) {
+            throw new Error(`Invalid decoded TransactionSignaturePQsig: ${data}`);
+        }
+        return new TransactionSignaturePQsig({
+            publicKey: data.get('public-key'),
+            scheme: data.get('scheme'),
+            signature: data.get('signature'),
+            salt: data.get('salt'),
+        });
+    }
+}
+exports.TransactionSignaturePQsig = TransactionSignaturePQsig;
 /**
  * Fields for a state proof transaction.
  * Definition: