diff --git a/docs/code/README.md b/docs/code/README.md index 3d7e51e8..352e37e9 100644 --- a/docs/code/README.md +++ b/docs/code/README.md @@ -20,6 +20,7 @@ - [types/config](modules/types_config.md) - [types/indexer](modules/types_indexer.md) - [types/logging](modules/types_logging.md) +- [types/logic-error](modules/types_logic_error.md) - [types/network-client](modules/types_network_client.md) - [types/testing](modules/types_testing.md) - [types/transaction](modules/types_transaction.md) diff --git a/docs/code/classes/testing.TestLogger.md b/docs/code/classes/testing.TestLogger.md index cf652f7b..61c19058 100644 --- a/docs/code/classes/testing.TestLogger.md +++ b/docs/code/classes/testing.TestLogger.md @@ -52,7 +52,7 @@ Create a new test logger that wraps the given logger if provided. #### Defined in -[testing/test-logger.ts:16](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L16) +[src/testing/test-logger.ts:16](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L16) ## Properties @@ -62,7 +62,7 @@ Create a new test logger that wraps the given logger if provided. #### Defined in -[testing/test-logger.ts:10](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L10) +[src/testing/test-logger.ts:10](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L10) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -[testing/test-logger.ts:9](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L9) +[src/testing/test-logger.ts:9](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L9) ## Accessors @@ -88,7 +88,7 @@ Returns all logs captured thus far. #### Defined in -[testing/test-logger.ts:22](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L22) +[src/testing/test-logger.ts:22](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L22) ## Methods @@ -104,7 +104,7 @@ Clears all logs captured so far. #### Defined in -[testing/test-logger.ts:27](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L27) +[src/testing/test-logger.ts:27](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L27) ___ @@ -129,7 +129,7 @@ Logger.debug #### Defined in -[testing/test-logger.ts:75](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L75) +[src/testing/test-logger.ts:75](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L75) ___ @@ -154,7 +154,7 @@ Logger.error #### Defined in -[testing/test-logger.ts:59](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L59) +[src/testing/test-logger.ts:59](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L59) ___ @@ -193,7 +193,7 @@ The snapshotted logs. #### Defined in -[testing/test-logger.ts:45](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L45) +[src/testing/test-logger.ts:45](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L45) ___ @@ -218,7 +218,7 @@ Logger.info #### Defined in -[testing/test-logger.ts:67](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L67) +[src/testing/test-logger.ts:67](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L67) ___ @@ -243,7 +243,7 @@ Logger.verbose #### Defined in -[testing/test-logger.ts:71](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L71) +[src/testing/test-logger.ts:71](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L71) ___ @@ -268,4 +268,4 @@ Logger.warn #### Defined in -[testing/test-logger.ts:63](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L63) +[src/testing/test-logger.ts:63](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L63) diff --git a/docs/code/classes/testing.TransactionLogger.md b/docs/code/classes/testing.TransactionLogger.md index 06c71c94..36456605 100644 --- a/docs/code/classes/testing.TransactionLogger.md +++ b/docs/code/classes/testing.TransactionLogger.md @@ -46,7 +46,7 @@ Useful for automated tests. #### Defined in -[testing/transaction-logger.ts:9](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/transaction-logger.ts#L9) +[src/testing/transaction-logger.ts:9](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/transaction-logger.ts#L9) ## Accessors @@ -62,7 +62,7 @@ readonly `string`[] #### Defined in -[testing/transaction-logger.ts:14](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/transaction-logger.ts#L14) +[src/testing/transaction-logger.ts:14](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/transaction-logger.ts#L14) ## Methods @@ -91,7 +91,7 @@ The wrapped #### Defined in -[testing/transaction-logger.ts:45](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/transaction-logger.ts#L45) +[src/testing/transaction-logger.ts:45](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/transaction-logger.ts#L45) ___ @@ -107,7 +107,7 @@ Clear all logged IDs. #### Defined in -[testing/transaction-logger.ts:21](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/transaction-logger.ts#L21) +[src/testing/transaction-logger.ts:21](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/transaction-logger.ts#L21) ___ @@ -129,7 +129,7 @@ The method that captures raw transactions and stores the transaction IDs. #### Defined in -[testing/transaction-logger.ts:28](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/transaction-logger.ts#L28) +[src/testing/transaction-logger.ts:28](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/transaction-logger.ts#L28) ___ @@ -155,4 +155,4 @@ Indexer. #### Defined in -[testing/transaction-logger.ts:50](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/transaction-logger.ts#L50) +[src/testing/transaction-logger.ts:50](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/transaction-logger.ts#L50) diff --git a/docs/code/classes/types_account.MultisigAccount.md b/docs/code/classes/types_account.MultisigAccount.md index 2f7a2811..06415aeb 100644 --- a/docs/code/classes/types_account.MultisigAccount.md +++ b/docs/code/classes/types_account.MultisigAccount.md @@ -43,7 +43,7 @@ Account wrapper that supports partial or full multisig signing. #### Defined in -[types/account.ts:29](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L29) +[src/types/account.ts:29](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L29) ## Properties @@ -53,7 +53,7 @@ Account wrapper that supports partial or full multisig signing. #### Defined in -[types/account.ts:12](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L12) +[src/types/account.ts:12](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L12) ___ @@ -63,7 +63,7 @@ ___ #### Defined in -[types/account.ts:10](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L10) +[src/types/account.ts:10](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L10) ___ @@ -73,7 +73,7 @@ ___ #### Defined in -[types/account.ts:11](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L11) +[src/types/account.ts:11](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L11) ## Accessors @@ -89,7 +89,7 @@ The address of the multisig account #### Defined in -[types/account.ts:25](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L25) +[src/types/account.ts:25](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L25) ___ @@ -105,7 +105,7 @@ The parameters for the multisig account #### Defined in -[types/account.ts:15](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L15) +[src/types/account.ts:15](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L15) ___ @@ -121,7 +121,7 @@ readonly (`default` \| [`SigningAccount`](types_account.SigningAccount.md))[] #### Defined in -[types/account.ts:20](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L20) +[src/types/account.ts:20](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L20) ## Methods @@ -145,4 +145,4 @@ The transaction signed by the present signers #### Defined in -[types/account.ts:40](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L40) +[src/types/account.ts:40](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L40) diff --git a/docs/code/classes/types_account.SigningAccount.md b/docs/code/classes/types_account.SigningAccount.md index ee037611..bc0776c8 100644 --- a/docs/code/classes/types_account.SigningAccount.md +++ b/docs/code/classes/types_account.SigningAccount.md @@ -43,7 +43,7 @@ Account wrapper that supports a rekeyed account #### Defined in -[types/account.ts:90](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L90) +[src/types/account.ts:90](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L90) ## Properties @@ -53,7 +53,7 @@ Account wrapper that supports a rekeyed account #### Defined in -[types/account.ts:56](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L56) +[src/types/account.ts:56](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L56) ___ @@ -63,7 +63,7 @@ ___ #### Defined in -[types/account.ts:57](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L57) +[src/types/account.ts:57](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L57) ## Accessors @@ -83,7 +83,7 @@ Account.addr #### Defined in -[types/account.ts:62](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L62) +[src/types/account.ts:62](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L62) ___ @@ -99,7 +99,7 @@ Algorand account of the sender address and signer private key #### Defined in -[types/account.ts:83](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L83) +[src/types/account.ts:83](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L83) ___ @@ -115,7 +115,7 @@ Algorand account of the underlying signing account #### Defined in -[types/account.ts:76](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L76) +[src/types/account.ts:76](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L76) ___ @@ -135,4 +135,4 @@ Account.sk #### Defined in -[types/account.ts:69](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L69) +[src/types/account.ts:69](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L69) diff --git a/docs/code/classes/types_algo_http_client_with_retry.AlgoHttpClientWithRetry.md b/docs/code/classes/types_algo_http_client_with_retry.AlgoHttpClientWithRetry.md index c7e01ae3..0abf0a1e 100644 --- a/docs/code/classes/types_algo_http_client_with_retry.AlgoHttpClientWithRetry.md +++ b/docs/code/classes/types_algo_http_client_with_retry.AlgoHttpClientWithRetry.md @@ -53,7 +53,7 @@ A HTTP Client that wraps the Algorand SDK HTTP Client with retries #### Defined in -[types/urlTokenBaseHTTPClient.ts:45](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/urlTokenBaseHTTPClient.ts#L45) +[src/types/urlTokenBaseHTTPClient.ts:45](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/urlTokenBaseHTTPClient.ts#L45) ## Properties @@ -63,7 +63,7 @@ A HTTP Client that wraps the Algorand SDK HTTP Client with retries #### Defined in -[types/algo-http-client-with-retry.ts:8](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algo-http-client-with-retry.ts#L8) +[src/types/algo-http-client-with-retry.ts:8](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algo-http-client-with-retry.ts#L8) ___ @@ -73,7 +73,7 @@ ___ #### Defined in -[types/algo-http-client-with-retry.ts:7](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algo-http-client-with-retry.ts#L7) +[src/types/algo-http-client-with-retry.ts:7](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algo-http-client-with-retry.ts#L7) ___ @@ -83,7 +83,7 @@ ___ #### Defined in -[types/algo-http-client-with-retry.ts:13](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algo-http-client-with-retry.ts#L13) +[src/types/algo-http-client-with-retry.ts:13](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algo-http-client-with-retry.ts#L13) ___ @@ -93,7 +93,7 @@ ___ #### Defined in -[types/algo-http-client-with-retry.ts:12](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algo-http-client-with-retry.ts#L12) +[src/types/algo-http-client-with-retry.ts:12](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algo-http-client-with-retry.ts#L12) ## Methods @@ -113,7 +113,7 @@ ___ #### Defined in -[types/algo-http-client-with-retry.ts:25](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algo-http-client-with-retry.ts#L25) +[src/types/algo-http-client-with-retry.ts:25](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algo-http-client-with-retry.ts#L25) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[types/algo-http-client-with-retry.ts:67](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algo-http-client-with-retry.ts#L67) +[src/types/algo-http-client-with-retry.ts:67](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algo-http-client-with-retry.ts#L67) ___ @@ -166,7 +166,7 @@ ___ #### Defined in -[types/algo-http-client-with-retry.ts:54](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algo-http-client-with-retry.ts#L54) +[src/types/algo-http-client-with-retry.ts:54](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algo-http-client-with-retry.ts#L54) ___ @@ -193,4 +193,4 @@ ___ #### Defined in -[types/algo-http-client-with-retry.ts:58](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algo-http-client-with-retry.ts#L58) +[src/types/algo-http-client-with-retry.ts:58](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algo-http-client-with-retry.ts#L58) diff --git a/docs/code/classes/types_amount.AlgoAmount.md b/docs/code/classes/types_amount.AlgoAmount.md index 36c83e11..203459d6 100644 --- a/docs/code/classes/types_amount.AlgoAmount.md +++ b/docs/code/classes/types_amount.AlgoAmount.md @@ -42,7 +42,7 @@ Wrapper class to ensure safe, explicit conversion between µAlgos, Algos and num #### Defined in -[types/amount.ts:17](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/amount.ts#L17) +[src/types/amount.ts:17](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/amount.ts#L17) ## Properties @@ -52,7 +52,7 @@ Wrapper class to ensure safe, explicit conversion between µAlgos, Algos and num #### Defined in -[types/amount.ts:5](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/amount.ts#L5) +[src/types/amount.ts:5](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/amount.ts#L5) ## Accessors @@ -68,7 +68,7 @@ Return the amount as a number in Algos #### Defined in -[types/amount.ts:13](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/amount.ts#L13) +[src/types/amount.ts:13](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/amount.ts#L13) ___ @@ -84,7 +84,7 @@ Return the amount as a number in µAlgos #### Defined in -[types/amount.ts:8](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/amount.ts#L8) +[src/types/amount.ts:8](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/amount.ts#L8) ## Methods @@ -98,7 +98,7 @@ Return the amount as a number in µAlgos #### Defined in -[types/amount.ts:21](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/amount.ts#L21) +[src/types/amount.ts:21](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/amount.ts#L21) ___ @@ -112,7 +112,7 @@ ___ #### Defined in -[types/amount.ts:25](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/amount.ts#L25) +[src/types/amount.ts:25](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/amount.ts#L25) ___ @@ -138,7 +138,7 @@ object representing the given number of Algos #### Defined in -[types/amount.ts:30](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/amount.ts#L30) +[src/types/amount.ts:30](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/amount.ts#L30) ___ @@ -164,4 +164,4 @@ object representing the given number of µAlgos #### Defined in -[types/amount.ts:35](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/amount.ts#L35) +[src/types/amount.ts:35](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/amount.ts#L35) diff --git a/docs/code/classes/types_application_client.ApplicationClient.md b/docs/code/classes/types_application_client.ApplicationClient.md index bc27fde5..6bbbe695 100644 --- a/docs/code/classes/types_application_client.ApplicationClient.md +++ b/docs/code/classes/types_application_client.ApplicationClient.md @@ -17,6 +17,8 @@ Application client - a class that wraps an ARC-0032 app spec and provides high p - [\_appAddress](types_application_client.ApplicationClient.md#_appaddress) - [\_appId](types_application_client.ApplicationClient.md#_appid) - [\_appName](types_application_client.ApplicationClient.md#_appname) +- [\_approvalSourceMap](types_application_client.ApplicationClient.md#_approvalsourcemap) +- [\_clearSourceMap](types_application_client.ApplicationClient.md#_clearsourcemap) - [\_creator](types_application_client.ApplicationClient.md#_creator) - [algod](types_application_client.ApplicationClient.md#algod) - [appSpec](types_application_client.ApplicationClient.md#appspec) @@ -37,6 +39,7 @@ Application client - a class that wraps an ARC-0032 app spec and provides high p - [getABIMethod](types_application_client.ApplicationClient.md#getabimethod) - [getAppReference](types_application_client.ApplicationClient.md#getappreference) - [getCallArgs](types_application_client.ApplicationClient.md#getcallargs) +- [handleLogicError](types_application_client.ApplicationClient.md#handlelogicerror) - [optIn](types_application_client.ApplicationClient.md#optin) - [update](types_application_client.ApplicationClient.md#update) @@ -57,7 +60,7 @@ Create a new ApplicationClient instance #### Defined in -[types/application-client.ts:147](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L147) +[src/types/application-client.ts:151](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L151) ## Properties @@ -67,7 +70,7 @@ Create a new ApplicationClient instance #### Defined in -[types/application-client.ts:137](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L137) +[src/types/application-client.ts:138](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L138) ___ @@ -77,7 +80,7 @@ ___ #### Defined in -[types/application-client.ts:136](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L136) +[src/types/application-client.ts:137](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L137) ___ @@ -87,7 +90,27 @@ ___ #### Defined in -[types/application-client.ts:139](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L139) +[src/types/application-client.ts:140](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L140) + +___ + +### \_approvalSourceMap + +• `Private` **\_approvalSourceMap**: `undefined` \| `SourceMap` + +#### Defined in + +[src/types/application-client.ts:142](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L142) + +___ + +### \_clearSourceMap + +• `Private` **\_clearSourceMap**: `undefined` \| `SourceMap` + +#### Defined in + +[src/types/application-client.ts:143](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L143) ___ @@ -97,7 +120,7 @@ ___ #### Defined in -[types/application-client.ts:138](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L138) +[src/types/application-client.ts:139](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L139) ___ @@ -107,7 +130,7 @@ ___ #### Defined in -[types/application-client.ts:129](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L129) +[src/types/application-client.ts:130](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L130) ___ @@ -117,7 +140,7 @@ ___ #### Defined in -[types/application-client.ts:131](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L131) +[src/types/application-client.ts:132](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L132) ___ @@ -127,7 +150,7 @@ ___ #### Defined in -[types/application-client.ts:134](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L134) +[src/types/application-client.ts:135](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L135) ___ @@ -137,7 +160,7 @@ ___ #### Defined in -[types/application-client.ts:130](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L130) +[src/types/application-client.ts:131](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L131) ___ @@ -147,7 +170,7 @@ ___ #### Defined in -[types/application-client.ts:133](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L133) +[src/types/application-client.ts:134](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L134) ___ @@ -157,7 +180,7 @@ ___ #### Defined in -[types/application-client.ts:132](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L132) +[src/types/application-client.ts:133](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L133) ## Methods @@ -178,7 +201,7 @@ ___ #### Defined in -[types/application-client.ts:383](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L383) +[src/types/application-client.ts:408](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L408) ___ @@ -198,7 +221,7 @@ ___ #### Defined in -[types/application-client.ts:363](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L363) +[src/types/application-client.ts:388](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L388) ___ @@ -218,7 +241,7 @@ ___ #### Defined in -[types/application-client.ts:375](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L375) +[src/types/application-client.ts:400](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L400) ___ @@ -238,13 +261,13 @@ ___ #### Defined in -[types/application-client.ts:371](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L371) +[src/types/application-client.ts:396](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L396) ___ ### create -▸ **create**(`create?`): `Promise`<[`AppCallTransactionResult`](../interfaces/types_app.AppCallTransactionResult.md) & [`AppReference`](../interfaces/types_app.AppReference.md)\> +▸ **create**(`create?`): `Promise`<`Partial`<[`AppCompilationResult`](../interfaces/types_app.AppCompilationResult.md)\> & [`AppCallTransactionResult`](../interfaces/types_app.AppCallTransactionResult.md) & [`AppReference`](../interfaces/types_app.AppReference.md)\> #### Parameters @@ -254,11 +277,11 @@ ___ #### Returns -`Promise`<[`AppCallTransactionResult`](../interfaces/types_app.AppCallTransactionResult.md) & [`AppReference`](../interfaces/types_app.AppReference.md)\> +`Promise`<`Partial`<[`AppCompilationResult`](../interfaces/types_app.AppCompilationResult.md)\> & [`AppCallTransactionResult`](../interfaces/types_app.AppCallTransactionResult.md) & [`AppReference`](../interfaces/types_app.AppReference.md)\> #### Defined in -[types/application-client.ts:282](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L282) +[src/types/application-client.ts:293](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L293) ___ @@ -278,13 +301,13 @@ ___ #### Defined in -[types/application-client.ts:379](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L379) +[src/types/application-client.ts:404](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L404) ___ ### deploy -▸ **deploy**(`deploy`): `Promise`<[`ConfirmedTransactionResult`](../interfaces/types_transaction.ConfirmedTransactionResult.md) & [`AppMetadata`](../interfaces/types_app.AppMetadata.md) & { `operationPerformed`: ``"update"`` \| ``"create"`` } \| [`ConfirmedTransactionResult`](../interfaces/types_transaction.ConfirmedTransactionResult.md) & [`AppMetadata`](../interfaces/types_app.AppMetadata.md) & { `deleteResult`: [`ConfirmedTransactionResult`](../interfaces/types_transaction.ConfirmedTransactionResult.md) ; `operationPerformed`: ``"replace"`` } \| [`AppMetadata`](../interfaces/types_app.AppMetadata.md) & { `operationPerformed`: ``"nothing"`` }\> +▸ **deploy**(`deploy`): `Promise`<`Partial`<[`AppCompilationResult`](../interfaces/types_app.AppCompilationResult.md)\> & [`ConfirmedTransactionResult`](../interfaces/types_transaction.ConfirmedTransactionResult.md) & [`AppMetadata`](../interfaces/types_app.AppMetadata.md) & { `operationPerformed`: ``"update"`` \| ``"create"`` } \| `Partial`<[`AppCompilationResult`](../interfaces/types_app.AppCompilationResult.md)\> & [`ConfirmedTransactionResult`](../interfaces/types_transaction.ConfirmedTransactionResult.md) & [`AppMetadata`](../interfaces/types_app.AppMetadata.md) & { `deleteResult`: [`ConfirmedTransactionResult`](../interfaces/types_transaction.ConfirmedTransactionResult.md) ; `operationPerformed`: ``"replace"`` } \| `Partial`<[`AppCompilationResult`](../interfaces/types_app.AppCompilationResult.md)\> & [`AppMetadata`](../interfaces/types_app.AppMetadata.md) & { `operationPerformed`: ``"nothing"`` }\> Idempotently deploy (create, update/delete if changed) an app against the given name via the given creator account, including deploy-time template placeholder substitutions. @@ -306,13 +329,13 @@ https://github.com/algorandfoundation/algokit-cli/blob/main/docs/architecture-de #### Returns -`Promise`<[`ConfirmedTransactionResult`](../interfaces/types_transaction.ConfirmedTransactionResult.md) & [`AppMetadata`](../interfaces/types_app.AppMetadata.md) & { `operationPerformed`: ``"update"`` \| ``"create"`` } \| [`ConfirmedTransactionResult`](../interfaces/types_transaction.ConfirmedTransactionResult.md) & [`AppMetadata`](../interfaces/types_app.AppMetadata.md) & { `deleteResult`: [`ConfirmedTransactionResult`](../interfaces/types_transaction.ConfirmedTransactionResult.md) ; `operationPerformed`: ``"replace"`` } \| [`AppMetadata`](../interfaces/types_app.AppMetadata.md) & { `operationPerformed`: ``"nothing"`` }\> +`Promise`<`Partial`<[`AppCompilationResult`](../interfaces/types_app.AppCompilationResult.md)\> & [`ConfirmedTransactionResult`](../interfaces/types_transaction.ConfirmedTransactionResult.md) & [`AppMetadata`](../interfaces/types_app.AppMetadata.md) & { `operationPerformed`: ``"update"`` \| ``"create"`` } \| `Partial`<[`AppCompilationResult`](../interfaces/types_app.AppCompilationResult.md)\> & [`ConfirmedTransactionResult`](../interfaces/types_transaction.ConfirmedTransactionResult.md) & [`AppMetadata`](../interfaces/types_app.AppMetadata.md) & { `deleteResult`: [`ConfirmedTransactionResult`](../interfaces/types_transaction.ConfirmedTransactionResult.md) ; `operationPerformed`: ``"replace"`` } \| `Partial`<[`AppCompilationResult`](../interfaces/types_app.AppCompilationResult.md)\> & [`AppMetadata`](../interfaces/types_app.AppMetadata.md) & { `operationPerformed`: ``"nothing"`` }\> The metadata and transaction result(s) of the deployment, or just the metadata if it didn't need to issue transactions #### Defined in -[types/application-client.ts:191](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L191) +[src/types/application-client.ts:195](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L195) ___ @@ -332,7 +355,7 @@ ___ #### Defined in -[types/application-client.ts:434](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L434) +[src/types/application-client.ts:463](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L463) ___ @@ -346,7 +369,7 @@ ___ #### Defined in -[types/application-client.ts:449](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L449) +[src/types/application-client.ts:478](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L478) ___ @@ -366,7 +389,28 @@ ___ #### Defined in -[types/application-client.ts:414](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L414) +[src/types/application-client.ts:443](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L443) + +___ + +### handleLogicError + +▸ `Private` **handleLogicError**(`e`, `isClear?`): `Error` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `e` | `Error` | +| `isClear?` | `boolean` | + +#### Returns + +`Error` + +#### Defined in + +[src/types/application-client.ts:502](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L502) ___ @@ -386,13 +430,13 @@ ___ #### Defined in -[types/application-client.ts:367](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L367) +[src/types/application-client.ts:392](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L392) ___ ### update -▸ **update**(`update?`): `Promise`<[`AppCallTransactionResult`](../interfaces/types_app.AppCallTransactionResult.md)\> +▸ **update**(`update?`): `Promise`<`Partial`<[`AppCompilationResult`](../interfaces/types_app.AppCompilationResult.md)\> & [`AppCallTransactionResult`](../interfaces/types_app.AppCallTransactionResult.md)\> #### Parameters @@ -402,8 +446,8 @@ ___ #### Returns -`Promise`<[`AppCallTransactionResult`](../interfaces/types_app.AppCallTransactionResult.md)\> +`Promise`<`Partial`<[`AppCompilationResult`](../interfaces/types_app.AppCompilationResult.md)\> & [`AppCallTransactionResult`](../interfaces/types_app.AppCallTransactionResult.md)\> #### Defined in -[types/application-client.ts:328](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L328) +[src/types/application-client.ts:346](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L346) diff --git a/docs/code/classes/types_config.UpdatableConfig.md b/docs/code/classes/types_config.UpdatableConfig.md index 1f8c7283..38bde19c 100644 --- a/docs/code/classes/types_config.UpdatableConfig.md +++ b/docs/code/classes/types_config.UpdatableConfig.md @@ -37,7 +37,7 @@ Updatable AlgoKit config #### Defined in -[types/config.ts:24](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/config.ts#L24) +[src/types/config.ts:24](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/config.ts#L24) ## Properties @@ -47,7 +47,7 @@ Updatable AlgoKit config #### Defined in -[types/config.ts:10](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/config.ts#L10) +[src/types/config.ts:10](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/config.ts#L10) ## Accessors @@ -65,7 +65,7 @@ Readonly.logger #### Defined in -[types/config.ts:12](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/config.ts#L12) +[src/types/config.ts:12](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/config.ts#L12) ## Methods @@ -87,7 +87,7 @@ Update the AlgoKit configuration with your own configuration settings #### Defined in -[types/config.ts:31](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/config.ts#L31) +[src/types/config.ts:31](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/config.ts#L31) ___ @@ -107,4 +107,4 @@ ___ #### Defined in -[types/config.ts:16](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/config.ts#L16) +[src/types/config.ts:16](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/config.ts#L16) diff --git a/docs/code/classes/types_logic_error.LogicError.md b/docs/code/classes/types_logic_error.LogicError.md new file mode 100644 index 00000000..64d8c619 --- /dev/null +++ b/docs/code/classes/types_logic_error.LogicError.md @@ -0,0 +1,234 @@ +[@algorandfoundation/algokit-utils](../README.md) / [types/logic-error](../modules/types_logic_error.md) / LogicError + +# Class: LogicError + +[types/logic-error](../modules/types_logic_error.md).LogicError + +## Hierarchy + +- `Error` + + ↳ **`LogicError`** + +## Table of contents + +### Constructors + +- [constructor](types_logic_error.LogicError.md#constructor) + +### Properties + +- [led](types_logic_error.LogicError.md#led) +- [lines](types_logic_error.LogicError.md#lines) +- [message](types_logic_error.LogicError.md#message) +- [name](types_logic_error.LogicError.md#name) +- [program](types_logic_error.LogicError.md#program) +- [stack](types_logic_error.LogicError.md#stack) +- [teal\_line](types_logic_error.LogicError.md#teal_line) +- [prepareStackTrace](types_logic_error.LogicError.md#preparestacktrace) +- [stackTraceLimit](types_logic_error.LogicError.md#stacktracelimit) + +### Methods + +- [captureStackTrace](types_logic_error.LogicError.md#capturestacktrace) +- [parseLogicError](types_logic_error.LogicError.md#parselogicerror) + +## Constructors + +### constructor + +• **new LogicError**(`led`, `program`, `map`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `led` | [`LogicErrorDetails`](../interfaces/types_logic_error.LogicErrorDetails.md) | +| `program` | `string`[] | +| `map` | `SourceMap` | + +#### Overrides + +Error.constructor + +#### Defined in + +src/types/logic-error.ts:29 + +## Properties + +### led + +• **led**: [`LogicErrorDetails`](../interfaces/types_logic_error.LogicErrorDetails.md) + +#### Defined in + +src/types/logic-error.ts:23 + +___ + +### lines + +• **lines**: `number` = `5` + +#### Defined in + +src/types/logic-error.ts:25 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1054 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1053 + +___ + +### program + +• **program**: `string`[] + +#### Defined in + +src/types/logic-error.ts:24 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Overrides + +Error.stack + +#### Defined in + +src/types/logic-error.ts:27 + +___ + +### teal\_line + +• **teal\_line**: `number` = `0` + +#### Defined in + +src/types/logic-error.ts:26 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +Optional override for formatting stack traces + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:11 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:13 + +## Methods + +### captureStackTrace + +▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:4 + +___ + +### parseLogicError + +▸ `Static` **parseLogicError**(`errMsg`): [`LogicErrorDetails`](../interfaces/types_logic_error.LogicErrorDetails.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `errMsg` | `string` | + +#### Returns + +[`LogicErrorDetails`](../interfaces/types_logic_error.LogicErrorDetails.md) + +#### Defined in + +src/types/logic-error.ts:12 diff --git a/docs/code/classes/types_urlTokenBaseHTTPClient.URLTokenBaseHTTPClient.md b/docs/code/classes/types_urlTokenBaseHTTPClient.URLTokenBaseHTTPClient.md index cee2c125..156951e7 100644 --- a/docs/code/classes/types_urlTokenBaseHTTPClient.URLTokenBaseHTTPClient.md +++ b/docs/code/classes/types_urlTokenBaseHTTPClient.URLTokenBaseHTTPClient.md @@ -57,7 +57,7 @@ This is the default implementation of BaseHTTPClient. #### Defined in -[types/urlTokenBaseHTTPClient.ts:45](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/urlTokenBaseHTTPClient.ts#L45) +[src/types/urlTokenBaseHTTPClient.ts:45](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/urlTokenBaseHTTPClient.ts#L45) ## Properties @@ -67,7 +67,7 @@ This is the default implementation of BaseHTTPClient. #### Defined in -[types/urlTokenBaseHTTPClient.ts:41](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/urlTokenBaseHTTPClient.ts#L41) +[src/types/urlTokenBaseHTTPClient.ts:41](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/urlTokenBaseHTTPClient.ts#L41) ___ @@ -77,7 +77,7 @@ ___ #### Defined in -[types/urlTokenBaseHTTPClient.ts:45](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/urlTokenBaseHTTPClient.ts#L45) +[src/types/urlTokenBaseHTTPClient.ts:45](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/urlTokenBaseHTTPClient.ts#L45) ___ @@ -87,7 +87,7 @@ ___ #### Defined in -[types/urlTokenBaseHTTPClient.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/urlTokenBaseHTTPClient.ts#L42) +[src/types/urlTokenBaseHTTPClient.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/urlTokenBaseHTTPClient.ts#L42) ## Methods @@ -114,7 +114,7 @@ BaseHTTPClient.delete #### Defined in -[types/urlTokenBaseHTTPClient.ts:176](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/urlTokenBaseHTTPClient.ts#L176) +[src/types/urlTokenBaseHTTPClient.ts:176](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/urlTokenBaseHTTPClient.ts#L176) ___ @@ -140,7 +140,7 @@ BaseHTTPClient.get #### Defined in -[types/urlTokenBaseHTTPClient.ts:137](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/urlTokenBaseHTTPClient.ts#L137) +[src/types/urlTokenBaseHTTPClient.ts:137](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/urlTokenBaseHTTPClient.ts#L137) ___ @@ -165,7 +165,7 @@ A URL string #### Defined in -[types/urlTokenBaseHTTPClient.ts:71](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/urlTokenBaseHTTPClient.ts#L71) +[src/types/urlTokenBaseHTTPClient.ts:71](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/urlTokenBaseHTTPClient.ts#L71) ___ @@ -192,7 +192,7 @@ BaseHTTPClient.post #### Defined in -[types/urlTokenBaseHTTPClient.ts:153](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/urlTokenBaseHTTPClient.ts#L153) +[src/types/urlTokenBaseHTTPClient.ts:153](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/urlTokenBaseHTTPClient.ts#L153) ___ @@ -212,7 +212,7 @@ ___ #### Defined in -[types/urlTokenBaseHTTPClient.ts:97](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/urlTokenBaseHTTPClient.ts#L97) +[src/types/urlTokenBaseHTTPClient.ts:97](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/urlTokenBaseHTTPClient.ts#L97) ___ @@ -232,7 +232,7 @@ ___ #### Defined in -[types/urlTokenBaseHTTPClient.ts:128](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/urlTokenBaseHTTPClient.ts#L128) +[src/types/urlTokenBaseHTTPClient.ts:128](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/urlTokenBaseHTTPClient.ts#L128) ___ @@ -252,4 +252,4 @@ ___ #### Defined in -[types/urlTokenBaseHTTPClient.ts:89](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/urlTokenBaseHTTPClient.ts#L89) +[src/types/urlTokenBaseHTTPClient.ts:89](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/urlTokenBaseHTTPClient.ts#L89) diff --git a/docs/code/enums/types_app.OnSchemaBreak.md b/docs/code/enums/types_app.OnSchemaBreak.md index 0406cdfa..3555297e 100644 --- a/docs/code/enums/types_app.OnSchemaBreak.md +++ b/docs/code/enums/types_app.OnSchemaBreak.md @@ -23,7 +23,7 @@ Fail the deployment #### Defined in -[types/app.ts:224](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L224) +[src/types/app.ts:226](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L226) ___ @@ -35,4 +35,4 @@ Delete the app and create a new one in its place #### Defined in -[types/app.ts:226](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L226) +[src/types/app.ts:228](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L228) diff --git a/docs/code/enums/types_app.OnUpdate.md b/docs/code/enums/types_app.OnUpdate.md index 1d15649c..91a67b8b 100644 --- a/docs/code/enums/types_app.OnUpdate.md +++ b/docs/code/enums/types_app.OnUpdate.md @@ -24,7 +24,7 @@ Fail the deployment #### Defined in -[types/app.ts:214](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L214) +[src/types/app.ts:216](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L216) ___ @@ -36,7 +36,7 @@ Delete the app and create a new one in its place #### Defined in -[types/app.ts:218](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L218) +[src/types/app.ts:220](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L220) ___ @@ -48,4 +48,4 @@ Update the app #### Defined in -[types/app.ts:216](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L216) +[src/types/app.ts:218](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L218) diff --git a/docs/code/enums/types_appspec.AVMType.md b/docs/code/enums/types_appspec.AVMType.md index d5ef162a..1b9b8f0f 100644 --- a/docs/code/enums/types_appspec.AVMType.md +++ b/docs/code/enums/types_appspec.AVMType.md @@ -19,7 +19,7 @@ #### Defined in -[types/appspec.ts:56](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L56) +[src/types/appspec.ts:56](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L56) ___ @@ -29,4 +29,4 @@ ___ #### Defined in -[types/appspec.ts:55](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L55) +[src/types/appspec.ts:55](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L55) diff --git a/docs/code/enums/types_indexer.AccountStatus.md b/docs/code/enums/types_indexer.AccountStatus.md index 1e6ca748..6d814c59 100644 --- a/docs/code/enums/types_indexer.AccountStatus.md +++ b/docs/code/enums/types_indexer.AccountStatus.md @@ -20,7 +20,7 @@ #### Defined in -[types/indexer.ts:305](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L305) +[src/types/indexer.ts:305](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L305) ___ @@ -30,7 +30,7 @@ ___ #### Defined in -[types/indexer.ts:303](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L303) +[src/types/indexer.ts:303](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L303) ___ @@ -40,4 +40,4 @@ ___ #### Defined in -[types/indexer.ts:304](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L304) +[src/types/indexer.ts:304](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L304) diff --git a/docs/code/enums/types_indexer.ApplicationOnComplete.md b/docs/code/enums/types_indexer.ApplicationOnComplete.md index c5f97a60..a7c36806 100644 --- a/docs/code/enums/types_indexer.ApplicationOnComplete.md +++ b/docs/code/enums/types_indexer.ApplicationOnComplete.md @@ -23,7 +23,7 @@ #### Defined in -[types/indexer.ts:217](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L217) +[src/types/indexer.ts:217](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L217) ___ @@ -33,7 +33,7 @@ ___ #### Defined in -[types/indexer.ts:216](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L216) +[src/types/indexer.ts:216](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L216) ___ @@ -43,7 +43,7 @@ ___ #### Defined in -[types/indexer.ts:219](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L219) +[src/types/indexer.ts:219](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L219) ___ @@ -53,7 +53,7 @@ ___ #### Defined in -[types/indexer.ts:214](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L214) +[src/types/indexer.ts:214](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L214) ___ @@ -63,7 +63,7 @@ ___ #### Defined in -[types/indexer.ts:215](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L215) +[src/types/indexer.ts:215](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L215) ___ @@ -73,4 +73,4 @@ ___ #### Defined in -[types/indexer.ts:218](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L218) +[src/types/indexer.ts:218](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L218) diff --git a/docs/code/enums/types_indexer.SignatureType.md b/docs/code/enums/types_indexer.SignatureType.md index 16035c49..852d0809 100644 --- a/docs/code/enums/types_indexer.SignatureType.md +++ b/docs/code/enums/types_indexer.SignatureType.md @@ -20,7 +20,7 @@ #### Defined in -[types/indexer.ts:299](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L299) +[src/types/indexer.ts:299](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L299) ___ @@ -30,7 +30,7 @@ ___ #### Defined in -[types/indexer.ts:298](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L298) +[src/types/indexer.ts:298](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L298) ___ @@ -40,4 +40,4 @@ ___ #### Defined in -[types/indexer.ts:297](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L297) +[src/types/indexer.ts:297](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L297) diff --git a/docs/code/interfaces/types_account.TransactionSignerAccount.md b/docs/code/interfaces/types_account.TransactionSignerAccount.md index a718cfaa..276aa098 100644 --- a/docs/code/interfaces/types_account.TransactionSignerAccount.md +++ b/docs/code/interfaces/types_account.TransactionSignerAccount.md @@ -25,7 +25,7 @@ that also has the sender address. #### Defined in -[types/account.ts:98](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L98) +[src/types/account.ts:98](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L98) ___ @@ -35,4 +35,4 @@ ___ #### Defined in -[types/account.ts:99](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L99) +[src/types/account.ts:99](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L99) diff --git a/docs/code/interfaces/types_algod.ApplicationParams.md b/docs/code/interfaces/types_algod.ApplicationParams.md index 09681f5e..60038fe6 100644 --- a/docs/code/interfaces/types_algod.ApplicationParams.md +++ b/docs/code/interfaces/types_algod.ApplicationParams.md @@ -32,7 +32,7 @@ Base64 encoded TEAL approval program #### Defined in -[types/algod.ts:83](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algod.ts#L83) +[src/types/algod.ts:83](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algod.ts#L83) ___ @@ -44,7 +44,7 @@ Base64 encoded TEAL clear state program #### Defined in -[types/algod.ts:85](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algod.ts#L85) +[src/types/algod.ts:85](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algod.ts#L85) ___ @@ -56,7 +56,7 @@ Address of the account that created the app #### Defined in -[types/algod.ts:81](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algod.ts#L81) +[src/types/algod.ts:81](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algod.ts#L81) ___ @@ -68,7 +68,7 @@ The amount of extra program pages available to this app. #### Defined in -[types/algod.ts:87](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algod.ts#L87) +[src/types/algod.ts:87](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algod.ts#L87) ___ @@ -80,7 +80,7 @@ Current global state values #### Defined in -[types/algod.ts:89](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algod.ts#L89) +[src/types/algod.ts:89](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algod.ts#L89) ___ @@ -92,7 +92,7 @@ Global state schema #### Defined in -[types/algod.ts:91](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algod.ts#L91) +[src/types/algod.ts:91](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algod.ts#L91) ___ @@ -104,4 +104,4 @@ Local state schema #### Defined in -[types/algod.ts:93](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algod.ts#L93) +[src/types/algod.ts:93](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algod.ts#L93) diff --git a/docs/code/interfaces/types_algod.ApplicationResponse.md b/docs/code/interfaces/types_algod.ApplicationResponse.md index e543a091..b2ff5109 100644 --- a/docs/code/interfaces/types_algod.ApplicationResponse.md +++ b/docs/code/interfaces/types_algod.ApplicationResponse.md @@ -25,7 +25,7 @@ https://developer.algorand.org/docs/rest-apis/algod/v2/#get-v2applicationsapplic #### Defined in -[types/algod.ts:74](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algod.ts#L74) +[src/types/algod.ts:74](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algod.ts#L74) ___ @@ -35,4 +35,4 @@ ___ #### Defined in -[types/algod.ts:75](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algod.ts#L75) +[src/types/algod.ts:75](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algod.ts#L75) diff --git a/docs/code/interfaces/types_algod.ApplicationStateSchema.md b/docs/code/interfaces/types_algod.ApplicationStateSchema.md index 1a2234c1..d1676e50 100644 --- a/docs/code/interfaces/types_algod.ApplicationStateSchema.md +++ b/docs/code/interfaces/types_algod.ApplicationStateSchema.md @@ -27,7 +27,7 @@ https://developer.algorand.org/docs/rest-apis/algod/v2/#applicationstateschema #### Defined in -[types/algod.ts:125](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algod.ts#L125) +[src/types/algod.ts:125](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algod.ts#L125) ___ @@ -39,4 +39,4 @@ ___ #### Defined in -[types/algod.ts:127](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algod.ts#L127) +[src/types/algod.ts:127](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algod.ts#L127) diff --git a/docs/code/interfaces/types_algod.EvalDelta.md b/docs/code/interfaces/types_algod.EvalDelta.md index a20dd203..2327d2a3 100644 --- a/docs/code/interfaces/types_algod.EvalDelta.md +++ b/docs/code/interfaces/types_algod.EvalDelta.md @@ -26,7 +26,7 @@ https://developer.algorand.org/docs/rest-apis/algod/v2/#evaldelta #### Defined in -[types/algod.ts:67](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algod.ts#L67) +[src/types/algod.ts:67](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algod.ts#L67) ___ @@ -36,7 +36,7 @@ ___ #### Defined in -[types/algod.ts:68](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algod.ts#L68) +[src/types/algod.ts:68](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algod.ts#L68) ___ @@ -46,4 +46,4 @@ ___ #### Defined in -[types/algod.ts:69](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algod.ts#L69) +[src/types/algod.ts:69](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algod.ts#L69) diff --git a/docs/code/interfaces/types_algod.PendingTransactionResponse.md b/docs/code/interfaces/types_algod.PendingTransactionResponse.md index 739a4a93..1f80fcb6 100644 --- a/docs/code/interfaces/types_algod.PendingTransactionResponse.md +++ b/docs/code/interfaces/types_algod.PendingTransactionResponse.md @@ -40,7 +40,7 @@ application. #### Defined in -[types/algod.ts:9](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algod.ts#L9) +[src/types/algod.ts:9](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algod.ts#L9) ___ @@ -52,7 +52,7 @@ The number of the asset's unit that were transferred to the close-to address. #### Defined in -[types/algod.ts:13](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algod.ts#L13) +[src/types/algod.ts:13](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algod.ts#L13) ___ @@ -64,7 +64,7 @@ The asset id if the transaction was found and it created an asset. #### Defined in -[types/algod.ts:17](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algod.ts#L17) +[src/types/algod.ts:17](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algod.ts#L17) ___ @@ -76,7 +76,7 @@ Rewards in microalgos applied to the close remainder to account. #### Defined in -[types/algod.ts:21](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algod.ts#L21) +[src/types/algod.ts:21](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algod.ts#L21) ___ @@ -88,7 +88,7 @@ Closing amount for the transaction. #### Defined in -[types/algod.ts:25](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algod.ts#L25) +[src/types/algod.ts:25](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algod.ts#L25) ___ @@ -100,7 +100,7 @@ The round where this transaction was confirmed, if present. #### Defined in -[types/algod.ts:29](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algod.ts#L29) +[src/types/algod.ts:29](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algod.ts#L29) ___ @@ -113,7 +113,7 @@ transaction. #### Defined in -[types/algod.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algod.ts#L34) +[src/types/algod.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algod.ts#L34) ___ @@ -125,7 +125,7 @@ Inner transactions produced by application execution. #### Defined in -[types/algod.ts:38](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algod.ts#L38) +[src/types/algod.ts:38](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algod.ts#L38) ___ @@ -138,7 +138,7 @@ transaction. #### Defined in -[types/algod.ts:43](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algod.ts#L43) +[src/types/algod.ts:43](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algod.ts#L43) ___ @@ -150,7 +150,7 @@ ___ #### Defined in -[types/algod.ts:47](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algod.ts#L47) +[src/types/algod.ts:47](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algod.ts#L47) ___ @@ -163,7 +163,7 @@ An empty string indicates the transaction wasn't kicked out of this node's txpoo #### Defined in -[types/algod.ts:50](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algod.ts#L50) +[src/types/algod.ts:50](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algod.ts#L50) ___ @@ -175,7 +175,7 @@ Rewards in µALGOs applied to the receiver account. #### Defined in -[types/algod.ts:54](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algod.ts#L54) +[src/types/algod.ts:54](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algod.ts#L54) ___ @@ -187,7 +187,7 @@ Rewards in µALGOs applied to the sender account. #### Defined in -[types/algod.ts:58](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algod.ts#L58) +[src/types/algod.ts:58](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algod.ts#L58) ___ @@ -199,4 +199,4 @@ The raw signed transaction. #### Defined in -[types/algod.ts:62](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algod.ts#L62) +[src/types/algod.ts:62](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algod.ts#L62) diff --git a/docs/code/interfaces/types_app.ABIAppCallArgs.md b/docs/code/interfaces/types_app.ABIAppCallArgs.md index 9cb53a80..b4ce4ce6 100644 --- a/docs/code/interfaces/types_app.ABIAppCallArgs.md +++ b/docs/code/interfaces/types_app.ABIAppCallArgs.md @@ -25,7 +25,7 @@ The ABI args to pass in #### Defined in -[types/app.ts:71](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L71) +[src/types/app.ts:71](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L71) ___ @@ -37,7 +37,7 @@ Any box references to load #### Defined in -[types/app.ts:75](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L75) +[src/types/app.ts:75](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L75) ___ @@ -49,7 +49,7 @@ The optional lease for the transaction #### Defined in -[types/app.ts:73](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L73) +[src/types/app.ts:73](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L73) ___ @@ -63,4 +63,4 @@ The ABI method to call, either: #### Defined in -[types/app.ts:69](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L69) +[src/types/app.ts:69](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L69) diff --git a/docs/code/interfaces/types_app.AppCallParams.md b/docs/code/interfaces/types_app.AppCallParams.md index e2d28f36..f0c47cdf 100644 --- a/docs/code/interfaces/types_app.AppCallParams.md +++ b/docs/code/interfaces/types_app.AppCallParams.md @@ -39,7 +39,7 @@ The id of the app to call #### Defined in -[types/app.ts:114](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L114) +[src/types/app.ts:114](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L114) ___ @@ -51,7 +51,7 @@ The arguments passed in to the app call #### Defined in -[types/app.ts:124](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L124) +[src/types/app.ts:124](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L124) ___ @@ -63,7 +63,7 @@ The type of call, everything except create (@see createApp ) and update (@see up #### Defined in -[types/app.ts:116](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L116) +[src/types/app.ts:116](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L116) ___ @@ -79,7 +79,7 @@ The flat fee you want to pay, useful for covering extra fees in a transaction gr #### Defined in -[types/transaction.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L32) +[src/types/transaction.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L32) ___ @@ -91,7 +91,7 @@ The account to make the call from #### Defined in -[types/app.ts:118](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L118) +[src/types/app.ts:118](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L118) ___ @@ -107,7 +107,7 @@ The maximum fee that you are happy to pay (default: unbounded) - if this is set #### Defined in -[types/transaction.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L34) +[src/types/transaction.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L34) ___ @@ -123,7 +123,7 @@ The maximum number of rounds to wait for confirmation, only applies if `skipWait #### Defined in -[types/transaction.ts:36](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L36) +[src/types/transaction.ts:36](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L36) ___ @@ -135,7 +135,7 @@ The (optional) transaction note #### Defined in -[types/app.ts:122](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L122) +[src/types/app.ts:122](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L122) ___ @@ -152,7 +152,7 @@ Whether to skip signing and sending the transaction to the chain (default: trans #### Defined in -[types/transaction.ts:26](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L26) +[src/types/transaction.ts:26](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L26) ___ @@ -168,7 +168,7 @@ Whether to skip waiting for the submitted transaction (only relevant if `skipSen #### Defined in -[types/transaction.ts:28](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L28) +[src/types/transaction.ts:28](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L28) ___ @@ -184,7 +184,7 @@ Whether to suppress log messages from transaction send, default: do not suppress #### Defined in -[types/transaction.ts:30](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L30) +[src/types/transaction.ts:30](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L30) ___ @@ -196,4 +196,4 @@ Optional transaction parameters #### Defined in -[types/app.ts:120](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L120) +[src/types/app.ts:120](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L120) diff --git a/docs/code/interfaces/types_app.AppCallTransactionResult.md b/docs/code/interfaces/types_app.AppCallTransactionResult.md index a7f3e9ca..889ecd68 100644 --- a/docs/code/interfaces/types_app.AppCallTransactionResult.md +++ b/docs/code/interfaces/types_app.AppCallTransactionResult.md @@ -34,7 +34,7 @@ The response if the transaction was sent and waited for #### Defined in -[types/transaction.ts:44](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L44) +[src/types/transaction.ts:44](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L44) ___ @@ -46,7 +46,7 @@ If an ABI method was called the processed return value #### Defined in -[types/app.ts:156](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L156) +[src/types/app.ts:158](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L158) ___ @@ -62,4 +62,4 @@ The transaction #### Defined in -[types/transaction.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L42) +[src/types/transaction.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L42) diff --git a/docs/code/interfaces/types_app.AppCompilationResult.md b/docs/code/interfaces/types_app.AppCompilationResult.md new file mode 100644 index 00000000..02203a47 --- /dev/null +++ b/docs/code/interfaces/types_app.AppCompilationResult.md @@ -0,0 +1,38 @@ +[@algorandfoundation/algokit-utils](../README.md) / [types/app](../modules/types_app.md) / AppCompilationResult + +# Interface: AppCompilationResult + +[types/app](../modules/types_app.md).AppCompilationResult + +The result of compiling the approval and clear TEAL for an app + +## Table of contents + +### Properties + +- [compiledApproval](types_app.AppCompilationResult.md#compiledapproval) +- [compiledClear](types_app.AppCompilationResult.md#compiledclear) + +## Properties + +### compiledApproval + +• **compiledApproval**: [`CompiledTeal`](types_app.CompiledTeal.md) + +The compilation result of approval + +#### Defined in + +[src/types/app.ts:254](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L254) + +___ + +### compiledClear + +• **compiledClear**: [`CompiledTeal`](types_app.CompiledTeal.md) + +The compilation result of clear + +#### Defined in + +[src/types/app.ts:256](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L256) diff --git a/docs/code/interfaces/types_app.AppDeployMetadata.md b/docs/code/interfaces/types_app.AppDeployMetadata.md index cfc1b6b4..d2b37466 100644 --- a/docs/code/interfaces/types_app.AppDeployMetadata.md +++ b/docs/code/interfaces/types_app.AppDeployMetadata.md @@ -35,7 +35,7 @@ Whether or not the app is deletable / permanent / unspecified #### Defined in -[types/app.ts:177](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L177) +[src/types/app.ts:179](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L179) ___ @@ -47,7 +47,7 @@ The unique name identifier of the app within the creator account #### Defined in -[types/app.ts:173](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L173) +[src/types/app.ts:175](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L175) ___ @@ -59,7 +59,7 @@ Whether or not the app is updatable / immutable / unspecified #### Defined in -[types/app.ts:179](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L179) +[src/types/app.ts:181](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L181) ___ @@ -71,4 +71,4 @@ The version of app that is / will be deployed #### Defined in -[types/app.ts:175](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L175) +[src/types/app.ts:177](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L177) diff --git a/docs/code/interfaces/types_app.AppDeploymentParams.md b/docs/code/interfaces/types_app.AppDeploymentParams.md index 95a74973..760efe5c 100644 --- a/docs/code/interfaces/types_app.AppDeploymentParams.md +++ b/docs/code/interfaces/types_app.AppDeploymentParams.md @@ -48,7 +48,7 @@ Omit.approvalProgram #### Defined in -[types/app.ts:89](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L89) +[src/types/app.ts:89](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L89) ___ @@ -64,7 +64,7 @@ Omit.clearStateProgram #### Defined in -[types/app.ts:91](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L91) +[src/types/app.ts:91](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L91) ___ @@ -76,7 +76,7 @@ Any args to pass to any create transaction that is issued as part of deployment #### Defined in -[types/app.ts:242](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L242) +[src/types/app.ts:244](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L244) ___ @@ -88,7 +88,7 @@ Any args to pass to any delete transaction that is issued as part of deployment #### Defined in -[types/app.ts:246](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L246) +[src/types/app.ts:248](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L248) ___ @@ -100,7 +100,7 @@ Any deploy-time parameters to replace in the TEAL code #### Defined in -[types/app.ts:234](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L234) +[src/types/app.ts:236](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L236) ___ @@ -112,7 +112,7 @@ Optional cached value of the existing apps for the given creator #### Defined in -[types/app.ts:240](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L240) +[src/types/app.ts:242](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L242) ___ @@ -128,7 +128,7 @@ Omit.fee #### Defined in -[types/transaction.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L32) +[src/types/transaction.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L32) ___ @@ -144,7 +144,7 @@ Omit.from #### Defined in -[types/app.ts:87](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L87) +[src/types/app.ts:87](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L87) ___ @@ -160,7 +160,7 @@ Omit.maxFee #### Defined in -[types/transaction.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L34) +[src/types/transaction.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L34) ___ @@ -176,7 +176,7 @@ Omit.maxRoundsToWaitForConfirmation #### Defined in -[types/transaction.ts:36](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L36) +[src/types/transaction.ts:36](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L36) ___ @@ -188,7 +188,7 @@ The deployment metadata #### Defined in -[types/app.ts:232](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L232) +[src/types/app.ts:234](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L234) ___ @@ -200,7 +200,7 @@ What action to perform if a schema break is detected #### Defined in -[types/app.ts:236](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L236) +[src/types/app.ts:238](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L238) ___ @@ -212,7 +212,7 @@ What action to perform if a TEAL update is detected #### Defined in -[types/app.ts:238](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L238) +[src/types/app.ts:240](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L240) ___ @@ -228,7 +228,7 @@ Omit.schema #### Defined in -[types/app.ts:103](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L103) +[src/types/app.ts:103](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L103) ___ @@ -244,7 +244,7 @@ Omit.suppressLog #### Defined in -[types/transaction.ts:30](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L30) +[src/types/transaction.ts:30](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L30) ___ @@ -260,7 +260,7 @@ Omit.transactionParams #### Defined in -[types/app.ts:93](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L93) +[src/types/app.ts:93](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L93) ___ @@ -272,4 +272,4 @@ Any args to pass to any update transaction that is issued as part of deployment #### Defined in -[types/app.ts:244](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L244) +[src/types/app.ts:246](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L246) diff --git a/docs/code/interfaces/types_app.AppLookup.md b/docs/code/interfaces/types_app.AppLookup.md index 5675dd42..19828dd9 100644 --- a/docs/code/interfaces/types_app.AppLookup.md +++ b/docs/code/interfaces/types_app.AppLookup.md @@ -21,7 +21,7 @@ A lookup of name -> Algorand app for a creator #### Defined in -[types/app.ts:197](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L197) +[src/types/app.ts:199](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L199) ___ @@ -31,4 +31,4 @@ ___ #### Defined in -[types/app.ts:196](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L196) +[src/types/app.ts:198](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L198) diff --git a/docs/code/interfaces/types_app.AppMetadata.md b/docs/code/interfaces/types_app.AppMetadata.md index a911ac3c..a24aff97 100644 --- a/docs/code/interfaces/types_app.AppMetadata.md +++ b/docs/code/interfaces/types_app.AppMetadata.md @@ -43,7 +43,7 @@ The Algorand address of the account associated with the app #### Defined in -[types/app.ts:24](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L24) +[src/types/app.ts:24](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L24) ___ @@ -59,7 +59,7 @@ The id of the app #### Defined in -[types/app.ts:22](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L22) +[src/types/app.ts:22](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L22) ___ @@ -71,7 +71,7 @@ The metadata when the app was created #### Defined in -[types/app.ts:189](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L189) +[src/types/app.ts:191](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L191) ___ @@ -83,7 +83,7 @@ The round the app was created #### Defined in -[types/app.ts:185](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L185) +[src/types/app.ts:187](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L187) ___ @@ -99,7 +99,7 @@ Whether or not the app is deletable / permanent / unspecified #### Defined in -[types/app.ts:177](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L177) +[src/types/app.ts:179](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L179) ___ @@ -111,7 +111,7 @@ Whether or not the app is deleted #### Defined in -[types/app.ts:191](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L191) +[src/types/app.ts:193](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L193) ___ @@ -127,7 +127,7 @@ The unique name identifier of the app within the creator account #### Defined in -[types/app.ts:173](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L173) +[src/types/app.ts:175](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L175) ___ @@ -143,7 +143,7 @@ Whether or not the app is updatable / immutable / unspecified #### Defined in -[types/app.ts:179](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L179) +[src/types/app.ts:181](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L181) ___ @@ -155,7 +155,7 @@ The last round that the app was updated #### Defined in -[types/app.ts:187](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L187) +[src/types/app.ts:189](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L189) ___ @@ -171,4 +171,4 @@ The version of app that is / will be deployed #### Defined in -[types/app.ts:175](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L175) +[src/types/app.ts:177](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L177) diff --git a/docs/code/interfaces/types_app.AppReference.md b/docs/code/interfaces/types_app.AppReference.md index 13d098c3..960bfebe 100644 --- a/docs/code/interfaces/types_app.AppReference.md +++ b/docs/code/interfaces/types_app.AppReference.md @@ -29,7 +29,7 @@ The Algorand address of the account associated with the app #### Defined in -[types/app.ts:24](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L24) +[src/types/app.ts:24](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L24) ___ @@ -41,4 +41,4 @@ The id of the app #### Defined in -[types/app.ts:22](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L22) +[src/types/app.ts:22](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L22) diff --git a/docs/code/interfaces/types_app.AppStorageSchema.md b/docs/code/interfaces/types_app.AppStorageSchema.md index 77fc5421..944b3433 100644 --- a/docs/code/interfaces/types_app.AppStorageSchema.md +++ b/docs/code/interfaces/types_app.AppStorageSchema.md @@ -26,7 +26,7 @@ Any extra pages that are needed for the smart contract; if left blank then the r #### Defined in -[types/app.ts:138](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L138) +[src/types/app.ts:138](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L138) ___ @@ -38,7 +38,7 @@ Restricts number of byte slices in global state #### Defined in -[types/app.ts:136](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L136) +[src/types/app.ts:136](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L136) ___ @@ -50,7 +50,7 @@ Restricts number of ints in global state #### Defined in -[types/app.ts:134](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L134) +[src/types/app.ts:134](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L134) ___ @@ -62,7 +62,7 @@ Restricts number of byte slices in per-user local state #### Defined in -[types/app.ts:132](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L132) +[src/types/app.ts:132](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L132) ___ @@ -74,4 +74,4 @@ Restricts number of ints in per-user local state #### Defined in -[types/app.ts:130](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L130) +[src/types/app.ts:130](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L130) diff --git a/docs/code/interfaces/types_app.BoxReference.md b/docs/code/interfaces/types_app.BoxReference.md index 3010f5d9..d7879cf4 100644 --- a/docs/code/interfaces/types_app.BoxReference.md +++ b/docs/code/interfaces/types_app.BoxReference.md @@ -23,7 +23,7 @@ A unique application id #### Defined in -[types/app.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L34) +[src/types/app.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L34) ___ @@ -35,4 +35,4 @@ Name of box to reference #### Defined in -[types/app.ts:38](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L38) +[src/types/app.ts:38](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L38) diff --git a/docs/code/interfaces/types_app.CompiledTeal.md b/docs/code/interfaces/types_app.CompiledTeal.md index e5623e1c..2dc67335 100644 --- a/docs/code/interfaces/types_app.CompiledTeal.md +++ b/docs/code/interfaces/types_app.CompiledTeal.md @@ -13,6 +13,7 @@ Information about a compiled teal program - [compiled](types_app.CompiledTeal.md#compiled) - [compiledBase64ToBytes](types_app.CompiledTeal.md#compiledbase64tobytes) - [compiledHash](types_app.CompiledTeal.md#compiledhash) +- [sourceMap](types_app.CompiledTeal.md#sourcemap) - [teal](types_app.CompiledTeal.md#teal) ## Properties @@ -25,7 +26,7 @@ The compiled code #### Defined in -[types/app.ts:146](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L146) +[src/types/app.ts:146](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L146) ___ @@ -37,7 +38,7 @@ The base64 encoded code as a byte array #### Defined in -[types/app.ts:150](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L150) +[src/types/app.ts:150](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L150) ___ @@ -49,7 +50,19 @@ The has returned by the compiler #### Defined in -[types/app.ts:148](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L148) +[src/types/app.ts:148](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L148) + +___ + +### sourceMap + +• **sourceMap**: `SourceMap` + +Source map from the compilation + +#### Defined in + +[src/types/app.ts:152](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L152) ___ @@ -61,4 +74,4 @@ Original TEAL code #### Defined in -[types/app.ts:144](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L144) +[src/types/app.ts:144](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L144) diff --git a/docs/code/interfaces/types_app.CreateAppParams.md b/docs/code/interfaces/types_app.CreateAppParams.md index 4033c011..c35ab963 100644 --- a/docs/code/interfaces/types_app.CreateAppParams.md +++ b/docs/code/interfaces/types_app.CreateAppParams.md @@ -44,7 +44,7 @@ CreateOrUpdateAppParams.approvalProgram #### Defined in -[types/app.ts:89](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L89) +[src/types/app.ts:89](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L89) ___ @@ -60,7 +60,7 @@ CreateOrUpdateAppParams.args #### Defined in -[types/app.ts:97](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L97) +[src/types/app.ts:97](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L97) ___ @@ -76,7 +76,7 @@ CreateOrUpdateAppParams.clearStateProgram #### Defined in -[types/app.ts:91](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L91) +[src/types/app.ts:91](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L91) ___ @@ -92,7 +92,7 @@ CreateOrUpdateAppParams.fee #### Defined in -[types/transaction.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L32) +[src/types/transaction.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L32) ___ @@ -108,7 +108,7 @@ CreateOrUpdateAppParams.from #### Defined in -[types/app.ts:87](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L87) +[src/types/app.ts:87](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L87) ___ @@ -124,7 +124,7 @@ CreateOrUpdateAppParams.maxFee #### Defined in -[types/transaction.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L34) +[src/types/transaction.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L34) ___ @@ -140,7 +140,7 @@ CreateOrUpdateAppParams.maxRoundsToWaitForConfirmation #### Defined in -[types/transaction.ts:36](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L36) +[src/types/transaction.ts:36](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L36) ___ @@ -156,7 +156,7 @@ CreateOrUpdateAppParams.note #### Defined in -[types/app.ts:95](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L95) +[src/types/app.ts:95](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L95) ___ @@ -168,7 +168,7 @@ The storage schema to request for the created app #### Defined in -[types/app.ts:103](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L103) +[src/types/app.ts:103](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L103) ___ @@ -185,7 +185,7 @@ CreateOrUpdateAppParams.skipSending #### Defined in -[types/transaction.ts:26](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L26) +[src/types/transaction.ts:26](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L26) ___ @@ -201,7 +201,7 @@ CreateOrUpdateAppParams.skipWaiting #### Defined in -[types/transaction.ts:28](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L28) +[src/types/transaction.ts:28](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L28) ___ @@ -217,7 +217,7 @@ CreateOrUpdateAppParams.suppressLog #### Defined in -[types/transaction.ts:30](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L30) +[src/types/transaction.ts:30](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L30) ___ @@ -233,4 +233,4 @@ CreateOrUpdateAppParams.transactionParams #### Defined in -[types/app.ts:93](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L93) +[src/types/app.ts:93](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L93) diff --git a/docs/code/interfaces/types_app.RawAppCallArgs.md b/docs/code/interfaces/types_app.RawAppCallArgs.md index fddf6e14..a1ed9d49 100644 --- a/docs/code/interfaces/types_app.RawAppCallArgs.md +++ b/docs/code/interfaces/types_app.RawAppCallArgs.md @@ -27,7 +27,7 @@ The address of any accounts to load in #### Defined in -[types/app.ts:46](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L46) +[src/types/app.ts:46](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L46) ___ @@ -39,7 +39,7 @@ Any application arguments to pass through #### Defined in -[types/app.ts:48](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L48) +[src/types/app.ts:48](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L48) ___ @@ -51,7 +51,7 @@ IDs of any apps to load into the foreignApps array #### Defined in -[types/app.ts:52](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L52) +[src/types/app.ts:52](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L52) ___ @@ -63,7 +63,7 @@ IDs of any assets to load into the foreignAssets array #### Defined in -[types/app.ts:54](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L54) +[src/types/app.ts:54](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L54) ___ @@ -75,7 +75,7 @@ Any box references to load #### Defined in -[types/app.ts:50](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L50) +[src/types/app.ts:50](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L50) ___ @@ -87,4 +87,4 @@ The optional lease for the transaction #### Defined in -[types/app.ts:56](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L56) +[src/types/app.ts:56](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L56) diff --git a/docs/code/interfaces/types_app.UpdateAppParams.md b/docs/code/interfaces/types_app.UpdateAppParams.md index 26df8468..ba11dac1 100644 --- a/docs/code/interfaces/types_app.UpdateAppParams.md +++ b/docs/code/interfaces/types_app.UpdateAppParams.md @@ -40,7 +40,7 @@ The id of the app to update #### Defined in -[types/app.ts:109](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L109) +[src/types/app.ts:109](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L109) ___ @@ -56,7 +56,7 @@ CreateOrUpdateAppParams.approvalProgram #### Defined in -[types/app.ts:89](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L89) +[src/types/app.ts:89](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L89) ___ @@ -72,7 +72,7 @@ CreateOrUpdateAppParams.args #### Defined in -[types/app.ts:97](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L97) +[src/types/app.ts:97](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L97) ___ @@ -88,7 +88,7 @@ CreateOrUpdateAppParams.clearStateProgram #### Defined in -[types/app.ts:91](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L91) +[src/types/app.ts:91](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L91) ___ @@ -104,7 +104,7 @@ CreateOrUpdateAppParams.fee #### Defined in -[types/transaction.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L32) +[src/types/transaction.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L32) ___ @@ -120,7 +120,7 @@ CreateOrUpdateAppParams.from #### Defined in -[types/app.ts:87](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L87) +[src/types/app.ts:87](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L87) ___ @@ -136,7 +136,7 @@ CreateOrUpdateAppParams.maxFee #### Defined in -[types/transaction.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L34) +[src/types/transaction.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L34) ___ @@ -152,7 +152,7 @@ CreateOrUpdateAppParams.maxRoundsToWaitForConfirmation #### Defined in -[types/transaction.ts:36](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L36) +[src/types/transaction.ts:36](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L36) ___ @@ -168,7 +168,7 @@ CreateOrUpdateAppParams.note #### Defined in -[types/app.ts:95](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L95) +[src/types/app.ts:95](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L95) ___ @@ -185,7 +185,7 @@ CreateOrUpdateAppParams.skipSending #### Defined in -[types/transaction.ts:26](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L26) +[src/types/transaction.ts:26](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L26) ___ @@ -201,7 +201,7 @@ CreateOrUpdateAppParams.skipWaiting #### Defined in -[types/transaction.ts:28](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L28) +[src/types/transaction.ts:28](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L28) ___ @@ -217,7 +217,7 @@ CreateOrUpdateAppParams.suppressLog #### Defined in -[types/transaction.ts:30](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L30) +[src/types/transaction.ts:30](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L30) ___ @@ -233,4 +233,4 @@ CreateOrUpdateAppParams.transactionParams #### Defined in -[types/app.ts:93](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L93) +[src/types/app.ts:93](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L93) diff --git a/docs/code/interfaces/types_application_client.AppClientDeployParams.md b/docs/code/interfaces/types_application_client.AppClientDeployParams.md index a52afb90..b03c2daf 100644 --- a/docs/code/interfaces/types_application_client.AppClientDeployParams.md +++ b/docs/code/interfaces/types_application_client.AppClientDeployParams.md @@ -33,7 +33,7 @@ If this is not specified then it will automatically be determined based on the A #### Defined in -[types/application-client.ts:74](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L74) +[src/types/application-client.ts:75](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L75) ___ @@ -46,7 +46,7 @@ If this is not specified then it will automatically be determined based on the A #### Defined in -[types/application-client.ts:70](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L70) +[src/types/application-client.ts:71](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L71) ___ @@ -58,7 +58,7 @@ Any args to pass to any create transaction that is issued as part of deployment #### Defined in -[types/application-client.ts:84](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L84) +[src/types/application-client.ts:85](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L85) ___ @@ -70,7 +70,7 @@ Any args to pass to any delete transaction that is issued as part of deployment #### Defined in -[types/application-client.ts:88](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L88) +[src/types/application-client.ts:89](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L89) ___ @@ -82,7 +82,7 @@ Any deploy-time parameters to replace in the TEAL code #### Defined in -[types/application-client.ts:78](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L78) +[src/types/application-client.ts:79](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L79) ___ @@ -94,7 +94,7 @@ What action to perform if a schema break is detected #### Defined in -[types/application-client.ts:80](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L80) +[src/types/application-client.ts:81](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L81) ___ @@ -106,7 +106,7 @@ What action to perform if a TEAL update is detected #### Defined in -[types/application-client.ts:82](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L82) +[src/types/application-client.ts:83](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L83) ___ @@ -118,7 +118,7 @@ Parameters to control transaction sending #### Defined in -[types/application-client.ts:76](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L76) +[src/types/application-client.ts:77](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L77) ___ @@ -130,7 +130,7 @@ The optional sender to send the transaction from, will use the application clien #### Defined in -[types/application-client.ts:66](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L66) +[src/types/application-client.ts:67](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L67) ___ @@ -142,7 +142,7 @@ Any args to pass to any update transaction that is issued as part of deployment #### Defined in -[types/application-client.ts:86](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L86) +[src/types/application-client.ts:87](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L87) ___ @@ -154,4 +154,4 @@ The version of the contract, uses "1.0" by default #### Defined in -[types/application-client.ts:64](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L64) +[src/types/application-client.ts:65](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L65) diff --git a/docs/code/interfaces/types_application_client.ResolveAppById.md b/docs/code/interfaces/types_application_client.ResolveAppById.md index 7fe3a23f..dde5e6d7 100644 --- a/docs/code/interfaces/types_application_client.ResolveAppById.md +++ b/docs/code/interfaces/types_application_client.ResolveAppById.md @@ -23,7 +23,7 @@ The id of an existing app to call using this client, or 0 if the app hasn't been #### Defined in -[types/application-client.ts:43](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L43) +[src/types/application-client.ts:44](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L44) ___ @@ -39,4 +39,4 @@ ApplicationClient.deploy (default: uses the name in the ABI contract) #### Defined in -[types/application-client.ts:45](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L45) +[src/types/application-client.ts:46](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L46) diff --git a/docs/code/interfaces/types_appspec.AppSources.md b/docs/code/interfaces/types_appspec.AppSources.md index e6ed1850..4ec88fa7 100644 --- a/docs/code/interfaces/types_appspec.AppSources.md +++ b/docs/code/interfaces/types_appspec.AppSources.md @@ -19,7 +19,7 @@ #### Defined in -[types/appspec.ts:22](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L22) +[src/types/appspec.ts:22](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L22) ___ @@ -29,4 +29,4 @@ ___ #### Defined in -[types/appspec.ts:23](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L23) +[src/types/appspec.ts:23](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L23) diff --git a/docs/code/interfaces/types_appspec.AppSpec.md b/docs/code/interfaces/types_appspec.AppSpec.md index 218e002a..0cdea7c6 100644 --- a/docs/code/interfaces/types_appspec.AppSpec.md +++ b/docs/code/interfaces/types_appspec.AppSpec.md @@ -34,7 +34,7 @@ #### Defined in -[types/appspec.ts:9](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L9) +[src/types/appspec.ts:9](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L9) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[types/appspec.ts:7](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L7) +[src/types/appspec.ts:7](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L7) ___ @@ -54,7 +54,7 @@ ___ #### Defined in -[types/appspec.ts:4](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L4) +[src/types/appspec.ts:4](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L4) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[types/appspec.ts:5](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L5) +[src/types/appspec.ts:5](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L5) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[types/appspec.ts:6](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L6) +[src/types/appspec.ts:6](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L6) ___ @@ -84,4 +84,4 @@ ___ #### Defined in -[types/appspec.ts:8](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L8) +[src/types/appspec.ts:8](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L8) diff --git a/docs/code/interfaces/types_appspec.DeclaredSchemaValueSpec.md b/docs/code/interfaces/types_appspec.DeclaredSchemaValueSpec.md index 01581fa5..6cc20cf5 100644 --- a/docs/code/interfaces/types_appspec.DeclaredSchemaValueSpec.md +++ b/docs/code/interfaces/types_appspec.DeclaredSchemaValueSpec.md @@ -21,7 +21,7 @@ #### Defined in -[types/appspec.ts:61](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L61) +[src/types/appspec.ts:61](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L61) ___ @@ -31,7 +31,7 @@ ___ #### Defined in -[types/appspec.ts:60](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L60) +[src/types/appspec.ts:60](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L60) ___ @@ -41,7 +41,7 @@ ___ #### Defined in -[types/appspec.ts:62](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L62) +[src/types/appspec.ts:62](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L62) ___ @@ -51,4 +51,4 @@ ___ #### Defined in -[types/appspec.ts:59](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L59) +[src/types/appspec.ts:59](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L59) diff --git a/docs/code/interfaces/types_appspec.DefaultArgument.md b/docs/code/interfaces/types_appspec.DefaultArgument.md index c9c0ed74..e87f79bb 100644 --- a/docs/code/interfaces/types_appspec.DefaultArgument.md +++ b/docs/code/interfaces/types_appspec.DefaultArgument.md @@ -19,7 +19,7 @@ #### Defined in -[types/appspec.ts:51](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L51) +[src/types/appspec.ts:51](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L51) ___ @@ -29,4 +29,4 @@ ___ #### Defined in -[types/appspec.ts:50](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L50) +[src/types/appspec.ts:50](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L50) diff --git a/docs/code/interfaces/types_appspec.Hint.md b/docs/code/interfaces/types_appspec.Hint.md index f2c64185..123f1758 100644 --- a/docs/code/interfaces/types_appspec.Hint.md +++ b/docs/code/interfaces/types_appspec.Hint.md @@ -32,7 +32,7 @@ #### Defined in -[types/appspec.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L32) +[src/types/appspec.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L32) ___ @@ -42,7 +42,7 @@ ___ #### Defined in -[types/appspec.ts:31](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L31) +[src/types/appspec.ts:31](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L31) ___ @@ -52,7 +52,7 @@ ___ #### Defined in -[types/appspec.ts:30](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L30) +[src/types/appspec.ts:30](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L30) ___ @@ -62,4 +62,4 @@ ___ #### Defined in -[types/appspec.ts:29](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L29) +[src/types/appspec.ts:29](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L29) diff --git a/docs/code/interfaces/types_appspec.ReservedSchemaValueSpec.md b/docs/code/interfaces/types_appspec.ReservedSchemaValueSpec.md index 3e31ad86..0f865fe4 100644 --- a/docs/code/interfaces/types_appspec.ReservedSchemaValueSpec.md +++ b/docs/code/interfaces/types_appspec.ReservedSchemaValueSpec.md @@ -20,7 +20,7 @@ #### Defined in -[types/appspec.ts:67](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L67) +[src/types/appspec.ts:67](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L67) ___ @@ -30,7 +30,7 @@ ___ #### Defined in -[types/appspec.ts:68](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L68) +[src/types/appspec.ts:68](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L68) ___ @@ -40,4 +40,4 @@ ___ #### Defined in -[types/appspec.ts:66](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L66) +[src/types/appspec.ts:66](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L66) diff --git a/docs/code/interfaces/types_appspec.Schema.md b/docs/code/interfaces/types_appspec.Schema.md index 15176c88..1784a4f8 100644 --- a/docs/code/interfaces/types_appspec.Schema.md +++ b/docs/code/interfaces/types_appspec.Schema.md @@ -19,7 +19,7 @@ #### Defined in -[types/appspec.ts:77](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L77) +[src/types/appspec.ts:77](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L77) ___ @@ -29,4 +29,4 @@ ___ #### Defined in -[types/appspec.ts:78](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L78) +[src/types/appspec.ts:78](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L78) diff --git a/docs/code/interfaces/types_appspec.SchemaSpec.md b/docs/code/interfaces/types_appspec.SchemaSpec.md index d89130ed..ff41f6ff 100644 --- a/docs/code/interfaces/types_appspec.SchemaSpec.md +++ b/docs/code/interfaces/types_appspec.SchemaSpec.md @@ -19,7 +19,7 @@ #### Defined in -[types/appspec.ts:73](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L73) +[src/types/appspec.ts:73](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L73) ___ @@ -29,4 +29,4 @@ ___ #### Defined in -[types/appspec.ts:72](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L72) +[src/types/appspec.ts:72](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L72) diff --git a/docs/code/interfaces/types_appspec.StateSchemaSpec.md b/docs/code/interfaces/types_appspec.StateSchemaSpec.md index fac1bbfb..8811b481 100644 --- a/docs/code/interfaces/types_appspec.StateSchemaSpec.md +++ b/docs/code/interfaces/types_appspec.StateSchemaSpec.md @@ -19,7 +19,7 @@ #### Defined in -[types/appspec.ts:82](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L82) +[src/types/appspec.ts:82](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L82) ___ @@ -29,4 +29,4 @@ ___ #### Defined in -[types/appspec.ts:83](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L83) +[src/types/appspec.ts:83](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L83) diff --git a/docs/code/interfaces/types_appspec.Struct.md b/docs/code/interfaces/types_appspec.Struct.md index 3493ddf4..e6d4dc17 100644 --- a/docs/code/interfaces/types_appspec.Struct.md +++ b/docs/code/interfaces/types_appspec.Struct.md @@ -19,7 +19,7 @@ #### Defined in -[types/appspec.ts:46](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L46) +[src/types/appspec.ts:46](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L46) ___ @@ -29,4 +29,4 @@ ___ #### Defined in -[types/appspec.ts:45](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L45) +[src/types/appspec.ts:45](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L45) diff --git a/docs/code/interfaces/types_config.Config.md b/docs/code/interfaces/types_config.Config.md index 371a5a8f..c16f83c6 100644 --- a/docs/code/interfaces/types_config.Config.md +++ b/docs/code/interfaces/types_config.Config.md @@ -20,4 +20,4 @@ The AlgoKit configuration type #### Defined in -[types/config.ts:5](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/config.ts#L5) +[src/types/config.ts:5](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/config.ts#L5) diff --git a/docs/code/interfaces/types_indexer.AccountLookupResult.md b/docs/code/interfaces/types_indexer.AccountLookupResult.md index 03d21971..41ef5192 100644 --- a/docs/code/interfaces/types_indexer.AccountLookupResult.md +++ b/docs/code/interfaces/types_indexer.AccountLookupResult.md @@ -21,7 +21,7 @@ https://developer.algorand.org/docs/rest-apis/indexer/#get-v2accountsaccount-id #### Defined in -[types/indexer.ts:14](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L14) +[src/types/indexer.ts:14](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L14) ___ @@ -31,4 +31,4 @@ ___ #### Defined in -[types/indexer.ts:13](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L13) +[src/types/indexer.ts:13](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L13) diff --git a/docs/code/interfaces/types_indexer.AccountResult.md b/docs/code/interfaces/types_indexer.AccountResult.md index 5ab11bfa..4027a8f2 100644 --- a/docs/code/interfaces/types_indexer.AccountResult.md +++ b/docs/code/interfaces/types_indexer.AccountResult.md @@ -34,7 +34,7 @@ #### Defined in -[types/indexer.ts:94](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L94) +[src/types/indexer.ts:94](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L94) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[types/indexer.ts:95](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L95) +[src/types/indexer.ts:95](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L95) ___ @@ -54,7 +54,7 @@ ___ #### Defined in -[types/indexer.ts:96](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L96) +[src/types/indexer.ts:96](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L96) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[types/indexer.ts:97](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L97) +[src/types/indexer.ts:97](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L97) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[types/indexer.ts:98](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L98) +[src/types/indexer.ts:98](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L98) ___ @@ -84,7 +84,7 @@ ___ #### Defined in -[types/indexer.ts:99](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L99) +[src/types/indexer.ts:99](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L99) ___ @@ -94,7 +94,7 @@ ___ #### Defined in -[types/indexer.ts:100](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L100) +[src/types/indexer.ts:100](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L100) ___ @@ -104,7 +104,7 @@ ___ #### Defined in -[types/indexer.ts:101](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L101) +[src/types/indexer.ts:101](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L101) ___ @@ -114,7 +114,7 @@ ___ #### Defined in -[types/indexer.ts:102](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L102) +[src/types/indexer.ts:102](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L102) ___ @@ -124,7 +124,7 @@ ___ #### Defined in -[types/indexer.ts:103](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L103) +[src/types/indexer.ts:103](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L103) ___ @@ -134,7 +134,7 @@ ___ #### Defined in -[types/indexer.ts:104](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L104) +[src/types/indexer.ts:104](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L104) ___ @@ -144,7 +144,7 @@ ___ #### Defined in -[types/indexer.ts:105](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L105) +[src/types/indexer.ts:105](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L105) ___ @@ -154,7 +154,7 @@ ___ #### Defined in -[types/indexer.ts:106](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L106) +[src/types/indexer.ts:106](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L106) ___ @@ -164,7 +164,7 @@ ___ #### Defined in -[types/indexer.ts:107](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L107) +[src/types/indexer.ts:107](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L107) ___ @@ -174,7 +174,7 @@ ___ #### Defined in -[types/indexer.ts:108](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L108) +[src/types/indexer.ts:108](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L108) ___ @@ -184,7 +184,7 @@ ___ #### Defined in -[types/indexer.ts:109](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L109) +[src/types/indexer.ts:109](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L109) ___ @@ -194,4 +194,4 @@ ___ #### Defined in -[types/indexer.ts:110](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L110) +[src/types/indexer.ts:110](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L110) diff --git a/docs/code/interfaces/types_indexer.AppLocalState.md b/docs/code/interfaces/types_indexer.AppLocalState.md index c6c852c1..c2122568 100644 --- a/docs/code/interfaces/types_indexer.AppLocalState.md +++ b/docs/code/interfaces/types_indexer.AppLocalState.md @@ -23,7 +23,7 @@ #### Defined in -[types/indexer.ts:309](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L309) +[src/types/indexer.ts:309](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L309) ___ @@ -33,7 +33,7 @@ ___ #### Defined in -[types/indexer.ts:310](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L310) +[src/types/indexer.ts:310](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L310) ___ @@ -43,7 +43,7 @@ ___ #### Defined in -[types/indexer.ts:311](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L311) +[src/types/indexer.ts:311](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L311) ___ @@ -53,7 +53,7 @@ ___ #### Defined in -[types/indexer.ts:312](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L312) +[src/types/indexer.ts:312](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L312) ___ @@ -63,7 +63,7 @@ ___ #### Defined in -[types/indexer.ts:313](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L313) +[src/types/indexer.ts:313](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L313) ___ @@ -73,4 +73,4 @@ ___ #### Defined in -[types/indexer.ts:314](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L314) +[src/types/indexer.ts:314](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L314) diff --git a/docs/code/interfaces/types_indexer.ApplicationCreatedLookupResult.md b/docs/code/interfaces/types_indexer.ApplicationCreatedLookupResult.md index 14281a04..16f4e4bb 100644 --- a/docs/code/interfaces/types_indexer.ApplicationCreatedLookupResult.md +++ b/docs/code/interfaces/types_indexer.ApplicationCreatedLookupResult.md @@ -22,7 +22,7 @@ https://developer.algorand.org/docs/rest-apis/indexer/#get-v2accountsaccount-idc #### Defined in -[types/indexer.ts:35](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L35) +[src/types/indexer.ts:35](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L35) ___ @@ -32,7 +32,7 @@ ___ #### Defined in -[types/indexer.ts:33](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L33) +[src/types/indexer.ts:33](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L33) ___ @@ -42,4 +42,4 @@ ___ #### Defined in -[types/indexer.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L34) +[src/types/indexer.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L34) diff --git a/docs/code/interfaces/types_indexer.ApplicationLookupResult.md b/docs/code/interfaces/types_indexer.ApplicationLookupResult.md index cd5eb8bb..3bdb715e 100644 --- a/docs/code/interfaces/types_indexer.ApplicationLookupResult.md +++ b/docs/code/interfaces/types_indexer.ApplicationLookupResult.md @@ -21,7 +21,7 @@ https://developer.algorand.org/docs/rest-apis/indexer/#get-v2applicationsapplica #### Defined in -[types/indexer.ts:53](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L53) +[src/types/indexer.ts:53](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L53) ___ @@ -31,4 +31,4 @@ ___ #### Defined in -[types/indexer.ts:52](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L52) +[src/types/indexer.ts:52](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L52) diff --git a/docs/code/interfaces/types_indexer.ApplicationParams.md b/docs/code/interfaces/types_indexer.ApplicationParams.md index caa2e397..d399ccbb 100644 --- a/docs/code/interfaces/types_indexer.ApplicationParams.md +++ b/docs/code/interfaces/types_indexer.ApplicationParams.md @@ -24,7 +24,7 @@ #### Defined in -[types/indexer.ts:200](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L200) +[src/types/indexer.ts:200](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L200) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[types/indexer.ts:201](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L201) +[src/types/indexer.ts:201](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L201) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[types/indexer.ts:199](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L199) +[src/types/indexer.ts:199](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L199) ___ @@ -54,7 +54,7 @@ ___ #### Defined in -[types/indexer.ts:202](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L202) +[src/types/indexer.ts:202](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L202) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[types/indexer.ts:203](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L203) +[src/types/indexer.ts:203](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L203) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[types/indexer.ts:204](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L204) +[src/types/indexer.ts:204](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L204) ___ @@ -84,4 +84,4 @@ ___ #### Defined in -[types/indexer.ts:205](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L205) +[src/types/indexer.ts:205](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L205) diff --git a/docs/code/interfaces/types_indexer.ApplicationResult.md b/docs/code/interfaces/types_indexer.ApplicationResult.md index bb3cbafd..b5116ea6 100644 --- a/docs/code/interfaces/types_indexer.ApplicationResult.md +++ b/docs/code/interfaces/types_indexer.ApplicationResult.md @@ -24,7 +24,7 @@ The result of looking up an application #### Defined in -[types/indexer.ts:163](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L163) +[src/types/indexer.ts:163](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L163) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[types/indexer.ts:164](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L164) +[src/types/indexer.ts:164](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L164) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[types/indexer.ts:165](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L165) +[src/types/indexer.ts:165](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L165) ___ @@ -54,7 +54,7 @@ ___ #### Defined in -[types/indexer.ts:161](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L161) +[src/types/indexer.ts:161](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L161) ___ @@ -64,4 +64,4 @@ ___ #### Defined in -[types/indexer.ts:162](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L162) +[src/types/indexer.ts:162](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L162) diff --git a/docs/code/interfaces/types_indexer.ApplicationTransactionResult.md b/docs/code/interfaces/types_indexer.ApplicationTransactionResult.md index 1fbace0e..0fef5540 100644 --- a/docs/code/interfaces/types_indexer.ApplicationTransactionResult.md +++ b/docs/code/interfaces/types_indexer.ApplicationTransactionResult.md @@ -31,7 +31,7 @@ #### Defined in -[types/indexer.ts:124](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L124) +[src/types/indexer.ts:124](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L124) ___ @@ -41,7 +41,7 @@ ___ #### Defined in -[types/indexer.ts:123](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L123) +[src/types/indexer.ts:123](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L123) ___ @@ -51,7 +51,7 @@ ___ #### Defined in -[types/indexer.ts:121](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L121) +[src/types/indexer.ts:121](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L121) ___ @@ -65,7 +65,7 @@ Exclude.creator #### Defined in -[types/indexer.ts:120](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L120) +[src/types/indexer.ts:120](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L120) ___ @@ -75,7 +75,7 @@ ___ #### Defined in -[types/indexer.ts:125](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L125) +[src/types/indexer.ts:125](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L125) ___ @@ -85,7 +85,7 @@ ___ #### Defined in -[types/indexer.ts:126](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L126) +[src/types/indexer.ts:126](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L126) ___ @@ -99,7 +99,7 @@ Exclude.global-state #### Defined in -[types/indexer.ts:120](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L120) +[src/types/indexer.ts:120](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L120) ___ @@ -109,4 +109,4 @@ ___ #### Defined in -[types/indexer.ts:122](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L122) +[src/types/indexer.ts:122](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L122) diff --git a/docs/code/interfaces/types_indexer.AssetConfigTransactionResult.md b/docs/code/interfaces/types_indexer.AssetConfigTransactionResult.md index 8fcbb13a..87f233a9 100644 --- a/docs/code/interfaces/types_indexer.AssetConfigTransactionResult.md +++ b/docs/code/interfaces/types_indexer.AssetConfigTransactionResult.md @@ -19,7 +19,7 @@ #### Defined in -[types/indexer.ts:130](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L130) +[src/types/indexer.ts:130](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L130) ___ @@ -29,4 +29,4 @@ ___ #### Defined in -[types/indexer.ts:131](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L131) +[src/types/indexer.ts:131](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L131) diff --git a/docs/code/interfaces/types_indexer.AssetFreezeTransactionResult.md b/docs/code/interfaces/types_indexer.AssetFreezeTransactionResult.md index 18d6fc80..ac7d92f6 100644 --- a/docs/code/interfaces/types_indexer.AssetFreezeTransactionResult.md +++ b/docs/code/interfaces/types_indexer.AssetFreezeTransactionResult.md @@ -20,7 +20,7 @@ #### Defined in -[types/indexer.ts:135](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L135) +[src/types/indexer.ts:135](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L135) ___ @@ -30,7 +30,7 @@ ___ #### Defined in -[types/indexer.ts:136](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L136) +[src/types/indexer.ts:136](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L136) ___ @@ -40,4 +40,4 @@ ___ #### Defined in -[types/indexer.ts:137](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L137) +[src/types/indexer.ts:137](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L137) diff --git a/docs/code/interfaces/types_indexer.AssetHolding.md b/docs/code/interfaces/types_indexer.AssetHolding.md index 9517738c..7af52672 100644 --- a/docs/code/interfaces/types_indexer.AssetHolding.md +++ b/docs/code/interfaces/types_indexer.AssetHolding.md @@ -26,7 +26,7 @@ #### Defined in -[types/indexer.ts:321](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L321) +[src/types/indexer.ts:321](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L321) ___ @@ -38,7 +38,7 @@ Asset ID of the holding. #### Defined in -[types/indexer.ts:325](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L325) +[src/types/indexer.ts:325](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L325) ___ @@ -52,7 +52,7 @@ sent in the worst case. #### Defined in -[types/indexer.ts:331](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L331) +[src/types/indexer.ts:331](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L331) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[types/indexer.ts:336](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L336) +[src/types/indexer.ts:336](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L336) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[types/indexer.ts:335](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L335) +[src/types/indexer.ts:335](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L335) ___ @@ -84,7 +84,7 @@ ___ #### Defined in -[types/indexer.ts:337](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L337) +[src/types/indexer.ts:337](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L337) ___ @@ -94,4 +94,4 @@ ___ #### Defined in -[types/indexer.ts:338](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L338) +[src/types/indexer.ts:338](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L338) diff --git a/docs/code/interfaces/types_indexer.AssetLookupResult.md b/docs/code/interfaces/types_indexer.AssetLookupResult.md index 3e72b779..e9a1b181 100644 --- a/docs/code/interfaces/types_indexer.AssetLookupResult.md +++ b/docs/code/interfaces/types_indexer.AssetLookupResult.md @@ -21,7 +21,7 @@ https://developer.algorand.org/docs/rest-apis/indexer/#get-v2assetsasset-id #### Defined in -[types/indexer.ts:41](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L41) +[src/types/indexer.ts:41](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L41) ___ @@ -31,4 +31,4 @@ ___ #### Defined in -[types/indexer.ts:40](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L40) +[src/types/indexer.ts:40](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L40) diff --git a/docs/code/interfaces/types_indexer.AssetParams.md b/docs/code/interfaces/types_indexer.AssetParams.md index 3da5b3ee..d8522a65 100644 --- a/docs/code/interfaces/types_indexer.AssetParams.md +++ b/docs/code/interfaces/types_indexer.AssetParams.md @@ -35,7 +35,7 @@ clawback is not permitted. #### Defined in -[types/indexer.ts:244](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L244) +[src/types/indexer.ts:244](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L244) ___ @@ -49,7 +49,7 @@ be sent in the worst case. #### Defined in -[types/indexer.ts:228](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L228) +[src/types/indexer.ts:228](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L228) ___ @@ -64,7 +64,7 @@ must be between 0 and 19 (inclusive). #### Defined in -[types/indexer.ts:235](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L235) +[src/types/indexer.ts:235](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L235) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[types/indexer.ts:248](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L248) +[src/types/indexer.ts:248](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L248) ___ @@ -89,7 +89,7 @@ is not permitted. #### Defined in -[types/indexer.ts:253](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L253) +[src/types/indexer.ts:253](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L253) ___ @@ -101,7 +101,7 @@ ___ #### Defined in -[types/indexer.ts:257](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L257) +[src/types/indexer.ts:257](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L257) ___ @@ -114,7 +114,7 @@ metadata is up to the application. #### Defined in -[types/indexer.ts:262](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L262) +[src/types/indexer.ts:262](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L262) ___ @@ -127,7 +127,7 @@ asset name is composed of printable utf-8 characters. #### Defined in -[types/indexer.ts:267](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L267) +[src/types/indexer.ts:267](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L267) ___ @@ -139,7 +139,7 @@ Base64 encoded name of this asset, as supplied by the creator. #### Defined in -[types/indexer.ts:271](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L271) +[src/types/indexer.ts:271](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L271) ___ @@ -151,7 +151,7 @@ ___ #### Defined in -[types/indexer.ts:275](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L275) +[src/types/indexer.ts:275](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L275) ___ @@ -163,7 +163,7 @@ ___ #### Defined in -[types/indexer.ts:239](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L239) +[src/types/indexer.ts:239](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L239) ___ @@ -176,7 +176,7 @@ when the name of a unit of this asset is composed of printable utf-8 characters. #### Defined in -[types/indexer.ts:280](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L280) +[src/types/indexer.ts:280](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L280) ___ @@ -188,7 +188,7 @@ Base64 encoded name of a unit of this asset, as supplied by the creator. #### Defined in -[types/indexer.ts:284](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L284) +[src/types/indexer.ts:284](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L284) ___ @@ -201,7 +201,7 @@ when the URL is composed of printable utf-8 characters. #### Defined in -[types/indexer.ts:289](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L289) +[src/types/indexer.ts:289](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L289) ___ @@ -213,4 +213,4 @@ Base64 encoded URL where more information about the asset can be retrieved. #### Defined in -[types/indexer.ts:293](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L293) +[src/types/indexer.ts:293](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L293) diff --git a/docs/code/interfaces/types_indexer.AssetResult.md b/docs/code/interfaces/types_indexer.AssetResult.md index fdb80642..786a4f2c 100644 --- a/docs/code/interfaces/types_indexer.AssetResult.md +++ b/docs/code/interfaces/types_indexer.AssetResult.md @@ -22,7 +22,7 @@ #### Defined in -[types/indexer.ts:152](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L152) +[src/types/indexer.ts:152](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L152) ___ @@ -32,7 +32,7 @@ ___ #### Defined in -[types/indexer.ts:151](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L151) +[src/types/indexer.ts:151](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L151) ___ @@ -42,7 +42,7 @@ ___ #### Defined in -[types/indexer.ts:153](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L153) +[src/types/indexer.ts:153](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L153) ___ @@ -52,7 +52,7 @@ ___ #### Defined in -[types/indexer.ts:150](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L150) +[src/types/indexer.ts:150](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L150) ___ @@ -62,4 +62,4 @@ ___ #### Defined in -[types/indexer.ts:154](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L154) +[src/types/indexer.ts:154](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L154) diff --git a/docs/code/interfaces/types_indexer.AssetTransferTransactionResult.md b/docs/code/interfaces/types_indexer.AssetTransferTransactionResult.md index 68d9afcd..6d505f2b 100644 --- a/docs/code/interfaces/types_indexer.AssetTransferTransactionResult.md +++ b/docs/code/interfaces/types_indexer.AssetTransferTransactionResult.md @@ -23,7 +23,7 @@ #### Defined in -[types/indexer.ts:141](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L141) +[src/types/indexer.ts:141](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L141) ___ @@ -33,7 +33,7 @@ ___ #### Defined in -[types/indexer.ts:142](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L142) +[src/types/indexer.ts:142](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L142) ___ @@ -43,7 +43,7 @@ ___ #### Defined in -[types/indexer.ts:143](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L143) +[src/types/indexer.ts:143](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L143) ___ @@ -53,7 +53,7 @@ ___ #### Defined in -[types/indexer.ts:144](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L144) +[src/types/indexer.ts:144](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L144) ___ @@ -63,7 +63,7 @@ ___ #### Defined in -[types/indexer.ts:145](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L145) +[src/types/indexer.ts:145](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L145) ___ @@ -73,4 +73,4 @@ ___ #### Defined in -[types/indexer.ts:146](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L146) +[src/types/indexer.ts:146](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L146) diff --git a/docs/code/interfaces/types_indexer.AssetsCreatedLookupResult.md b/docs/code/interfaces/types_indexer.AssetsCreatedLookupResult.md index 1e2796ff..b8fcf5ac 100644 --- a/docs/code/interfaces/types_indexer.AssetsCreatedLookupResult.md +++ b/docs/code/interfaces/types_indexer.AssetsCreatedLookupResult.md @@ -22,7 +22,7 @@ https://developer.algorand.org/docs/rest-apis/indexer/#get-v2accountsaccount-idc #### Defined in -[types/indexer.ts:28](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L28) +[src/types/indexer.ts:28](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L28) ___ @@ -32,7 +32,7 @@ ___ #### Defined in -[types/indexer.ts:26](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L26) +[src/types/indexer.ts:26](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L26) ___ @@ -42,4 +42,4 @@ ___ #### Defined in -[types/indexer.ts:27](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L27) +[src/types/indexer.ts:27](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L27) diff --git a/docs/code/interfaces/types_indexer.AssetsLookupResult.md b/docs/code/interfaces/types_indexer.AssetsLookupResult.md index 0a95d0f9..b787d6e8 100644 --- a/docs/code/interfaces/types_indexer.AssetsLookupResult.md +++ b/docs/code/interfaces/types_indexer.AssetsLookupResult.md @@ -22,7 +22,7 @@ https://developer.algorand.org/docs/rest-apis/indexer/#get-v2accountsaccount-ida #### Defined in -[types/indexer.ts:21](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L21) +[src/types/indexer.ts:21](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L21) ___ @@ -32,7 +32,7 @@ ___ #### Defined in -[types/indexer.ts:19](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L19) +[src/types/indexer.ts:19](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L19) ___ @@ -42,4 +42,4 @@ ___ #### Defined in -[types/indexer.ts:20](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L20) +[src/types/indexer.ts:20](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L20) diff --git a/docs/code/interfaces/types_indexer.EvalDelta.md b/docs/code/interfaces/types_indexer.EvalDelta.md index d7679972..1369bbd1 100644 --- a/docs/code/interfaces/types_indexer.EvalDelta.md +++ b/docs/code/interfaces/types_indexer.EvalDelta.md @@ -20,7 +20,7 @@ #### Defined in -[types/indexer.ts:193](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L193) +[src/types/indexer.ts:193](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L193) ___ @@ -30,7 +30,7 @@ ___ #### Defined in -[types/indexer.ts:194](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L194) +[src/types/indexer.ts:194](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L194) ___ @@ -40,4 +40,4 @@ ___ #### Defined in -[types/indexer.ts:195](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L195) +[src/types/indexer.ts:195](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L195) diff --git a/docs/code/interfaces/types_indexer.LogicTransactionSignature.md b/docs/code/interfaces/types_indexer.LogicTransactionSignature.md index 7a3903e4..098a8796 100644 --- a/docs/code/interfaces/types_indexer.LogicTransactionSignature.md +++ b/docs/code/interfaces/types_indexer.LogicTransactionSignature.md @@ -21,7 +21,7 @@ #### Defined in -[types/indexer.ts:175](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L175) +[src/types/indexer.ts:175](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L175) ___ @@ -31,7 +31,7 @@ ___ #### Defined in -[types/indexer.ts:176](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L176) +[src/types/indexer.ts:176](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L176) ___ @@ -41,7 +41,7 @@ ___ #### Defined in -[types/indexer.ts:177](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L177) +[src/types/indexer.ts:177](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L177) ___ @@ -51,4 +51,4 @@ ___ #### Defined in -[types/indexer.ts:178](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L178) +[src/types/indexer.ts:178](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L178) diff --git a/docs/code/interfaces/types_indexer.MultisigTransactionSignature.md b/docs/code/interfaces/types_indexer.MultisigTransactionSignature.md index 0c2db0ff..24a9778d 100644 --- a/docs/code/interfaces/types_indexer.MultisigTransactionSignature.md +++ b/docs/code/interfaces/types_indexer.MultisigTransactionSignature.md @@ -20,7 +20,7 @@ #### Defined in -[types/indexer.ts:182](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L182) +[src/types/indexer.ts:182](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L182) ___ @@ -30,7 +30,7 @@ ___ #### Defined in -[types/indexer.ts:183](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L183) +[src/types/indexer.ts:183](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L183) ___ @@ -40,4 +40,4 @@ ___ #### Defined in -[types/indexer.ts:184](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L184) +[src/types/indexer.ts:184](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L184) diff --git a/docs/code/interfaces/types_indexer.MultisigTransactionSubSignature.md b/docs/code/interfaces/types_indexer.MultisigTransactionSubSignature.md index 2f5ea8ad..3226e453 100644 --- a/docs/code/interfaces/types_indexer.MultisigTransactionSubSignature.md +++ b/docs/code/interfaces/types_indexer.MultisigTransactionSubSignature.md @@ -19,7 +19,7 @@ #### Defined in -[types/indexer.ts:188](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L188) +[src/types/indexer.ts:188](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L188) ___ @@ -29,4 +29,4 @@ ___ #### Defined in -[types/indexer.ts:189](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L189) +[src/types/indexer.ts:189](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L189) diff --git a/docs/code/interfaces/types_indexer.PaymentTransactionResult.md b/docs/code/interfaces/types_indexer.PaymentTransactionResult.md index 73efc574..e0c7319a 100644 --- a/docs/code/interfaces/types_indexer.PaymentTransactionResult.md +++ b/docs/code/interfaces/types_indexer.PaymentTransactionResult.md @@ -21,7 +21,7 @@ #### Defined in -[types/indexer.ts:114](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L114) +[src/types/indexer.ts:114](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L114) ___ @@ -31,7 +31,7 @@ ___ #### Defined in -[types/indexer.ts:115](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L115) +[src/types/indexer.ts:115](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L115) ___ @@ -41,7 +41,7 @@ ___ #### Defined in -[types/indexer.ts:116](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L116) +[src/types/indexer.ts:116](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L116) ___ @@ -51,4 +51,4 @@ ___ #### Defined in -[types/indexer.ts:117](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L117) +[src/types/indexer.ts:117](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L117) diff --git a/docs/code/interfaces/types_indexer.StateSchema.md b/docs/code/interfaces/types_indexer.StateSchema.md index 1fb98bb1..4ddd5495 100644 --- a/docs/code/interfaces/types_indexer.StateSchema.md +++ b/docs/code/interfaces/types_indexer.StateSchema.md @@ -19,7 +19,7 @@ #### Defined in -[types/indexer.ts:209](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L209) +[src/types/indexer.ts:209](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L209) ___ @@ -29,4 +29,4 @@ ___ #### Defined in -[types/indexer.ts:210](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L210) +[src/types/indexer.ts:210](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L210) diff --git a/docs/code/interfaces/types_indexer.TransactionLookupResult.md b/docs/code/interfaces/types_indexer.TransactionLookupResult.md index 0a792f2e..28c5487b 100644 --- a/docs/code/interfaces/types_indexer.TransactionLookupResult.md +++ b/docs/code/interfaces/types_indexer.TransactionLookupResult.md @@ -21,7 +21,7 @@ https://developer.algorand.org/docs/rest-apis/indexer/#get-v2transactionstxid #### Defined in -[types/indexer.ts:46](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L46) +[src/types/indexer.ts:46](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L46) ___ @@ -31,4 +31,4 @@ ___ #### Defined in -[types/indexer.ts:47](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L47) +[src/types/indexer.ts:47](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L47) diff --git a/docs/code/interfaces/types_indexer.TransactionResult.md b/docs/code/interfaces/types_indexer.TransactionResult.md index 43bd545f..66b8674e 100644 --- a/docs/code/interfaces/types_indexer.TransactionResult.md +++ b/docs/code/interfaces/types_indexer.TransactionResult.md @@ -56,7 +56,7 @@ https://developer.algorand.org/docs/rest-apis/indexer/#transaction #### Defined in -[types/indexer.ts:70](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L70) +[src/types/indexer.ts:70](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L70) ___ @@ -66,7 +66,7 @@ ___ #### Defined in -[types/indexer.ts:72](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L72) +[src/types/indexer.ts:72](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L72) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[types/indexer.ts:74](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L74) +[src/types/indexer.ts:74](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L74) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[types/indexer.ts:75](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L75) +[src/types/indexer.ts:75](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L75) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[types/indexer.ts:78](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L78) +[src/types/indexer.ts:78](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L78) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[types/indexer.ts:89](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L89) +[src/types/indexer.ts:89](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L89) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[types/indexer.ts:79](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L79) +[src/types/indexer.ts:79](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L79) ___ @@ -126,7 +126,7 @@ ___ #### Defined in -[types/indexer.ts:63](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L63) +[src/types/indexer.ts:63](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L63) ___ @@ -136,7 +136,7 @@ ___ #### Defined in -[types/indexer.ts:71](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L71) +[src/types/indexer.ts:71](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L71) ___ @@ -146,7 +146,7 @@ ___ #### Defined in -[types/indexer.ts:73](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L73) +[src/types/indexer.ts:73](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L73) ___ @@ -156,7 +156,7 @@ ___ #### Defined in -[types/indexer.ts:59](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L59) +[src/types/indexer.ts:59](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L59) ___ @@ -166,7 +166,7 @@ ___ #### Defined in -[types/indexer.ts:61](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L61) +[src/types/indexer.ts:61](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L61) ___ @@ -176,7 +176,7 @@ ___ #### Defined in -[types/indexer.ts:80](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L80) +[src/types/indexer.ts:80](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L80) ___ @@ -186,7 +186,7 @@ ___ #### Defined in -[types/indexer.ts:81](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L81) +[src/types/indexer.ts:81](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L81) ___ @@ -196,7 +196,7 @@ ___ #### Defined in -[types/indexer.ts:86](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L86) +[src/types/indexer.ts:86](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L86) ___ @@ -206,7 +206,7 @@ ___ #### Defined in -[types/indexer.ts:64](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L64) +[src/types/indexer.ts:64](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L64) ___ @@ -216,7 +216,7 @@ ___ #### Defined in -[types/indexer.ts:58](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L58) +[src/types/indexer.ts:58](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L58) ___ @@ -226,7 +226,7 @@ ___ #### Defined in -[types/indexer.ts:82](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L82) +[src/types/indexer.ts:82](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L82) ___ @@ -236,7 +236,7 @@ ___ #### Defined in -[types/indexer.ts:68](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L68) +[src/types/indexer.ts:68](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L68) ___ @@ -246,7 +246,7 @@ ___ #### Defined in -[types/indexer.ts:76](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L76) +[src/types/indexer.ts:76](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L76) ___ @@ -256,7 +256,7 @@ ___ #### Defined in -[types/indexer.ts:62](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L62) +[src/types/indexer.ts:62](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L62) ___ @@ -266,7 +266,7 @@ ___ #### Defined in -[types/indexer.ts:84](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L84) +[src/types/indexer.ts:84](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L84) ___ @@ -276,7 +276,7 @@ ___ #### Defined in -[types/indexer.ts:85](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L85) +[src/types/indexer.ts:85](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L85) ___ @@ -286,7 +286,7 @@ ___ #### Defined in -[types/indexer.ts:66](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L66) +[src/types/indexer.ts:66](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L66) ___ @@ -296,7 +296,7 @@ ___ #### Defined in -[types/indexer.ts:65](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L65) +[src/types/indexer.ts:65](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L65) ___ @@ -306,7 +306,7 @@ ___ #### Defined in -[types/indexer.ts:77](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L77) +[src/types/indexer.ts:77](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L77) ___ @@ -316,7 +316,7 @@ ___ #### Defined in -[types/indexer.ts:87](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L87) +[src/types/indexer.ts:87](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L87) ___ @@ -326,7 +326,7 @@ ___ #### Defined in -[types/indexer.ts:83](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L83) +[src/types/indexer.ts:83](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L83) ___ @@ -336,7 +336,7 @@ ___ #### Defined in -[types/indexer.ts:67](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L67) +[src/types/indexer.ts:67](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L67) ___ @@ -346,7 +346,7 @@ ___ #### Defined in -[types/indexer.ts:60](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L60) +[src/types/indexer.ts:60](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L60) ___ @@ -356,7 +356,7 @@ ___ #### Defined in -[types/indexer.ts:88](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L88) +[src/types/indexer.ts:88](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L88) ___ @@ -366,7 +366,7 @@ ___ #### Defined in -[types/indexer.ts:69](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L69) +[src/types/indexer.ts:69](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L69) ___ @@ -376,4 +376,4 @@ ___ #### Defined in -[types/indexer.ts:90](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L90) +[src/types/indexer.ts:90](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L90) diff --git a/docs/code/interfaces/types_indexer.TransactionSearchResults.md b/docs/code/interfaces/types_indexer.TransactionSearchResults.md index 6e823b24..bb18118c 100644 --- a/docs/code/interfaces/types_indexer.TransactionSearchResults.md +++ b/docs/code/interfaces/types_indexer.TransactionSearchResults.md @@ -22,7 +22,7 @@ https://developer.algorand.org/docs/rest-apis/indexer/#get-v2transactions #### Defined in -[types/indexer.ts:6](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L6) +[src/types/indexer.ts:6](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L6) ___ @@ -32,7 +32,7 @@ ___ #### Defined in -[types/indexer.ts:7](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L7) +[src/types/indexer.ts:7](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L7) ___ @@ -42,4 +42,4 @@ ___ #### Defined in -[types/indexer.ts:8](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L8) +[src/types/indexer.ts:8](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L8) diff --git a/docs/code/interfaces/types_indexer.TransactionSignature.md b/docs/code/interfaces/types_indexer.TransactionSignature.md index a79193c4..7ecbc18a 100644 --- a/docs/code/interfaces/types_indexer.TransactionSignature.md +++ b/docs/code/interfaces/types_indexer.TransactionSignature.md @@ -20,7 +20,7 @@ #### Defined in -[types/indexer.ts:169](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L169) +[src/types/indexer.ts:169](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L169) ___ @@ -30,7 +30,7 @@ ___ #### Defined in -[types/indexer.ts:170](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L170) +[src/types/indexer.ts:170](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L170) ___ @@ -40,4 +40,4 @@ ___ #### Defined in -[types/indexer.ts:171](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L171) +[src/types/indexer.ts:171](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L171) diff --git a/docs/code/interfaces/types_logic_error.LogicErrorDetails.md b/docs/code/interfaces/types_logic_error.LogicErrorDetails.md new file mode 100644 index 00000000..1d0e4dc2 --- /dev/null +++ b/docs/code/interfaces/types_logic_error.LogicErrorDetails.md @@ -0,0 +1,43 @@ +[@algorandfoundation/algokit-utils](../README.md) / [types/logic-error](../modules/types_logic_error.md) / LogicErrorDetails + +# Interface: LogicErrorDetails + +[types/logic-error](../modules/types_logic_error.md).LogicErrorDetails + +## Table of contents + +### Properties + +- [msg](types_logic_error.LogicErrorDetails.md#msg) +- [pc](types_logic_error.LogicErrorDetails.md#pc) +- [txId](types_logic_error.LogicErrorDetails.md#txid) + +## Properties + +### msg + +• **msg**: `string` + +#### Defined in + +src/types/logic-error.ts:8 + +___ + +### pc + +• **pc**: `number` + +#### Defined in + +src/types/logic-error.ts:7 + +___ + +### txId + +• **txId**: `string` + +#### Defined in + +src/types/logic-error.ts:6 diff --git a/docs/code/interfaces/types_network_client.AlgoClientConfig.md b/docs/code/interfaces/types_network_client.AlgoClientConfig.md index bec4bc8b..b7f28087 100644 --- a/docs/code/interfaces/types_network_client.AlgoClientConfig.md +++ b/docs/code/interfaces/types_network_client.AlgoClientConfig.md @@ -24,7 +24,7 @@ The port to use e.g. 4001, 443, etc. #### Defined in -[types/network-client.ts:8](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/network-client.ts#L8) +[src/types/network-client.ts:8](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/network-client.ts#L8) ___ @@ -36,7 +36,7 @@ Base URL of the server e.g. http://localhost, https://testnet-api.algonode.cloud #### Defined in -[types/network-client.ts:6](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/network-client.ts#L6) +[src/types/network-client.ts:6](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/network-client.ts#L6) ___ @@ -48,4 +48,4 @@ The token to use for API authentication (or undefined if none needed) - can be a #### Defined in -[types/network-client.ts:10](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/network-client.ts#L10) +[src/types/network-client.ts:10](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/network-client.ts#L10) diff --git a/docs/code/interfaces/types_testing.AlgoKitLogCaptureFixture.md b/docs/code/interfaces/types_testing.AlgoKitLogCaptureFixture.md index 2ecd89be..ed6103a4 100644 --- a/docs/code/interfaces/types_testing.AlgoKitLogCaptureFixture.md +++ b/docs/code/interfaces/types_testing.AlgoKitLogCaptureFixture.md @@ -33,7 +33,7 @@ Testing framework agnostic handler method to run after each test to reset the lo #### Defined in -[types/testing.ts:94](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L94) +[src/types/testing.ts:94](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L94) ___ @@ -57,7 +57,7 @@ testLogger for that test. #### Defined in -[types/testing.ts:90](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L90) +[src/types/testing.ts:90](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L90) ## Accessors @@ -73,4 +73,4 @@ The test logger instance for the current test #### Defined in -[types/testing.ts:86](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L86) +[src/types/testing.ts:86](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L86) diff --git a/docs/code/interfaces/types_testing.AlgorandFixture.md b/docs/code/interfaces/types_testing.AlgorandFixture.md index 37813628..3b13e7c9 100644 --- a/docs/code/interfaces/types_testing.AlgorandFixture.md +++ b/docs/code/interfaces/types_testing.AlgorandFixture.md @@ -38,7 +38,7 @@ context for that test. #### Defined in -[types/testing.ts:68](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L68) +[src/types/testing.ts:68](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L68) ## Accessors @@ -63,4 +63,4 @@ test('My test', () => { #### Defined in -[types/testing.ts:63](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L63) +[src/types/testing.ts:63](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L63) diff --git a/docs/code/interfaces/types_testing.AlgorandFixtureConfig.md b/docs/code/interfaces/types_testing.AlgorandFixtureConfig.md index dde10d92..a2999351 100644 --- a/docs/code/interfaces/types_testing.AlgorandFixtureConfig.md +++ b/docs/code/interfaces/types_testing.AlgorandFixtureConfig.md @@ -25,7 +25,7 @@ An optional algod client, if not specified then it will create one against defau #### Defined in -[types/testing.ts:43](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L43) +[src/types/testing.ts:43](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L43) ___ @@ -37,7 +37,7 @@ An optional indexer client, if not specified then it will create one against def #### Defined in -[types/testing.ts:45](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L45) +[src/types/testing.ts:45](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L45) ___ @@ -49,7 +49,7 @@ An optional kmd client, if not specified then it will create one against default #### Defined in -[types/testing.ts:47](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L47) +[src/types/testing.ts:47](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L47) ___ @@ -61,4 +61,4 @@ The amount of funds to allocate to the default testing account, if not specified #### Defined in -[types/testing.ts:49](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L49) +[src/types/testing.ts:49](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L49) diff --git a/docs/code/interfaces/types_testing.AlgorandTestAutomationContext.md b/docs/code/interfaces/types_testing.AlgorandTestAutomationContext.md index b3a196ca..259f1ae1 100644 --- a/docs/code/interfaces/types_testing.AlgorandTestAutomationContext.md +++ b/docs/code/interfaces/types_testing.AlgorandTestAutomationContext.md @@ -33,7 +33,7 @@ transactionLogger #### Defined in -[types/testing.ts:13](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L13) +[src/types/testing.ts:13](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L13) ___ @@ -59,7 +59,7 @@ Generate and fund an additional ephemerally created account #### Defined in -[types/testing.ts:23](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L23) +[src/types/testing.ts:23](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L23) ___ @@ -71,7 +71,7 @@ Indexer client instance #### Defined in -[types/testing.ts:15](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L15) +[src/types/testing.ts:15](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L15) ___ @@ -83,7 +83,7 @@ KMD client instance #### Defined in -[types/testing.ts:17](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L17) +[src/types/testing.ts:17](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L17) ___ @@ -95,7 +95,7 @@ Default, funded test account that is ephemerally created #### Defined in -[types/testing.ts:21](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L21) +[src/types/testing.ts:21](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L21) ___ @@ -111,7 +111,7 @@ algod #### Defined in -[types/testing.ts:19](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L19) +[src/types/testing.ts:19](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L19) ___ @@ -135,7 +135,7 @@ transactionLogger #### Defined in -[types/testing.ts:25](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L25) +[src/types/testing.ts:25](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L25) ___ @@ -161,4 +161,4 @@ Wait for the indexer to catch up with the given transaction ID #### Defined in -[types/testing.ts:27](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L27) +[src/types/testing.ts:27](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L27) diff --git a/docs/code/interfaces/types_testing.GetTestAccountParams.md b/docs/code/interfaces/types_testing.GetTestAccountParams.md index eebcfa19..848dc866 100644 --- a/docs/code/interfaces/types_testing.GetTestAccountParams.md +++ b/docs/code/interfaces/types_testing.GetTestAccountParams.md @@ -27,7 +27,7 @@ Initial funds to ensure the account has #### Defined in -[types/testing.ts:35](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L35) +[src/types/testing.ts:35](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L35) ___ @@ -39,4 +39,4 @@ Whether to suppress the log (which includes a mnemonic) or not (default: do not #### Defined in -[types/testing.ts:37](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L37) +[src/types/testing.ts:37](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L37) diff --git a/docs/code/interfaces/types_testing.LogSnapshotConfig.md b/docs/code/interfaces/types_testing.LogSnapshotConfig.md index ddfd0d82..eeefd97d 100644 --- a/docs/code/interfaces/types_testing.LogSnapshotConfig.md +++ b/docs/code/interfaces/types_testing.LogSnapshotConfig.md @@ -26,7 +26,7 @@ Any accounts/addresses to replace the address for predictably #### Defined in -[types/testing.ts:79](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L79) +[src/types/testing.ts:79](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L79) ___ @@ -38,7 +38,7 @@ Any app IDs to replace predictably #### Defined in -[types/testing.ts:81](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L81) +[src/types/testing.ts:81](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L81) ___ @@ -50,4 +50,4 @@ Any transaction IDs or transactions to replace the ID for predictably #### Defined in -[types/testing.ts:77](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L77) +[src/types/testing.ts:77](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L77) diff --git a/docs/code/interfaces/types_transaction.ConfirmedTransactionResult.md b/docs/code/interfaces/types_transaction.ConfirmedTransactionResult.md index 52f4b077..feb12e1a 100644 --- a/docs/code/interfaces/types_transaction.ConfirmedTransactionResult.md +++ b/docs/code/interfaces/types_transaction.ConfirmedTransactionResult.md @@ -33,7 +33,7 @@ The response if the transaction was sent and waited for #### Defined in -[types/transaction.ts:50](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L50) +[src/types/transaction.ts:50](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L50) ___ @@ -49,4 +49,4 @@ The transaction #### Defined in -[types/transaction.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L42) +[src/types/transaction.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L42) diff --git a/docs/code/interfaces/types_transaction.SendTransactionParams.md b/docs/code/interfaces/types_transaction.SendTransactionParams.md index 5e755375..734862d6 100644 --- a/docs/code/interfaces/types_transaction.SendTransactionParams.md +++ b/docs/code/interfaces/types_transaction.SendTransactionParams.md @@ -37,7 +37,7 @@ The flat fee you want to pay, useful for covering extra fees in a transaction gr #### Defined in -[types/transaction.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L32) +[src/types/transaction.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L32) ___ @@ -49,7 +49,7 @@ The maximum fee that you are happy to pay (default: unbounded) - if this is set #### Defined in -[types/transaction.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L34) +[src/types/transaction.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L34) ___ @@ -61,7 +61,7 @@ The maximum number of rounds to wait for confirmation, only applies if `skipWait #### Defined in -[types/transaction.ts:36](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L36) +[src/types/transaction.ts:36](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L36) ___ @@ -74,7 +74,7 @@ Whether to skip signing and sending the transaction to the chain (default: trans #### Defined in -[types/transaction.ts:26](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L26) +[src/types/transaction.ts:26](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L26) ___ @@ -86,7 +86,7 @@ Whether to skip waiting for the submitted transaction (only relevant if `skipSen #### Defined in -[types/transaction.ts:28](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L28) +[src/types/transaction.ts:28](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L28) ___ @@ -98,4 +98,4 @@ Whether to suppress log messages from transaction send, default: do not suppress #### Defined in -[types/transaction.ts:30](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L30) +[src/types/transaction.ts:30](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L30) diff --git a/docs/code/interfaces/types_transaction.SendTransactionResult.md b/docs/code/interfaces/types_transaction.SendTransactionResult.md index 42586883..ed35ffcc 100644 --- a/docs/code/interfaces/types_transaction.SendTransactionResult.md +++ b/docs/code/interfaces/types_transaction.SendTransactionResult.md @@ -31,7 +31,7 @@ The response if the transaction was sent and waited for #### Defined in -[types/transaction.ts:44](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L44) +[src/types/transaction.ts:44](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L44) ___ @@ -43,4 +43,4 @@ The transaction #### Defined in -[types/transaction.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L42) +[src/types/transaction.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L42) diff --git a/docs/code/interfaces/types_transaction.TransactionToSign.md b/docs/code/interfaces/types_transaction.TransactionToSign.md index 2f4baeb5..6c4c611b 100644 --- a/docs/code/interfaces/types_transaction.TransactionToSign.md +++ b/docs/code/interfaces/types_transaction.TransactionToSign.md @@ -23,7 +23,7 @@ The account to use to sign the transaction, either an account (with private key #### Defined in -[types/transaction.ts:60](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L60) +[src/types/transaction.ts:60](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L60) ___ @@ -35,4 +35,4 @@ The unsigned transaction to sign and send #### Defined in -[types/transaction.ts:58](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L58) +[src/types/transaction.ts:58](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L58) diff --git a/docs/code/interfaces/types_transfer.AlgoTransferParams.md b/docs/code/interfaces/types_transfer.AlgoTransferParams.md index 61fadc3e..ef1e946f 100644 --- a/docs/code/interfaces/types_transfer.AlgoTransferParams.md +++ b/docs/code/interfaces/types_transfer.AlgoTransferParams.md @@ -42,7 +42,7 @@ The amount to send #### Defined in -[types/transfer.ts:12](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L12) +[src/types/transfer.ts:12](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L12) ___ @@ -58,7 +58,7 @@ The flat fee you want to pay, useful for covering extra fees in a transaction gr #### Defined in -[types/transaction.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L32) +[src/types/transaction.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L32) ___ @@ -70,7 +70,7 @@ The account (with private key loaded) that will send the µALGOs #### Defined in -[types/transfer.ts:8](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L8) +[src/types/transfer.ts:8](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L8) ___ @@ -86,7 +86,7 @@ The maximum fee that you are happy to pay (default: unbounded) - if this is set #### Defined in -[types/transaction.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L34) +[src/types/transaction.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L34) ___ @@ -102,7 +102,7 @@ The maximum number of rounds to wait for confirmation, only applies if `skipWait #### Defined in -[types/transaction.ts:36](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L36) +[src/types/transaction.ts:36](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L36) ___ @@ -114,7 +114,7 @@ The (optional) transaction note #### Defined in -[types/transfer.ts:16](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L16) +[src/types/transfer.ts:16](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L16) ___ @@ -131,7 +131,7 @@ Whether to skip signing and sending the transaction to the chain (default: trans #### Defined in -[types/transaction.ts:26](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L26) +[src/types/transaction.ts:26](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L26) ___ @@ -147,7 +147,7 @@ Whether to skip waiting for the submitted transaction (only relevant if `skipSen #### Defined in -[types/transaction.ts:28](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L28) +[src/types/transaction.ts:28](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L28) ___ @@ -163,7 +163,7 @@ Whether to suppress log messages from transaction send, default: do not suppress #### Defined in -[types/transaction.ts:30](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L30) +[src/types/transaction.ts:30](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L30) ___ @@ -175,7 +175,7 @@ The account address that will receive the ALGOs #### Defined in -[types/transfer.ts:10](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L10) +[src/types/transfer.ts:10](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L10) ___ @@ -187,4 +187,4 @@ Optional transaction parameters #### Defined in -[types/transfer.ts:14](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L14) +[src/types/transfer.ts:14](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L14) diff --git a/docs/code/interfaces/types_transfer.EnsureFundedParams.md b/docs/code/interfaces/types_transfer.EnsureFundedParams.md index d2357a3d..a4e10871 100644 --- a/docs/code/interfaces/types_transfer.EnsureFundedParams.md +++ b/docs/code/interfaces/types_transfer.EnsureFundedParams.md @@ -43,7 +43,7 @@ The account to fund #### Defined in -[types/transfer.ts:22](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L22) +[src/types/transfer.ts:22](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L22) ___ @@ -59,7 +59,7 @@ The flat fee you want to pay, useful for covering extra fees in a transaction gr #### Defined in -[types/transaction.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L32) +[src/types/transaction.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L32) ___ @@ -71,7 +71,7 @@ The account to use as a funding source #### Defined in -[types/transfer.ts:24](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L24) +[src/types/transfer.ts:24](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L24) ___ @@ -87,7 +87,7 @@ The maximum fee that you are happy to pay (default: unbounded) - if this is set #### Defined in -[types/transaction.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L34) +[src/types/transaction.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L34) ___ @@ -103,7 +103,7 @@ The maximum number of rounds to wait for confirmation, only applies if `skipWait #### Defined in -[types/transaction.ts:36](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L36) +[src/types/transaction.ts:36](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L36) ___ @@ -115,7 +115,7 @@ When issuing a funding amount, the minimum amount to transfer (avoids many small #### Defined in -[types/transfer.ts:28](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L28) +[src/types/transfer.ts:28](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L28) ___ @@ -127,7 +127,7 @@ The minimum balance of ALGOs that the account should have available to spend (i. #### Defined in -[types/transfer.ts:26](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L26) +[src/types/transfer.ts:26](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L26) ___ @@ -139,7 +139,7 @@ The (optional) transaction note, default: "Funding account to meet minimum requi #### Defined in -[types/transfer.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L32) +[src/types/transfer.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L32) ___ @@ -156,7 +156,7 @@ Whether to skip signing and sending the transaction to the chain (default: trans #### Defined in -[types/transaction.ts:26](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L26) +[src/types/transaction.ts:26](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L26) ___ @@ -172,7 +172,7 @@ Whether to skip waiting for the submitted transaction (only relevant if `skipSen #### Defined in -[types/transaction.ts:28](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L28) +[src/types/transaction.ts:28](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L28) ___ @@ -188,7 +188,7 @@ Whether to suppress log messages from transaction send, default: do not suppress #### Defined in -[types/transaction.ts:30](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L30) +[src/types/transaction.ts:30](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L30) ___ @@ -200,4 +200,4 @@ Optional transaction parameters #### Defined in -[types/transfer.ts:30](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L30) +[src/types/transfer.ts:30](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L30) diff --git a/docs/code/interfaces/types_urlTokenBaseHTTPClient.AlgodTokenHeader.md b/docs/code/interfaces/types_urlTokenBaseHTTPClient.AlgodTokenHeader.md index 6eef2a25..41ce3dc0 100644 --- a/docs/code/interfaces/types_urlTokenBaseHTTPClient.AlgodTokenHeader.md +++ b/docs/code/interfaces/types_urlTokenBaseHTTPClient.AlgodTokenHeader.md @@ -18,4 +18,4 @@ #### Defined in -[types/urlTokenBaseHTTPClient.ts:10](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/urlTokenBaseHTTPClient.ts#L10) +[src/types/urlTokenBaseHTTPClient.ts:10](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/urlTokenBaseHTTPClient.ts#L10) diff --git a/docs/code/interfaces/types_urlTokenBaseHTTPClient.IndexerTokenHeader.md b/docs/code/interfaces/types_urlTokenBaseHTTPClient.IndexerTokenHeader.md index 5df5fce4..9f63727a 100644 --- a/docs/code/interfaces/types_urlTokenBaseHTTPClient.IndexerTokenHeader.md +++ b/docs/code/interfaces/types_urlTokenBaseHTTPClient.IndexerTokenHeader.md @@ -18,4 +18,4 @@ #### Defined in -[types/urlTokenBaseHTTPClient.ts:14](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/urlTokenBaseHTTPClient.ts#L14) +[src/types/urlTokenBaseHTTPClient.ts:14](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/urlTokenBaseHTTPClient.ts#L14) diff --git a/docs/code/interfaces/types_urlTokenBaseHTTPClient.KMDTokenHeader.md b/docs/code/interfaces/types_urlTokenBaseHTTPClient.KMDTokenHeader.md index a2b3d536..267d2573 100644 --- a/docs/code/interfaces/types_urlTokenBaseHTTPClient.KMDTokenHeader.md +++ b/docs/code/interfaces/types_urlTokenBaseHTTPClient.KMDTokenHeader.md @@ -18,4 +18,4 @@ #### Defined in -[types/urlTokenBaseHTTPClient.ts:18](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/urlTokenBaseHTTPClient.ts#L18) +[src/types/urlTokenBaseHTTPClient.ts:18](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/urlTokenBaseHTTPClient.ts#L18) diff --git a/docs/code/modules/index.md b/docs/code/modules/index.md index bfcbf23f..0a53674e 100644 --- a/docs/code/modules/index.md +++ b/docs/code/modules/index.md @@ -71,7 +71,7 @@ The AlgoKit config. To update it use the configure method. #### Defined in -[index.ts:15](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/index.ts#L15) +[src/index.ts:15](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/index.ts#L15) ## Functions @@ -97,7 +97,7 @@ AlgoAmount #### Defined in -[amount.ts:5](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/amount.ts#L5) +[src/amount.ts:5](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/amount.ts#L5) ___ @@ -122,7 +122,7 @@ The result of the call #### Defined in -[app.ts:112](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L112) +[src/app.ts:128](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L128) ___ @@ -147,7 +147,7 @@ the estimated rate. #### Defined in -[transaction.ts:267](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction.ts#L267) +[src/transaction.ts:267](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction.ts#L267) ___ @@ -172,13 +172,13 @@ The information about the compiled file #### Defined in -[app.ts:279](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L279) +[src/app.ts:295](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L295) ___ ### createApp -▸ **createApp**(`create`, `algod`): `Promise`<[`AppCallTransactionResult`](../interfaces/types_app.AppCallTransactionResult.md) & [`AppReference`](../interfaces/types_app.AppReference.md)\> +▸ **createApp**(`create`, `algod`): `Promise`<`Partial`<[`AppCompilationResult`](../interfaces/types_app.AppCompilationResult.md)\> & [`AppCallTransactionResult`](../interfaces/types_app.AppCallTransactionResult.md) & [`AppReference`](../interfaces/types_app.AppReference.md)\> Creates a smart contract app, returns the details of the created app. @@ -191,19 +191,19 @@ Creates a smart contract app, returns the details of the created app. #### Returns -`Promise`<[`AppCallTransactionResult`](../interfaces/types_app.AppCallTransactionResult.md) & [`AppReference`](../interfaces/types_app.AppReference.md)\> +`Promise`<`Partial`<[`AppCompilationResult`](../interfaces/types_app.AppCompilationResult.md)\> & [`AppCallTransactionResult`](../interfaces/types_app.AppCallTransactionResult.md) & [`AppReference`](../interfaces/types_app.AppReference.md)\> The details of the created app, or the transaction to create it if `skipSending` #### Defined in -[app.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L32) +[src/app.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L34) ___ ### deployApp -▸ **deployApp**(`deployment`, `algod`, `indexer?`): `Promise`<[`ConfirmedTransactionResult`](../interfaces/types_transaction.ConfirmedTransactionResult.md) & [`AppMetadata`](../interfaces/types_app.AppMetadata.md) & { `operationPerformed`: ``"create"`` \| ``"update"`` } \| [`ConfirmedTransactionResult`](../interfaces/types_transaction.ConfirmedTransactionResult.md) & [`AppMetadata`](../interfaces/types_app.AppMetadata.md) & { `deleteResult`: [`ConfirmedTransactionResult`](../interfaces/types_transaction.ConfirmedTransactionResult.md) ; `operationPerformed`: ``"replace"`` } \| [`AppMetadata`](../interfaces/types_app.AppMetadata.md) & { `operationPerformed`: ``"nothing"`` }\> +▸ **deployApp**(`deployment`, `algod`, `indexer?`): `Promise`<`Partial`<[`AppCompilationResult`](../interfaces/types_app.AppCompilationResult.md)\> & [`ConfirmedTransactionResult`](../interfaces/types_transaction.ConfirmedTransactionResult.md) & [`AppMetadata`](../interfaces/types_app.AppMetadata.md) & { `operationPerformed`: ``"create"`` \| ``"update"`` } \| [`ConfirmedTransactionResult`](../interfaces/types_transaction.ConfirmedTransactionResult.md) & [`AppMetadata`](../interfaces/types_app.AppMetadata.md) & { `deleteResult`: [`ConfirmedTransactionResult`](../interfaces/types_transaction.ConfirmedTransactionResult.md) ; `operationPerformed`: ``"replace"`` } \| [`AppMetadata`](../interfaces/types_app.AppMetadata.md) & { `operationPerformed`: ``"nothing"`` }\> Idempotently deploy (create, update/delete if changed) an app against the given name via the given creator account, including deploy-time template placeholder substitutions. @@ -229,13 +229,13 @@ https://github.com/algorandfoundation/algokit-cli/blob/main/docs/architecture-de #### Returns -`Promise`<[`ConfirmedTransactionResult`](../interfaces/types_transaction.ConfirmedTransactionResult.md) & [`AppMetadata`](../interfaces/types_app.AppMetadata.md) & { `operationPerformed`: ``"create"`` \| ``"update"`` } \| [`ConfirmedTransactionResult`](../interfaces/types_transaction.ConfirmedTransactionResult.md) & [`AppMetadata`](../interfaces/types_app.AppMetadata.md) & { `deleteResult`: [`ConfirmedTransactionResult`](../interfaces/types_transaction.ConfirmedTransactionResult.md) ; `operationPerformed`: ``"replace"`` } \| [`AppMetadata`](../interfaces/types_app.AppMetadata.md) & { `operationPerformed`: ``"nothing"`` }\> +`Promise`<`Partial`<[`AppCompilationResult`](../interfaces/types_app.AppCompilationResult.md)\> & [`ConfirmedTransactionResult`](../interfaces/types_transaction.ConfirmedTransactionResult.md) & [`AppMetadata`](../interfaces/types_app.AppMetadata.md) & { `operationPerformed`: ``"create"`` \| ``"update"`` } \| [`ConfirmedTransactionResult`](../interfaces/types_transaction.ConfirmedTransactionResult.md) & [`AppMetadata`](../interfaces/types_app.AppMetadata.md) & { `deleteResult`: [`ConfirmedTransactionResult`](../interfaces/types_transaction.ConfirmedTransactionResult.md) ; `operationPerformed`: ``"replace"`` } \| [`AppMetadata`](../interfaces/types_app.AppMetadata.md) & { `operationPerformed`: ``"nothing"`` }\> The app reference of the new/existing app #### Defined in -[deploy-app.ts:37](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/deploy-app.ts#L37) +[src/deploy-app.ts:38](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/deploy-app.ts#L38) ___ @@ -266,7 +266,7 @@ the transaction note ready for inclusion in a transaction #### Defined in -[transaction.ts:21](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction.ts#L21) +[src/transaction.ts:21](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction.ts#L21) ___ @@ -295,7 +295,7 @@ undefined if nothing was needed or the transaction send result #### Defined in -[transfer.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transfer.ts#L42) +[src/transfer.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transfer.ts#L42) ___ @@ -323,7 +323,7 @@ ___ #### Defined in -[indexer-lookup.ts:92](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/indexer-lookup.ts#L92) +[src/indexer-lookup.ts:92](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/indexer-lookup.ts#L92) ___ @@ -344,7 +344,7 @@ ___ #### Defined in -[app.ts:151](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L151) +[src/app.ts:167](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L167) ___ @@ -396,7 +396,7 @@ The requested account with private key loaded from the environment variables or #### Defined in -[account.ts:79](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account.ts#L79) +[src/account.ts:79](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account.ts#L79) ___ @@ -418,7 +418,7 @@ Returns the string address of an Algorand account from a base64 encoded version #### Defined in -[account.ts:132](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account.ts#L132) +[src/account.ts:132](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account.ts#L132) ___ @@ -440,7 +440,7 @@ Returns an account's address as a byte array #### Defined in -[account.ts:124](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account.ts#L124) +[src/account.ts:124](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account.ts#L124) ___ @@ -497,7 +497,7 @@ Custom (e.g. default local sandbox, although we recommend loading this into a .e #### Defined in -[network-client.ts:99](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/network-client.ts#L99) +[src/network-client.ts:99](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/network-client.ts#L99) ___ @@ -554,7 +554,7 @@ Custom (e.g. default local sandbox, although we recommend loading this into a .e #### Defined in -[network-client.ts:132](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/network-client.ts#L132) +[src/network-client.ts:132](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/network-client.ts#L132) ___ @@ -594,7 +594,7 @@ Custom (e.g. default local sandbox, although we recommend loading this into a .e #### Defined in -[network-client.ts:155](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/network-client.ts#L155) +[src/network-client.ts:155](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/network-client.ts#L155) ___ @@ -617,7 +617,7 @@ Returns the Algorand configuration to point to the AlgoNode service #### Defined in -[network-client.ts:45](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/network-client.ts#L45) +[src/network-client.ts:45](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/network-client.ts#L45) ___ @@ -633,7 +633,7 @@ Retrieve the algod configuration from environment variables (expects to be calle #### Defined in -[network-client.ts:7](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/network-client.ts#L7) +[src/network-client.ts:7](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/network-client.ts#L7) ___ @@ -659,7 +659,7 @@ object #### Defined in -[app.ts:183](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L183) +[src/app.ts:199](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L199) ___ @@ -684,7 +684,7 @@ The data about the app #### Defined in -[app.ts:268](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L268) +[src/app.ts:284](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L284) ___ @@ -714,7 +714,7 @@ The transaction note as a utf-8 string #### Defined in -[deploy-app.ts:454](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/deploy-app.ts#L454) +[src/deploy-app.ts:475](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/deploy-app.ts#L475) ___ @@ -739,7 +739,7 @@ The application client #### Defined in -[application-client.ts:10](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/application-client.ts#L10) +[src/application-client.ts:10](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/application-client.ts#L10) ___ @@ -770,7 +770,7 @@ A name-based lookup of the app information (id, address) #### Defined in -[deploy-app.ts:358](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/deploy-app.ts#L358) +[src/deploy-app.ts:379](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/deploy-app.ts#L379) ___ @@ -792,7 +792,7 @@ Returns the Algorand configuration to point to the default LocalNet #### Defined in -[network-client.ts:56](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/network-client.ts#L56) +[src/network-client.ts:56](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/network-client.ts#L56) ___ @@ -823,7 +823,7 @@ If running on Sandbox then it will return the default dispenser account automati #### Defined in -[account.ts:144](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account.ts#L144) +[src/account.ts:144](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account.ts#L144) ___ @@ -839,7 +839,7 @@ Retrieve the indexer configuration from environment variables (expects to be cal #### Defined in -[network-client.ts:24](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/network-client.ts#L24) +[src/network-client.ts:24](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/network-client.ts#L24) ___ @@ -878,7 +878,7 @@ const defaultDispenserAccount = await getKmdWalletAccount(algod, #### Defined in -[localnet.ts:90](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/localnet.ts#L90) +[src/localnet.ts:90](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/localnet.ts#L90) ___ @@ -903,7 +903,7 @@ Returns an Algorand account with private key loaded for the default LocalNet dis #### Defined in -[localnet.ts:141](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/localnet.ts#L141) +[src/localnet.ts:141](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/localnet.ts#L141) ___ @@ -943,7 +943,7 @@ An Algorand account with private key loaded - either one that already existed in #### Defined in -[localnet.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/localnet.ts#L32) +[src/localnet.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/localnet.ts#L32) ___ @@ -967,7 +967,7 @@ The public address #### Defined in -[transaction.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction.ts#L42) +[src/transaction.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction.ts#L42) ___ @@ -992,7 +992,7 @@ The suggested transaction parameters #### Defined in -[transaction.ts:291](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction.ts#L291) +[src/transaction.ts:291](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction.ts#L291) ___ @@ -1014,7 +1014,7 @@ Returns true if the algod client is pointing to a LocalNet Algorand network #### Defined in -[localnet.ts:9](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/localnet.ts#L9) +[src/localnet.ts:9](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/localnet.ts#L9) ___ @@ -1041,7 +1041,7 @@ Whether or not there is a breaking change #### Defined in -[deploy-app.ts:345](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/deploy-app.ts#L345) +[src/deploy-app.ts:366](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/deploy-app.ts#L366) ___ @@ -1070,7 +1070,7 @@ The list of application results #### Defined in -[indexer-lookup.ts:25](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/indexer-lookup.ts#L25) +[src/indexer-lookup.ts:25](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/indexer-lookup.ts#L25) ___ @@ -1095,7 +1095,7 @@ The result of the look-up #### Defined in -[indexer-lookup.ts:13](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/indexer-lookup.ts#L13) +[src/indexer-lookup.ts:13](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/indexer-lookup.ts#L13) ___ @@ -1121,7 +1121,7 @@ AlgoAmount #### Defined in -[amount.ts:10](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/amount.ts#L10) +[src/amount.ts:10](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/amount.ts#L10) ___ @@ -1145,7 +1145,7 @@ This is a wrapper around algosdk.mnemonicToSecretKey to provide a more friendly/ #### Defined in -[account.ts:45](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account.ts#L45) +[src/account.ts:45](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account.ts#L45) ___ @@ -1170,7 +1170,7 @@ A multisig account wrapper #### Defined in -[account.ts:14](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account.ts#L14) +[src/account.ts:14](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account.ts#L14) ___ @@ -1197,7 +1197,7 @@ The TEAL code with replacements #### Defined in -[deploy-app.ts:503](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/deploy-app.ts#L503) +[src/deploy-app.ts:524](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/deploy-app.ts#L524) ___ @@ -1226,7 +1226,7 @@ The information about the compiled code #### Defined in -[deploy-app.ts:533](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/deploy-app.ts#L533) +[src/deploy-app.ts:554](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/deploy-app.ts#L554) ___ @@ -1255,7 +1255,7 @@ The #### Defined in -[account.ts:24](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account.ts#L24) +[src/account.ts:24](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account.ts#L24) ___ @@ -1287,7 +1287,7 @@ The replaced TEAL code #### Defined in -[deploy-app.ts:472](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/deploy-app.ts#L472) +[src/deploy-app.ts:493](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/deploy-app.ts#L493) ___ @@ -1315,7 +1315,7 @@ The search results #### Defined in -[indexer-lookup.ts:58](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/indexer-lookup.ts#L58) +[src/indexer-lookup.ts:58](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/indexer-lookup.ts#L58) ___ @@ -1342,7 +1342,7 @@ An object with group transaction ID (`groupTransactionId`) and (if `skipWaiting` #### Defined in -[transaction.ts:115](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction.ts#L115) +[src/transaction.ts:115](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction.ts#L115) ___ @@ -1370,7 +1370,7 @@ An object with transaction (`transaction`) and (if `skipWaiting` is `false` or u #### Defined in -[transaction.ts:56](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction.ts#L56) +[src/transaction.ts:56](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction.ts#L56) ___ @@ -1396,7 +1396,7 @@ AlgoAmount #### Defined in -[amount.ts:15](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/amount.ts#L15) +[src/amount.ts:15](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/amount.ts#L15) ___ @@ -1425,7 +1425,7 @@ The #### Defined in -[account.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account.ts#L34) +[src/account.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account.ts#L34) ___ @@ -1450,13 +1450,13 @@ The transaction object and optionally the confirmation if it was sent to the cha #### Defined in -[transfer.ts:13](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transfer.ts#L13) +[src/transfer.ts:13](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transfer.ts#L13) ___ ### updateApp -▸ **updateApp**(`update`, `algod`): `Promise`<[`AppCallTransactionResult`](../interfaces/types_app.AppCallTransactionResult.md)\> +▸ **updateApp**(`update`, `algod`): `Promise`<`Partial`<[`AppCompilationResult`](../interfaces/types_app.AppCompilationResult.md)\> & [`AppCallTransactionResult`](../interfaces/types_app.AppCallTransactionResult.md)\> Updates a smart contract app. @@ -1469,13 +1469,13 @@ Updates a smart contract app. #### Returns -`Promise`<[`AppCallTransactionResult`](../interfaces/types_app.AppCallTransactionResult.md)\> +`Promise`<`Partial`<[`AppCompilationResult`](../interfaces/types_app.AppCompilationResult.md)\> & [`AppCallTransactionResult`](../interfaces/types_app.AppCallTransactionResult.md)\> The transaction #### Defined in -[app.ts:79](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L79) +[src/app.ts:88](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L88) ___ @@ -1506,4 +1506,4 @@ Pending transaction information #### Defined in -[transaction.ts:220](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction.ts#L220) +[src/transaction.ts:220](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction.ts#L220) diff --git a/docs/code/modules/testing.md b/docs/code/modules/testing.md index 6cc147ff..f02e6db4 100644 --- a/docs/code/modules/testing.md +++ b/docs/code/modules/testing.md @@ -45,7 +45,7 @@ The fixture #### Defined in -[testing/fixtures/algokit-log-capture-fixture.ts:21](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/fixtures/algokit-log-capture-fixture.ts#L21) +[src/testing/fixtures/algokit-log-capture-fixture.ts:21](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/fixtures/algokit-log-capture-fixture.ts#L21) ___ @@ -82,7 +82,7 @@ The fixture #### Defined in -[testing/fixtures/algorand-fixture.ts:22](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/fixtures/algorand-fixture.ts#L22) +[src/testing/fixtures/algorand-fixture.ts:22](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/fixtures/algorand-fixture.ts#L22) ___ @@ -115,7 +115,7 @@ The account, with private key loaded #### Defined in -[testing/account.ts:17](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/account.ts#L17) +[src/testing/account.ts:17](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/account.ts#L17) ___ @@ -153,4 +153,4 @@ The result (as a promise), or throws if the indexer didn't catch up in time #### Defined in -[testing/indexer.ts:11](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/indexer.ts#L11) +[src/testing/indexer.ts:11](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/indexer.ts#L11) diff --git a/docs/code/modules/types_account.md b/docs/code/modules/types_account.md index 139d6e43..520746e9 100644 --- a/docs/code/modules/types_account.md +++ b/docs/code/modules/types_account.md @@ -27,4 +27,4 @@ The account name identifier used for fund dispensing in test environments #### Defined in -[types/account.ts:6](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L6) +[src/types/account.ts:6](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L6) diff --git a/docs/code/modules/types_algod.md b/docs/code/modules/types_algod.md index d0230207..0b4e8374 100644 --- a/docs/code/modules/types_algod.md +++ b/docs/code/modules/types_algod.md @@ -30,4 +30,4 @@ https://developer.algorand.org/docs/rest-apis/algod/v2/#tealvalue #### Defined in -[types/algod.ts:99](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algod.ts#L99) +[src/types/algod.ts:99](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algod.ts#L99) diff --git a/docs/code/modules/types_app.md b/docs/code/modules/types_app.md index 9259cc0d..b16f1610 100644 --- a/docs/code/modules/types_app.md +++ b/docs/code/modules/types_app.md @@ -14,6 +14,7 @@ - [ABIAppCallArgs](../interfaces/types_app.ABIAppCallArgs.md) - [AppCallParams](../interfaces/types_app.AppCallParams.md) - [AppCallTransactionResult](../interfaces/types_app.AppCallTransactionResult.md) +- [AppCompilationResult](../interfaces/types_app.AppCompilationResult.md) - [AppDeployMetadata](../interfaces/types_app.AppDeployMetadata.md) - [AppDeploymentParams](../interfaces/types_app.AppDeploymentParams.md) - [AppLookup](../interfaces/types_app.AppLookup.md) @@ -49,7 +50,7 @@ #### Defined in -[types/app.ts:59](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L59) +[src/types/app.ts:59](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L59) ___ @@ -61,7 +62,7 @@ The return value of an ABI method call #### Defined in -[types/app.ts:160](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L160) +[src/types/app.ts:162](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L162) ___ @@ -75,7 +76,7 @@ Arguments to pass to an app call either: #### Defined in -[types/app.ts:82](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L82) +[src/types/app.ts:82](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L82) ## Variables @@ -87,7 +88,7 @@ First 4 bytes of SHA-512/256 hash of "return" for retrieving ABI return values #### Defined in -[types/app.ts:17](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L17) +[src/types/app.ts:17](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L17) ___ @@ -99,7 +100,7 @@ The app create/update ARC-2 transaction note prefix #### Defined in -[types/app.ts:11](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L11) +[src/types/app.ts:11](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L11) ___ @@ -111,7 +112,7 @@ The maximum number of bytes in a single app code page #### Defined in -[types/app.ts:14](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L14) +[src/types/app.ts:14](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L14) ___ @@ -123,7 +124,7 @@ The name of the TEAL template variable for deploy-time permanence control #### Defined in -[types/app.ts:8](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L8) +[src/types/app.ts:8](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L8) ___ @@ -135,4 +136,4 @@ The name of the TEAL template variable for deploy-time immutability control #### Defined in -[types/app.ts:5](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L5) +[src/types/app.ts:5](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L5) diff --git a/docs/code/modules/types_application_client.md b/docs/code/modules/types_application_client.md index 4b07dc3e..977df8e3 100644 --- a/docs/code/modules/types_application_client.md +++ b/docs/code/modules/types_application_client.md @@ -32,7 +32,7 @@ The arguments to pass to an Application Client smart contract call #### Defined in -[types/application-client.ts:92](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L92) +[src/types/application-client.ts:93](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L93) ___ @@ -44,7 +44,7 @@ Parameters to construct a ApplicationClient contract call #### Defined in -[types/application-client.ts:105](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L105) +[src/types/application-client.ts:106](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L106) ___ @@ -56,7 +56,7 @@ Parameters for creating a contract using ApplicationClient #### Defined in -[types/application-client.ts:115](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L115) +[src/types/application-client.ts:116](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L116) ___ @@ -68,7 +68,7 @@ Parameters for updating a contract using ApplicationClient #### Defined in -[types/application-client.ts:125](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L125) +[src/types/application-client.ts:126](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L126) ___ @@ -80,7 +80,7 @@ The details of an ARC-0032 app spec specified app #### Defined in -[types/application-client.ts:49](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L49) +[src/types/application-client.ts:50](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L50) ___ @@ -96,4 +96,4 @@ getCreatorAppsByName #### Defined in -[types/application-client.ts:24](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L24) +[src/types/application-client.ts:25](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L25) diff --git a/docs/code/modules/types_appspec.md b/docs/code/modules/types_appspec.md index 3e6a87c9..239d5de4 100644 --- a/docs/code/modules/types_appspec.md +++ b/docs/code/modules/types_appspec.md @@ -40,7 +40,7 @@ #### Defined in -[types/appspec.ts:26](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L26) +[src/types/appspec.ts:26](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L26) ___ @@ -50,7 +50,7 @@ ___ #### Defined in -[types/appspec.ts:19](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L19) +[src/types/appspec.ts:19](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L19) ___ @@ -67,7 +67,7 @@ ___ #### Defined in -[types/appspec.ts:86](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L86) +[src/types/appspec.ts:86](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L86) ___ @@ -77,7 +77,7 @@ ___ #### Defined in -[types/appspec.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L42) +[src/types/appspec.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L42) ## Functions @@ -97,4 +97,4 @@ ___ #### Defined in -[types/appspec.ts:91](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L91) +[src/types/appspec.ts:91](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/appspec.ts#L91) diff --git a/docs/code/modules/types_logging.md b/docs/code/modules/types_logging.md index ab7c96ca..a6b1ea3e 100644 --- a/docs/code/modules/types_logging.md +++ b/docs/code/modules/types_logging.md @@ -33,7 +33,7 @@ General purpose logger type, compatible with Winston and others. #### Defined in -[types/logging.ts:5](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/logging.ts#L5) +[src/types/logging.ts:5](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/logging.ts#L5) ## Variables @@ -45,7 +45,7 @@ A logger implementation that writes to console #### Defined in -[types/logging.ts:14](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/logging.ts#L14) +[src/types/logging.ts:14](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/logging.ts#L14) ___ @@ -57,4 +57,4 @@ A logger implementation that does nothing #### Defined in -[types/logging.ts:23](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/logging.ts#L23) +[src/types/logging.ts:23](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/logging.ts#L23) diff --git a/docs/code/modules/types_logic_error.md b/docs/code/modules/types_logic_error.md new file mode 100644 index 00000000..7f856b15 --- /dev/null +++ b/docs/code/modules/types_logic_error.md @@ -0,0 +1,13 @@ +[@algorandfoundation/algokit-utils](../README.md) / types/logic-error + +# Module: types/logic-error + +## Table of contents + +### Classes + +- [LogicError](../classes/types_logic_error.LogicError.md) + +### Interfaces + +- [LogicErrorDetails](../interfaces/types_logic_error.LogicErrorDetails.md) diff --git a/docs/code/modules/types_transaction.md b/docs/code/modules/types_transaction.md index 9ba146a2..6f9a1872 100644 --- a/docs/code/modules/types_transaction.md +++ b/docs/code/modules/types_transaction.md @@ -32,7 +32,7 @@ https://github.com/algorandfoundation/ARCs/blob/main/ARCs/arc-0002.md #### Defined in -[types/transaction.ts:10](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L10) +[src/types/transaction.ts:10](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L10) ___ @@ -42,7 +42,7 @@ ___ #### Defined in -[types/transaction.ts:53](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L53) +[src/types/transaction.ts:53](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L53) ___ @@ -52,7 +52,7 @@ ___ #### Defined in -[types/transaction.ts:6](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L6) +[src/types/transaction.ts:6](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L6) ___ @@ -62,4 +62,4 @@ ___ #### Defined in -[types/transaction.ts:8](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L8) +[src/types/transaction.ts:8](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L8) diff --git a/docs/code/modules/types_urlTokenBaseHTTPClient.md b/docs/code/modules/types_urlTokenBaseHTTPClient.md index 9bc397b2..1707e21b 100644 --- a/docs/code/modules/types_urlTokenBaseHTTPClient.md +++ b/docs/code/modules/types_urlTokenBaseHTTPClient.md @@ -27,4 +27,4 @@ #### Defined in -[types/urlTokenBaseHTTPClient.ts:33](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/urlTokenBaseHTTPClient.ts#L33) +[src/types/urlTokenBaseHTTPClient.ts:33](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/urlTokenBaseHTTPClient.ts#L33) diff --git a/src/app.ts b/src/app.ts index 06d12c4b..72e28e92 100644 --- a/src/app.ts +++ b/src/app.ts @@ -4,6 +4,7 @@ import algosdk, { AtomicTransactionComposer, makeBasicAccountTransactionSigner, OnApplicationComplete, + SourceMap, Transaction, } from 'algosdk' import { Buffer } from 'buffer' @@ -16,6 +17,7 @@ import { AppCallArgs, AppCallParams, AppCallTransactionResult, + AppCompilationResult, AppReference, APP_PAGE_MAX_SIZE, CompiledTeal, @@ -29,15 +31,20 @@ import { * @param algod An algod client * @returns The details of the created app, or the transaction to create it if `skipSending` */ -export async function createApp(create: CreateAppParams, algod: Algodv2): Promise { +export async function createApp( + create: CreateAppParams, + algod: Algodv2, +): Promise & AppCallTransactionResult & AppReference> { const { from, approvalProgram: approval, clearStateProgram: clear, schema, note, transactionParams, args, ...sendParams } = create - const approvalProgram = typeof approval === 'string' ? (await compileTeal(approval, algod)).compiledBase64ToBytes : approval - const clearProgram = typeof clear === 'string' ? (await compileTeal(clear, algod)).compiledBase64ToBytes : clear + const compiledApproval = typeof approval === 'string' ? await compileTeal(approval, algod) : undefined + const approvalProgram = compiledApproval ? compiledApproval.compiledBase64ToBytes : approval + const compiledClear = typeof clear === 'string' ? await compileTeal(clear, algod) : undefined + const clearProgram = compiledClear ? compiledClear.compiledBase64ToBytes : clear const transaction = algosdk.makeApplicationCreateTxnFromObject({ - approvalProgram: approvalProgram, - clearProgram: clearProgram, + approvalProgram: approvalProgram as Uint8Array, + clearProgram: clearProgram as Uint8Array, numLocalInts: schema.localInts, numLocalByteSlices: schema.localByteSlices, numGlobalInts: schema.globalInts, @@ -64,9 +71,11 @@ export async function createApp(create: CreateAppParams, algod: Algodv2): Promis appId, appAddress: algosdk.getApplicationAddress(appId), return: getABIReturn(args, confirmation), + compiledApproval, + compiledClear, } } else { - return { transaction, appId: 0, appAddress: '' } + return { transaction, appId: 0, appAddress: '', compiledApproval, compiledClear } } } @@ -76,16 +85,21 @@ export async function createApp(create: CreateAppParams, algod: Algodv2): Promis * @param algod An algod client * @returns The transaction */ -export async function updateApp(update: UpdateAppParams, algod: Algodv2): Promise { +export async function updateApp( + update: UpdateAppParams, + algod: Algodv2, +): Promise & AppCallTransactionResult> { const { appId, from, approvalProgram: approval, clearStateProgram: clear, note, transactionParams, args, ...sendParams } = update - const approvalProgram = typeof approval === 'string' ? (await compileTeal(approval, algod)).compiledBase64ToBytes : approval - const clearProgram = typeof clear === 'string' ? (await compileTeal(clear, algod)).compiledBase64ToBytes : clear + const compiledApproval = typeof approval === 'string' ? await compileTeal(approval, algod) : undefined + const approvalProgram = compiledApproval ? compiledApproval.compiledBase64ToBytes : approval + const compiledClear = typeof clear === 'string' ? await compileTeal(clear, algod) : undefined + const clearProgram = compiledClear ? compiledClear.compiledBase64ToBytes : clear const transaction = algosdk.makeApplicationUpdateTxnFromObject({ appIndex: appId, - approvalProgram: approvalProgram, - clearProgram: clearProgram, + approvalProgram: approvalProgram as Uint8Array, + clearProgram: clearProgram as Uint8Array, suggestedParams: await getTransactionParams(transactionParams, algod), from: getSenderAddress(from), note: encodeTransactionNote(note), @@ -100,6 +114,8 @@ export async function updateApp(update: UpdateAppParams, algod: Algodv2): Promis return { ...result, return: getABIReturn(args, result.confirmation), + compiledApproval, + compiledClear, } } @@ -277,11 +293,12 @@ export async function getAppByIndex(appId: number, algod: Algodv2) { * @returns The information about the compiled file */ export async function compileTeal(tealCode: string, algod: Algodv2): Promise { - const compiled = await algod.compile(tealCode).do() + const compiled = await algod.compile(tealCode).sourcemap(true).do() return { teal: tealCode, compiled: compiled.result, compiledHash: compiled.hash, compiledBase64ToBytes: new Uint8Array(Buffer.from(compiled.result, 'base64')), + sourceMap: new SourceMap(compiled['sourcemap']), } } diff --git a/src/deploy-app.ts b/src/deploy-app.ts index 241d9d50..566406d2 100644 --- a/src/deploy-app.ts +++ b/src/deploy-app.ts @@ -1,10 +1,11 @@ import { Algodv2, getApplicationAddress, Indexer, TransactionType } from 'algosdk' import { Config } from './' -import { callApp, createApp, getAppByIndex, updateApp } from './app' +import { callApp, compileTeal, createApp, getAppByIndex, updateApp } from './app' import { lookupAccountCreatedApplicationByAddress, searchTransactions } from './indexer-lookup' import { getSenderAddress, sendGroupOfTransactions } from './transaction' import { ApplicationStateSchema } from './types/algod' import { + AppCompilationResult, AppDeploymentParams, AppDeployMetadata, AppLookup, @@ -39,9 +40,12 @@ export async function deployApp( algod: Algodv2, indexer?: Indexer, ): Promise< - | (ConfirmedTransactionResult & AppMetadata & { operationPerformed: 'create' | 'update' }) - | (ConfirmedTransactionResult & AppMetadata & { deleteResult: ConfirmedTransactionResult; operationPerformed: 'replace' }) - | (AppMetadata & { operationPerformed: 'nothing' }) + Partial & + ( + | (ConfirmedTransactionResult & AppMetadata & { operationPerformed: 'create' | 'update' }) + | (ConfirmedTransactionResult & AppMetadata & { deleteResult: ConfirmedTransactionResult; operationPerformed: 'replace' }) + | (AppMetadata & { operationPerformed: 'nothing' }) + ) > { const { metadata, deployTimeParameters, onSchemaBreak, onUpdate, existingDeployments, createArgs, updateArgs, deleteArgs, ...appParams } = deployment @@ -61,20 +65,25 @@ export async function deployApp( } bytes of teal code and ${appParams.clearStateProgram.length} bytes of teal code`, ) - appParams.approvalProgram = + const compiledApproval = typeof appParams.approvalProgram === 'string' - ? (await performTemplateSubstitutionAndCompile(appParams.approvalProgram, algod, deployTimeParameters, metadata)) - .compiledBase64ToBytes - : appParams.approvalProgram - appParams.clearStateProgram = + ? await performTemplateSubstitutionAndCompile(appParams.approvalProgram, algod, deployTimeParameters, metadata) + : undefined + appParams.approvalProgram = compiledApproval ? compiledApproval.compiledBase64ToBytes : appParams.approvalProgram + + const compiledClear = typeof appParams.clearStateProgram === 'string' - ? (await performTemplateSubstitutionAndCompile(appParams.clearStateProgram, algod, deployTimeParameters)).compiledBase64ToBytes - : appParams.clearStateProgram + ? await performTemplateSubstitutionAndCompile(appParams.clearStateProgram, algod, deployTimeParameters) + : undefined + + appParams.clearStateProgram = compiledClear ? compiledClear.compiledBase64ToBytes : appParams.clearStateProgram // eslint-disable-next-line @typescript-eslint/no-non-null-assertion const apps = existingDeployments ?? (await getCreatorAppsByName(appParams.from, indexer!)) - const create = async (skipSending?: boolean): Promise => { + const create = async ( + skipSending?: boolean, + ): Promise & ConfirmedTransactionResult & AppMetadata & { operationPerformed: 'create' }> => { const result = await createApp( { ...appParams, @@ -98,6 +107,8 @@ export async function deployApp( ...metadata, deleted: false, operationPerformed: 'create', + compiledApproval, + compiledClear, } } @@ -142,7 +153,9 @@ export async function deployApp( const isSchemaBreak = isSchemaIsBroken(existingGlobalSchema, newGlobalSchema) || isSchemaIsBroken(existingLocalSchema, newLocalSchema) const replace = async (): Promise< - ConfirmedTransactionResult & AppMetadata & { deleteResult: ConfirmedTransactionResult; operationPerformed: 'replace' } + Partial & + ConfirmedTransactionResult & + AppMetadata & { deleteResult: ConfirmedTransactionResult; operationPerformed: 'replace' } > => { // Create @@ -219,10 +232,16 @@ export async function deployApp( deleted: false, deleteResult: { transaction: deleteTransaction, confirmation: deleteConfirmation }, operationPerformed: 'replace', - } as ConfirmedTransactionResult & AppMetadata & { deleteResult: ConfirmedTransactionResult; operationPerformed: 'replace' } + compiledApproval, + compiledClear, + } as Partial & + ConfirmedTransactionResult & + AppMetadata & { deleteResult: ConfirmedTransactionResult; operationPerformed: 'replace' } } - const update = async (): Promise => { + const update = async (): Promise< + Partial & ConfirmedTransactionResult & AppMetadata & { operationPerformed: 'update' } + > => { Config.getLogger(appParams.suppressLog).info( `Updating existing ${metadata.name} app for ${getSenderAddress(appParams.from)} to version ${metadata.version}.`, ) @@ -255,6 +274,8 @@ export async function deployApp( ...metadata, deleted: false, operationPerformed: 'update', + compiledApproval, + compiledClear, } } @@ -331,7 +352,7 @@ export async function deployApp( Config.getLogger(appParams.suppressLog).debug('No detected changes in app, nothing to do.') - return { ...existingApp, operationPerformed: 'nothing' } + return { ...existingApp, operationPerformed: 'nothing', compiledApproval, compiledClear } } /** Returns true is there is a breaking change in the application state schema from before to after. @@ -542,11 +563,5 @@ export async function performTemplateSubstitutionAndCompile( tealCode = replaceDeployTimeControlParams(tealCode, deploymentMetadata) } - const compiled = await algod.compile(tealCode).do() - return { - teal: tealCode, - compiled: compiled.result, - compiledHash: compiled.hash, - compiledBase64ToBytes: new Uint8Array(Buffer.from(compiled.result, 'base64')), - } + return await compileTeal(tealCode, algod) } diff --git a/src/types/app.ts b/src/types/app.ts index 648c94a2..9e95b804 100644 --- a/src/types/app.ts +++ b/src/types/app.ts @@ -1,4 +1,4 @@ -import { ABIArgument, ABIMethod, ABIMethodParams, ABIValue, Address, SuggestedParams, Transaction } from 'algosdk' +import { ABIArgument, ABIMethod, ABIMethodParams, ABIValue, Address, SourceMap, SuggestedParams, Transaction } from 'algosdk' import { SendTransactionFrom, SendTransactionParams, SendTransactionResult, TransactionNote, TransactionToSign } from './transaction' /** The name of the TEAL template variable for deploy-time immutability control */ @@ -148,6 +148,8 @@ export interface CompiledTeal { compiledHash: string /** The base64 encoded code as a byte array */ compiledBase64ToBytes: Uint8Array + /** Source map from the compilation */ + sourceMap: SourceMap } /** Result from calling an app */ @@ -245,3 +247,11 @@ export interface AppDeploymentParams extends Omit - !this.appSpec.hints[h].call_config.update_application && - this.appSpec.hints[h].call_config.update_application !== 'NEVER', - )[0] - : undefined, - deletable: - allowDelete ?? approval.includes(DELETABLE_TEMPLATE_NAME) - ? (!this.appSpec.bare_call_config.delete_application && this.appSpec.bare_call_config.delete_application !== 'NEVER') || - !!Object.keys(this.appSpec.hints).filter( - (h) => - !this.appSpec.hints[h].call_config.delete_application && - this.appSpec.hints[h].call_config.delete_application !== 'NEVER', - )[0] - : undefined, - }, - schema: { - globalByteSlices: this.appSpec.state.global.num_byte_slices, - globalInts: this.appSpec.state.global.num_uints, - localByteSlices: this.appSpec.state.local.num_byte_slices, - localInts: this.appSpec.state.local.num_uints, + try { + await this.getAppReference() + const result = await deployApp( + { + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + from, + approvalProgram: approval, + clearStateProgram: clear, + metadata: { + name: this._appName, + // todo: intelligent version management + version: version ?? '1.0', + updatable: + allowUpdate ?? approval.includes(UPDATABLE_TEMPLATE_NAME) + ? (!this.appSpec.bare_call_config.update_application && this.appSpec.bare_call_config.update_application !== 'NEVER') || + !!Object.keys(this.appSpec.hints).filter( + (h) => + !this.appSpec.hints[h].call_config.update_application && + this.appSpec.hints[h].call_config.update_application !== 'NEVER', + )[0] + : undefined, + deletable: + allowDelete ?? approval.includes(DELETABLE_TEMPLATE_NAME) + ? (!this.appSpec.bare_call_config.delete_application && this.appSpec.bare_call_config.delete_application !== 'NEVER') || + !!Object.keys(this.appSpec.hints).filter( + (h) => + !this.appSpec.hints[h].call_config.delete_application && + this.appSpec.hints[h].call_config.delete_application !== 'NEVER', + )[0] + : undefined, + }, + schema: { + globalByteSlices: this.appSpec.state.global.num_byte_slices, + globalInts: this.appSpec.state.global.num_uints, + localByteSlices: this.appSpec.state.local.num_byte_slices, + localInts: this.appSpec.state.local.num_uints, + }, + transactionParams: this.params, + ...(sendParams ?? {}), + existingDeployments: this.existingDeployments, + createArgs: this.getCallArgs(createArgs), + updateArgs: this.getCallArgs(updateArgs), + deleteArgs: this.getCallArgs(deleteArgs), + ...deployArgs, }, - transactionParams: this.params, - ...(sendParams ?? {}), - existingDeployments: this.existingDeployments, - createArgs: this.getCallArgs(createArgs), - updateArgs: this.getCallArgs(updateArgs), - deleteArgs: this.getCallArgs(deleteArgs), - ...deployArgs, - }, - this.algod, - this.indexer, - ) - - // Nothing needed to happen - if (result.operationPerformed === 'nothing') { - return result - } + this.algod, + this.indexer, + ) - if (!this.existingDeployments) { - throw new Error('Expected existingDeployments to be present') - } - const { transaction, confirmation, operationPerformed, ...appMetadata } = result - this.existingDeployments = { - creator: this.existingDeployments.creator, - apps: { ...this.existingDeployments.apps, [this._appName]: appMetadata }, - } + this._approvalSourceMap = result.compiledApproval?.sourceMap + this._clearSourceMap = result.compiledClear?.sourceMap + + // Nothing needed to happen + if (result.operationPerformed === 'nothing') { + return result + } - return result + if (!this.existingDeployments) { + throw new Error('Expected existingDeployments to be present') + } + const { transaction, confirmation, operationPerformed, ...appMetadata } = result + this.existingDeployments = { + creator: this.existingDeployments.creator, + apps: { ...this.existingDeployments.apps, [this._appName]: appMetadata }, + } + + return result + } catch (e) { + throw this.handleLogicError(e as Error) + } } async create(create?: AppClientCreateParams) { @@ -293,36 +304,43 @@ export class ApplicationClient { const approval = Buffer.from(this.appSpec.source.approval, 'base64').toString('utf-8') const clear = Buffer.from(this.appSpec.source.clear, 'base64').toString('utf-8') - const result = await createApp( - { - // eslint-disable-next-line @typescript-eslint/no-non-null-assertion - from: sender ?? this.sender!, - approvalProgram: replaceDeployTimeControlParams(performTemplateSubstitution(approval, deployTimeParameters), { - updatable, - deletable, - }), - clearStateProgram: performTemplateSubstitution(clear, deployTimeParameters), - schema: { - globalByteSlices: this.appSpec.state.global.num_byte_slices, - globalInts: this.appSpec.state.global.num_uints, - localByteSlices: this.appSpec.state.local.num_byte_slices, - localInts: this.appSpec.state.local.num_uints, + try { + const result = await createApp( + { + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + from: sender ?? this.sender!, + approvalProgram: replaceDeployTimeControlParams(performTemplateSubstitution(approval, deployTimeParameters), { + updatable, + deletable, + }), + clearStateProgram: performTemplateSubstitution(clear, deployTimeParameters), + schema: { + globalByteSlices: this.appSpec.state.global.num_byte_slices, + globalInts: this.appSpec.state.global.num_uints, + localByteSlices: this.appSpec.state.local.num_byte_slices, + localInts: this.appSpec.state.local.num_uints, + }, + args: this.getCallArgs(args), + note: note, + transactionParams: this.params, + ...(sendParams ?? {}), }, - args: this.getCallArgs(args), - note: note, - transactionParams: this.params, - ...(sendParams ?? {}), - }, - this.algod, - ) - - if (result.confirmation) { - // eslint-disable-next-line @typescript-eslint/no-non-null-assertion - this._appId = result.confirmation['application-index']! - this._appAddress = getApplicationAddress(this._appId) - } + this.algod, + ) - return result + this._approvalSourceMap = result.compiledApproval?.sourceMap + this._clearSourceMap = result.compiledClear?.sourceMap + + if (result.confirmation) { + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + this._appId = result.confirmation['application-index']! + this._appAddress = getApplicationAddress(this._appId) + } + + return result + } catch (e) { + throw this.handleLogicError(e as Error) + } } async update(update?: AppClientUpdateParams) { @@ -339,25 +357,32 @@ export class ApplicationClient { const approval = Buffer.from(this.appSpec.source.approval, 'base64').toString('utf-8') const clear = Buffer.from(this.appSpec.source.clear, 'base64').toString('utf-8') - const result = await updateApp( - { - appId: this._appId, - // eslint-disable-next-line @typescript-eslint/no-non-null-assertion - from: sender ?? this.sender!, - approvalProgram: replaceDeployTimeControlParams(performTemplateSubstitution(approval, deployTimeParameters), { - updatable, - deletable, - }), - clearStateProgram: performTemplateSubstitution(clear, deployTimeParameters), - args: this.getCallArgs(args), - note: note, - transactionParams: this.params, - ...(sendParams ?? {}), - }, - this.algod, - ) - - return result + try { + const result = await updateApp( + { + appId: this._appId, + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + from: sender ?? this.sender!, + approvalProgram: replaceDeployTimeControlParams(performTemplateSubstitution(approval, deployTimeParameters), { + updatable, + deletable, + }), + clearStateProgram: performTemplateSubstitution(clear, deployTimeParameters), + args: this.getCallArgs(args), + note: note, + transactionParams: this.params, + ...(sendParams ?? {}), + }, + this.algod, + ) + + this._approvalSourceMap = result.compiledApproval?.sourceMap + this._clearSourceMap = result.compiledClear?.sourceMap + + return result + } catch (e) { + throw this.handleLogicError(e as Error) + } } async call(call: AppClientCallParams) { @@ -396,19 +421,23 @@ export class ApplicationClient { // todo: support unwrapping a logic error and source map. // todo: support readonly method calls - return callApp( - { - appId: appMetadata.appId, - callType: callType, - // eslint-disable-next-line @typescript-eslint/no-non-null-assertion - from: sender ?? this.sender!, - args: this.getCallArgs(args), - note: note, - transactionParams: this.params, - ...(sendParams ?? {}), - }, - this.algod, - ) + try { + return callApp( + { + appId: appMetadata.appId, + callType: callType, + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + from: sender ?? this.sender!, + args: this.getCallArgs(args), + note: note, + transactionParams: this.params, + ...(sendParams ?? {}), + }, + this.algod, + ) + } catch (e) { + throw this.handleLogicError(e as Error) + } } getCallArgs(args?: AppClientCallArgs): AppCallArgs | undefined { @@ -469,4 +498,21 @@ export class ApplicationClient { appAddress: this._appAddress, } as AppReference } + + private handleLogicError(e: Error, isClear?: boolean): Error { + if ((!isClear && this._approvalSourceMap == undefined) || (isClear && this._clearSourceMap == undefined)) return e + + const errorDetails = LogicError.parseLogicError(e.message) + + if (errorDetails.msg !== undefined) + return new LogicError( + errorDetails, + Buffer.from(isClear ? this.appSpec.source.clear : this.appSpec.source.approval, 'base64') + .toString() + .split('\n'), + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + isClear ? this._clearSourceMap! : this._approvalSourceMap!, + ) + else return e + } } diff --git a/src/types/logic-error.ts b/src/types/logic-error.ts new file mode 100644 index 00000000..edd21346 --- /dev/null +++ b/src/types/logic-error.ts @@ -0,0 +1,50 @@ +import type algosdk from 'algosdk' + +const LOGIC_ERROR = /TransactionPool.Remember: transaction ([A-Z0-9]+): logic eval error: (.*). Details: pc=([0-9]+), opcodes=.*/ + +export interface LogicErrorDetails { + txId: string + pc: number + msg: string +} + +export class LogicError extends Error { + static parseLogicError(errMsg: string): LogicErrorDetails { + const res = LOGIC_ERROR.exec(errMsg) + if (res === null || res.length <= 3) return {} as LogicErrorDetails + + return { + txId: res[1], + msg: res[2], + pc: parseInt(res[3] ? res[3] : '0'), + } as LogicErrorDetails + } + + led: LogicErrorDetails + program: string[] + lines = 5 + teal_line = 0 + override stack?: string + + constructor(led: LogicErrorDetails, program: string[], map: algosdk.SourceMap) { + super() + this.led = led + this.program = program + + const line = map.getLineForPc(led.pc) + this.teal_line = line === undefined ? 0 : line + + this.message = `${this.led.msg.slice(0, 20)}... at:${line}` + + if (this.teal_line > 0) { + const start = this.teal_line > this.lines ? this.teal_line - this.lines : 0 + const stop = program.length > this.teal_line + this.lines ? this.teal_line + this.lines : program.length + + const stack_lines = program.slice(start, stop) + + stack_lines[stack_lines.length / 2] += ' <--- Error' + + this.stack = stack_lines.join('\n') + } + } +}