algosdk 3.0.0-beta.2 → 3.1.0

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

@@ -3,8 +3,8 @@
  * NOTICE: This file was generated. Editing this file manually is not recommended.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TransactionAssetConfig = exports.TransactionApplication = exports.Transaction = exports.TealValue = exports.TealKeyValue = exports.StateSchema = exports.StateProofVerifier = exports.StateProofTracking = exports.StateProofSignature = exports.StateProofSigSlot = exports.StateProofReveal = exports.StateProofParticipant = exports.StateProofFields = exports.ParticipationUpdates = exports.MiniAssetHolding = exports.MerkleArrayProof = exports.IndexerStateProofMessage = exports.HealthCheck = exports.HashFactory = exports.EvalDeltaKeyValue = exports.EvalDelta = exports.ErrorResponse = exports.BoxesResponse = exports.BoxDescriptor = exports.Box = exports.BlockUpgradeVote = exports.BlockUpgradeState = exports.BlockRewards = 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.TransactionAssetTransfer = exports.TransactionAssetFreeze = void 0;
+exports.Transaction = exports.TealValue = exports.TealKeyValue = exports.StateSchema = exports.StateProofVerifier = exports.StateProofTracking = exports.StateProofSignature = exports.StateProofSigSlot = exports.StateProofReveal = exports.StateProofParticipant = exports.StateProofFields = exports.ParticipationUpdates = exports.MiniAssetHolding = exports.MerkleArrayProof = exports.IndexerStateProofMessage = exports.HealthCheck = exports.HbProofFields = exports.HashFactory = exports.EvalDeltaKeyValue = exports.EvalDelta = exports.ErrorResponse = exports.BoxesResponse = 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 = 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");
@@ -2037,6 +2037,64 @@ class Block {
     }
 }
 exports.Block = Block;
+/**
+ *
+ */
+class BlockHeadersResponse {
+    static get encodingSchema() {
+        if (!this.encodingSchemaValue) {
+            this.encodingSchemaValue = new index_js_1.NamedMapSchema([]);
+            this.encodingSchemaValue.pushEntries({
+                key: 'blocks',
+                valueSchema: new index_js_1.ArraySchema(Block.encodingSchema),
+                omitEmpty: true,
+            }, {
+                key: 'current-round',
+                valueSchema: new index_js_1.Uint64Schema(),
+                omitEmpty: true,
+            }, {
+                key: 'next-token',
+                valueSchema: new index_js_1.OptionalSchema(new index_js_1.StringSchema()),
+                omitEmpty: true,
+            });
+        }
+        return this.encodingSchemaValue;
+    }
+    /**
+     * Creates a new `BlockHeadersResponse` object.
+     * @param blocks -
+     * @param currentRound - Round at which the results were computed.
+     * @param nextToken - Used for pagination, when making another request provide this token with the
+     * next parameter.
+     */
+    constructor({ blocks, currentRound, nextToken, }) {
+        this.blocks = blocks;
+        this.currentRound = (0, utils_js_1.ensureBigInt)(currentRound);
+        this.nextToken = nextToken;
+    }
+    // eslint-disable-next-line class-methods-use-this
+    getEncodingSchema() {
+        return BlockHeadersResponse.encodingSchema;
+    }
+    toEncodingData() {
+        return new Map([
+            ['blocks', this.blocks.map((v) => v.toEncodingData())],
+            ['current-round', this.currentRound],
+            ['next-token', this.nextToken],
+        ]);
+    }
+    static fromEncodingData(data) {
+        if (!(data instanceof Map)) {
+            throw new Error(`Invalid decoded BlockHeadersResponse: ${data}`);
+        }
+        return new BlockHeadersResponse({
+            blocks: (data.get('blocks') ?? []).map((v) => Block.fromEncodingData(v)),
+            currentRound: data.get('current-round'),
+            nextToken: data.get('next-token'),
+        });
+    }
+}
+exports.BlockHeadersResponse = BlockHeadersResponse;
 /**
  * Fields relating to rewards,
  */
@@ -2587,6 +2645,84 @@ class HashFactory {
     }
 }
 exports.HashFactory = HashFactory;
