@algorandfoundation/algokit-utils 10.0.0-alpha.4 → 10.0.0-alpha.41

package/packages/algod_client/src/apis/api-service.mjs

@@ -1,6 +1,8 @@
 import { concatArrays } from "../../../common/src/array.mjs";
 import { decodeSignedTransaction } from "../../../transact/src/transactions/signed-transaction.mjs";
+import { PendingTransactionResponseMeta } from "../models/pending-transaction-response.mjs";
 import { decodeJson, decodeMsgpack, encodeMsgpack } from "../core/model-runtime.mjs";
+import { SimulateResponseMeta } from "../models/simulate-response.mjs";
 import { GenesisMeta } from "../models/genesis.mjs";
 import { LedgerStateDeltaMeta } from "../models/ledger-state-delta.mjs";
 import { ApplicationMeta } from "../models/application.mjs";
@@ -9,7 +11,6 @@ import { AccountMeta } from "../models/account.mjs";
 import { SimulateRequestMeta } from "../models/simulate-request.mjs";
 import { BoxMeta } from "../models/box.mjs";
 import { VersionMeta } from "../models/version.mjs";
-import { PendingTransactionResponseMeta } from "../models/pending-transaction-response.mjs";
 import { StateProofMeta } from "../models/state-proof.mjs";
 import { LightBlockHeaderProofMeta } from "../models/light-block-header-proof.mjs";
 import { TransactionProofMeta } from "../models/transaction-proof.mjs";
@@ -24,7 +25,6 @@ import { BlockHashResponseMeta } from "../models/block-hash-response.mjs";
 import { NodeStatusResponseMeta } from "../models/node-status-response.mjs";
 import { PendingTransactionsResponseMeta } from "../models/pending-transactions-response.mjs";
 import { PostTransactionsResponseMeta } from "../models/post-transactions-response.mjs";
-import { SimulateResponseMeta } from "../models/simulate-response.mjs";
 import { SupplyResponseMeta } from "../models/supply-response.mjs";
 import { TransactionParametersResponseMeta } from "../models/transaction-parameters-response.mjs";
 import { BoxesResponseMeta } from "../models/boxes-response.mjs";
