algosdk 3.5.1 → 3.6.0

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

@@ -338,6 +338,96 @@ export class Account {
         });
     }
 }
+/**
+ * AccountApplicationResource describes the account's application resource (local
+ * state and params if the account is the creator) for a specific application ID.
+ */
+export class AccountApplicationResource {
+    static get encodingSchema() {
+        if (!this.encodingSchemaValue) {
+            this.encodingSchemaValue = new NamedMapSchema([]);
+            this.encodingSchemaValue.pushEntries({ key: 'id', valueSchema: new Uint64Schema(), omitEmpty: true }, {
+                key: 'app-local-state',
+                valueSchema: new OptionalSchema(ApplicationLocalState.encodingSchema),
+                omitEmpty: true,
+            }, {
+                key: 'created-at-round',
+                valueSchema: new OptionalSchema(new Uint64Schema()),
+                omitEmpty: true,
+            }, {
+                key: 'deleted',
+                valueSchema: new OptionalSchema(new BooleanSchema()),
+                omitEmpty: true,
+            }, {
+                key: 'params',
+                valueSchema: new OptionalSchema(ApplicationParams.encodingSchema),
+                omitEmpty: true,
+            });
+        }
+        return this.encodingSchemaValue;
+    }
+    /**
+     * Creates a new `AccountApplicationResource` object.
+     * @param id - The application ID.
+     * @param appLocalState - (appl) the application local data stored in this account.
+     * The raw account uses `AppLocalState` for this type.
+     * @param createdAtRound - Round when the account opted into or created the application.
+     * @param deleted - Whether the application has been deleted.
+     * @param params - (appp) parameters of the application created by this account including app
+     * global data.
+     * The raw account uses `AppParams` for this type.
+     * Only present if the account is the creator and `include=params` is specified.
+     */
+    constructor({ id, appLocalState, createdAtRound, deleted, params, }) {
+        this.id = ensureSafeInteger(id);
+        this.appLocalState = appLocalState;
+        this.createdAtRound =
+            typeof createdAtRound === 'undefined'
+                ? undefined
+                : ensureSafeInteger(createdAtRound);
+        this.deleted = deleted;
+        this.params = params;
+    }
+    // eslint-disable-next-line class-methods-use-this
+    getEncodingSchema() {
+        return AccountApplicationResource.encodingSchema;
+    }
+    toEncodingData() {
+        return new Map([
+            ['id', this.id],
+            [
+                'app-local-state',
+                typeof this.appLocalState !== 'undefined'
+                    ? this.appLocalState.toEncodingData()
+                    : undefined,
+            ],
+            ['created-at-round', this.createdAtRound],
+            ['deleted', this.deleted],
+            [
+                'params',
+                typeof this.params !== 'undefined'
+                    ? this.params.toEncodingData()
+                    : undefined,
+            ],
+        ]);
+    }
+    static fromEncodingData(data) {
+        if (!(data instanceof Map)) {
+            throw new Error(`Invalid decoded AccountApplicationResource: ${data}`);
+        }
+        return new AccountApplicationResource({
+            id: data.get('id'),
+            appLocalState: typeof data.get('app-local-state') !== 'undefined'
+                ? ApplicationLocalState.fromEncodingData(data.get('app-local-state'))
+                : undefined,
+            createdAtRound: data.get('created-at-round'),
+            deleted: data.get('deleted'),
+            params: typeof data.get('params') !== 'undefined'
+                ? ApplicationParams.fromEncodingData(data.get('params'))
+                : undefined,
+        });
+    }
+}
 /**
  * AccountApplicationResponse describes the account's application local state and
  * global state (AppLocalState and AppParams, if either exists) for a specific
@@ -410,6 +500,70 @@ export class AccountApplicationResponse {
         });
     }
 }
+/**
+ * AccountApplicationsInformationResponse contains a list of application resources
+ * for an account.
+ */
+export class AccountApplicationsInformationResponse {
+    static get encodingSchema() {
+        if (!this.encodingSchemaValue) {
+            this.encodingSchemaValue = new NamedMapSchema([]);
+            this.encodingSchemaValue.pushEntries({ key: 'round', valueSchema: new Uint64Schema(), omitEmpty: true }, {
+                key: 'application-resources',
+                valueSchema: new OptionalSchema(new ArraySchema(AccountApplicationResource.encodingSchema)),
+                omitEmpty: true,
+            }, {
+                key: 'next-token',
+                valueSchema: new OptionalSchema(new StringSchema()),
+                omitEmpty: true,
+            });
+        }
+        return this.encodingSchemaValue;
+    }
+    /**
+     * Creates a new `AccountApplicationsInformationResponse` object.
+     * @param round - The round for which this information is relevant.
+     * @param applicationResources -
+     * @param nextToken - Used for pagination, when making another request provide this token with the
+     * next parameter. The next token is the next application ID to use as the
+     * pagination cursor.
+     */
+    constructor({ round, applicationResources, nextToken, }) {
+        this.round = ensureSafeInteger(round);
+        this.applicationResources = applicationResources;
+        this.nextToken = nextToken;
+    }
+    // eslint-disable-next-line class-methods-use-this
+    getEncodingSchema() {
+        return AccountApplicationsInformationResponse.encodingSchema;
+    }
+    toEncodingData() {
+        return new Map([
+            ['round', this.round],
+            [
+                'application-resources',
+                typeof this.applicationResources !== 'undefined'
+                    ? this.applicationResources.map((v) => v.toEncodingData())
+                    : undefined,
+            ],
+            ['next-token', this.nextToken],
+        ]);
+    }
+    static fromEncodingData(data) {
+        if (!(data instanceof Map)) {
+            throw new Error(`Invalid decoded AccountApplicationsInformationResponse: ${data}`);
+        }
+        return new AccountApplicationsInformationResponse({
+            round: data.get('round'),
+            applicationResources: typeof data.get('application-resources') !== 'undefined'
+                ? data
+                    .get('application-resources')
+                    .map((v) => AccountApplicationResource.fromEncodingData(v))
+                : undefined,
+            nextToken: data.get('next-token'),
+        });
+    }
+}
 /**
  * AccountAssetHolding describes the account's asset holding and asset parameters
  * (if either exist) for a specific asset ID.
@@ -797,7 +951,7 @@ export class Application {
             this.encodingSchemaValue = new NamedMapSchema([]);
             this.encodingSchemaValue.pushEntries({ key: 'id', valueSchema: new Uint64Schema(), omitEmpty: true }, {
                 key: 'params',
-                valueSchema: ApplicationParams.encodingSchema,
+                valueSchema: new OptionalSchema(ApplicationParams.encodingSchema),
                 omitEmpty: true,
             });
         }
@@ -819,7 +973,12 @@ export class Application {
     toEncodingData() {
         return new Map([
             ['id', this.id],
-            ['params', this.params.toEncodingData()],
+            [
+                'params',
+                typeof this.params !== 'undefined'
+                    ? this.params.toEncodingData()
+                    : undefined,
+            ],
         ]);
     }
     static fromEncodingData(data) {
@@ -828,7 +987,9 @@ export class Application {
         }
         return new Application({
             id: data.get('id'),
-            params: ApplicationParams.fromEncodingData(data.get('params') ?? new Map()),
+            params: typeof data.get('params') !== 'undefined'
+                ? ApplicationParams.fromEncodingData(data.get('params'))
+                : undefined,
         });
     }
 }
@@ -1103,6 +1264,10 @@ export class ApplicationParams {
                 key: 'local-state-schema',
                 valueSchema: new OptionalSchema(ApplicationStateSchema.encodingSchema),
                 omitEmpty: true,
+            }, {
+                key: 'size-sponsor',
+                valueSchema: new OptionalSchema(new StringSchema()),
+                omitEmpty: true,
             }, {
                 key: 'version',
                 valueSchema: new OptionalSchema(new Uint64Schema()),
@@ -1121,9 +1286,10 @@ export class ApplicationParams {
      * @param globalState - (gs) global state
      * @param globalStateSchema - (gsch) global schema
      * @param localStateSchema - (lsch) local schema
+     * @param sizeSponsor - (ss) the account responsible for extra pages and global state MBR
      * @param version - (v) the number of updates to the application programs
      */