+/**
+ * (hbprf) HbProof is a signature using HeartbeatAddress's partkey, thereby showing
+ * it is online.
+ */
+class HbProofFields {
+    static get encodingSchema() {
+        if (!this.encodingSchemaValue) {
+            this.encodingSchemaValue = new index_js_1.NamedMapSchema([]);
+            this.encodingSchemaValue.pushEntries({
+                key: 'hb-pk',
+                valueSchema: new index_js_1.OptionalSchema(new index_js_1.ByteArraySchema()),
+                omitEmpty: true,
+            }, {
+                key: 'hb-pk1sig',
+                valueSchema: new index_js_1.OptionalSchema(new index_js_1.ByteArraySchema()),
+                omitEmpty: true,
+            }, {
+                key: 'hb-pk2',
+                valueSchema: new index_js_1.OptionalSchema(new index_js_1.ByteArraySchema()),
+                omitEmpty: true,
+            }, {
+                key: 'hb-pk2sig',
+                valueSchema: new index_js_1.OptionalSchema(new index_js_1.ByteArraySchema()),
+                omitEmpty: true,
+            }, {
+                key: 'hb-sig',
+                valueSchema: new index_js_1.OptionalSchema(new index_js_1.ByteArraySchema()),
+                omitEmpty: true,
+            });
+        }
+        return this.encodingSchemaValue;
+    }
+    /**
+     * Creates a new `HbProofFields` object.
+     * @param hbPk - (p) Public key of the heartbeat message.
+     * @param hbPk1sig - (p1s) Signature of OneTimeSignatureSubkeyOffsetID(PK, Batch, Offset) under the
+     * key PK2.
+     * @param hbPk2 - (p2) Key for new-style two-level ephemeral signature.
+     * @param hbPk2sig - (p2s) Signature of OneTimeSignatureSubkeyBatchID(PK2, Batch) under the master
+     * key (OneTimeSignatureVerifier).
+     * @param hbSig - (s) Signature of the heartbeat message.
+     */
+    constructor({ hbPk, hbPk1sig, hbPk2, hbPk2sig, hbSig, }) {
+        this.hbPk = typeof hbPk === 'string' ? (0, binarydata_js_1.base64ToBytes)(hbPk) : hbPk;
+        this.hbPk1sig =
+            typeof hbPk1sig === 'string' ? (0, binarydata_js_1.base64ToBytes)(hbPk1sig) : hbPk1sig;
+        this.hbPk2 = typeof hbPk2 === 'string' ? (0, binarydata_js_1.base64ToBytes)(hbPk2) : hbPk2;
+        this.hbPk2sig =
+            typeof hbPk2sig === 'string' ? (0, binarydata_js_1.base64ToBytes)(hbPk2sig) : hbPk2sig;
+        this.hbSig = typeof hbSig === 'string' ? (0, binarydata_js_1.base64ToBytes)(hbSig) : hbSig;
+    }
+    // eslint-disable-next-line class-methods-use-this
+    getEncodingSchema() {
+        return HbProofFields.encodingSchema;
+    }
+    toEncodingData() {
+        return new Map([
+            ['hb-pk', this.hbPk],
+            ['hb-pk1sig', this.hbPk1sig],
+            ['hb-pk2', this.hbPk2],
+            ['hb-pk2sig', this.hbPk2sig],
+            ['hb-sig', this.hbSig],
+        ]);
+    }
+    static fromEncodingData(data) {
+        if (!(data instanceof Map)) {
+            throw new Error(`Invalid decoded HbProofFields: ${data}`);
+        }
+        return new HbProofFields({
+            hbPk: data.get('hb-pk'),
+            hbPk1sig: data.get('hb-pk1sig'),
+            hbPk2: data.get('hb-pk2'),
+            hbPk2sig: data.get('hb-pk2sig'),
+            hbSig: data.get('hb-sig'),
+        });
+    }
+}
+exports.HbProofFields = HbProofFields;
 /**
  * A health check response.
  */