@@ -93,7 +93,7 @@ var AlgodApi = class {
 	/**
 	* 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...'.
 	*/
-	async _getApplicationBoxByName(applicationId, params) {
+	async _applicationBoxByName(applicationId, params) {
 		const headers = {};
 		headers["Accept"] = this.mimeTypeFor("json");
 		return decodeJson(await this.httpRequest.request({
@@ -108,7 +108,7 @@ var AlgodApi = class {
 	/**
 	* 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.
 	*/
-	async getApplicationBoxes(applicationId, params) {
+	async applicationBoxes(applicationId, params) {
 		const headers = {};
 		headers["Accept"] = this.mimeTypeFor("json");
 		return decodeJson(await this.httpRequest.request({
@@ -123,7 +123,7 @@ var AlgodApi = class {
 	/**
 	* Given a application ID, it returns application information including creator, approval and clear programs, global and local schemas, and global state.
 	*/
-	async getApplicationById(applicationId) {
+	async applicationById(applicationId) {
 		const headers = {};
 		headers["Accept"] = this.mimeTypeFor("json");
 		return decodeJson(await this.httpRequest.request({
@@ -138,7 +138,7 @@ var AlgodApi = class {
 	/**
 	* Given a asset ID, it returns asset information including creator, name, total supply and special addresses.
 	*/
-	async getAssetById(assetId) {
+	async assetById(assetId) {
 		const headers = {};
 		headers["Accept"] = this.mimeTypeFor("json");
 		return decodeJson(await this.httpRequest.request({
@@ -150,7 +150,7 @@ var AlgodApi = class {
 			body: void 0
 		}), AssetMeta);
 	}
-	async getBlock(round, params) {
+	async block(round, params) {
 		const headers = {};
 		headers["Accept"] = this.mimeTypeFor("msgpack");
 		return decodeMsgpack(await this.httpRequest.request({
@@ -165,7 +165,7 @@ var AlgodApi = class {
 			body: void 0
 		}), BlockResponseMeta);
 	}
-	async getBlockHash(round) {
+	async blockHash(round) {
 		const headers = {};
 		headers["Accept"] = this.mimeTypeFor("json");
 		return decodeJson(await this.httpRequest.request({
@@ -180,7 +180,7 @@ var AlgodApi = class {
 	/**
 	* Gets the current timestamp offset.
 	*/
-	async getBlockTimeStampOffset() {
+	async blockTimeStampOffset() {
 		const headers = {};
 		headers["Accept"] = this.mimeTypeFor("json");
 		return decodeJson(await this.httpRequest.request({
@@ -192,7 +192,7 @@ var AlgodApi = class {
 			body: void 0
 		}), GetBlockTimeStampOffsetResponseMeta);
 	}
-	async getBlockTxIds(round) {
+	async blockTxIds(round) {
 		const headers = {};
 		headers["Accept"] = this.mimeTypeFor("json");
 		return decodeJson(await this.httpRequest.request({
@@ -207,7 +207,7 @@ var AlgodApi = class {
 	/**
 	* Returns the entire genesis file in json.
 	*/
-	async getGenesis() {
+	async genesis() {
 		const headers = {};
 		headers["Accept"] = this.mimeTypeFor("json");
 		return decodeJson(await this.httpRequest.request({
@@ -219,10 +219,22 @@ var AlgodApi = class {
 			body: void 0
 		}), GenesisMeta);
 	}
+	async healthCheck() {
+		const headers = {};
+		headers["Accept"] = this.mimeTypeFor("json");
+		await this.httpRequest.request({
+			method: "GET",
+			url: "/health",
+			path: {},
+			query: {},
+			headers,
+			body: void 0
+		});
+	}
 	/**
 	* Get ledger deltas for a round.
 	*/
-	async getLedgerStateDelta(round) {
+	async ledgerStateDelta(round) {
 		const headers = {};
 		headers["Accept"] = this.mimeTypeFor("msgpack");
 		return decodeMsgpack(await this.httpRequest.request({
@@ -237,7 +249,7 @@ var AlgodApi = class {
 	/**
 	* Get a ledger delta for a given transaction group.
 	*/
-	async getLedgerStateDeltaForTransactionGroup(id) {
+	async ledgerStateDeltaForTransactionGroup(id) {
 		const headers = {};
 		headers["Accept"] = this.mimeTypeFor("msgpack");
 		return decodeMsgpack(await this.httpRequest.request({
@@ -249,7 +261,7 @@ var AlgodApi = class {
 			body: void 0
 		}), LedgerStateDeltaMeta);
 	}
-	async getLightBlockHeaderProof(round) {
+	async lightBlockHeaderProof(round) {
 		const headers = {};
 		headers["Accept"] = this.mimeTypeFor("json");
 		return decodeJson(await this.httpRequest.request({
@@ -262,9 +274,28 @@ var AlgodApi = class {
 		}), LightBlockHeaderProofMeta);
 	}
 	/**
+	* 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.
+	*/
+	async pendingTransactionInformation(txId) {
+		const headers = {};
+		headers["Accept"] = this.mimeTypeFor("msgpack");
+		return decodeMsgpack(await this.httpRequest.request({
+			method: "GET",
+			url: "/v2/transactions/pending/{txid}",
+			path: { txid: txId },
+			query: { format: "msgpack" },
+			headers,
+			body: void 0
+		}), PendingTransactionResponseMeta);
+	}
+	/**
 	* 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.
 	*/
-	async getPendingTransactions(params) {
+	async pendingTransactions(params) {
 		const headers = {};
 		headers["Accept"] = this.mimeTypeFor("msgpack");
 		return decodeMsgpack(await this.httpRequest.request({
@@ -282,7 +313,7 @@ var AlgodApi = class {
 	/**
 	* 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.
 	*/
-	async getPendingTransactionsByAddress(address, params) {
+	async pendingTransactionsByAddress(address, params) {
 		const headers = {};
 		headers["Accept"] = this.mimeTypeFor("msgpack");
 		return decodeMsgpack(await this.httpRequest.request({
@@ -297,120 +328,26 @@ var AlgodApi = class {
 			body: void 0
 		}), PendingTransactionsResponseMeta);
 	}
-	async getReady() {
-		const headers = {};
-		headers["Accept"] = this.mimeTypeFor("json");
-		await this.httpRequest.request({
-			method: "GET",
-			url: "/ready",
-			path: {},
-			query: {},
-			headers,
-			body: void 0
-		});
-	}
-	async getStateProof(round) {
-		const headers = {};
-		headers["Accept"] = this.mimeTypeFor("json");
-		return decodeJson(await this.httpRequest.request({
-			method: "GET",
-			url: "/v2/stateproofs/{round}",
-			path: { round },
-			query: {},
-			headers,
-			body: void 0
-		}), StateProofMeta);
-	}
-	async getStatus() {
-		const headers = {};
-		headers["Accept"] = this.mimeTypeFor("json");
-		return decodeJson(await this.httpRequest.request({
-			method: "GET",
-			url: "/v2/status",
-			path: {},
-			query: {},
-			headers,
-			body: void 0
-		}), NodeStatusResponseMeta);
-	}
-	async getSupply() {
-		const headers = {};
-		headers["Accept"] = this.mimeTypeFor("json");
-		return decodeJson(await this.httpRequest.request({
-			method: "GET",
-			url: "/v2/ledger/supply",
-			path: {},
-			query: {},
-			headers,
-			body: void 0
-		}), SupplyResponseMeta);
-	}
-	/**
-	* Gets the minimum sync round for the ledger.
-	*/
-	async getSyncRound() {
-		const headers = {};
-		headers["Accept"] = this.mimeTypeFor("json");
-		return decodeJson(await this.httpRequest.request({
-			method: "GET",
-			url: "/v2/ledger/sync",
-			path: {},
-			query: {},
-			headers,
-			body: void 0
-		}), GetSyncRoundResponseMeta);
-	}
-	/**
-	* Get ledger deltas for transaction groups in a given round.
-	*/
-	async getTransactionGroupLedgerStateDeltasForRound(round) {
-		const headers = {};
-		headers["Accept"] = this.mimeTypeFor("msgpack");
-		return decodeMsgpack(await this.httpRequest.request({
-			method: "GET",
-			url: "/v2/deltas/{round}/txn/group",
-			path: { round },
-			query: { format: "msgpack" },
-			headers,
-			body: void 0
-		}), TransactionGroupLedgerStateDeltasForRoundResponseMeta);
-	}
-	async getTransactionProof(round, txId, params) {
-		const headers = {};
-		headers["Accept"] = this.mimeTypeFor("json");
-		return decodeJson(await this.httpRequest.request({
-			method: "GET",
-			url: "/v2/blocks/{round}/transactions/{txid}/proof",
-			path: {
-				round,
-				txid: txId
-			},
-			query: { hashtype: params?.hashtype },
-			headers,
-			body: void 0
-		}), TransactionProofMeta);
-	}
-	/**
-	* Retrieves the supported API versions, binary build versions, and genesis information.
-	*/
-	async getVersion() {
+	async _rawTransaction(body) {
 		const headers = {};
 		headers["Accept"] = this.mimeTypeFor("json");
+		const serializedBody = body ?? void 0;
+		headers["Content-Type"] = "application/x-binary";
 		return decodeJson(await this.httpRequest.request({
-			method: "GET",
-			url: "/versions",
+			method: "POST",
+			url: "/v2/transactions",
 			path: {},
 			query: {},
 			headers,
-			body: void 0
-		}), VersionMeta);
+			body: serializedBody
+		}), PostTransactionsResponseMeta);
 	}
-	async healthCheck() {
+	async ready() {
 		const headers = {};
 		headers["Accept"] = this.mimeTypeFor("json");
 		await this.httpRequest.request({
 			method: "GET",
-			url: "/health",
+			url: "/ready",
 			path: {},
 			query: {},
 			headers,
@@ -418,39 +355,6 @@ var AlgodApi = class {
 		});
 	}
 	/**
-	* 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.
-	*/
-	async pendingTransactionInformation(txId) {
-		const headers = {};
-		headers["Accept"] = this.mimeTypeFor("msgpack");
-		return decodeMsgpack(await this.httpRequest.request({
-			method: "GET",
-			url: "/v2/transactions/pending/{txid}",
-			path: { txid: txId },
-			query: { format: "msgpack" },
-			headers,
-			body: void 0
-		}), PendingTransactionResponseMeta);
-	}
-	async _rawTransaction(body) {
-		const headers = {};
-		headers["Accept"] = this.mimeTypeFor("json");
-		const serializedBody = body ?? void 0;
-		headers["Content-Type"] = "application/x-binary";
-		return decodeJson(await this.httpRequest.request({
-			method: "POST",
-			url: "/v2/transactions",
-			path: {},
-			query: {},
-			headers,
-			body: serializedBody
-		}), PostTransactionsResponseMeta);
-	}
-	/**
 	* 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.
 	*/
 	async setBlockTimeStampOffset(offset) {
@@ -497,6 +401,30 @@ var AlgodApi = class {
 			body: serializedBody
 		}), SimulateResponseMeta);
 	}
+	async stateProof(round) {
+		const headers = {};
+		headers["Accept"] = this.mimeTypeFor("json");
+		return decodeJson(await this.httpRequest.request({
+			method: "GET",
+			url: "/v2/stateproofs/{round}",
+			path: { round },
+			query: {},
+			headers,
+			body: void 0
+		}), StateProofMeta);
+	}
+	async status() {
+		const headers = {};
+		headers["Accept"] = this.mimeTypeFor("json");
+		return decodeJson(await this.httpRequest.request({
+			method: "GET",
+			url: "/v2/status",
+			path: {},
+			query: {},
+			headers,
+			body: void 0
+		}), NodeStatusResponseMeta);
+	}
 	/**
 	* 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.
 	*/
@@ -512,6 +440,33 @@ var AlgodApi = class {
 			body: void 0
 		}), NodeStatusResponseMeta);
 	}
+	async supply() {
+		const headers = {};
+		headers["Accept"] = this.mimeTypeFor("json");
+		return decodeJson(await this.httpRequest.request({
+			method: "GET",
+			url: "/v2/ledger/supply",
+			path: {},
+			query: {},
+			headers,
+			body: void 0
+		}), SupplyResponseMeta);
+	}
+	/**
+	* Gets the minimum sync round for the ledger.
+	*/
+	async syncRound() {
+		const headers = {};
+		headers["Accept"] = this.mimeTypeFor("json");
+		return decodeJson(await this.httpRequest.request({
+			method: "GET",
+			url: "/v2/ledger/sync",
+			path: {},
+			query: {},
+			headers,
+			body: void 0
+		}), GetSyncRoundResponseMeta);
+	}
 	/**
 	* 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.
 	*/
@@ -546,6 +501,21 @@ var AlgodApi = class {
 			body: serializedBody
 		}), DisassembleResponseMeta);
 	}
+	/**
+	* Get ledger deltas for transaction groups in a given round.
+	*/
+	async transactionGroupLedgerStateDeltasForRound(round) {
+		const headers = {};
+		headers["Accept"] = this.mimeTypeFor("msgpack");
+		return decodeMsgpack(await this.httpRequest.request({
+			method: "GET",
+			url: "/v2/deltas/{round}/txn/group",
+			path: { round },
+			query: { format: "msgpack" },
+			headers,
+			body: void 0
+		}), TransactionGroupLedgerStateDeltasForRoundResponseMeta);
+	}
 	async _transactionParams() {
 		const headers = {};
 		headers["Accept"] = this.mimeTypeFor("json");
@@ -558,6 +528,21 @@ var AlgodApi = class {
 			body: void 0
 		}), TransactionParametersResponseMeta);
 	}
+	async transactionProof(round, txId, params) {
+		const headers = {};
+		headers["Accept"] = this.mimeTypeFor("json");
+		return decodeJson(await this.httpRequest.request({
+			method: "GET",
+			url: "/v2/blocks/{round}/transactions/{txid}/proof",
+			path: {
+				round,
+				txid: txId
+			},
+			query: { hashtype: params?.hashtype },
+			headers,
+			body: void 0
+		}), TransactionProofMeta);
+	}
 	/**
 	* Unset the ledger sync round.
 	*/
@@ -574,6 +559,21 @@ var AlgodApi = class {
 		});
 	}
 	/**
+	* Retrieves the supported API versions, binary build versions, and genesis information.
+	*/
+	async version() {
+		const headers = {};
+		headers["Accept"] = this.mimeTypeFor("json");
+		return decodeJson(await this.httpRequest.request({
+			method: "GET",
+			url: "/versions",
+			path: {},
+			query: {},
+			headers,
+			body: void 0
+		}), VersionMeta);
+	}
+	/**
 	* Send a signed transaction or array of signed transactions to the network.
 	*/
 	async sendRawTransaction(stxOrStxs) {
@@ -587,9 +587,9 @@ var AlgodApi = class {
 	/**
 	* Given an application ID and box name, it returns the round, box name, and value.
 	*/
-	async getApplicationBoxByName(applicationId, boxName) {
+	async applicationBoxByName(applicationId, boxName) {
 		const name = `b64:${Buffer.from(boxName).toString("base64")}`;
-		return this._getApplicationBoxByName(applicationId, { name });
+		return this._applicationBoxByName(applicationId, { name });
 	}
 	/**
 	* Returns the common needed parameters for a new transaction.
@@ -610,7 +610,7 @@ var AlgodApi = class {
 	/**
 	* Returns the common needed parameters for a new transaction.
 	*/
-	async getTransactionParams() {
+	async transactionParams() {
 		return await this.suggestedParams();
 	}
 	/**