-    constructor({ approvalProgram, clearStateProgram, creator, extraProgramPages, globalState, globalStateSchema, localStateSchema, version, }) {
+    constructor({ approvalProgram, clearStateProgram, creator, extraProgramPages, globalState, globalStateSchema, localStateSchema, sizeSponsor, version, }) {
         this.approvalProgram =
             typeof approvalProgram === 'string'
                 ? base64ToBytes(approvalProgram)
@@ -1141,6 +1307,10 @@ export class ApplicationParams {
         this.globalState = globalState;
         this.globalStateSchema = globalStateSchema;
         this.localStateSchema = localStateSchema;
+        this.sizeSponsor =
+            typeof sizeSponsor === 'string'
+                ? Address.fromString(sizeSponsor)
+                : sizeSponsor;
         this.version =
             typeof version === 'undefined' ? undefined : ensureSafeInteger(version);
     }
@@ -1172,6 +1342,12 @@ export class ApplicationParams {
                     ? this.localStateSchema.toEncodingData()
                     : undefined,
             ],
+            [
+                'size-sponsor',
+                typeof this.sizeSponsor !== 'undefined'
+                    ? this.sizeSponsor.toString()
+                    : undefined,
+            ],
             ['version', this.version],
         ]);
     }
@@ -1195,6 +1371,7 @@ export class ApplicationParams {
             localStateSchema: typeof data.get('local-state-schema') !== 'undefined'
                 ? ApplicationStateSchema.fromEncodingData(data.get('local-state-schema'))
                 : undefined,
+            sizeSponsor: data.get('size-sponsor'),
             version: data.get('version'),
         });
     }
