From 10a193696ea0a22c5b5514bcd08949759fa17d26 Mon Sep 17 00:00:00 2001 From: Neil Campbell Date: Fri, 13 Dec 2024 12:49:54 +0800 Subject: [PATCH] fix: replace JSON.stringify to handle bigint --- docs/code/classes/testing.TestLogger.md | 22 ++-- ..._sender.AlgorandClientTransactionSender.md | 54 ++++----- .../types_composer.TransactionComposer.md | 108 +++++++++--------- ...penser_client.TestNetDispenserApiClient.md | 18 +-- .../types_composer.BuiltTransactions.md | 6 +- ..._dispenser_client.DispenserFundResponse.md | 4 +- ...dispenser_client.DispenserLimitResponse.md | 2 +- ..._client.TestNetDispenserApiClientParams.md | 4 +- docs/code/modules/types_composer.md | 58 +++++----- package-lock.json | 6 +- src/testing/test-logger.ts | 11 +- src/transaction/transaction.ts | 6 +- .../algorand-client-transaction-sender.ts | 12 +- src/types/app-client.ts | 8 +- src/types/composer.ts | 3 +- src/types/dispenser-client.ts | 3 +- src/util.ts | 18 +++ 17 files changed, 187 insertions(+), 156 deletions(-) diff --git a/docs/code/classes/testing.TestLogger.md b/docs/code/classes/testing.TestLogger.md index e4588d41..fbe759b7 100644 --- a/docs/code/classes/testing.TestLogger.md +++ b/docs/code/classes/testing.TestLogger.md @@ -56,7 +56,7 @@ Create a new test logger that wraps the given logger if provided. #### Defined in -[src/testing/test-logger.ts:15](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L15) +[src/testing/test-logger.ts:16](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L16) ## Properties @@ -66,7 +66,7 @@ Create a new test logger that wraps the given logger if provided. #### Defined in -[src/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:10](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L10) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[src/testing/test-logger.ts:8](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L8) +[src/testing/test-logger.ts:9](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L9) ## Accessors @@ -92,7 +92,7 @@ Returns all logs captured thus far. #### Defined in -[src/testing/test-logger.ts:21](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L21) +[src/testing/test-logger.ts:22](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L22) ## Methods @@ -108,7 +108,7 @@ Clears all logs captured so far. #### Defined in -[src/testing/test-logger.ts:26](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L26) +[src/testing/test-logger.ts:27](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L27) ___ @@ -133,7 +133,7 @@ Logger.debug #### Defined in -[src/testing/test-logger.ts:88](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L88) +[src/testing/test-logger.ts:89](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L89) ___ @@ -158,7 +158,7 @@ Logger.error #### Defined in -[src/testing/test-logger.ts:72](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L72) +[src/testing/test-logger.ts:73](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L73) ___ @@ -194,7 +194,7 @@ expect(logger.getLogSnapshot()).toMatchSnapshot() #### Defined in -[src/testing/test-logger.ts:46](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L46) +[src/testing/test-logger.ts:47](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L47) ___ @@ -219,7 +219,7 @@ Logger.info #### Defined in -[src/testing/test-logger.ts:80](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L80) +[src/testing/test-logger.ts:81](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L81) ___ @@ -244,7 +244,7 @@ Logger.verbose #### Defined in -[src/testing/test-logger.ts:84](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L84) +[src/testing/test-logger.ts:85](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L85) ___ @@ -269,4 +269,4 @@ Logger.warn #### Defined in -[src/testing/test-logger.ts:76](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L76) +[src/testing/test-logger.ts:77](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L77) diff --git a/docs/code/classes/types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md b/docs/code/classes/types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md index 8be9e39f..3ce93bea 100644 --- a/docs/code/classes/types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md +++ b/docs/code/classes/types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md @@ -66,7 +66,7 @@ Creates a new `AlgorandClientSender` #### Defined in -[src/types/algorand-client-transaction-sender.ts:38](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L38) +[src/types/algorand-client-transaction-sender.ts:48](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L48) ## Properties @@ -76,7 +76,7 @@ Creates a new `AlgorandClientSender` #### Defined in -[src/types/algorand-client-transaction-sender.ts:31](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L31) +[src/types/algorand-client-transaction-sender.ts:41](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L41) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[src/types/algorand-client-transaction-sender.ts:30](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L30) +[src/types/algorand-client-transaction-sender.ts:40](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L40) ___ @@ -104,7 +104,7 @@ ___ #### Defined in -[src/types/algorand-client-transaction-sender.ts:29](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L29) +[src/types/algorand-client-transaction-sender.ts:39](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L39) ___ @@ -168,7 +168,7 @@ await algorand.send.appCall({ #### Defined in -[src/types/algorand-client-transaction-sender.ts:708](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L708) +[src/types/algorand-client-transaction-sender.ts:718](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L718) ___ @@ -244,7 +244,7 @@ await algorand.send.appCallMethodCall({ #### Defined in -[src/types/algorand-client-transaction-sender.ts:944](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L944) +[src/types/algorand-client-transaction-sender.ts:954](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L954) ___ @@ -318,7 +318,7 @@ await algorand.send.appCreate({ #### Defined in -[src/types/algorand-client-transaction-sender.ts:574](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L574) +[src/types/algorand-client-transaction-sender.ts:584](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L584) ___ @@ -404,7 +404,7 @@ await algorand.send.appCreate({ #### Defined in -[src/types/algorand-client-transaction-sender.ts:774](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L774) +[src/types/algorand-client-transaction-sender.ts:784](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L784) ___ @@ -468,7 +468,7 @@ await algorand.send.appDelete({ #### Defined in -[src/types/algorand-client-transaction-sender.ts:664](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L664) +[src/types/algorand-client-transaction-sender.ts:674](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L674) ___ @@ -544,7 +544,7 @@ await algorand.send.appDeleteMethodCall({ #### Defined in -[src/types/algorand-client-transaction-sender.ts:888](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L888) +[src/types/algorand-client-transaction-sender.ts:898](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L898) ___ @@ -610,7 +610,7 @@ await algorand.send.appUpdate({ #### Defined in -[src/types/algorand-client-transaction-sender.ts:620](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L620) +[src/types/algorand-client-transaction-sender.ts:630](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L630) ___ @@ -688,7 +688,7 @@ await algorand.send.appUpdateMethodCall({ #### Defined in -[src/types/algorand-client-transaction-sender.ts:832](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L832) +[src/types/algorand-client-transaction-sender.ts:842](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L842) ___ @@ -753,7 +753,7 @@ await algorand.send.assetConfig({ #### Defined in -[src/types/algorand-client-transaction-sender.ts:285](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L285) +[src/types/algorand-client-transaction-sender.ts:295](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L295) ___ @@ -814,7 +814,7 @@ await algorand.send.assetDestroy({ #### Defined in -[src/types/algorand-client-transaction-sender.ts:365](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L365) +[src/types/algorand-client-transaction-sender.ts:375](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L375) ___ @@ -873,7 +873,7 @@ await algorand.send.assetFreeze({ #### Defined in -[src/types/algorand-client-transaction-sender.ts:324](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L324) +[src/types/algorand-client-transaction-sender.ts:334](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L334) ___ @@ -930,7 +930,7 @@ await algorand.send.assetOptIn({ #### Defined in -[src/types/algorand-client-transaction-sender.ts:445](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L445) +[src/types/algorand-client-transaction-sender.ts:455](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L455) ___ @@ -992,7 +992,7 @@ await algorand.send.assetTransfer({ #### Defined in -[src/types/algorand-client-transaction-sender.ts:407](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L407) +[src/types/algorand-client-transaction-sender.ts:417](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L417) ___ @@ -1018,7 +1018,7 @@ Register an offline key. #### Defined in -[src/types/algorand-client-transaction-sender.ts:955](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L955) +[src/types/algorand-client-transaction-sender.ts:965](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L965) ___ @@ -1044,7 +1044,7 @@ Register an online key. #### Defined in -[src/types/algorand-client-transaction-sender.ts:950](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L950) +[src/types/algorand-client-transaction-sender.ts:960](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L960) ___ @@ -1109,7 +1109,7 @@ const result = await algorand.send.payment({ #### Defined in -[src/types/algorand-client-transaction-sender.ts:185](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L185) +[src/types/algorand-client-transaction-sender.ts:195](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L195) ## Methods @@ -1150,7 +1150,7 @@ const result = await algorand.send.payment({ #### Defined in -[src/types/algorand-client-transaction-sender.ts:48](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L48) +[src/types/algorand-client-transaction-sender.ts:58](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L58) ___ @@ -1191,7 +1191,7 @@ ___ #### Defined in -[src/types/algorand-client-transaction-sender.ts:83](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L83) +[src/types/algorand-client-transaction-sender.ts:93](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L93) ___ @@ -1232,7 +1232,7 @@ ___ #### Defined in -[src/types/algorand-client-transaction-sender.ts:126](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L126) +[src/types/algorand-client-transaction-sender.ts:136](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L136) ___ @@ -1273,7 +1273,7 @@ ___ #### Defined in -[src/types/algorand-client-transaction-sender.ts:107](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L107) +[src/types/algorand-client-transaction-sender.ts:117](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L117) ___ @@ -1341,7 +1341,7 @@ await algorand.send.assetCreate({ #### Defined in -[src/types/algorand-client-transaction-sender.ts:236](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L236) +[src/types/algorand-client-transaction-sender.ts:246](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L246) ___ @@ -1408,7 +1408,7 @@ await algorand.send.assetOptOut({ #### Defined in -[src/types/algorand-client-transaction-sender.ts:492](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L492) +[src/types/algorand-client-transaction-sender.ts:502](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L502) ___ @@ -1422,4 +1422,4 @@ ___ #### Defined in -[src/types/algorand-client-transaction-sender.ts:44](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L44) +[src/types/algorand-client-transaction-sender.ts:54](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L54) diff --git a/docs/code/classes/types_composer.TransactionComposer.md b/docs/code/classes/types_composer.TransactionComposer.md index 95403f5e..2d0b43fa 100644 --- a/docs/code/classes/types_composer.TransactionComposer.md +++ b/docs/code/classes/types_composer.TransactionComposer.md @@ -89,7 +89,7 @@ Create a `TransactionComposer`. #### Defined in -[src/types/composer.ts:542](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L542) +[src/types/composer.ts:543](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L543) ## Properties @@ -101,7 +101,7 @@ The algod client used by the composer. #### Defined in -[src/types/composer.ts:522](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L522) +[src/types/composer.ts:523](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L523) ___ @@ -111,7 +111,7 @@ ___ #### Defined in -[src/types/composer.ts:536](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L536) +[src/types/composer.ts:537](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L537) ___ @@ -123,7 +123,7 @@ The ATC used to compose the group #### Defined in -[src/types/composer.ts:513](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L513) +[src/types/composer.ts:514](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L514) ___ @@ -135,7 +135,7 @@ The default transaction validity window #### Defined in -[src/types/composer.ts:531](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L531) +[src/types/composer.ts:532](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L532) ___ @@ -147,7 +147,7 @@ Whether the validity window was explicitly set on construction #### Defined in -[src/types/composer.ts:534](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L534) +[src/types/composer.ts:535](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L535) ___ @@ -173,7 +173,7 @@ A function that takes in an address and return a signer function for that addres #### Defined in -[src/types/composer.ts:528](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L528) +[src/types/composer.ts:529](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L529) ___ @@ -193,7 +193,7 @@ An async function that will return suggested params for the transaction. #### Defined in -[src/types/composer.ts:525](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L525) +[src/types/composer.ts:526](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L526) ___ @@ -205,7 +205,7 @@ Map of txid to ABI method #### Defined in -[src/types/composer.ts:516](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L516) +[src/types/composer.ts:517](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L517) ___ @@ -217,7 +217,7 @@ Transactions that have not yet been composed #### Defined in -[src/types/composer.ts:519](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L519) +[src/types/composer.ts:520](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L520) ___ @@ -229,7 +229,7 @@ Signer used to represent a lack of signer #### Defined in -[src/types/composer.ts:510](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L510) +[src/types/composer.ts:511](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L511) ## Methods @@ -257,7 +257,7 @@ The composer so you can chain method calls #### Defined in -[src/types/composer.ts:704](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L704) +[src/types/composer.ts:705](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L705) ___ @@ -283,7 +283,7 @@ The composer so you can chain method calls #### Defined in -[src/types/composer.ts:753](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L753) +[src/types/composer.ts:754](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L754) ___ @@ -334,7 +334,7 @@ The composer so you can chain method calls #### Defined in -[src/types/composer.ts:663](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L663) +[src/types/composer.ts:664](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L664) ___ @@ -360,7 +360,7 @@ The composer so you can chain method calls #### Defined in -[src/types/composer.ts:717](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L717) +[src/types/composer.ts:718](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L718) ___ @@ -386,7 +386,7 @@ The composer so you can chain method calls #### Defined in -[src/types/composer.ts:689](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L689) +[src/types/composer.ts:690](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L690) ___ @@ -412,7 +412,7 @@ The composer so you can chain method calls #### Defined in -[src/types/composer.ts:741](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L741) +[src/types/composer.ts:742](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L742) ___ @@ -458,7 +458,7 @@ The composer so you can chain method calls #### Defined in -[src/types/composer.ts:676](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L676) +[src/types/composer.ts:677](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L677) ___ @@ -484,7 +484,7 @@ The composer so you can chain method calls #### Defined in -[src/types/composer.ts:729](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L729) +[src/types/composer.ts:730](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L730) ___ @@ -508,7 +508,7 @@ The composer so you can chain method calls #### Defined in -[src/types/composer.ts:595](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L595) +[src/types/composer.ts:596](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L596) ___ @@ -532,7 +532,7 @@ The composer so you can chain method calls #### Defined in -[src/types/composer.ts:584](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L584) +[src/types/composer.ts:585](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L585) ___ @@ -556,7 +556,7 @@ The composer so you can chain method calls #### Defined in -[src/types/composer.ts:617](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L617) +[src/types/composer.ts:618](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L618) ___ @@ -580,7 +580,7 @@ The composer so you can chain method calls #### Defined in -[src/types/composer.ts:606](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L606) +[src/types/composer.ts:607](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L607) ___ @@ -604,7 +604,7 @@ The composer so you can chain method calls #### Defined in -[src/types/composer.ts:639](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L639) +[src/types/composer.ts:640](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L640) ___ @@ -628,7 +628,7 @@ The composer so you can chain method calls #### Defined in -[src/types/composer.ts:650](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L650) +[src/types/composer.ts:651](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L651) ___ @@ -652,7 +652,7 @@ The composer so you can chain method calls #### Defined in -[src/types/composer.ts:628](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L628) +[src/types/composer.ts:629](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L629) ___ @@ -676,7 +676,7 @@ The composer so you can chain method calls #### Defined in -[src/types/composer.ts:785](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L785) +[src/types/composer.ts:786](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L786) ___ @@ -700,7 +700,7 @@ The composer so you can chain method calls #### Defined in -[src/types/composer.ts:774](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L774) +[src/types/composer.ts:775](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L775) ___ @@ -724,7 +724,7 @@ The composer so you can chain method calls #### Defined in -[src/types/composer.ts:763](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L763) +[src/types/composer.ts:764](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L764) ___ @@ -748,7 +748,7 @@ The composer so you can chain method calls #### Defined in -[src/types/composer.ts:573](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L573) +[src/types/composer.ts:574](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L574) ___ @@ -773,7 +773,7 @@ The composer so you can chain method calls #### Defined in -[src/types/composer.ts:558](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L558) +[src/types/composer.ts:559](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L559) ___ @@ -796,7 +796,7 @@ The built atomic transaction composer and the transactions #### Defined in -[src/types/composer.ts:1240](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1240) +[src/types/composer.ts:1241](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1241) ___ @@ -817,7 +817,7 @@ ___ #### Defined in -[src/types/composer.ts:1063](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1063) +[src/types/composer.ts:1064](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1064) ___ @@ -838,7 +838,7 @@ ___ #### Defined in -[src/types/composer.ts:1020](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1020) +[src/types/composer.ts:1021](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1021) ___ @@ -859,7 +859,7 @@ ___ #### Defined in -[src/types/composer.ts:1002](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1002) +[src/types/composer.ts:1003](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1003) ___ @@ -880,7 +880,7 @@ ___ #### Defined in -[src/types/composer.ts:1033](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1033) +[src/types/composer.ts:1034](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1034) ___ @@ -901,7 +901,7 @@ ___ #### Defined in -[src/types/composer.ts:1041](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1041) +[src/types/composer.ts:1042](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1042) ___ @@ -922,7 +922,7 @@ ___ #### Defined in -[src/types/composer.ts:1051](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1051) +[src/types/composer.ts:1052](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1052) ___ @@ -944,7 +944,7 @@ Build an ATC and return transactions ready to be incorporated into a broader set #### Defined in -[src/types/composer.ts:791](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L791) +[src/types/composer.ts:792](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L792) ___ @@ -965,7 +965,7 @@ ___ #### Defined in -[src/types/composer.ts:1114](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1114) +[src/types/composer.ts:1115](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1115) ___ @@ -989,7 +989,7 @@ Builds an ABI method call transaction and any other associated transactions repr #### Defined in -[src/types/composer.ts:861](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L861) +[src/types/composer.ts:862](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L862) ___ @@ -1010,7 +1010,7 @@ ___ #### Defined in -[src/types/composer.ts:992](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L992) +[src/types/composer.ts:993](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L993) ___ @@ -1028,7 +1028,7 @@ The array of built transactions and any corresponding method calls #### Defined in -[src/types/composer.ts:1187](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1187) +[src/types/composer.ts:1188](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1188) ___ @@ -1051,7 +1051,7 @@ Builds all transaction types apart from `txnWithSigner`, `atc` and `methodCall` #### Defined in -[src/types/composer.ts:1137](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1137) +[src/types/composer.ts:1138](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1138) ___ @@ -1072,7 +1072,7 @@ ___ #### Defined in -[src/types/composer.ts:1164](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1164) +[src/types/composer.ts:1165](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1165) ___ @@ -1100,7 +1100,7 @@ ___ #### Defined in -[src/types/composer.ts:807](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L807) +[src/types/composer.ts:808](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L808) ___ @@ -1116,7 +1116,7 @@ Get the number of transactions currently added to this composer. #### Defined in -[src/types/composer.ts:1227](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1227) +[src/types/composer.ts:1228](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1228) ___ @@ -1146,7 +1146,7 @@ An alias for `composer.send(params)`. #### Defined in -[src/types/composer.ts:1309](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1309) +[src/types/composer.ts:1310](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1310) ___ @@ -1165,7 +1165,7 @@ The newly built atomic transaction composer and the transactions #### Defined in -[src/types/composer.ts:1269](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1269) +[src/types/composer.ts:1270](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1270) ___ @@ -1189,7 +1189,7 @@ The execution result #### Defined in -[src/types/composer.ts:1279](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1279) +[src/types/composer.ts:1280](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1280) ___ @@ -1207,7 +1207,7 @@ The simulation result #### Defined in -[src/types/composer.ts:1317](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1317) +[src/types/composer.ts:1318](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1318) ▸ **simulate**(`options`): `Promise`\<[`SendAtomicTransactionComposerResults`](../interfaces/types_transaction.SendAtomicTransactionComposerResults.md) & \{ `simulateResponse`: `SimulateResponse` }\> @@ -1229,7 +1229,7 @@ The simulation result #### Defined in -[src/types/composer.ts:1318](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1318) +[src/types/composer.ts:1319](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1319) ▸ **simulate**(`options`): `Promise`\<[`SendAtomicTransactionComposerResults`](../interfaces/types_transaction.SendAtomicTransactionComposerResults.md) & \{ `simulateResponse`: `SimulateResponse` }\> @@ -1252,7 +1252,7 @@ The simulation result #### Defined in -[src/types/composer.ts:1321](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1321) +[src/types/composer.ts:1322](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1322) ___ @@ -1278,4 +1278,4 @@ The binary encoded transaction note #### Defined in -[src/types/composer.ts:1398](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1398) +[src/types/composer.ts:1399](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1399) diff --git a/docs/code/classes/types_dispenser_client.TestNetDispenserApiClient.md b/docs/code/classes/types_dispenser_client.TestNetDispenserApiClient.md index e6777ae9..54cb73d5 100644 --- a/docs/code/classes/types_dispenser_client.TestNetDispenserApiClient.md +++ b/docs/code/classes/types_dispenser_client.TestNetDispenserApiClient.md @@ -78,7 +78,7 @@ If neither the environment variable 'ALGOKIT_DISPENSER_ACCESS_TOKEN' nor the aut #### Defined in -[src/types/dispenser-client.ts:75](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L75) +[src/types/dispenser-client.ts:76](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L76) ## Properties @@ -88,7 +88,7 @@ If neither the environment variable 'ALGOKIT_DISPENSER_ACCESS_TOKEN' nor the aut #### Defined in -[src/types/dispenser-client.ts:72](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L72) +[src/types/dispenser-client.ts:73](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L73) ___ @@ -98,7 +98,7 @@ ___ #### Defined in -[src/types/dispenser-client.ts:73](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L73) +[src/types/dispenser-client.ts:74](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L74) ## Accessors @@ -114,7 +114,7 @@ The authentication token used for API requests. #### Defined in -[src/types/dispenser-client.ts:91](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L91) +[src/types/dispenser-client.ts:92](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L92) ___ @@ -130,7 +130,7 @@ The timeout for API requests, in seconds. #### Defined in -[src/types/dispenser-client.ts:95](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L95) +[src/types/dispenser-client.ts:96](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L96) ## Methods @@ -155,7 +155,7 @@ DispenserFundResponse: An object containing the transaction ID and funded amount #### Defined in -[src/types/dispenser-client.ts:157](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L157) +[src/types/dispenser-client.ts:158](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L158) ___ @@ -173,7 +173,7 @@ DispenserLimitResponse: An object containing the funding limit amount. #### Defined in -[src/types/dispenser-client.ts:187](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L187) +[src/types/dispenser-client.ts:188](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L188) ___ @@ -200,7 +200,7 @@ The API response. #### Defined in -[src/types/dispenser-client.ts:109](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L109) +[src/types/dispenser-client.ts:110](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L110) ___ @@ -222,4 +222,4 @@ Sends a refund request to the dispenser API for the specified refundTxnId. #### Defined in -[src/types/dispenser-client.ts:178](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L178) +[src/types/dispenser-client.ts:179](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L179) diff --git a/docs/code/interfaces/types_composer.BuiltTransactions.md b/docs/code/interfaces/types_composer.BuiltTransactions.md index 57c0dbd8..5e643622 100644 --- a/docs/code/interfaces/types_composer.BuiltTransactions.md +++ b/docs/code/interfaces/types_composer.BuiltTransactions.md @@ -24,7 +24,7 @@ Any `ABIMethod` objects associated with any of the transactions in a map keyed b #### Defined in -[src/types/composer.ts:502](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L502) +[src/types/composer.ts:503](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L503) ___ @@ -36,7 +36,7 @@ Any `TransactionSigner` objects associated with any of the transactions in a map #### Defined in -[src/types/composer.ts:504](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L504) +[src/types/composer.ts:505](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L505) ___ @@ -48,4 +48,4 @@ The built transactions #### Defined in -[src/types/composer.ts:500](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L500) +[src/types/composer.ts:501](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L501) diff --git a/docs/code/interfaces/types_dispenser_client.DispenserFundResponse.md b/docs/code/interfaces/types_dispenser_client.DispenserFundResponse.md index b3366a37..9893d106 100644 --- a/docs/code/interfaces/types_dispenser_client.DispenserFundResponse.md +++ b/docs/code/interfaces/types_dispenser_client.DispenserFundResponse.md @@ -23,7 +23,7 @@ The number of µAlgo that was funded. #### Defined in -[src/types/dispenser-client.ts:28](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L28) +[src/types/dispenser-client.ts:29](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L29) ___ @@ -35,4 +35,4 @@ The ID of the transaction that was issued to fund the account. #### Defined in -[src/types/dispenser-client.ts:26](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L26) +[src/types/dispenser-client.ts:27](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L27) diff --git a/docs/code/interfaces/types_dispenser_client.DispenserLimitResponse.md b/docs/code/interfaces/types_dispenser_client.DispenserLimitResponse.md index deaec0c3..f9140ad0 100644 --- a/docs/code/interfaces/types_dispenser_client.DispenserLimitResponse.md +++ b/docs/code/interfaces/types_dispenser_client.DispenserLimitResponse.md @@ -22,4 +22,4 @@ The limit, in µAlgo, that you can currently fund. #### Defined in -[src/types/dispenser-client.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L34) +[src/types/dispenser-client.ts:35](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L35) diff --git a/docs/code/interfaces/types_dispenser_client.TestNetDispenserApiClientParams.md b/docs/code/interfaces/types_dispenser_client.TestNetDispenserApiClientParams.md index 2f95aec1..a880daed 100644 --- a/docs/code/interfaces/types_dispenser_client.TestNetDispenserApiClientParams.md +++ b/docs/code/interfaces/types_dispenser_client.TestNetDispenserApiClientParams.md @@ -23,7 +23,7 @@ The API auth token #### Defined in -[src/types/dispenser-client.ts:40](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L40) +[src/types/dispenser-client.ts:41](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L41) ___ @@ -35,4 +35,4 @@ The request timeout in seconds #### Defined in -[src/types/dispenser-client.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L42) +[src/types/dispenser-client.ts:43](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L43) diff --git a/docs/code/modules/types_composer.md b/docs/code/modules/types_composer.md index fdf155cd..4d5d5a9b 100644 --- a/docs/code/modules/types_composer.md +++ b/docs/code/modules/types_composer.md @@ -57,7 +57,7 @@ Parameters to define an ABI method call transaction. #### Defined in -[src/types/composer.ts:426](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L426) +[src/types/composer.ts:427](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L427) ___ @@ -69,7 +69,7 @@ Parameters to define an application call transaction. #### Defined in -[src/types/composer.ts:402](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L402) +[src/types/composer.ts:403](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L403) ___ @@ -81,7 +81,7 @@ Parameters to define an ABI method call create transaction. #### Defined in -[src/types/composer.ts:420](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L420) +[src/types/composer.ts:421](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L421) ___ @@ -93,7 +93,7 @@ Parameters to define an app create transaction #### Defined in -[src/types/composer.ts:365](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L365) +[src/types/composer.ts:366](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L366) ___ @@ -105,7 +105,7 @@ Parameters to define an ABI method call delete transaction. #### Defined in -[src/types/composer.ts:424](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L424) +[src/types/composer.ts:425](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L425) ___ @@ -117,7 +117,7 @@ Parameters to define an application delete call transaction. #### Defined in -[src/types/composer.ts:415](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L415) +[src/types/composer.ts:416](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L416) ___ @@ -135,7 +135,7 @@ Parameters to define an ABI method call. #### Defined in -[src/types/composer.ts:439](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L439) +[src/types/composer.ts:440](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L440) ___ @@ -147,7 +147,7 @@ Common parameters to define an ABI method call transaction. #### Defined in -[src/types/composer.ts:407](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L407) +[src/types/composer.ts:408](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L408) ___ @@ -159,7 +159,7 @@ Types that can be used to define a transaction argument for an ABI call transact #### Defined in -[src/types/composer.ts:429](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L429) +[src/types/composer.ts:430](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L430) ___ @@ -171,7 +171,7 @@ Parameters to define an ABI method call update transaction. #### Defined in -[src/types/composer.ts:422](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L422) +[src/types/composer.ts:423](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L423) ___ @@ -183,7 +183,7 @@ Parameters to define an app update transaction #### Defined in -[src/types/composer.ts:391](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L391) +[src/types/composer.ts:392](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L392) ___ @@ -199,7 +199,7 @@ all fields are immutable from that point forward. #### Defined in -[src/types/composer.ts:218](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L218) +[src/types/composer.ts:219](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L219) ___ @@ -213,7 +213,7 @@ The account that sends this transaction will automatically be opted in to the as #### Defined in -[src/types/composer.ts:102](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L102) +[src/types/composer.ts:103](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L103) ___ @@ -227,7 +227,7 @@ Created assets can be destroyed only by the asset manager account. All of the as #### Defined in -[src/types/composer.ts:276](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L276) +[src/types/composer.ts:277](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L277) ___ @@ -239,7 +239,7 @@ Parameters to define an asset freeze transaction. #### Defined in -[src/types/composer.ts:263](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L263) +[src/types/composer.ts:264](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L264) ___ @@ -251,7 +251,7 @@ Parameters to define an asset opt-in transaction. #### Defined in -[src/types/composer.ts:304](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L304) +[src/types/composer.ts:305](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L305) ___ @@ -263,7 +263,7 @@ Parameters to define an asset opt-out transaction. #### Defined in -[src/types/composer.ts:310](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L310) +[src/types/composer.ts:311](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L311) ___ @@ -275,7 +275,7 @@ Parameters to define an asset transfer transaction. #### Defined in -[src/types/composer.ts:282](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L282) +[src/types/composer.ts:283](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L283) ___ @@ -287,7 +287,7 @@ Common parameters for defining an application call transaction. #### Defined in -[src/types/composer.ts:343](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L343) +[src/types/composer.ts:344](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L344) ___ @@ -315,7 +315,7 @@ Common parameters for defining a transaction. #### Defined in -[src/types/composer.ts:45](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L45) +[src/types/composer.ts:46](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L46) ___ @@ -327,7 +327,7 @@ Parameters to define an offline key registration transaction. #### Defined in -[src/types/composer.ts:337](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L337) +[src/types/composer.ts:338](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L338) ___ @@ -339,7 +339,7 @@ Parameters to define an online key registration transaction. #### Defined in -[src/types/composer.ts:321](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L321) +[src/types/composer.ts:322](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L322) ___ @@ -351,7 +351,7 @@ Parameters to define a payment transaction. #### Defined in -[src/types/composer.ts:86](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L86) +[src/types/composer.ts:87](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L87) ___ @@ -364,7 +364,7 @@ See algod API docs for more information: https://developer.algorand.org/docs/res #### Defined in -[src/types/composer.ts:39](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L39) +[src/types/composer.ts:40](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L40) ___ @@ -376,7 +376,7 @@ All options to control a simulate request #### Defined in -[src/types/composer.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L42) +[src/types/composer.ts:43](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L43) ___ @@ -388,7 +388,7 @@ Options to control a simulate request, that does not require transaction signing #### Defined in -[src/types/composer.ts:27](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L27) +[src/types/composer.ts:28](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L28) ___ @@ -410,7 +410,7 @@ Parameters to create an `TransactionComposer`. #### Defined in -[src/types/composer.ts:479](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L479) +[src/types/composer.ts:480](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L480) ___ @@ -420,7 +420,7 @@ ___ #### Defined in -[src/types/composer.ts:463](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L463) +[src/types/composer.ts:464](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L464) ## Variables @@ -430,4 +430,4 @@ ___ #### Defined in -[src/types/composer.ts:24](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L24) +[src/types/composer.ts:25](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L25) diff --git a/package-lock.json b/package-lock.json index defde9e9..4be06dc8 100644 --- a/package-lock.json +++ b/package-lock.json @@ -6652,9 +6652,9 @@ } }, "node_modules/nanoid": { - "version": "3.3.7", - "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.7.tgz", - "integrity": "sha512-eSRppjcPIatRIMC1U6UngP8XFcz8MQWGQdt1MTBQ7NaAmvXDfvNxbvWV3x2y6CdEUciCSsDHDQZbhYaB8QEo2g==", + "version": "3.3.8", + "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.8.tgz", + "integrity": "sha512-WNLf5Sd8oZxOm+TzppcYk8gVOgP+l58xNy58D0nbUnOxOWRWvlcCV4kUF7ltmI6PsrLl/BgKEyS4mqsGChFN0w==", "dev": true, "funding": [ { diff --git a/src/testing/test-logger.ts b/src/testing/test-logger.ts index 1c1df3b8..d7da6e01 100644 --- a/src/testing/test-logger.ts +++ b/src/testing/test-logger.ts @@ -1,5 +1,6 @@ import { Logger } from '../types/logging' import { LogSnapshotConfig } from '../types/testing' +import { asJson } from '../util' /** Exposes an AlgoKit logger which captures log messages, while wrapping an original logger. * This is useful for automated testing. @@ -71,22 +72,22 @@ export class TestLogger implements Logger { error(message: string, ...optionalParams: unknown[]): void { this.originalLogger?.error(message, ...optionalParams) - this.logs.push(`ERROR: ${message}${optionalParams.length ? ` | ${JSON.stringify(optionalParams)}` : ''}`) + this.logs.push(`ERROR: ${message}${optionalParams.length ? ` | ${asJson(optionalParams)}` : ''}`) } warn(message: string, ...optionalParams: unknown[]): void { this.originalLogger?.warn(message, ...optionalParams) - this.logs.push(`WARN: ${message}${optionalParams.length ? ` | ${JSON.stringify(optionalParams)}` : ''}`) + this.logs.push(`WARN: ${message}${optionalParams.length ? ` | ${asJson(optionalParams)}` : ''}`) } info(message: string, ...optionalParams: unknown[]): void { this.originalLogger?.info(message, ...optionalParams) - this.logs.push(`INFO: ${message}${optionalParams.length ? ` | ${JSON.stringify(optionalParams)}` : ''}`) + this.logs.push(`INFO: ${message}${optionalParams.length ? ` | ${asJson(optionalParams)}` : ''}`) } verbose(message: string, ...optionalParams: unknown[]): void { this.originalLogger?.verbose(message, ...optionalParams) - this.logs.push(`VERBOSE: ${message}${optionalParams.length ? ` | ${JSON.stringify(optionalParams)}` : ''}`) + this.logs.push(`VERBOSE: ${message}${optionalParams.length ? ` | ${asJson(optionalParams)}` : ''}`) } debug(message: string, ...optionalParams: unknown[]): void { this.originalLogger?.debug(message, ...optionalParams) - this.logs.push(`DEBUG: ${message}${optionalParams.length ? ` | ${JSON.stringify(optionalParams)}` : ''}`) + this.logs.push(`DEBUG: ${message}${optionalParams.length ? ` | ${asJson(optionalParams)}` : ''}`) } } diff --git a/src/transaction/transaction.ts b/src/transaction/transaction.ts index 3bc4df2c..df568c8a 100644 --- a/src/transaction/transaction.ts +++ b/src/transaction/transaction.ts @@ -14,7 +14,7 @@ import { TransactionNote, TransactionToSign, } from '../types/transaction' -import { toNumber } from '../util' +import { asJson, toNumber } from '../util' import { performAtomicTransactionComposerSimulate } from './perform-atomic-transaction-composer-simulate' import Algodv2 = algosdk.Algodv2 import AtomicTransactionComposer = algosdk.AtomicTransactionComposer @@ -51,11 +51,11 @@ export function encodeTransactionNote(note?: TransactionNote): Uint8Array | unde } else if (typeof note === 'object' && note.constructor === Uint8Array) { return note } else if (typeof note === 'object' && 'dAppName' in note) { - const arc2Payload = `${note.dAppName}:${note.format}${typeof note.data === 'string' ? note.data : JSON.stringify(note.data)}` + const arc2Payload = `${note.dAppName}:${note.format}${typeof note.data === 'string' ? note.data : asJson(note.data)}` const encoder = new TextEncoder() return encoder.encode(arc2Payload) } else { - const n = typeof note === 'string' ? note : JSON.stringify(note) + const n = typeof note === 'string' ? note : asJson(note) const encoder = new TextEncoder() return encoder.encode(n) } diff --git a/src/types/algorand-client-transaction-sender.ts b/src/types/algorand-client-transaction-sender.ts index 5e014fd7..4d3be6df 100644 --- a/src/types/algorand-client-transaction-sender.ts +++ b/src/types/algorand-client-transaction-sender.ts @@ -1,6 +1,7 @@ import algosdk, { Address } from 'algosdk' import { Buffer } from 'buffer' import { Config } from '../config' +import { asJson, defaultJsonValueReplacer } from '../util' import { SendAppCreateTransactionResult, SendAppTransactionResult, SendAppUpdateTransactionResult } from './app' import { AppManager } from './app-manager' import { AssetManager } from './asset-manager' @@ -20,8 +21,17 @@ import { import { SendParams, SendSingleTransactionResult } from './transaction' import Transaction = algosdk.Transaction +// + const getMethodCallForLog = ({ method, args }: { method: algosdk.ABIMethod; args?: unknown[] }) => { - return `${method.name}(${(args ?? []).map((a) => (typeof a === 'object' ? JSON.stringify(a, (_, v) => (typeof v === 'bigint' ? Number(v) : v instanceof Uint8Array ? Buffer.from(v).toString('base64') : v)) : a))})` + return `${method.name}(${(args ?? []).map((a) => + typeof a === 'object' + ? asJson(a, (k, v) => { + const newV = defaultJsonValueReplacer(k, v) + return newV instanceof Uint8Array ? Buffer.from(newV).toString('base64') : newV + }) + : a, + )})` } /** Orchestrates sending transactions for `AlgorandClient`. */ diff --git a/src/types/app-client.ts b/src/types/app-client.ts index 6f835c30..630da966 100644 --- a/src/types/app-client.ts +++ b/src/types/app-client.ts @@ -15,7 +15,7 @@ import { deployApp, getCreatorAppsByName, performTemplateSubstitution, replaceDe import { Config } from '../config' import { legacySendTransactionBridge } from '../transaction/legacy-bridge' import { encodeTransactionNote, getSenderAddress } from '../transaction/transaction' -import { binaryStartsWith } from '../util' +import { asJson, binaryStartsWith } from '../util' import { TransactionSignerAccount } from './account' import { AlgorandClientInterface } from './algorand-client-interface' import { AlgoAmount } from './amount' @@ -599,7 +599,7 @@ export class AppClient { const networkIndex = availableAppSpecNetworks.findIndex((n) => networkNames.includes(n)) if (networkIndex === -1) { - throw new Error(`No app ID found for network ${JSON.stringify(networkNames)} in the app spec`) + throw new Error(`No app ID found for network ${asJson(networkNames)} in the app spec`) } const appId = BigInt(appSpec.networks![networkIndex].appID) @@ -951,8 +951,8 @@ export class AppClient { ) } if (errorMessage) { - const appId = JSON.stringify(e).match(/(?<=app=)\d+/)?.[0] || '' - const txId = JSON.stringify(e).match(/(?<=transaction )\S+(?=:)/)?.[0] + const appId = asJson(e).match(/(?<=app=)\d+/)?.[0] || '' + const txId = asJson(e).match(/(?<=transaction )\S+(?=:)/)?.[0] const error = new Error(`Runtime error when executing ${appSpec.name} (appId: ${appId}) in transaction ${txId}: ${errorMessage}`) // eslint-disable-next-line @typescript-eslint/no-explicit-any ;(error as any).cause = e diff --git a/src/types/composer.ts b/src/types/composer.ts index f5a2fe2a..02beba75 100644 --- a/src/types/composer.ts +++ b/src/types/composer.ts @@ -1,6 +1,7 @@ import algosdk, { Address } from 'algosdk' import { Config } from '../config' import { encodeLease, getABIReturnValue, sendAtomicTransactionComposer } from '../transaction/transaction' +import { asJson } from '../util' import { TransactionSignerAccount } from './account' import { AlgoAmount } from './amount' import { APP_PAGE_MAX_SIZE } from './app' @@ -1396,7 +1397,7 @@ export class TransactionComposer { * @returns The binary encoded transaction note */ static arc2Note(note: Arc2TransactionNote): Uint8Array { - const arc2Payload = `${note.dAppName}:${note.format}${typeof note.data === 'string' ? note.data : JSON.stringify(note.data)}` + const arc2Payload = `${note.dAppName}:${note.format}${typeof note.data === 'string' ? note.data : asJson(note.data)}` const encoder = new TextEncoder() return encoder.encode(arc2Payload) } diff --git a/src/types/dispenser-client.ts b/src/types/dispenser-client.ts index 109e21fd..cc9a9b44 100644 --- a/src/types/dispenser-client.ts +++ b/src/types/dispenser-client.ts @@ -1,4 +1,5 @@ import { Address } from 'algosdk' +import { asJson } from '../util' const DISPENSER_BASE_URL = 'https://api.dispenser.algorandfoundation.tools' const DEFAULT_DISPENSER_REQUEST_TIMEOUT = 15 @@ -121,7 +122,7 @@ export class TestNetDispenserApiClient { } if (body) { - requestArgs.body = JSON.stringify(body) + requestArgs.body = asJson(body) } const response = await fetch(`${DISPENSER_BASE_URL}/${urlSuffix}`, requestArgs) diff --git a/src/util.ts b/src/util.ts index 5f5c2bc6..95771444 100644 --- a/src/util.ts +++ b/src/util.ts @@ -81,3 +81,21 @@ export const binaryStartsWith = (base: Uint8Array, startsWith: Uint8Array): bool } return true } + +export const defaultJsonValueReplacer = (key: string, value: unknown) => { + if (typeof value === 'bigint') { + try { + return toNumber(value) + } catch { + return value.toString() + } + } + return value +} +export const asJson = ( + value: unknown, + replacer: (key: string, value: unknown) => unknown = defaultJsonValueReplacer, + space?: string | number, +) => { + return JSON.stringify(value, replacer, space) +}