@algorandfoundation/algokit-utils 9.2.0-beta.6 → 10.0.0-alpha.1

package/packages/algod_client/src/models/ledger-state-delta.d.ts

@@ -0,0 +1,351 @@
+import { Address } from "../../../common/src/address.js";
+import { Block } from "./block.js";
+
+//#region packages/algod_client/src/models/ledger-state-delta.d.ts
+
+/**
+ * Contains type information and a value, representing a value in a TEAL program.
+ */
+type LedgerTealValue = {
+  /**
+   * Type determines the type of the value.
+   * * 1 represents the type of a byte slice in a TEAL program
+   * * 2 represents the type of an unsigned integer in a TEAL program
+   */
+  type: number;
+  /** bytes value. */
+  bytes?: Uint8Array;
+  /** uint value. */
+  uint?: bigint;
+};
+/**
+ * Sets maximums on the number of each type that may be stored.
+ */
+type LedgerStateSchema = {
+  /** Number of uints in state. */
+  numUints?: bigint;
+  /** Number of byte slices in state. */
+  numByteSlices?: bigint;
+};
+/**
+ * Stores the global information associated with an application.
+ */
+type LedgerAppParams = {
+  approvalProgram: Uint8Array;
+  clearStateProgram: Uint8Array;
+  localStateSchema: LedgerStateSchema;
+  globalStateSchema: LedgerStateSchema;
+  extraProgramPages: number;
+  version?: number;
+  sizeSponsor?: Address;
+  globalState?: Map<Uint8Array, LedgerTealValue>;
+};
+/**
+ * Stores the LocalState associated with an application.
+ */
+type LedgerAppLocalState = {
+  schema: LedgerStateSchema;
+  keyValue?: Map<Uint8Array, LedgerTealValue>;
+};
+/**
+ * Tracks a changed AppLocalState, and whether it was deleted.
+ */
+type LedgerAppLocalStateDelta = {
+  deleted: boolean;
+  localState?: LedgerAppLocalState;
+};
+/**
+ * Tracks a changed AppParams, and whether it was deleted.
+ */
+type LedgerAppParamsDelta = {
+  deleted: boolean;
+  params?: LedgerAppParams;
+};
+/**
+ * Represents AppParams and AppLocalState in deltas.
+ */
+type LedgerAppResourceRecord = {
+  appId: bigint;
+  address: Address;
+  params: LedgerAppParamsDelta;
+  state: LedgerAppLocalStateDelta;
+};
+/**
+ * Describes an asset held by an account.
+ */
+type LedgerAssetHolding = {
+  amount: bigint;
+  frozen: boolean;
+};
+/**
+ * Records a changed AssetHolding, and whether it was deleted.
+ */
+type LedgerAssetHoldingDelta = {
+  deleted: boolean;
+  holding?: LedgerAssetHolding;
+};
+/**
+ * Describes the parameters of an asset.
+ */
+type LedgerAssetParams = {
+  /**
+   * Specifies the total number of units of this asset created.
+   */
+  total: bigint;
+  /**
+   * Specifies the number of digits to display after the decimal place when displaying this asset.
+   * A value of 0 represents an asset that is not divisible, a value of 1 represents an asset divisible into tenths, and so on.
+   * This value must be between 0 and 19 (inclusive).
+   */
+  decimals: number;
+  /**
+   * Specifies whether slots for this asset in user accounts are frozen by default or not.
+   */
+  defaultFrozen: boolean;
+  /**
+   * Specifies a hint for the name of a unit of this asset.
+   */
+  unitName?: string;
+  /**
+   * Specifies a hint for the name of the asset.
+   */
+  assetName?: string;
+  /**
+   * Specifies a URL where more information about the asset can be retrieved.
+   */
+  url?: string;
+  /**
+   * Specifies a commitment to some unspecified asset metadata. The format of this
+   * metadata is up to the application.
+   */
+  metadataHash?: Uint8Array;
+  /**
+   * Manager specifies an account that is allowed to change the non-zero addresses in this AssetParams.
+   */
+  manager?: Address;
+  /**
+   * Specifies an account whose holdings of this asset should be reported as "not minted".
+   */
+  reserve?: Address;
+  /**
+   * Specifies an account that is allowed to change the frozen state of holdings of this asset.
+   */
+  freeze?: Address;
+  /**
+   * Specifies an account that is allowed to take units of this asset from any account.
+   */
+  clawback?: Address;
+};
+/**
+ * Tracks a changed asset params, and whether it was deleted.
+ */
+type LedgerAssetParamsDelta = {
+  deleted: boolean;
+  params?: LedgerAssetParams;
+};
+/**
+ * Represents asset params and asset holding in deltas.
+ */
+type LedgerAssetResourceRecord = {
+  assetId: bigint;
+  address: Address;
+  params: LedgerAssetParamsDelta;
+  holding: LedgerAssetHoldingDelta;
+};
+/**
+ * Holds participation information.
+ */
+type LedgerVotingData = {
+  voteId: Uint8Array;
+  selectionId: Uint8Array;
+  stateProofId: Uint8Array;
+  voteFirstValid: bigint;
+  voteLastValid: bigint;
+  voteKeyDilution: bigint;
+};
+/**
+ * Contains base account info like balance, status and total number of resources.
+ */
+type LedgerAccountBaseData = {
+  /**
+   * Account status. Values are:
+   * * 0: Offline
+   * * 1: Online
+   * * 2: NotParticipating
+   */
+  status: number;
+  microAlgos: bigint;
+  rewardsBase: bigint;
+  rewardedMicroAlgos: bigint;
+  authAddress: Address;
+  incentiveEligible: boolean;
+  /**
+   * Totals across created globals, and opted in locals.
+   */
+  totalAppSchema: LedgerStateSchema;
+  /**
+   * Total number of extra pages across all created apps.
+   */
+  totalExtraAppPages: number;
+  /**
+   * Total number of apps this account has created.
+   */
+  totalAppParams: number;
+  /**
+   * Total number of apps this account is opted into.
+   */
+  totalAppLocalStates: number;
+  /**
+   * Total number of assets created by this account.
+   */
+  totalAssetParams: number;
+  /**
+   * Total of asset creations and optins (i.e. number of holdings).
+   */
+  totalAssets: number;
+  /**
+   * Total number of boxes associated to this account.
+   */
+  totalBoxes: bigint;
+  /**
+   * Total bytes for this account's boxes. keys and values count.
+   */
+  totalBoxBytes: bigint;
+  /**
+   * The last round that this account proposed the winning block.
+   */
+  lastProposed: bigint;
+  /**
+   * The last round that this account sent a heartbeat to show it was online.
+   */
+  lastHeartbeat: bigint;
+};
+/**
+ * Provides per-account data.
+ */
+type LedgerAccountData = {
+  accountBaseData: LedgerAccountBaseData;
+  votingData: LedgerVotingData;
+};
+type LedgerBalanceRecord = {
+  address: Address;
+  accountData: LedgerAccountData;
+};
+type LedgerAccountDeltas = {
+  accounts?: LedgerBalanceRecord[];
+  appResources?: LedgerAppResourceRecord[];
+  assetResources?: LedgerAssetResourceRecord[];
+};
+/**
+ * Shows how the data associated with a key in the kvstore has changed.
+ */
+type LedgerKvValueDelta = {
+  /**
+   * Stores the most recent value (undefined means deleted).
+   */
+  data?: Uint8Array;
+  /**
+   * Stores the previous value (undefined means didn't exist).
+   */
+  oldData?: Uint8Array;
+};
+/**
+ * Defines the transactions included in a block, their index and last valid round.
+ */
+type LedgerIncludedTransactions = {
+  lastValid: bigint;
+  /**
+   * The index of the transaction in the block.
+   */
+  intra: number;
+};
+/**
+ * Represents a change to a single creatable state.
+ */
+type LedgerModifiedCreatable = {
+  /**
+   * Type of the creatable. The values are:
+   * * 0: Asset
+   * * 1: Application
+   */
+  creatableType: number;
+  /**
+   * Created if true, deleted if false.
+   */
+  created: boolean;
+  /**
+   * Creator of the app/asset.
+   */
+  creator: Address;
+  /**
+   * Keeps track of how many times this app/asset appears in accountUpdates.creatableDeltas.
+   */
+  nDeltas: number;
+};
+/**
+ * Represents a total of algos of a certain class of accounts (split up by their Status value).
+ */
+type LedgerAlgoCount = {
+  /**
+   * Sum of algos of all accounts in this scope.
+   */
+  money: bigint;
+  /**
+   * Total number of whole reward units in accounts.
+   */
+  rewardUnits: bigint;
+};
+/**
+ * Represents the totals of algos in the system grouped by different account status values.
+ */
+type LedgerAccountTotals = {
+  online: LedgerAlgoCount;
+  offline: LedgerAlgoCount;
+  notParticipating: LedgerAlgoCount;
+  /**
+   * Total number of algos received per reward unit since genesis.
+   */
+  rewardsLevel: bigint;
+};
+/**
+ * Describes the delta between a given round to the previous round.
+ */
+type LedgerStateDelta = {
+  /**
+   * Modified new accounts.
+   */
+  accounts: LedgerAccountDeltas;
+  /**
+   * Block header.
+   */
+  block: Block;
+  /**
+   * Represents modification on StateProofNextRound field in the block header. If the block contains
+   * a valid state proof transaction, this field will contain the next round for state proof.
+   * otherwise it will be set to 0.
+   */
+  stateProofNext: bigint;
+  /**
+   * Previous block timestamp
+   */
+  prevTimestamp: bigint;
+  /**
+   * The account totals reflecting the changes in this StateDelta object.
+   */
+  totals: LedgerAccountTotals;
+  /**
+   * Modified kv pairs.
+   */
+  kvMods?: Map<Uint8Array, LedgerKvValueDelta>;
+  /**
+   * New Txids for the txtail and TxnCounter, mapped to txn.LastValid.
+   */
+  txIds?: Map<Uint8Array, LedgerIncludedTransactions>;
+  /**
+   * New creatables creator lookup table.
+   */
+  creatables?: Map<number, LedgerModifiedCreatable>;
+};
+//#endregion
+export { LedgerStateDelta };
+//# sourceMappingURL=ledger-state-delta.d.ts.map