algosdk 3.5.1 → 3.6.0

package/src/client/v2/algod/models/types.ts

@@ -621,6 +621,152 @@ export class Account implements Encodable {
   }
 }
 
+/**
+ * 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 implements Encodable {
+  private static encodingSchemaValue: Schema | undefined;
+
+  static get encodingSchema(): Schema {
+    if (!this.encodingSchemaValue) {
+      this.encodingSchemaValue = new NamedMapSchema([]);
+      (this.encodingSchemaValue as NamedMapSchema).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;
+  }
+
+  /**
+   * The application ID.
+   */
+  public id: number;
+
+  /**
+   * (appl) the application local data stored in this account.
+   * The raw account uses `AppLocalState` for this type.
+   */
+  public appLocalState?: ApplicationLocalState;
+
+  /**
+   * Round when the account opted into or created the application.
+   */
+  public createdAtRound?: number;
+
+  /**
+   * Whether the application has been deleted.
+   */
+  public deleted?: boolean;
+
+  /**
+   * (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.
+   */
+  public params?: ApplicationParams;
+
+  /**
+   * 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,
+  }: {
+    id: number | bigint;
+    appLocalState?: ApplicationLocalState;
+    createdAtRound?: number | bigint;
+    deleted?: boolean;
+    params?: ApplicationParams;
+  }) {
+    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(): Schema {
+    return AccountApplicationResource.encodingSchema;
+  }
+
+  toEncodingData(): Map<string, unknown> {
+    return new Map<string, unknown>([
+      ['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: unknown): AccountApplicationResource {
+    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
@@ -732,6 +878,112 @@ export class AccountApplicationResponse implements Encodable {
   }
 }
 
+/**
+ * AccountApplicationsInformationResponse contains a list of application resources
+ * for an account.
+ */
+export class AccountApplicationsInformationResponse implements Encodable {
+  private static encodingSchemaValue: Schema | undefined;
+
+  static get encodingSchema(): Schema {
+    if (!this.encodingSchemaValue) {
+      this.encodingSchemaValue = new NamedMapSchema([]);
+      (this.encodingSchemaValue as NamedMapSchema).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;
+  }
+
+  /**
+   * The round for which this information is relevant.
+   */
+  public round: number;
+
+  public applicationResources?: AccountApplicationResource[];
+
+  /**
+   * 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.
+   */
+  public nextToken?: string;
+
+  /**
+   * 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,
+  }: {
+    round: number | bigint;
+    applicationResources?: AccountApplicationResource[];
+    nextToken?: string;
+  }) {
+    this.round = ensureSafeInteger(round);
+    this.applicationResources = applicationResources;
+    this.nextToken = nextToken;
+  }
+
+  // eslint-disable-next-line class-methods-use-this
+  getEncodingSchema(): Schema {
+    return AccountApplicationsInformationResponse.encodingSchema;
+  }
+
+  toEncodingData(): Map<string, unknown> {
+    return new Map<string, unknown>([
+      ['round', this.round],
+      [
+        'application-resources',
+        typeof this.applicationResources !== 'undefined'
+          ? this.applicationResources.map((v) => v.toEncodingData())
+          : undefined,
+      ],
+      ['next-token', this.nextToken],
+    ]);
+  }
+
+  static fromEncodingData(
+    data: unknown
+  ): AccountApplicationsInformationResponse {
+    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: unknown) =>
+                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.
@@ -1347,7 +1599,7 @@ export class Application implements Encodable {
         { key: 'id', valueSchema: new Uint64Schema(), omitEmpty: true },
         {
           key: 'params',
-          valueSchema: ApplicationParams.encodingSchema,
+          valueSchema: new OptionalSchema(ApplicationParams.encodingSchema),
           omitEmpty: true,
         }
       );
@@ -1363,7 +1615,7 @@ export class Application implements Encodable {
   /**
    * (appparams) application parameters.
    */
-  public params: ApplicationParams;
+  public params?: ApplicationParams;
 
   /**
    * Creates a new `Application` object.
@@ -1375,7 +1627,7 @@ export class Application implements Encodable {
     params,
   }: {
     id: number | bigint;
-    params: ApplicationParams;
+    params?: ApplicationParams;
   }) {
     this.id = ensureBigInt(id);
     this.params = params;
@@ -1389,7 +1641,12 @@ export class Application implements Encodable {
   toEncodingData(): Map<string, unknown> {
     return new Map<string, unknown>([
       ['id', this.id],
-      ['params', this.params.toEncodingData()],
+      [
+        'params',
+        typeof this.params !== 'undefined'
+          ? this.params.toEncodingData()
+          : undefined,
+      ],
     ]);
   }
 
@@ -1399,9 +1656,10 @@ export class Application implements Encodable {
     }
     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,
     });
   }
 }
@@ -1833,6 +2091,11 @@ export class ApplicationParams implements Encodable {
           ),
           omitEmpty: true,
         },
+        {
+          key: 'size-sponsor',
+          valueSchema: new OptionalSchema(new StringSchema()),
+          omitEmpty: true,
+        },
         {
           key: 'version',
           valueSchema: new OptionalSchema(new Uint64Schema()),
@@ -1879,6 +2142,11 @@ export class ApplicationParams implements Encodable {
    */
   public localStateSchema?: ApplicationStateSchema;
 
+  /**
+   * (ss) the account responsible for extra pages and global state MBR
+   */
+  public sizeSponsor?: Address;
+
   /**
    * (v) the number of updates to the application programs
    */
@@ -1894,6 +2162,7 @@ export class ApplicationParams implements Encodable {
    * @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({
@@ -1904,6 +2173,7 @@ export class ApplicationParams implements Encodable {
     globalState,
     globalStateSchema,
     localStateSchema,
+    sizeSponsor,
     version,
   }: {
     approvalProgram: string | Uint8Array;
@@ -1913,6 +2183,7 @@ export class ApplicationParams implements Encodable {
     globalState?: TealKeyValue[];
     globalStateSchema?: ApplicationStateSchema;
     localStateSchema?: ApplicationStateSchema;
+    sizeSponsor?: Address | string;
     version?: number | bigint;
   }) {
     this.approvalProgram =
@@ -1932,6 +2203,10 @@ export class ApplicationParams implements Encodable {
     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);
   }
@@ -1965,6 +2240,12 @@ export class ApplicationParams implements Encodable {
           ? this.localStateSchema.toEncodingData()
           : undefined,
       ],
+      [
+        'size-sponsor',
+        typeof this.sizeSponsor !== 'undefined'
+          ? this.sizeSponsor.toString()
+          : undefined,
+      ],
       ['version', this.version],
     ]);
   }
@@ -1996,6 +2277,7 @@ export class ApplicationParams implements Encodable {
               data.get('local-state-schema')
             )
           : undefined,
+      sizeSponsor: data.get('size-sponsor'),
       version: data.get('version'),
     });
   }
