@algorandfoundation/algokit-utils 10.0.0-alpha.3 → 10.0.0-alpha.31

package/packages/abi/src/utils.mjs

@@ -0,0 +1,55 @@
+//#region packages/abi/src/utils.ts
+/**
+* Checks if a type is an ABIStructType by checking for the structFields property.
+*/
+function isABIStructType(type) {
+	return !Array.isArray(type) && "structFields" in type;
+}
+/**
+* Converts a struct value (object with named fields) to a tuple value (array).
+* @param structType The struct type definition
+* @param structValue The struct value to convert
+* @returns The equivalent tuple value
+*/
+function getTupleValueFromStructValue(structType, structValue) {
+	const getTupleValueFromStructFields = (structFields, values) => {
+		return structFields.map(({ type }, index) => {
+			if (Array.isArray(type)) {
+				const value = values[index];
+				return getTupleValueFromStructFields(type, Object.values(value));
+			}
+			if (isABIStructType(type)) {
+				const value = values[index];
+				return getTupleValueFromStructFields(type.structFields, Object.values(value));
+			}
+			return values[index];
+		});
+	};
+	return getTupleValueFromStructFields(structType.structFields, Object.values(structValue));
+}
+/**
+* Converts a tuple value (array) to a struct value (object with named fields).
+* @param structType The struct type definition
+* @param tupleValue The tuple value to convert
+* @returns The equivalent struct value
+*/
+function getStructValueFromTupleValue(structType, tupleValue) {
+	const getStructFieldValues = (structFields, values) => {
+		return Object.fromEntries(structFields.map(({ name, type }, index) => {
+			if (Array.isArray(type)) {
+				const value = values[index];
+				return [name, getStructFieldValues(type, value)];
+			}
+			if (isABIStructType(type)) {
+				const value = values[index];
+				return [name, getStructFieldValues(type.structFields, value)];
+			}
+			return [name, values[index]];
+		}));
+	};
+	return getStructFieldValues(structType.structFields, tupleValue);
+}
+
+//#endregion
+export { getStructValueFromTupleValue, getTupleValueFromStructValue };
+//# sourceMappingURL=utils.mjs.map

