algosdk 3.3.1 → 3.4.0

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

@@ -2381,6 +2381,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
  */
@@ -4179,6 +4220,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 +4252,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;
@@ -4222,6 +4271,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,8 +4300,10 @@ 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, accounts, applicationArgs, approvalProgram, boxReferences, clearStateProgram, extraProgramPages, foreignApps, foreignAssets, globalStateSchema, localStateSchema, onCompletion, rejectVersion, }) {
         this.applicationId = ensureBigInt(applicationId);
         this.accounts =
             typeof accounts !== 'undefined'
@@ -4261,6 +4314,7 @@ export class TransactionApplication {
             typeof approvalProgram === 'string'
                 ? base64ToBytes(approvalProgram)
                 : approvalProgram;
+        this.boxReferences = boxReferences;
         this.clearStateProgram =
             typeof clearStateProgram === 'string'
                 ? base64ToBytes(clearStateProgram)
@@ -4280,6 +4334,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() {
@@ -4296,6 +4354,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 +4377,7 @@ export class TransactionApplication {
                     : undefined,
             ],
             ['on-completion', this.onCompletion],
+            ['reject-version', this.rejectVersion],
         ]);
     }
     static fromEncodingData(data) {
@@ -4324,6 +4389,11 @@ export class TransactionApplication {
             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 +4405,7 @@ export class TransactionApplication {
                 ? StateSchema.fromEncodingData(data.get('local-state-schema'))
                 : undefined,
             onCompletion: data.get('on-completion'),
+            rejectVersion: data.get('reject-version'),
         });
     }
 }