@@ -2216,7 +2498,7 @@ export class Asset implements Encodable {
         { key: 'index', valueSchema: new Uint64Schema(), omitEmpty: true },
         {
           key: 'params',
-          valueSchema: AssetParams.encodingSchema,
+          valueSchema: new OptionalSchema(AssetParams.encodingSchema),
           omitEmpty: true,
         }
       );
@@ -2235,7 +2517,7 @@ export class Asset implements Encodable {
    * Definition:
    * data/transactions/asset.go : AssetParams
    */
-  public params: AssetParams;
+  public params?: AssetParams;
 
   /**
    * Creates a new `Asset` object.
@@ -2250,7 +2532,7 @@ export class Asset implements Encodable {
     params,
   }: {
     index: number | bigint;
-    params: AssetParams;
+    params?: AssetParams;
   }) {
     this.index = ensureBigInt(index);
     this.params = params;
@@ -2264,7 +2546,12 @@ export class Asset implements Encodable {
   toEncodingData(): Map<string, unknown> {
     return new Map<string, unknown>([
       ['index', this.index],
-      ['params', this.params.toEncodingData()],
+      [
+        'params',
+        typeof this.params !== 'undefined'
+          ? this.params.toEncodingData()
+          : undefined,
+      ],
     ]);
   }
 
@@ -2274,7 +2561,10 @@ export class Asset implements Encodable {
     }
     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,
     });
   }
 }
@@ -3189,11 +3479,14 @@ export class BoxDescriptor implements Encodable {
   static get encodingSchema(): Schema {
     if (!this.encodingSchemaValue) {
       this.encodingSchemaValue = new NamedMapSchema([]);
-      (this.encodingSchemaValue as NamedMapSchema).pushEntries({
-        key: 'name',
-        valueSchema: new ByteArraySchema(),
-        omitEmpty: true,
-      });
+      (this.encodingSchemaValue as NamedMapSchema).pushEntries(
+        { key: 'name', valueSchema: new ByteArraySchema(), omitEmpty: true },
+        {
+          key: 'value',
+          valueSchema: new OptionalSchema(new ByteArraySchema()),
+          omitEmpty: true,
+        }
+      );
     }
     return this.encodingSchemaValue;
   }
@@ -3203,12 +3496,27 @@ export class BoxDescriptor implements Encodable {
    */
   public name: Uint8Array;
 
+  /**
+   * Base64 encoded box value. Present only when the `values` query parameter is set
+   * to true.
+   */
+  public value?: Uint8Array;
+
   /**
    * 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 }: { name: string | Uint8Array }) {
+  constructor({
+    name,
+    value,
+  }: {
+    name: string | Uint8Array;
+    value?: string | Uint8Array;
+  }) {
     this.name = typeof name === 'string' ? base64ToBytes(name) : name;
+    this.value = typeof value === 'string' ? base64ToBytes(value) : value;
   }
 
   // eslint-disable-next-line class-methods-use-this
@@ -3217,7 +3525,10 @@ export class BoxDescriptor implements Encodable {
   }
 
   toEncodingData(): Map<string, unknown> {
-    return new Map<string, unknown>([['name', this.name]]);
+    return new Map<string, unknown>([
+      ['name', this.name],
+      ['value', this.value],
+    ]);
   }
 
   static fromEncodingData(data: unknown): BoxDescriptor {
@@ -3226,6 +3537,7 @@ export class BoxDescriptor implements Encodable {
     }
     return new BoxDescriptor({
       name: data.get('name'),
+      value: data.get('value'),
     });
   }
 }
@@ -3297,7 +3609,7 @@ export class BoxReference implements Encodable {
 }
 
 /**
- * Box names of an application
+ * Boxes of an application
  */
 export class BoxesResponse implements Encodable {
   private static encodingSchemaValue: Schema | undefined;
@@ -3305,23 +3617,62 @@ export class BoxesResponse implements Encodable {
   static get encodingSchema(): Schema {
     if (!this.encodingSchemaValue) {
       this.encodingSchemaValue = new NamedMapSchema([]);
-      (this.encodingSchemaValue as NamedMapSchema).pushEntries({
-        key: 'boxes',
-        valueSchema: new ArraySchema(BoxDescriptor.encodingSchema),
-        omitEmpty: true,
-      });
+      (this.encodingSchemaValue as NamedMapSchema).pushEntries(
+        {
+          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;
   }
 
   public boxes: BoxDescriptor[];
 
+  /**
+   * 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.
+   */
+  public nextToken?: string;
+
+  /**
+   * The round for which this information is relevant.
+   */
+  public round?: number;
+
   /**
    * 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 }: { boxes: BoxDescriptor[] }) {
+  constructor({
+    boxes,
+    nextToken,
+    round,
+  }: {
+    boxes: BoxDescriptor[];
+    nextToken?: string;
+    round?: number | bigint;
+  }) {
     this.boxes = boxes;
+    this.nextToken = nextToken;
+    this.round =
+      typeof round === 'undefined' ? undefined : ensureSafeInteger(round);
   }
 
   // eslint-disable-next-line class-methods-use-this
@@ -3332,6 +3683,8 @@ export class BoxesResponse implements Encodable {
   toEncodingData(): Map<string, unknown> {
     return new Map<string, unknown>([
       ['boxes', this.boxes.map((v) => v.toEncodingData())],
+      ['next-token', this.nextToken],
+      ['round', this.round],
     ]);
   }
 
@@ -3343,6 +3696,8 @@ export class BoxesResponse implements Encodable {
       boxes: (data.get('boxes') ?? []).map((v: unknown) =>
         BoxDescriptor.fromEncodingData(v)
       ),
+      nextToken: data.get('next-token'),
+      round: data.get('round'),
     });
   }
 }
@@ -8039,6 +8394,11 @@ export class SupplyResponse implements Encodable {
           valueSchema: new Uint64Schema(),
           omitEmpty: true,
         },
+        {
+          key: 'online-stake',
+          valueSchema: new Uint64Schema(),
+          omitEmpty: true,
+        },
         { key: 'total-money', valueSchema: new Uint64Schema(), omitEmpty: true }
       );
     }
@@ -8051,10 +8411,18 @@ export class SupplyResponse implements Encodable {
   public currentRound: bigint;
 
   /**
-   * 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.
    */
   public onlineMoney: bigint;
 
+  /**
+   * Online stake used by agreement to vote for current_round, excluding accounts
+   * whose participation keys have expired.
+   */
+  public onlineStake: bigint;
+
   /**
    * TotalMoney
    */
@@ -8063,20 +8431,27 @@ export class SupplyResponse implements Encodable {
   /**
    * 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,
+    onlineStake,
     totalMoney,
   }: {
     currentRound: number | bigint;
     onlineMoney: number | bigint;
+    onlineStake: number | bigint;
     totalMoney: number | bigint;
   }) {
     this.currentRound = ensureBigInt(currentRound);
     this.onlineMoney = ensureBigInt(onlineMoney);
+    this.onlineStake = ensureBigInt(onlineStake);
     this.totalMoney = ensureBigInt(totalMoney);
   }
 
@@ -8089,6 +8464,7 @@ export class SupplyResponse implements Encodable {
     return new Map<string, unknown>([
       ['current_round', this.currentRound],
       ['online-money', this.onlineMoney],
+      ['online-stake', this.onlineStake],
       ['total-money', this.totalMoney],
     ]);
   }
@@ -8100,6 +8476,7 @@ export class SupplyResponse implements Encodable {
     return new SupplyResponse({
       currentRound: data.get('current_round'),
       onlineMoney: data.get('online-money'),
+      onlineStake: data.get('online-stake'),
       totalMoney: data.get('total-money'),
     });
   }
@@ -8360,8 +8737,8 @@ export class TransactionParametersResponse implements Encodable {
   public lastRound: bigint;
 
   /**
-   * The minimum transaction fee (not per byte) required for the
-   * txn to validate for the current network protocol.
+   * The minimum transaction fee (not per byte) required for the txn to validate for
+   * the current network protocol.
    */
   public minFee: bigint;
 
@@ -8376,8 +8753,8 @@ export class TransactionParametersResponse implements Encodable {
    * @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,