@@ -1331,7 +1508,7 @@ export class Asset {
             this.encodingSchemaValue = new NamedMapSchema([]);
             this.encodingSchemaValue.pushEntries({ key: 'index', valueSchema: new Uint64Schema(), omitEmpty: true }, {
                 key: 'params',
-                valueSchema: AssetParams.encodingSchema,
+                valueSchema: new OptionalSchema(AssetParams.encodingSchema),
                 omitEmpty: true,
             });
         }
@@ -1356,7 +1533,12 @@ export class Asset {
     toEncodingData() {
         return new Map([
             ['index', this.index],
-            ['params', this.params.toEncodingData()],
+            [
+                'params',
+                typeof this.params !== 'undefined'
+                    ? this.params.toEncodingData()
+                    : undefined,
+            ],
         ]);
     }
     static fromEncodingData(data) {
@@ -1365,7 +1547,9 @@ export class Asset {
         }
         return new Asset({
             index: data.get('index'),
-            params: AssetParams.fromEncodingData(data.get('params') ?? new Map()),
+            params: typeof data.get('params') !== 'undefined'
+                ? AssetParams.fromEncodingData(data.get('params'))
+                : undefined,
         });
     }
 }
@@ -1934,9 +2118,9 @@ export class BoxDescriptor {
     static get encodingSchema() {
         if (!this.encodingSchemaValue) {
             this.encodingSchemaValue = new NamedMapSchema([]);
-            this.encodingSchemaValue.pushEntries({
-                key: 'name',
-                valueSchema: new ByteArraySchema(),
+            this.encodingSchemaValue.pushEntries({ key: 'name', valueSchema: new ByteArraySchema(), omitEmpty: true }, {
+                key: 'value',
+                valueSchema: new OptionalSchema(new ByteArraySchema()),
                 omitEmpty: true,
             });
         }
@@ -1945,16 +2129,22 @@ export 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' ? base64ToBytes(name) : name;
+        this.value = typeof value === 'string' ? 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)) {
@@ -1962,6 +2152,7 @@ export class BoxDescriptor {
         }
         return new BoxDescriptor({
             name: data.get('name'),
+            value: data.get('value'),
         });
     }
 }
@@ -2006,7 +2197,7 @@ export class BoxReference {
     }
 }
 /**
- * Box names of an application
+ * Boxes of an application
  */
 export class BoxesResponse {
     static get encodingSchema() {
@@ -2016,6 +2207,14 @@ export class BoxesResponse {
                 key: 'boxes',
                 valueSchema: new ArraySchema(BoxDescriptor.encodingSchema),
                 omitEmpty: true,
+            }, {
+                key: 'next-token',
+                valueSchema: new OptionalSchema(new StringSchema()),
+                omitEmpty: true,
+            }, {
+                key: 'round',
+                valueSchema: new OptionalSchema(new Uint64Schema()),
+                omitEmpty: true,
             });
         }
         return this.encodingSchemaValue;