@@ -3655,6 +3791,10 @@ class Transaction {
                 key: 'group',
                 valueSchema: new index_js_1.OptionalSchema(new index_js_1.ByteArraySchema()),
                 omitEmpty: true,
+            }, {
+                key: 'heartbeat-transaction',
+                valueSchema: new index_js_1.OptionalSchema(TransactionHeartbeat.encodingSchema),
+                omitEmpty: true,
             }, {
                 key: 'id',
                 valueSchema: new index_js_1.OptionalSchema(new index_js_1.StringSchema()),
@@ -3759,6 +3899,9 @@ class Transaction {
      * @param group - (grp) Base64 encoded byte array of a sha512/256 digest. When present indicates
      * that this transaction is part of a transaction group and the value is the
      * sha512/256 hash of the transactions in that group.
+     * @param heartbeatTransaction - Fields for a heartbeat transaction.
+     * Definition:
+     * data/transactions/heartbeat.go : HeartbeatTxnFields
      * @param id - Transaction ID
      * @param innerTxns - Inner transactions produced by application execution.
      * @param intraRoundOffset - Offset into the round where this transaction was confirmed.
@@ -3798,8 +3941,9 @@ class Transaction {
      * * (afrz) asset-freeze-transaction
      * * (appl) application-transaction
      * * (stpf) state-proof-transaction
+     * * (hb) heartbeat-transaction
      */
-    constructor({ fee, firstValid, lastValid, sender, applicationTransaction, assetConfigTransaction, assetFreezeTransaction, assetTransferTransaction, authAddr, closeRewards, closingAmount, confirmedRound, createdApplicationIndex, createdAssetIndex, genesisHash, genesisId, globalStateDelta, group, id, innerTxns, intraRoundOffset, keyregTransaction, lease, localStateDelta, logs, note, paymentTransaction, receiverRewards, rekeyTo, roundTime, senderRewards, signature, stateProofTransaction, txType, }) {
+    constructor({ fee, firstValid, lastValid, sender, applicationTransaction, assetConfigTransaction, assetFreezeTransaction, assetTransferTransaction, authAddr, closeRewards, closingAmount, confirmedRound, createdApplicationIndex, createdAssetIndex, genesisHash, genesisId, globalStateDelta, group, heartbeatTransaction, id, innerTxns, intraRoundOffset, keyregTransaction, lease, localStateDelta, logs, note, paymentTransaction, receiverRewards, rekeyTo, roundTime, senderRewards, signature, stateProofTransaction, txType, }) {
         this.fee = (0, utils_js_1.ensureBigInt)(fee);
         this.firstValid = (0, utils_js_1.ensureBigInt)(firstValid);
         this.lastValid = (0, utils_js_1.ensureBigInt)(lastValid);
@@ -3837,6 +3981,7 @@ class Transaction {
         this.genesisId = genesisId;
         this.globalStateDelta = globalStateDelta;
         this.group = typeof group === 'string' ? (0, binarydata_js_1.base64ToBytes)(group) : group;
+        this.heartbeatTransaction = heartbeatTransaction;
         this.id = id;
         this.innerTxns = innerTxns;
         this.intraRoundOffset =
@@ -3921,6 +4066,12 @@ class Transaction {
                     : undefined,
             ],
             ['group', this.group],
+            [
+                'heartbeat-transaction',
+                typeof this.heartbeatTransaction !== 'undefined'
+                    ? this.heartbeatTransaction.toEncodingData()
+                    : undefined,
+            ],
             ['id', this.id],
             [
                 'inner-txns',
@@ -4009,6 +4160,9 @@ class Transaction {
                     .map((v) => EvalDeltaKeyValue.fromEncodingData(v))
                 : undefined,
             group: data.get('group'),
+            heartbeatTransaction: typeof data.get('heartbeat-transaction') !== 'undefined'
+                ? TransactionHeartbeat.fromEncodingData(data.get('heartbeat-transaction'))
+                : undefined,
             id: data.get('id'),
             innerTxns: typeof data.get('inner-txns') !== 'undefined'
                 ? data
@@ -4424,6 +4578,76 @@ class TransactionAssetTransfer {
     }
 }
 exports.TransactionAssetTransfer = TransactionAssetTransfer;
+/**
+ * Fields for a heartbeat transaction.
+ * Definition:
+ * data/transactions/heartbeat.go : HeartbeatTxnFields
+ */
+class TransactionHeartbeat {
+    static get encodingSchema() {
+        if (!this.encodingSchemaValue) {
+            this.encodingSchemaValue = new index_js_1.NamedMapSchema([]);
+            this.encodingSchemaValue.pushEntries({ key: 'hb-address', valueSchema: new index_js_1.StringSchema(), omitEmpty: true }, {
+                key: 'hb-key-dilution',
+                valueSchema: new index_js_1.Uint64Schema(),
+                omitEmpty: true,
+            }, {
+                key: 'hb-proof',
+                valueSchema: HbProofFields.encodingSchema,
+                omitEmpty: true,
+            }, { key: 'hb-seed', valueSchema: new index_js_1.ByteArraySchema(), omitEmpty: true }, {
+                key: 'hb-vote-id',
+                valueSchema: new index_js_1.ByteArraySchema(),
+                omitEmpty: true,
+            });
+        }
+        return this.encodingSchemaValue;
+    }
+    /**
+     * Creates a new `TransactionHeartbeat` object.
+     * @param hbAddress - (hbad) HbAddress is the account this txn is proving onlineness for.
+     * @param hbKeyDilution - (hbkd) HbKeyDilution must match HbAddress account's current KeyDilution.
+     * @param hbProof - (hbprf) HbProof is a signature using HeartbeatAddress's partkey, thereby showing
+     * it is online.
+     * @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.
+     */
+    constructor({ hbAddress, hbKeyDilution, hbProof, hbSeed, hbVoteId, }) {
+        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;
+    }
+    // eslint-disable-next-line class-methods-use-this
+    getEncodingSchema() {
+        return TransactionHeartbeat.encodingSchema;
+    }
+    toEncodingData() {
+        return new Map([
+            ['hb-address', this.hbAddress],
+            ['hb-key-dilution', this.hbKeyDilution],
+            ['hb-proof', this.hbProof.toEncodingData()],
+            ['hb-seed', this.hbSeed],
+            ['hb-vote-id', this.hbVoteId],
+        ]);
+    }
+    static fromEncodingData(data) {
+        if (!(data instanceof Map)) {
+            throw new Error(`Invalid decoded TransactionHeartbeat: ${data}`);
+        }
+        return new TransactionHeartbeat({
+            hbAddress: data.get('hb-address'),
+            hbKeyDilution: data.get('hb-key-dilution'),
+            hbProof: HbProofFields.fromEncodingData(data.get('hb-proof') ?? new Map()),
+            hbSeed: data.get('hb-seed'),
+            hbVoteId: data.get('hb-vote-id'),
+        });
+    }
+}
+exports.TransactionHeartbeat = TransactionHeartbeat;
 /**
  * Fields for a keyreg transaction.
  * Definition: