algosdk 3.3.1 → 3.5.0

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

@@ -1801,6 +1801,10 @@ export class Block {
                 key: 'participation-updates',
                 valueSchema: new OptionalSchema(ParticipationUpdates.encodingSchema),
                 omitEmpty: true,
+            }, {
+                key: 'previous-block-hash-512',
+                valueSchema: new OptionalSchema(new ByteArraySchema()),
+                omitEmpty: true,
             }, {
                 key: 'proposer',
                 valueSchema: new OptionalSchema(new StringSchema()),
@@ -1821,6 +1825,10 @@ export class Block {
                 key: 'transactions',
                 valueSchema: new OptionalSchema(new ArraySchema(Transaction.encodingSchema)),
                 omitEmpty: true,
+            }, {
+                key: 'transactions-root-sha512',
+                valueSchema: new OptionalSchema(new ByteArraySchema()),
+                omitEmpty: true,
             }, {
                 key: 'txn-counter',
                 valueSchema: new OptionalSchema(new Uint64Schema()),
@@ -1858,11 +1866,15 @@ export class Block {
      * @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 previousBlockHash512 - (prev512) Previous block hash, using SHA-512.
      * @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.
+     * @param transactionsRootSha512 - (txn512) TransactionsRootSHA512 is an auxiliary TransactionRoot, built using a
+     * vector commitment instead of a merkle tree, and SHA512 hash function instead of
+     * the default SHA512_256.
      * @param txnCounter - (tc) TxnCounter counts the number of transactions committed in the ledger, from
      * the time at which support for this feature was introduced.
      * Specifically, TxnCounter is the number of the next transaction that will be
@@ -1871,7 +1883,7 @@ export 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, proposer, proposerPayout, rewards, stateProofTracking, transactions, txnCounter, upgradeState, upgradeVote, }) {
+    constructor({ genesisHash, genesisId, previousBlockHash, round, seed, timestamp, transactionsRoot, transactionsRootSha256, bonus, feesCollected, participationUpdates, previousBlockHash512, proposer, proposerPayout, rewards, stateProofTracking, transactions, transactionsRootSha512, txnCounter, upgradeState, upgradeVote, }) {
         this.genesisHash =
             typeof genesisHash === 'string'
                 ? base64ToBytes(genesisHash)
@@ -1899,6 +1911,10 @@ export class Block {
                 ? undefined
                 : ensureSafeInteger(feesCollected);
         this.participationUpdates = participationUpdates;
+        this.previousBlockHash512 =
+            typeof previousBlockHash512 === 'string'
+                ? base64ToBytes(previousBlockHash512)
+                : previousBlockHash512;
         this.proposer =
             typeof proposer === 'string' ? Address.fromString(proposer) : proposer;
         this.proposerPayout =
@@ -1908,6 +1924,10 @@ export class Block {
         this.rewards = rewards;
         this.stateProofTracking = stateProofTracking;
         this.transactions = transactions;
+        this.transactionsRootSha512 =
+            typeof transactionsRootSha512 === 'string'
+                ? base64ToBytes(transactionsRootSha512)
+                : transactionsRootSha512;
         this.txnCounter =
             typeof txnCounter === 'undefined'
                 ? undefined
@@ -1937,6 +1957,7 @@ export class Block {
                     ? this.participationUpdates.toEncodingData()
                     : undefined,
             ],
+            ['previous-block-hash-512', this.previousBlockHash512],
             [
                 'proposer',
                 typeof this.proposer !== 'undefined'
@@ -1962,6 +1983,7 @@ export class Block {
                     ? this.transactions.map((v) => v.toEncodingData())
                     : undefined,
             ],
+            ['transactions-root-sha512', this.transactionsRootSha512],
             ['txn-counter', this.txnCounter],
             [
                 'upgrade-state',
@@ -1995,6 +2017,7 @@ export class Block {
             participationUpdates: typeof data.get('participation-updates') !== 'undefined'
                 ? ParticipationUpdates.fromEncodingData(data.get('participation-updates'))
                 : undefined,
+            previousBlockHash512: data.get('previous-block-hash-512'),
             proposer: data.get('proposer'),
             proposerPayout: data.get('proposer-payout'),
             rewards: typeof data.get('rewards') !== 'undefined'
@@ -2010,6 +2033,7 @@ export class Block {
                     .get('transactions')
                     .map((v) => Transaction.fromEncodingData(v))
                 : undefined,
+            transactionsRootSha512: data.get('transactions-root-sha512'),
             txnCounter: data.get('txn-counter'),
             upgradeState: typeof data.get('upgrade-state') !== 'undefined'
                 ? BlockUpgradeState.fromEncodingData(data.get('upgrade-state'))
@@ -2381,6 +2405,47 @@ export class BoxDescriptor {
         });
     }
 }
+/**
+ * BoxReference names a box by its name and the application ID it belongs to.
+ */
+export class BoxReference {
+    static get encodingSchema() {
+        if (!this.encodingSchemaValue) {
+            this.encodingSchemaValue = new NamedMapSchema([]);
+            this.encodingSchemaValue.pushEntries({ key: 'app', valueSchema: new Uint64Schema(), omitEmpty: true }, { key: 'name', valueSchema: new ByteArraySchema(), omitEmpty: true });
+        }
+        return this.encodingSchemaValue;
+    }
+    /**
+     * Creates a new `BoxReference` object.
+     * @param app - Application ID to which the box belongs, or zero if referring to the called
+     * application.
+     * @param name - Base64 encoded box name
+     */
+    constructor({ app, name, }) {
+        this.app = ensureSafeInteger(app);
+        this.name = typeof name === 'string' ? base64ToBytes(name) : name;
+    }
+    // eslint-disable-next-line class-methods-use-this
+    getEncodingSchema() {
+        return BoxReference.encodingSchema;
+    }
+    toEncodingData() {
+        return new Map([
+            ['app', this.app],
+            ['name', this.name],
+        ]);
+    }
+    static fromEncodingData(data) {
+        if (!(data instanceof Map)) {
+            throw new Error(`Invalid decoded BoxReference: ${data}`);
+        }
+        return new BoxReference({
+            app: data.get('app'),
+            name: data.get('name'),
+        });
+    }
+}
 /**
  * Box names of an application
  */
@@ -2777,6 +2842,47 @@ export class HealthCheck {
         });
     }
 }
+/**
+ * HoldingRef names a holding by referring to an Address and Asset it belongs to.
+ */
+export class HoldingRef {
+    static get encodingSchema() {
+        if (!this.encodingSchemaValue) {
+            this.encodingSchemaValue = new NamedMapSchema([]);
+            this.encodingSchemaValue.pushEntries({ key: 'address', valueSchema: new StringSchema(), omitEmpty: true }, { key: 'asset', valueSchema: new Uint64Schema(), omitEmpty: true });
+        }
+        return this.encodingSchemaValue;
+    }
+    /**
+     * Creates a new `HoldingRef` object.
+     * @param address - (d) Address in access list, or the sender of the transaction.
+     * @param asset - (s) Asset ID for asset in access list.
+     */
+    constructor({ address, asset, }) {
+        this.address =
+            typeof address === 'string' ? Address.fromString(address) : address;
+        this.asset = ensureSafeInteger(asset);
+    }
+    // eslint-disable-next-line class-methods-use-this
+    getEncodingSchema() {
+        return HoldingRef.encodingSchema;
+    }
+    toEncodingData() {
+        return new Map([
+            ['address', this.address.toString()],
+            ['asset', this.asset],
+        ]);
+    }
+    static fromEncodingData(data) {
+        if (!(data instanceof Map)) {
+            throw new Error(`Invalid decoded HoldingRef: ${data}`);
+        }
+        return new HoldingRef({
+            address: data.get('address'),
+            asset: data.get('asset'),
+        });
+    }
+}
 export class IndexerStateProofMessage {
     static get encodingSchema() {
         if (!this.encodingSchemaValue) {
@@ -2861,6 +2967,48 @@ export class IndexerStateProofMessage {
         });
     }
 }
+/**
+ * LocalsRef names a local state by referring to an Address and App it belongs to.
+ */
+export class LocalsRef {
+    static get encodingSchema() {
+        if (!this.encodingSchemaValue) {
+            this.encodingSchemaValue = new NamedMapSchema([]);
+            this.encodingSchemaValue.pushEntries({ key: 'address', valueSchema: new StringSchema(), omitEmpty: true }, { key: 'app', valueSchema: new Uint64Schema(), omitEmpty: true });
+        }
+        return this.encodingSchemaValue;
+    }
+    /**
+     * Creates a new `LocalsRef` object.
+     * @param address - (d) Address in access list, or the sender of the transaction.
+     * @param app - (p) Application ID for app in access list, or zero if referring to the called
+     * application.
+     */
+    constructor({ address, app, }) {
+        this.address =
+            typeof address === 'string' ? Address.fromString(address) : address;
+        this.app = ensureSafeInteger(app);
+    }
+    // eslint-disable-next-line class-methods-use-this
+    getEncodingSchema() {
+        return LocalsRef.encodingSchema;
+    }
+    toEncodingData() {
+        return new Map([
+            ['address', this.address.toString()],
+            ['app', this.app],
+        ]);
+    }
+    static fromEncodingData(data) {
+        if (!(data instanceof Map)) {
+            throw new Error(`Invalid decoded LocalsRef: ${data}`);
+        }
+        return new LocalsRef({
+            address: data.get('address'),
+            app: data.get('app'),
+        });
+    }
+}
 export class MerkleArrayProof {
     static get encodingSchema() {
         if (!this.encodingSchemaValue) {
@@ -3047,6 +3195,118 @@ export class ParticipationUpdates {
         });
     }
 }
+/**
+ * ResourceRef names a single resource. Only one of the fields should be set.
+ */
+export class ResourceRef {
+    static get encodingSchema() {
+        if (!this.encodingSchemaValue) {
+            this.encodingSchemaValue = new NamedMapSchema([]);
+            this.encodingSchemaValue.pushEntries({
+                key: 'address',
+                valueSchema: new OptionalSchema(new StringSchema()),
+                omitEmpty: true,
+            }, {
+                key: 'application-id',
+                valueSchema: new OptionalSchema(new Uint64Schema()),
+                omitEmpty: true,
+            }, {
+                key: 'asset-id',
+                valueSchema: new OptionalSchema(new Uint64Schema()),
+                omitEmpty: true,
+            }, {
+                key: 'box',
+                valueSchema: new OptionalSchema(BoxReference.encodingSchema),
+                omitEmpty: true,
+            }, {
+                key: 'holding',
+                valueSchema: new OptionalSchema(HoldingRef.encodingSchema),
+                omitEmpty: true,
+            }, {
+                key: 'local',
+                valueSchema: new OptionalSchema(LocalsRef.encodingSchema),
+                omitEmpty: true,
+            });
+        }
+        return this.encodingSchemaValue;
+    }
+    /**
+     * Creates a new `ResourceRef` object.
+     * @param address - (d) Account whose balance record is accessible by the executing ApprovalProgram
+     * or ClearStateProgram.
+     * @param applicationId - (p) Application id whose GlobalState may be read by the executing
+     * ApprovalProgram or ClearStateProgram.
+     * @param assetId - (s) Asset whose AssetParams may be read by the executing
+     * ApprovalProgram or ClearStateProgram.
+     * @param box - BoxReference names a box by its name and the application ID it belongs to.
+     * @param holding - HoldingRef names a holding by referring to an Address and Asset it belongs to.
+     * @param local - LocalsRef names a local state by referring to an Address and App it belongs to.
+     */
+    constructor({ address, applicationId, assetId, box, holding, local, }) {
+        this.address =
+            typeof address === 'string' ? Address.fromString(address) : address;
+        this.applicationId =
+            typeof applicationId === 'undefined'
+                ? undefined
+                : ensureSafeInteger(applicationId);
+        this.assetId =
+            typeof assetId === 'undefined' ? undefined : ensureSafeInteger(assetId);
+        this.box = box;
+        this.holding = holding;
+        this.local = local;
+    }
+    // eslint-disable-next-line class-methods-use-this
+    getEncodingSchema() {
+        return ResourceRef.encodingSchema;
+    }
+    toEncodingData() {
+        return new Map([
+            [
+                'address',
+                typeof this.address !== 'undefined'
+                    ? this.address.toString()
+                    : undefined,
+            ],
+            ['application-id', this.applicationId],
+            ['asset-id', this.assetId],
+            [
+                'box',
+                typeof this.box !== 'undefined' ? this.box.toEncodingData() : undefined,
+            ],
+            [
+                'holding',
+                typeof this.holding !== 'undefined'
+                    ? this.holding.toEncodingData()
+                    : undefined,
+            ],
+            [
+                'local',
+                typeof this.local !== 'undefined'
+                    ? this.local.toEncodingData()
+                    : undefined,
+            ],
+        ]);
+    }
+    static fromEncodingData(data) {
+        if (!(data instanceof Map)) {
+            throw new Error(`Invalid decoded ResourceRef: ${data}`);
+        }
+        return new ResourceRef({
+            address: data.get('address'),
+            applicationId: data.get('application-id'),
+            assetId: data.get('asset-id'),
+            box: typeof data.get('box') !== 'undefined'
+                ? BoxReference.fromEncodingData(data.get('box'))
+                : undefined,
+            holding: typeof data.get('holding') !== 'undefined'
+                ? HoldingRef.fromEncodingData(data.get('holding'))
+                : undefined,
+            local: typeof data.get('local') !== 'undefined'
+                ? LocalsRef.fromEncodingData(data.get('local'))
+                : undefined,
+        });
+    }
+}
 /**
  * (sp) represents a state proof.
  * Definition:
@@ -4167,6 +4427,10 @@ export class TransactionApplication {
                 key: 'application-id',
                 valueSchema: new Uint64Schema(),
                 omitEmpty: true,
+            }, {
+                key: 'access',
+                valueSchema: new OptionalSchema(new ArraySchema(ResourceRef.encodingSchema)),
+                omitEmpty: true,
             }, {
                 key: 'accounts',
                 valueSchema: new OptionalSchema(new ArraySchema(new StringSchema())),
@@ -4179,6 +4443,10 @@ export class TransactionApplication {
                 key: 'approval-program',
                 valueSchema: new OptionalSchema(new ByteArraySchema()),
                 omitEmpty: true,
+            }, {
+                key: 'box-references',
+                valueSchema: new OptionalSchema(new ArraySchema(BoxReference.encodingSchema)),
+                omitEmpty: true,
             }, {
                 key: 'clear-state-program',
                 valueSchema: new OptionalSchema(new ByteArraySchema()),
@@ -4207,6 +4475,10 @@ export class TransactionApplication {
                 key: 'on-completion',
                 valueSchema: new OptionalSchema(new StringSchema()),
                 omitEmpty: true,
+            }, {
+                key: 'reject-version',
+                valueSchema: new OptionalSchema(new Uint64Schema()),
+                omitEmpty: true,
             });
         }
         return this.encodingSchemaValue;
@@ -4214,6 +4486,9 @@ export class TransactionApplication {
     /**
      * Creates a new `TransactionApplication` object.
      * @param applicationId - (apid) ID of the application being configured or empty if creating.
+     * @param access - (al) Access unifies `accounts`, `foreign-apps`, `foreign-assets`, and
+     * `box-references` under a single list. If access is non-empty, these lists must
+     * be empty. If access is empty, those lists may be non-empty.
      * @param accounts - (apat) List of accounts in addition to the sender that may be accessed from the
      * application's approval-program and clear-state-program.
      * @param applicationArgs - (apaa) transaction specific arguments accessed from the application's
@@ -4222,6 +4497,8 @@ export class TransactionApplication {
      * on-completion is set to "clear". It can read and write global state for the
      * application, as well as account-specific local state. Approval programs may
      * reject the transaction.
+     * @param boxReferences - (apbx) the boxes that can be accessed by this transaction (and others in the
+     * same group).
      * @param clearStateProgram - (apsu) Logic executed for application transactions with on-completion set to
      * "clear". It can read and write global state for the application, as well as
      * account-specific local state. Clear state programs cannot reject the
@@ -4249,9 +4526,12 @@ export class TransactionApplication {
      * * update
      * * update
      * * delete
+     * @param rejectVersion - (aprv) the lowest application version for which this transaction should
+     * immediately fail. 0 indicates that no version check should be performed.
      */
-    constructor({ applicationId, accounts, applicationArgs, approvalProgram, clearStateProgram, extraProgramPages, foreignApps, foreignAssets, globalStateSchema, localStateSchema, onCompletion, }) {
+    constructor({ applicationId, access, accounts, applicationArgs, approvalProgram, boxReferences, clearStateProgram, extraProgramPages, foreignApps, foreignAssets, globalStateSchema, localStateSchema, onCompletion, rejectVersion, }) {
         this.applicationId = ensureBigInt(applicationId);
+        this.access = access;
         this.accounts =
             typeof accounts !== 'undefined'
                 ? accounts.map((addr) => typeof addr === 'string' ? Address.fromString(addr) : addr)
@@ -4261,6 +4541,7 @@ export class TransactionApplication {
             typeof approvalProgram === 'string'
                 ? base64ToBytes(approvalProgram)
                 : approvalProgram;
+        this.boxReferences = boxReferences;
         this.clearStateProgram =
             typeof clearStateProgram === 'string'
                 ? base64ToBytes(clearStateProgram)
@@ -4280,6 +4561,10 @@ export class TransactionApplication {
         this.globalStateSchema = globalStateSchema;
         this.localStateSchema = localStateSchema;
         this.onCompletion = onCompletion;
+        this.rejectVersion =
+            typeof rejectVersion === 'undefined'
+                ? undefined
+                : ensureSafeInteger(rejectVersion);
     }
     // eslint-disable-next-line class-methods-use-this
     getEncodingSchema() {
@@ -4288,6 +4573,12 @@ export class TransactionApplication {
     toEncodingData() {
         return new Map([
             ['application-id', this.applicationId],
+            [
+                'access',
+                typeof this.access !== 'undefined'
+                    ? this.access.map((v) => v.toEncodingData())
+                    : undefined,
+            ],
             [
                 'accounts',
                 typeof this.accounts !== 'undefined'
@@ -4296,6 +4587,12 @@ export class TransactionApplication {
             ],
             ['application-args', this.applicationArgs],
             ['approval-program', this.approvalProgram],
+            [
+                'box-references',
+                typeof this.boxReferences !== 'undefined'
+                    ? this.boxReferences.map((v) => v.toEncodingData())
+                    : undefined,
+            ],
             ['clear-state-program', this.clearStateProgram],
             ['extra-program-pages', this.extraProgramPages],
             ['foreign-apps', this.foreignApps],
@@ -4313,6 +4610,7 @@ export class TransactionApplication {
                     : undefined,
             ],
             ['on-completion', this.onCompletion],
+            ['reject-version', this.rejectVersion],
         ]);
     }
     static fromEncodingData(data) {
@@ -4321,9 +4619,19 @@ export class TransactionApplication {
         }
         return new TransactionApplication({
             applicationId: data.get('application-id'),
+            access: typeof data.get('access') !== 'undefined'
+                ? data
+                    .get('access')
+                    .map((v) => ResourceRef.fromEncodingData(v))
+                : undefined,
             accounts: data.get('accounts'),
             applicationArgs: data.get('application-args'),
             approvalProgram: data.get('approval-program'),
+            boxReferences: typeof data.get('box-references') !== 'undefined'
+                ? data
+                    .get('box-references')
+                    .map((v) => BoxReference.fromEncodingData(v))
+                : undefined,
             clearStateProgram: data.get('clear-state-program'),
             extraProgramPages: data.get('extra-program-pages'),
             foreignApps: data.get('foreign-apps'),
@@ -4335,6 +4643,7 @@ export class TransactionApplication {
                 ? StateSchema.fromEncodingData(data.get('local-state-schema'))
                 : undefined,
             onCompletion: data.get('on-completion'),
+            rejectVersion: data.get('reject-version'),
         });
     }
 }
@@ -4851,7 +5160,7 @@ export class TransactionSignature {
      * @param logicsig - (lsig) Programatic transaction signature.
      * Definition:
      * data/transactions/logicsig.go
-     * @param multisig - (msig) structure holding multiple subsignatures.
+     * @param multisig - structure holding multiple subsignatures.
      * Definition:
      * crypto/multisig.go : MultisigSig
      * @param sig - (sig) Standard ed25519 signature.
@@ -4910,6 +5219,10 @@ export class TransactionSignatureLogicsig {
                 key: 'args',
                 valueSchema: new OptionalSchema(new ArraySchema(new ByteArraySchema())),
                 omitEmpty: true,
+            }, {
+                key: 'logic-multisig-signature',
+                valueSchema: new OptionalSchema(TransactionSignatureMultisig.encodingSchema),
+                omitEmpty: true,
             }, {
                 key: 'multisig-signature',
                 valueSchema: new OptionalSchema(TransactionSignatureMultisig.encodingSchema),
@@ -4927,14 +5240,18 @@ export class TransactionSignatureLogicsig {
      * @param logic - (l) Program signed by a signature or multi signature, or hashed to be the
      * address of ana ccount. Base64 encoded TEAL program.
      * @param args - (arg) Logic arguments, base64 encoded.
-     * @param multisigSignature - (msig) structure holding multiple subsignatures.
+     * @param logicMultisigSignature - structure holding multiple subsignatures.
+     * Definition:
+     * crypto/multisig.go : MultisigSig
+     * @param multisigSignature - structure holding multiple subsignatures.
      * Definition:
      * crypto/multisig.go : MultisigSig
      * @param signature - (sig) ed25519 signature.
      */
-    constructor({ logic, args, multisigSignature, signature, }) {
+    constructor({ logic, args, logicMultisigSignature, multisigSignature, signature, }) {
         this.logic = typeof logic === 'string' ? base64ToBytes(logic) : logic;
         this.args = args;
+        this.logicMultisigSignature = logicMultisigSignature;
         this.multisigSignature = multisigSignature;
         this.signature =
             typeof signature === 'string' ? base64ToBytes(signature) : signature;
@@ -4947,6 +5264,12 @@ export class TransactionSignatureLogicsig {
         return new Map([
             ['logic', this.logic],
             ['args', this.args],
+            [
+                'logic-multisig-signature',
+                typeof this.logicMultisigSignature !== 'undefined'
+                    ? this.logicMultisigSignature.toEncodingData()
+                    : undefined,
+            ],
             [
                 'multisig-signature',
                 typeof this.multisigSignature !== 'undefined'
@@ -4963,6 +5286,9 @@ export class TransactionSignatureLogicsig {
         return new TransactionSignatureLogicsig({
             logic: data.get('logic'),
             args: data.get('args'),
+            logicMultisigSignature: typeof data.get('logic-multisig-signature') !== 'undefined'
+                ? TransactionSignatureMultisig.fromEncodingData(data.get('logic-multisig-signature'))
+                : undefined,
             multisigSignature: typeof data.get('multisig-signature') !== 'undefined'
                 ? TransactionSignatureMultisig.fromEncodingData(data.get('multisig-signature'))
                 : undefined,
@@ -4971,7 +5297,7 @@ export class TransactionSignatureLogicsig {
     }
 }
 /**
- * (msig) structure holding multiple subsignatures.
+ * structure holding multiple subsignatures.
  * Definition:
  * crypto/multisig.go : MultisigSig
  */