package/packages/abi/src/utils.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.mjs","names":[],"sources":["../../../../packages/abi/src/utils.ts"],"sourcesContent":["import type { ABIStructField, ABIStructType, ABIType } from './abi-type'\nimport type { ABIStructValue, ABIValue } from './abi-value'\n\n/**\n * Checks if a type is an ABIStructType by checking for the structFields property.\n */\nfunction isABIStructType(type: ABIType | ABIStructField[]): type is ABIStructType {\n  return !Array.isArray(type) && 'structFields' in type\n}\n\n/**\n * Converts a struct value (object with named fields) to a tuple value (array).\n * @param structType The struct type definition\n * @param structValue The struct value to convert\n * @returns The equivalent tuple value\n */\nexport function getTupleValueFromStructValue(structType: ABIStructType, structValue: ABIStructValue): ABIValue[] {\n  const getTupleValueFromStructFields = (structFields: ABIStructField[], values: ABIValue[]): ABIValue[] => {\n    return structFields.map(({ type }, index) => {\n      // if type is an array of fields, treat as unnamed struct\n      if (Array.isArray(type)) {\n        const value = values[index] as ABIStructValue\n        return getTupleValueFromStructFields(type, Object.values(value))\n      }\n      // if type is struct, treat as struct\n      if (isABIStructType(type)) {\n        const value = values[index] as ABIStructValue\n        return getTupleValueFromStructFields(type.structFields, Object.values(value))\n      }\n      return values[index]\n    })\n  }\n\n  return getTupleValueFromStructFields(structType.structFields, Object.values(structValue))\n}\n\n/**\n * Converts a tuple value (array) to a struct value (object with named fields).\n * @param structType The struct type definition\n * @param tupleValue The tuple value to convert\n * @returns The equivalent struct value\n */\nexport function getStructValueFromTupleValue(structType: ABIStructType, tupleValue: ABIValue[]): ABIStructValue {\n  const getStructFieldValues = (structFields: ABIStructField[], values: ABIValue[]): ABIStructValue => {\n    return Object.fromEntries(\n      structFields.map(({ name, type }, index) => {\n        // When the type is an array of fields, the value must be tuple\n        if (Array.isArray(type)) {\n          const value = values[index] as ABIValue[]\n          return [name, getStructFieldValues(type, value)]\n        }\n        // When the type is a struct, the value must be tuple\n        if (isABIStructType(type)) {\n          const value = values[index] as ABIValue[]\n          return [name, getStructFieldValues(type.structFields, value)]\n        }\n        return [name, values[index]]\n      }),\n    )\n  }\n\n  return getStructFieldValues(structType.structFields, tupleValue)\n}\n"],"mappings":";;;;AAMA,SAAS,gBAAgB,MAAyD;AAChF,QAAO,CAAC,MAAM,QAAQ,KAAK,IAAI,kBAAkB;;;;;;;;AASnD,SAAgB,6BAA6B,YAA2B,aAAyC;CAC/G,MAAM,iCAAiC,cAAgC,WAAmC;AACxG,SAAO,aAAa,KAAK,EAAE,QAAQ,UAAU;AAE3C,OAAI,MAAM,QAAQ,KAAK,EAAE;IACvB,MAAM,QAAQ,OAAO;AACrB,WAAO,8BAA8B,MAAM,OAAO,OAAO,MAAM,CAAC;;AAGlE,OAAI,gBAAgB,KAAK,EAAE;IACzB,MAAM,QAAQ,OAAO;AACrB,WAAO,8BAA8B,KAAK,cAAc,OAAO,OAAO,MAAM,CAAC;;AAE/E,UAAO,OAAO;IACd;;AAGJ,QAAO,8BAA8B,WAAW,cAAc,OAAO,OAAO,YAAY,CAAC;;;;;;;;AAS3F,SAAgB,6BAA6B,YAA2B,YAAwC;CAC9G,MAAM,wBAAwB,cAAgC,WAAuC;AACnG,SAAO,OAAO,YACZ,aAAa,KAAK,EAAE,MAAM,QAAQ,UAAU;AAE1C,OAAI,MAAM,QAAQ,KAAK,EAAE;IACvB,MAAM,QAAQ,OAAO;AACrB,WAAO,CAAC,MAAM,qBAAqB,MAAM,MAAM,CAAC;;AAGlD,OAAI,gBAAgB,KAAK,EAAE;IACzB,MAAM,QAAQ,OAAO;AACrB,WAAO,CAAC,MAAM,qBAAqB,KAAK,cAAc,MAAM,CAAC;;AAE/D,UAAO,CAAC,MAAM,OAAO,OAAO;IAC5B,CACH;;AAGH,QAAO,qBAAqB,WAAW,cAAc,WAAW"}

package/packages/algo25/src/index.js

@@ -1,5 +1,5 @@
-const require_crypto = require('../../common/src/crypto.js');
 const require_english = require('./english.js');
+const require_crypto = require('../../common/src/crypto.js');
 
 //#region packages/algo25/src/index.ts
 const FAIL_TO_DECODE_MNEMONIC_ERROR_MSG = "failed to decode mnemonic";

package/packages/algo25/src/index.mjs

@@ -1,5 +1,5 @@
-import { hash } from "../../common/src/crypto.mjs";
 import english_default from "./english.mjs";
+import { hash } from "../../common/src/crypto.mjs";
 
 //#region packages/algo25/src/index.ts
 const FAIL_TO_DECODE_MNEMONIC_ERROR_MSG = "failed to decode mnemonic";

package/packages/algod_client/src/apis/api-service.d.ts

@@ -52,84 +52,66 @@ declare class AlgodApi {
   /**
    * Given an application ID and box name, it returns the round, box name, and value (each base64 encoded). Box names must be in the goal app call arg encoding form 'encoding:value'. For ints, use the form 'int:1234'. For raw bytes, use the form 'b64:A=='. For printable strings, use the form 'str:hello'. For addresses, use the form 'addr:XYZ...'.
    */
-  private _getApplicationBoxByName;
+  private _applicationBoxByName;
   /**
    * Given an application ID, return all Box names. No particular ordering is guaranteed. Request fails when client or server-side configured limits prevent returning all Box names.
    */
-  getApplicationBoxes(applicationId: number | bigint, params?: {
+  applicationBoxes(applicationId: number | bigint, params?: {
     max?: number;
   }): Promise<BoxesResponse>;
   /**
    * Given a application ID, it returns application information including creator, approval and clear programs, global and local schemas, and global state.
    */
-  getApplicationById(applicationId: number | bigint): Promise<Application>;
+  applicationById(applicationId: number | bigint): Promise<Application>;
   /**
    * Given a asset ID, it returns asset information including creator, name, total supply and special addresses.
    */
-  getAssetById(assetId: number | bigint): Promise<Asset>;
-  getBlock(round: number | bigint, params?: {
+  assetById(assetId: number | bigint): Promise<Asset>;
+  block(round: number | bigint, params?: {
     headerOnly?: boolean;
   }): Promise<BlockResponse>;
-  getBlockHash(round: number | bigint): Promise<BlockHashResponse>;
+  blockHash(round: number | bigint): Promise<BlockHashResponse>;
   /**
    * Gets the current timestamp offset.
    */
-  getBlockTimeStampOffset(): Promise<GetBlockTimeStampOffsetResponse>;
-  getBlockTxIds(round: number | bigint): Promise<BlockTxidsResponse>;
+  blockTimeStampOffset(): Promise<GetBlockTimeStampOffsetResponse>;
+  blockTxIds(round: number | bigint): Promise<BlockTxidsResponse>;
   /**
    * Returns the entire genesis file in json.
    */
-  getGenesis(): Promise<Genesis>;
+  genesis(): Promise<Genesis>;
+  healthCheck(): Promise<void>;
   /**
    * Get ledger deltas for a round.
    */
-  getLedgerStateDelta(round: number | bigint): Promise<LedgerStateDelta>;
+  ledgerStateDelta(round: number | bigint): Promise<LedgerStateDelta>;
   /**
    * Get a ledger delta for a given transaction group.
    */
-  getLedgerStateDeltaForTransactionGroup(id: string): Promise<LedgerStateDelta>;
-  getLightBlockHeaderProof(round: number | bigint): Promise<LightBlockHeaderProof>;
+  ledgerStateDeltaForTransactionGroup(id: string): Promise<LedgerStateDelta>;
+  lightBlockHeaderProof(round: number | bigint): Promise<LightBlockHeaderProof>;
+  /**
+   * Given a transaction ID of a recently submitted transaction, it returns information about it.  There are several cases when this might succeed:
+   * - transaction committed (committed round > 0)
+   * - transaction still in the pool (committed round = 0, pool error = "")
+   * - transaction removed from pool due to error (committed round = 0, pool error != "")
+   * Or the transaction may have happened sufficiently long ago that the node no longer remembers it, and this will return an error.
+   */
+  pendingTransactionInformation(txId: string): Promise<PendingTransactionResponse>;
   /**
    * Get the list of pending transactions, sorted by priority, in decreasing order, truncated at the end at MAX. If MAX = 0, returns all pending transactions.
    */
-  getPendingTransactions(params?: {
+  pendingTransactions(params?: {
     max?: number;
   }): Promise<PendingTransactionsResponse>;
   /**
    * Get the list of pending transactions by address, sorted by priority, in decreasing order, truncated at the end at MAX. If MAX = 0, returns all pending transactions.
    */
-  getPendingTransactionsByAddress(address: ReadableAddress, params?: {
+  pendingTransactionsByAddress(address: ReadableAddress, params?: {
     max?: number;
   }): Promise<PendingTransactionsResponse>;
-  getReady(): Promise<void>;
-  getStateProof(round: number | bigint): Promise<StateProof>;
-  getStatus(): Promise<NodeStatusResponse>;
-  getSupply(): Promise<SupplyResponse>;
-  /**
-   * Gets the minimum sync round for the ledger.
-   */
-  getSyncRound(): Promise<GetSyncRoundResponse>;
-  /**
-   * Get ledger deltas for transaction groups in a given round.
-   */
-  getTransactionGroupLedgerStateDeltasForRound(round: number | bigint): Promise<TransactionGroupLedgerStateDeltasForRoundResponse>;
-  getTransactionProof(round: number | bigint, txId: string, params?: {
-    hashtype?: 'sha512_256' | 'sha256';
-  }): Promise<TransactionProof>;
-  /**
-   * Retrieves the supported API versions, binary build versions, and genesis information.
-   */
-  getVersion(): Promise<Version>;
-  healthCheck(): Promise<void>;
-  /**
-   * Given a transaction ID of a recently submitted transaction, it returns information about it.  There are several cases when this might succeed:
-   * - transaction committed (committed round > 0)
-   * - transaction still in the pool (committed round = 0, pool error = "")
-   * - transaction removed from pool due to error (committed round = 0, pool error != "")
-   * Or the transaction may have happened sufficiently long ago that the node no longer remembers it, and this will return an error.
-   */
-  pendingTransactionInformation(txId: string): Promise<PendingTransactionResponse>;
   private _rawTransaction;
+  ready(): Promise<void>;
   /**
    * Sets the timestamp offset (seconds) for blocks in dev mode. Providing an offset of 0 will unset this value and try to use the real clock for the timestamp.
    */
@@ -139,10 +121,17 @@ declare class AlgodApi {
    */
   setSyncRound(round: number | bigint): Promise<void>;
   simulateTransactions(body: SimulateRequest): Promise<SimulateResponse>;
+  stateProof(round: number | bigint): Promise<StateProof>;
+  status(): Promise<NodeStatusResponse>;
   /**
    * Waits for a block to appear after round {round} and returns the node's status at the time. There is a 1 minute timeout, when reached the current status is returned regardless of whether or not it is the round after the given round.
    */
   statusAfterBlock(round: number | bigint): Promise<NodeStatusResponse>;
+  supply(): Promise<SupplyResponse>;
+  /**
+   * Gets the minimum sync round for the ledger.
+   */
+  syncRound(): Promise<GetSyncRoundResponse>;
   /**
    * Given TEAL source code in plain text, return base64 encoded program bytes and base32 SHA512_256 hash of program bytes (Address style). This endpoint is only enabled when a node's configuration file sets EnableDeveloperAPI to true.
    */
@@ -153,11 +142,22 @@ declare class AlgodApi {
    * Given the program bytes, return the TEAL source code in plain text. This endpoint is only enabled when a node's configuration file sets EnableDeveloperAPI to true.
    */
   tealDisassemble(body: Uint8Array): Promise<DisassembleResponse>;
+  /**
+   * Get ledger deltas for transaction groups in a given round.
+   */
+  transactionGroupLedgerStateDeltasForRound(round: number | bigint): Promise<TransactionGroupLedgerStateDeltasForRoundResponse>;
   private _transactionParams;
+  transactionProof(round: number | bigint, txId: string, params?: {
+    hashtype?: 'sha512_256' | 'sha256';
+  }): Promise<TransactionProof>;
   /**
    * Unset the ledger sync round.
    */
   unsetSyncRound(): Promise<void>;
+  /**
+   * Retrieves the supported API versions, binary build versions, and genesis information.
+   */
+  version(): Promise<Version>;
   /**
    * Send a signed transaction or array of signed transactions to the network.
    */
@@ -165,7 +165,7 @@ declare class AlgodApi {
   /**
    * Given an application ID and box name, it returns the round, box name, and value.
    */
-  getApplicationBoxByName(applicationId: number | bigint, boxName: Uint8Array): Promise<Box>;
+  applicationBoxByName(applicationId: number | bigint, boxName: Uint8Array): Promise<Box>;
   /**
    * Returns the common needed parameters for a new transaction.
    */
@@ -173,7 +173,7 @@ declare class AlgodApi {
   /**
    * Returns the common needed parameters for a new transaction.
    */
-  getTransactionParams(): Promise<SuggestedParams>;
+  transactionParams(): Promise<SuggestedParams>;
   /**
    * Simulate an encoded signed transaction or array of encoded signed transactions.
    */