algosdk 3.6.0 → 3.7.0-beta.1

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

@@ -3943,706 +3943,6 @@ export class DisassembleResponse implements Encodable {
   }
 }
 
-/**
- * Request data type for dryrun endpoint. Given the Transactions and simulated
- * ledger state upload, run TEAL scripts and return debugging information.
- */
-export class DryrunRequest implements Encodable {
-  private static encodingSchemaValue: Schema | undefined;
-
-  static get encodingSchema(): Schema {
-    if (!this.encodingSchemaValue) {
-      this.encodingSchemaValue = new NamedMapSchema([]);
-      (this.encodingSchemaValue as NamedMapSchema).pushEntries(
-        {
-          key: 'accounts',
-          valueSchema: new ArraySchema(Account.encodingSchema),
-          omitEmpty: true,
-        },
-        {
-          key: 'apps',
-          valueSchema: new ArraySchema(Application.encodingSchema),
-          omitEmpty: true,
-        },
-        {
-          key: 'latest-timestamp',
-          valueSchema: new Uint64Schema(),
-          omitEmpty: true,
-        },
-        {
-          key: 'protocol-version',
-          valueSchema: new StringSchema(),
-          omitEmpty: true,
-        },
-        { key: 'round', valueSchema: new Uint64Schema(), omitEmpty: true },
-        {
-          key: 'sources',
-          valueSchema: new ArraySchema(DryrunSource.encodingSchema),
-          omitEmpty: true,
-        },
-        {
-          key: 'txns',
-          valueSchema: new ArraySchema(SignedTransaction.encodingSchema),
-          omitEmpty: true,
-        }
-      );
-    }
-    return this.encodingSchemaValue;
-  }
-
-  public accounts: Account[];
-
-  public apps: Application[];
-
-  /**
-   * LatestTimestamp is available to some TEAL scripts. Defaults to the latest
-   * confirmed timestamp this algod is attached to.
-   */
-  public latestTimestamp: number;
-
-  /**
-   * ProtocolVersion specifies a specific version string to operate under, otherwise
-   * whatever the current protocol of the network this algod is running in.
-   */
-  public protocolVersion: string;
-
-  /**
-   * Round is available to some TEAL scripts. Defaults to the current round on the
-   * network this algod is attached to.
-   */
-  public round: bigint;
-
-  public sources: DryrunSource[];
-
-  public txns: SignedTransaction[];
-
-  /**
-   * Creates a new `DryrunRequest` object.
-   * @param accounts -
-   * @param apps -
-   * @param latestTimestamp - LatestTimestamp is available to some TEAL scripts. Defaults to the latest
-   * confirmed timestamp this algod is attached to.
-   * @param protocolVersion - ProtocolVersion specifies a specific version string to operate under, otherwise
-   * whatever the current protocol of the network this algod is running in.
-   * @param round - Round is available to some TEAL scripts. Defaults to the current round on the
-   * network this algod is attached to.
-   * @param sources -
-   * @param txns -
-   */
-  constructor({
-    accounts,
-    apps,
-    latestTimestamp,
-    protocolVersion,
-    round,
-    sources,
-    txns,
-  }: {
-    accounts: Account[];
-    apps: Application[];
-    latestTimestamp: number | bigint;
-    protocolVersion: string;
-    round: number | bigint;
-    sources: DryrunSource[];
-    txns: SignedTransaction[];
-  }) {
-    this.accounts = accounts;
-    this.apps = apps;
-    this.latestTimestamp = ensureSafeInteger(latestTimestamp);
-    this.protocolVersion = protocolVersion;
-    this.round = ensureBigInt(round);
-    this.sources = sources;
-    this.txns = txns;
-  }
-
-  // eslint-disable-next-line class-methods-use-this
-  getEncodingSchema(): Schema {
-    return DryrunRequest.encodingSchema;
-  }
-
-  toEncodingData(): Map<string, unknown> {
-    return new Map<string, unknown>([
-      ['accounts', this.accounts.map((v) => v.toEncodingData())],
-      ['apps', this.apps.map((v) => v.toEncodingData())],
-      ['latest-timestamp', this.latestTimestamp],
-      ['protocol-version', this.protocolVersion],
-      ['round', this.round],
-      ['sources', this.sources.map((v) => v.toEncodingData())],
-      ['txns', this.txns.map((v) => v.toEncodingData())],
-    ]);
-  }
-
-  static fromEncodingData(data: unknown): DryrunRequest {
-    if (!(data instanceof Map)) {
-      throw new Error(`Invalid decoded DryrunRequest: ${data}`);
-    }
-    return new DryrunRequest({
-      accounts: (data.get('accounts') ?? []).map((v: unknown) =>
-        Account.fromEncodingData(v)
-      ),
-      apps: (data.get('apps') ?? []).map((v: unknown) =>
-        Application.fromEncodingData(v)
-      ),
-      latestTimestamp: data.get('latest-timestamp'),
-      protocolVersion: data.get('protocol-version'),
-      round: data.get('round'),
-      sources: (data.get('sources') ?? []).map((v: unknown) =>
-        DryrunSource.fromEncodingData(v)
-      ),
-      txns: (data.get('txns') ?? []).map((v: unknown) =>
-        SignedTransaction.fromEncodingData(v)
-      ),
-    });
-  }
-}
-
-/**
- * DryrunResponse contains per-txn debug information from a dryrun.
- */
-export class DryrunResponse implements Encodable {
-  private static encodingSchemaValue: Schema | undefined;
-
-  static get encodingSchema(): Schema {
-    if (!this.encodingSchemaValue) {
-      this.encodingSchemaValue = new NamedMapSchema([]);
-      (this.encodingSchemaValue as NamedMapSchema).pushEntries(
-        { key: 'error', valueSchema: new StringSchema(), omitEmpty: true },
-        {
-          key: 'protocol-version',
-          valueSchema: new StringSchema(),
-          omitEmpty: true,
-        },
-        {
-          key: 'txns',
-          valueSchema: new ArraySchema(DryrunTxnResult.encodingSchema),
-          omitEmpty: true,
-        }
-      );
-    }
-    return this.encodingSchemaValue;
-  }
-
-  public error: string;
-
-  /**
-   * Protocol version is the protocol version Dryrun was operated under.
-   */
-  public protocolVersion: string;
-
-  public txns: DryrunTxnResult[];
-
-  /**
-   * Creates a new `DryrunResponse` object.
-   * @param error -
-   * @param protocolVersion - Protocol version is the protocol version Dryrun was operated under.
-   * @param txns -
-   */
-  constructor({
-    error,
-    protocolVersion,
-    txns,
-  }: {
-    error: string;
-    protocolVersion: string;
-    txns: DryrunTxnResult[];
-  }) {
-    this.error = error;
-    this.protocolVersion = protocolVersion;
-    this.txns = txns;
-  }
-
-  // eslint-disable-next-line class-methods-use-this
-  getEncodingSchema(): Schema {
-    return DryrunResponse.encodingSchema;
-  }
-
-  toEncodingData(): Map<string, unknown> {
-    return new Map<string, unknown>([
-      ['error', this.error],
-      ['protocol-version', this.protocolVersion],
-      ['txns', this.txns.map((v) => v.toEncodingData())],
-    ]);
-  }
-
-  static fromEncodingData(data: unknown): DryrunResponse {
-    if (!(data instanceof Map)) {
-      throw new Error(`Invalid decoded DryrunResponse: ${data}`);
-    }
-    return new DryrunResponse({
-      error: data.get('error'),
-      protocolVersion: data.get('protocol-version'),
-      txns: (data.get('txns') ?? []).map((v: unknown) =>
-        DryrunTxnResult.fromEncodingData(v)
-      ),
-    });
-  }
-}
-
-/**
- * DryrunSource is TEAL source text that gets uploaded, compiled, and inserted into
- * transactions or application state.
- */
-export class DryrunSource implements Encodable {
-  private static encodingSchemaValue: Schema | undefined;
-
-  static get encodingSchema(): Schema {
-    if (!this.encodingSchemaValue) {
-      this.encodingSchemaValue = new NamedMapSchema([]);
-      (this.encodingSchemaValue as NamedMapSchema).pushEntries(
-        { key: 'app-index', valueSchema: new Uint64Schema(), omitEmpty: true },
-        { key: 'field-name', valueSchema: new StringSchema(), omitEmpty: true },
-        { key: 'source', valueSchema: new StringSchema(), omitEmpty: true },
-        { key: 'txn-index', valueSchema: new Uint64Schema(), omitEmpty: true }
-      );
-    }
-    return this.encodingSchemaValue;
-  }
-
-  public appIndex: bigint;
-
-  /**
-   * FieldName is what kind of sources this is. If lsig then it goes into the
-   * transactions[this.TxnIndex].LogicSig. If approv or clearp it goes into the
-   * Approval Program or Clear State Program of application[this.AppIndex].
-   */
-  public fieldName: string;
-
-  public source: string;
-
-  public txnIndex: number;
-
-  /**
-   * Creates a new `DryrunSource` object.
-   * @param appIndex -
-   * @param fieldName - FieldName is what kind of sources this is. If lsig then it goes into the
-   * transactions[this.TxnIndex].LogicSig. If approv or clearp it goes into the
-   * Approval Program or Clear State Program of application[this.AppIndex].
-   * @param source -
-   * @param txnIndex -
-   */
-  constructor({
-    appIndex,
-    fieldName,
-    source,
-    txnIndex,
-  }: {
-    appIndex: number | bigint;
-    fieldName: string;
-    source: string;
-    txnIndex: number | bigint;
-  }) {
-    this.appIndex = ensureBigInt(appIndex);
-    this.fieldName = fieldName;
-    this.source = source;
-    this.txnIndex = ensureSafeInteger(txnIndex);
-  }
-
-  // eslint-disable-next-line class-methods-use-this
-  getEncodingSchema(): Schema {
-    return DryrunSource.encodingSchema;
-  }
-
-  toEncodingData(): Map<string, unknown> {
-    return new Map<string, unknown>([
-      ['app-index', this.appIndex],
-      ['field-name', this.fieldName],
-      ['source', this.source],
-      ['txn-index', this.txnIndex],
-    ]);
-  }
-
-  static fromEncodingData(data: unknown): DryrunSource {
-    if (!(data instanceof Map)) {
-      throw new Error(`Invalid decoded DryrunSource: ${data}`);
-    }
-    return new DryrunSource({
-      appIndex: data.get('app-index'),
-      fieldName: data.get('field-name'),
-      source: data.get('source'),
-      txnIndex: data.get('txn-index'),
-    });
-  }
-}
-
-/**
- * Stores the TEAL eval step data
- */
-export class DryrunState implements Encodable {
-  private static encodingSchemaValue: Schema | undefined;
-
-  static get encodingSchema(): Schema {
-    if (!this.encodingSchemaValue) {
-      this.encodingSchemaValue = new NamedMapSchema([]);
-      (this.encodingSchemaValue as NamedMapSchema).pushEntries(
-        { key: 'line', valueSchema: new Uint64Schema(), omitEmpty: true },
-        { key: 'pc', valueSchema: new Uint64Schema(), omitEmpty: true },
-        {
-          key: 'stack',
-          valueSchema: new ArraySchema(TealValue.encodingSchema),
-          omitEmpty: true,
-        },
-        {
-          key: 'error',
-          valueSchema: new OptionalSchema(new StringSchema()),
-          omitEmpty: true,
-        },
-        {
-          key: 'scratch',
-          valueSchema: new OptionalSchema(
-            new ArraySchema(TealValue.encodingSchema)
-          ),
-          omitEmpty: true,
-        }
-      );
-    }
-    return this.encodingSchemaValue;
-  }
-
-  /**
-   * Line number
-   */
-  public line: number;
-
-  /**
-   * Program counter
-   */
-  public pc: number;
-
-  public stack: TealValue[];
-
-  /**
-   * Evaluation error if any
-   */
-  public error?: string;
-
-  public scratch?: TealValue[];
-
-  /**
-   * Creates a new `DryrunState` object.
-   * @param line - Line number
-   * @param pc - Program counter
-   * @param stack -
-   * @param error - Evaluation error if any
-   * @param scratch -
-   */
-  constructor({
-    line,
-    pc,
-    stack,
-    error,
-    scratch,
-  }: {
-    line: number | bigint;
-    pc: number | bigint;
-    stack: TealValue[];
-    error?: string;
-    scratch?: TealValue[];
-  }) {
-    this.line = ensureSafeInteger(line);
-    this.pc = ensureSafeInteger(pc);
-    this.stack = stack;
-    this.error = error;
-    this.scratch = scratch;
-  }
-
-  // eslint-disable-next-line class-methods-use-this
-  getEncodingSchema(): Schema {
-    return DryrunState.encodingSchema;
-  }
-
-  toEncodingData(): Map<string, unknown> {
-    return new Map<string, unknown>([
-      ['line', this.line],
-      ['pc', this.pc],
-      ['stack', this.stack.map((v) => v.toEncodingData())],
-      ['error', this.error],
-      [
-        'scratch',
-        typeof this.scratch !== 'undefined'
-          ? this.scratch.map((v) => v.toEncodingData())
-          : undefined,
-      ],
-    ]);
-  }
-
-  static fromEncodingData(data: unknown): DryrunState {
-    if (!(data instanceof Map)) {
-      throw new Error(`Invalid decoded DryrunState: ${data}`);
-    }
-    return new DryrunState({
-      line: data.get('line'),
-      pc: data.get('pc'),
-      stack: (data.get('stack') ?? []).map((v: unknown) =>
-        TealValue.fromEncodingData(v)
-      ),
-      error: data.get('error'),
-      scratch:
-        typeof data.get('scratch') !== 'undefined'
-          ? data
-              .get('scratch')
-              .map((v: unknown) => TealValue.fromEncodingData(v))
-          : undefined,
-    });
-  }
-}
-
-/**
- * DryrunTxnResult contains any LogicSig or ApplicationCall program debug
- * information and state updates from a dryrun.
- */
-export class DryrunTxnResult implements Encodable {
-  private static encodingSchemaValue: Schema | undefined;
-
-  static get encodingSchema(): Schema {
-    if (!this.encodingSchemaValue) {
-      this.encodingSchemaValue = new NamedMapSchema([]);
-      (this.encodingSchemaValue as NamedMapSchema).pushEntries(
-        {
-          key: 'disassembly',
-          valueSchema: new ArraySchema(new StringSchema()),
-          omitEmpty: true,
-        },
-        {
-          key: 'app-call-messages',
-          valueSchema: new OptionalSchema(new ArraySchema(new StringSchema())),
-          omitEmpty: true,
-        },
-        {
-          key: 'app-call-trace',
-          valueSchema: new OptionalSchema(
-            new ArraySchema(DryrunState.encodingSchema)
-          ),
-          omitEmpty: true,
-        },
-        {
-          key: 'budget-added',
-          valueSchema: new OptionalSchema(new Uint64Schema()),
-          omitEmpty: true,
-        },
-        {
-          key: 'budget-consumed',
-          valueSchema: new OptionalSchema(new Uint64Schema()),
-          omitEmpty: true,
-        },
-        {
-          key: 'global-delta',
-          valueSchema: new OptionalSchema(
-            new ArraySchema(EvalDeltaKeyValue.encodingSchema)
-          ),
-          omitEmpty: true,
-        },
-        {
-          key: 'local-deltas',
-          valueSchema: new OptionalSchema(
-            new ArraySchema(AccountStateDelta.encodingSchema)
-          ),
-          omitEmpty: true,
-        },
-        {
-          key: 'logic-sig-disassembly',
-          valueSchema: new OptionalSchema(new ArraySchema(new StringSchema())),
-          omitEmpty: true,
-        },
-        {
-          key: 'logic-sig-messages',
-          valueSchema: new OptionalSchema(new ArraySchema(new StringSchema())),
-          omitEmpty: true,
-        },
-        {
-          key: 'logic-sig-trace',
-          valueSchema: new OptionalSchema(
-            new ArraySchema(DryrunState.encodingSchema)
-          ),
-          omitEmpty: true,
-        },
-        {
-          key: 'logs',
-          valueSchema: new OptionalSchema(
-            new ArraySchema(new ByteArraySchema())
-          ),
-          omitEmpty: true,
-        }
-      );
-    }
-    return this.encodingSchemaValue;
-  }
-
-  /**
-   * Disassembled program line by line.
-   */
-  public disassembly: string[];
-
-  public appCallMessages?: string[];
-
-  public appCallTrace?: DryrunState[];
-
-  /**
-   * Budget added during execution of app call transaction.
-   */
-  public budgetAdded?: number;
-
-  /**
-   * Budget consumed during execution of app call transaction.
-   */
-  public budgetConsumed?: number;
-
-  /**
-   * Application state delta.
-   */
-  public globalDelta?: EvalDeltaKeyValue[];
-
-  public localDeltas?: AccountStateDelta[];
-
-  /**
-   * Disassembled lsig program line by line.
-   */
-  public logicSigDisassembly?: string[];
-
-  public logicSigMessages?: string[];
-
-  public logicSigTrace?: DryrunState[];
-
-  public logs?: Uint8Array[];
-
-  /**
-   * Creates a new `DryrunTxnResult` object.
-   * @param disassembly - Disassembled program line by line.
-   * @param appCallMessages -
-   * @param appCallTrace -
-   * @param budgetAdded - Budget added during execution of app call transaction.
-   * @param budgetConsumed - Budget consumed during execution of app call transaction.
-   * @param globalDelta - Application state delta.
-   * @param localDeltas -
-   * @param logicSigDisassembly - Disassembled lsig program line by line.
-   * @param logicSigMessages -
-   * @param logicSigTrace -
-   * @param logs -
-   */
-  constructor({
-    disassembly,
-    appCallMessages,
-    appCallTrace,
-    budgetAdded,
-    budgetConsumed,
-    globalDelta,
-    localDeltas,
-    logicSigDisassembly,
-    logicSigMessages,
-    logicSigTrace,
-    logs,
-  }: {
-    disassembly: string[];
-    appCallMessages?: string[];
-    appCallTrace?: DryrunState[];
-    budgetAdded?: number | bigint;
-    budgetConsumed?: number | bigint;
-    globalDelta?: EvalDeltaKeyValue[];
-    localDeltas?: AccountStateDelta[];
-    logicSigDisassembly?: string[];
-    logicSigMessages?: string[];
-    logicSigTrace?: DryrunState[];
-    logs?: Uint8Array[];
-  }) {
-    this.disassembly = disassembly;
-    this.appCallMessages = appCallMessages;
-    this.appCallTrace = appCallTrace;
-    this.budgetAdded =
-      typeof budgetAdded === 'undefined'
-        ? undefined
-        : ensureSafeInteger(budgetAdded);
-    this.budgetConsumed =
-      typeof budgetConsumed === 'undefined'
-        ? undefined
-        : ensureSafeInteger(budgetConsumed);
-    this.globalDelta = globalDelta;
-    this.localDeltas = localDeltas;
-    this.logicSigDisassembly = logicSigDisassembly;
-    this.logicSigMessages = logicSigMessages;
-    this.logicSigTrace = logicSigTrace;
-    this.logs = logs;
-  }
-
-  // eslint-disable-next-line class-methods-use-this
-  getEncodingSchema(): Schema {
-    return DryrunTxnResult.encodingSchema;
-  }
-
-  toEncodingData(): Map<string, unknown> {
-    return new Map<string, unknown>([
-      ['disassembly', this.disassembly],
-      ['app-call-messages', this.appCallMessages],
-      [
-        'app-call-trace',
-        typeof this.appCallTrace !== 'undefined'
-          ? this.appCallTrace.map((v) => v.toEncodingData())
-          : undefined,
-      ],
-      ['budget-added', this.budgetAdded],
-      ['budget-consumed', this.budgetConsumed],
-      [
-        'global-delta',
-        typeof this.globalDelta !== 'undefined'
-          ? this.globalDelta.map((v) => v.toEncodingData())
-          : undefined,
-      ],
-      [
-        'local-deltas',
-        typeof this.localDeltas !== 'undefined'
-          ? this.localDeltas.map((v) => v.toEncodingData())
-          : undefined,
-      ],
-      ['logic-sig-disassembly', this.logicSigDisassembly],
-      ['logic-sig-messages', this.logicSigMessages],
-      [
-        'logic-sig-trace',
-        typeof this.logicSigTrace !== 'undefined'
-          ? this.logicSigTrace.map((v) => v.toEncodingData())
-          : undefined,
-      ],
-      ['logs', this.logs],
-    ]);
-  }
-
-  static fromEncodingData(data: unknown): DryrunTxnResult {
-    if (!(data instanceof Map)) {
-      throw new Error(`Invalid decoded DryrunTxnResult: ${data}`);
-    }
-    return new DryrunTxnResult({
-      disassembly: data.get('disassembly'),
-      appCallMessages: data.get('app-call-messages'),
-      appCallTrace:
-        typeof data.get('app-call-trace') !== 'undefined'
-          ? data
-              .get('app-call-trace')
-              .map((v: unknown) => DryrunState.fromEncodingData(v))
-          : undefined,
-      budgetAdded: data.get('budget-added'),
-      budgetConsumed: data.get('budget-consumed'),
-      globalDelta:
-        typeof data.get('global-delta') !== 'undefined'
-          ? data
-              .get('global-delta')
-              .map((v: unknown) => EvalDeltaKeyValue.fromEncodingData(v))
-          : undefined,
-      localDeltas:
-        typeof data.get('local-deltas') !== 'undefined'
-          ? data
-              .get('local-deltas')
-              .map((v: unknown) => AccountStateDelta.fromEncodingData(v))
-          : undefined,
-      logicSigDisassembly: data.get('logic-sig-disassembly'),
-      logicSigMessages: data.get('logic-sig-messages'),
-      logicSigTrace:
-        typeof data.get('logic-sig-trace') !== 'undefined'
-          ? data
-              .get('logic-sig-trace')
-              .map((v: unknown) => DryrunState.fromEncodingData(v))
-          : undefined,
-      logs: data.get('logs'),
-    });
-  }
-}
-
 /**
  * An error response with optional data field.
  */