@@ -2023,9 +2222,16 @@ export class BoxesResponse {
     /**
      * Creates a new `BoxesResponse` object.
      * @param boxes -
+     * @param nextToken - Used for pagination, when making another request provide this token with the
+     * next parameter. The next token is the box name to use as the pagination cursor,
+     * encoded in the goal app call arg form.
+     * @param round - The round for which this information is relevant.
      */
-    constructor({ boxes }) {
+    constructor({ boxes, nextToken, round, }) {
         this.boxes = boxes;
+        this.nextToken = nextToken;
+        this.round =
+            typeof round === 'undefined' ? undefined : ensureSafeInteger(round);
     }
     // eslint-disable-next-line class-methods-use-this
     getEncodingSchema() {
@@ -2034,6 +2240,8 @@ export class BoxesResponse {
     toEncodingData() {
         return new Map([
             ['boxes', this.boxes.map((v) => v.toEncodingData())],
+            ['next-token', this.nextToken],
+            ['round', this.round],
         ]);
     }
     static fromEncodingData(data) {
@@ -2042,6 +2250,8 @@ export class BoxesResponse {
         }
         return new BoxesResponse({
             boxes: (data.get('boxes') ?? []).map((v) => BoxDescriptor.fromEncodingData(v)),
+            nextToken: data.get('next-token'),
+            round: data.get('round'),
         });
     }
 }
@@ -4909,6 +5119,10 @@ export class SupplyResponse {
                 key: 'online-money',
                 valueSchema: new Uint64Schema(),
                 omitEmpty: true,
+            }, {
+                key: 'online-stake',
+                valueSchema: new Uint64Schema(),
+                omitEmpty: true,
             }, { key: 'total-money', valueSchema: new Uint64Schema(), omitEmpty: true });
         }
         return this.encodingSchemaValue;
@@ -4916,12 +5130,17 @@ export class SupplyResponse {
     /**
      * Creates a new `SupplyResponse` object.
      * @param currentRound - Round
-     * @param onlineMoney - OnlineMoney
+     * @param onlineMoney - Total stake held by accounts with status Online at current_round, including
+     * those whose participation keys have expired but have not yet been marked
+     * offline.
+     * @param onlineStake - Online stake used by agreement to vote for current_round, excluding accounts
+     * whose participation keys have expired.
      * @param totalMoney - TotalMoney
      */
-    constructor({ currentRound, onlineMoney, totalMoney, }) {
+    constructor({ currentRound, onlineMoney, onlineStake, totalMoney, }) {
         this.currentRound = ensureBigInt(currentRound);
         this.onlineMoney = ensureBigInt(onlineMoney);
+        this.onlineStake = ensureBigInt(onlineStake);
         this.totalMoney = ensureBigInt(totalMoney);
     }
     // eslint-disable-next-line class-methods-use-this
@@ -4932,6 +5151,7 @@ export class SupplyResponse {
         return new Map([
             ['current_round', this.currentRound],
             ['online-money', this.onlineMoney],
+            ['online-stake', this.onlineStake],
             ['total-money', this.totalMoney],
         ]);
     }
@@ -4942,6 +5162,7 @@ export class SupplyResponse {
         return new SupplyResponse({
             currentRound: data.get('current_round'),
             onlineMoney: data.get('online-money'),
+            onlineStake: data.get('online-stake'),
             totalMoney: data.get('total-money'),
         });
     }
@@ -5102,8 +5323,8 @@ export class TransactionParametersResponse {
      * @param genesisHash - GenesisHash is the hash of the genesis block.
      * @param genesisId - GenesisID is an ID listed in the genesis block.
      * @param lastRound - LastRound indicates the last round seen
-     * @param minFee - The minimum transaction fee (not per byte) required for the
-     * txn to validate for the current network protocol.
+     * @param minFee - The minimum transaction fee (not per byte) required for the txn to validate for
+     * the current network protocol.
      */
     constructor({ consensusVersion, fee, genesisHash, genesisId, lastRound, minFee, }) {
         this.consensusVersion = consensusVersion;