diff --git a/docs/code/classes/types_app_client.AppClient.md b/docs/code/classes/types_app_client.AppClient.md index 3363aa6e..a6ae1019 100644 --- a/docs/code/classes/types_app_client.AppClient.md +++ b/docs/code/classes/types_app_client.AppClient.md @@ -95,7 +95,7 @@ state for a specific deployed instance of an app (with a known app ID). #### Defined in -[src/types/app-client.ts:417](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L417) +[src/types/app-client.ts:416](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L416) ## Properties @@ -105,7 +105,7 @@ state for a specific deployed instance of an app (with a known app ID). #### Defined in -[src/types/app-client.ts:397](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L397) +[src/types/app-client.ts:396](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L396) ___ @@ -115,7 +115,7 @@ ___ #### Defined in -[src/types/app-client.ts:394](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L394) +[src/types/app-client.ts:393](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L393) ___ @@ -125,7 +125,7 @@ ___ #### Defined in -[src/types/app-client.ts:393](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L393) +[src/types/app-client.ts:392](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L392) ___ @@ -135,7 +135,7 @@ ___ #### Defined in -[src/types/app-client.ts:395](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L395) +[src/types/app-client.ts:394](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L394) ___ @@ -145,7 +145,7 @@ ___ #### Defined in -[src/types/app-client.ts:396](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L396) +[src/types/app-client.ts:395](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L395) ___ @@ -155,7 +155,7 @@ ___ #### Defined in -[src/types/app-client.ts:400](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L400) +[src/types/app-client.ts:399](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L399) ___ @@ -174,7 +174,7 @@ ___ #### Defined in -[src/types/app-client.ts:405](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L405) +[src/types/app-client.ts:404](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L404) ___ @@ -184,7 +184,7 @@ ___ #### Defined in -[src/types/app-client.ts:401](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L401) +[src/types/app-client.ts:400](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L400) ___ @@ -194,7 +194,7 @@ ___ #### Defined in -[src/types/app-client.ts:398](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L398) +[src/types/app-client.ts:397](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L397) ___ @@ -213,7 +213,7 @@ ___ #### Defined in -[src/types/app-client.ts:404](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L404) +[src/types/app-client.ts:403](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L403) ___ @@ -244,7 +244,7 @@ ___ #### Defined in -[src/types/app-client.ts:403](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L403) +[src/types/app-client.ts:402](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L402) ___ @@ -254,7 +254,7 @@ ___ #### Defined in -[src/types/app-client.ts:407](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L407) +[src/types/app-client.ts:406](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L406) ___ @@ -264,7 +264,7 @@ ___ #### Defined in -[src/types/app-client.ts:413](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L413) +[src/types/app-client.ts:412](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L412) ___ @@ -274,7 +274,7 @@ ___ #### Defined in -[src/types/app-client.ts:410](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L410) +[src/types/app-client.ts:409](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L409) ## Accessors @@ -290,7 +290,7 @@ The app address of the app instance this client is linked to. #### Defined in -[src/types/app-client.ts:517](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L517) +[src/types/app-client.ts:516](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L516) ___ @@ -306,7 +306,7 @@ The ID of the app instance this client is linked to. #### Defined in -[src/types/app-client.ts:512](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L512) +[src/types/app-client.ts:511](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L511) ___ @@ -322,7 +322,7 @@ The name of the app (from the ARC-32 / ARC-56 app spec). #### Defined in -[src/types/app-client.ts:522](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L522) +[src/types/app-client.ts:521](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L521) ___ @@ -338,7 +338,7 @@ The ARC-56 app spec being used #### Defined in -[src/types/app-client.ts:527](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L527) +[src/types/app-client.ts:526](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L526) ___ @@ -354,7 +354,7 @@ Get parameters to define transactions to the current app #### Defined in -[src/types/app-client.ts:532](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L532) +[src/types/app-client.ts:531](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L531) ___ @@ -370,7 +370,7 @@ Send calls to the current app #### Defined in -[src/types/app-client.ts:542](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L542) +[src/types/app-client.ts:541](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L541) ___ @@ -398,7 +398,7 @@ ___ #### Defined in -[src/types/app-client.ts:546](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L546) +[src/types/app-client.ts:545](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L545) ___ @@ -414,7 +414,7 @@ Get transactions for the current app #### Defined in -[src/types/app-client.ts:537](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L537) +[src/types/app-client.ts:536](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L536) ## Methods @@ -442,7 +442,7 @@ Will store any generated source maps for later use in debugging. #### Defined in -[src/types/app-client.ts:1119](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1119) +[src/types/app-client.ts:1118](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1118) ___ @@ -460,7 +460,7 @@ The source maps #### Defined in -[src/types/app-client.ts:672](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L672) +[src/types/app-client.ts:671](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L671) ___ @@ -486,7 +486,7 @@ The new error, or if there was no logic error or source map then the wrapped err #### Defined in -[src/types/app-client.ts:660](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L660) +[src/types/app-client.ts:659](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L659) ___ @@ -526,7 +526,7 @@ The result of the funding #### Defined in -[src/types/app-client.ts:569](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L569) +[src/types/app-client.ts:568](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L568) ___ @@ -550,7 +550,7 @@ A tuple with: [ARC-56 `Method`, algosdk `ABIMethod`] #### Defined in -[src/types/app-client.ts:700](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L700) +[src/types/app-client.ts:699](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L699) ___ @@ -578,7 +578,7 @@ ___ #### Defined in -[src/types/app-client.ts:1153](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1153) +[src/types/app-client.ts:1152](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1152) ___ @@ -606,7 +606,7 @@ ___ #### Defined in -[src/types/app-client.ts:1141](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1141) +[src/types/app-client.ts:1140](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1140) ___ @@ -629,7 +629,7 @@ ___ #### Defined in -[src/types/app-client.ts:853](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L853) +[src/types/app-client.ts:852](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L852) ___ @@ -652,7 +652,7 @@ ___ #### Defined in -[src/types/app-client.ts:917](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L917) +[src/types/app-client.ts:916](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L916) ___ @@ -675,7 +675,7 @@ ___ #### Defined in -[src/types/app-client.ts:888](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L888) +[src/types/app-client.ts:887](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L887) ___ @@ -696,7 +696,7 @@ ___ #### Defined in -[src/types/app-client.ts:1178](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1178) +[src/types/app-client.ts:1177](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1177) ___ @@ -714,7 +714,7 @@ The names of the boxes #### Defined in -[src/types/app-client.ts:594](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L594) +[src/types/app-client.ts:593](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L593) ___ @@ -738,7 +738,7 @@ The current box value as a byte array #### Defined in -[src/types/app-client.ts:603](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L603) +[src/types/app-client.ts:602](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L602) ___ @@ -763,7 +763,7 @@ The current box value as a byte array #### Defined in -[src/types/app-client.ts:613](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L613) +[src/types/app-client.ts:612](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L612) ___ @@ -788,7 +788,7 @@ The (name, value) pair of the boxes with values as raw byte arrays #### Defined in -[src/types/app-client.ts:627](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L627) +[src/types/app-client.ts:626](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L626) ___ @@ -814,7 +814,7 @@ The (name, value) pair of the boxes with values as the ABI Value #### Defined in -[src/types/app-client.ts:643](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L643) +[src/types/app-client.ts:642](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L642) ___ @@ -832,7 +832,7 @@ The global state #### Defined in -[src/types/app-client.ts:577](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L577) +[src/types/app-client.ts:576](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L576) ___ @@ -856,7 +856,7 @@ The local state #### Defined in -[src/types/app-client.ts:586](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L586) +[src/types/app-client.ts:585](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L585) ___ @@ -879,7 +879,7 @@ ___ #### Defined in -[src/types/app-client.ts:946](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L946) +[src/types/app-client.ts:945](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L945) ___ @@ -902,7 +902,7 @@ ___ #### Defined in -[src/types/app-client.ts:985](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L985) +[src/types/app-client.ts:984](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L984) ___ @@ -925,7 +925,7 @@ ___ #### Defined in -[src/types/app-client.ts:1071](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1071) +[src/types/app-client.ts:1070](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1070) ___ @@ -948,7 +948,7 @@ if none provided and throws an error if neither provided #### Defined in -[src/types/app-client.ts:1134](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1134) +[src/types/app-client.ts:1133](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1133) ___ @@ -977,7 +977,7 @@ ___ #### Defined in -[src/types/app-client.ts:1250](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1250) +[src/types/app-client.ts:1249](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1249) ___ @@ -1005,7 +1005,7 @@ Make the given call and catch any errors, augmenting with debugging information #### Defined in -[src/types/app-client.ts:1170](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1170) +[src/types/app-client.ts:1169](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1169) ___ @@ -1027,7 +1027,7 @@ Import source maps for the app. #### Defined in -[src/types/app-client.ts:689](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L689) +[src/types/app-client.ts:688](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L688) ___ @@ -1043,7 +1043,7 @@ Start a new `AlgoKitComposer` transaction group #### Defined in -[src/types/app-client.ts:450](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L450) +[src/types/app-client.ts:449](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L449) ___ @@ -1078,7 +1078,7 @@ The smart contract response with an updated return value #### Defined in -[src/types/app-client.ts:714](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L714) +[src/types/app-client.ts:713](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L713) ___ @@ -1108,7 +1108,7 @@ Will store any generated source maps for later use in debugging. #### Defined in -[src/types/app-client.ts:782](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L782) +[src/types/app-client.ts:781](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L781) ___ @@ -1138,7 +1138,7 @@ The new error, or if there was no logic error or source map then the wrapped err #### Defined in -[src/types/app-client.ts:732](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L732) +[src/types/app-client.ts:731](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L731) ___ @@ -1170,7 +1170,7 @@ using AlgoKit app deployment semantics (i.e. looking for the app creation transa #### Defined in -[src/types/app-client.ts:459](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L459) +[src/types/app-client.ts:458](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L458) ___ @@ -1201,7 +1201,7 @@ If no IDs are in the app spec or the network isn't recognised, an error is throw #### Defined in -[src/types/app-client.ts:481](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L481) +[src/types/app-client.ts:480](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L480) ___ @@ -1228,7 +1228,7 @@ It does this by replacing any `undefined` values with the equivalent default val #### Defined in -[src/types/app-client.ts:832](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L832) +[src/types/app-client.ts:831](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L831) ___ @@ -1253,4 +1253,4 @@ The normalised ARC-56 contract object #### Defined in -[src/types/app-client.ts:505](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L505) +[src/types/app-client.ts:504](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L504) diff --git a/docs/code/classes/types_app_client.ApplicationClient.md b/docs/code/classes/types_app_client.ApplicationClient.md index 5300d2af..056e8abd 100644 --- a/docs/code/classes/types_app_client.ApplicationClient.md +++ b/docs/code/classes/types_app_client.ApplicationClient.md @@ -92,7 +92,7 @@ Create a new ApplicationClient instance #### Defined in -[src/types/app-client.ts:1377](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1377) +[src/types/app-client.ts:1376](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1376) ## Properties @@ -102,7 +102,7 @@ Create a new ApplicationClient instance #### Defined in -[src/types/app-client.ts:1360](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1360) +[src/types/app-client.ts:1359](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1359) ___ @@ -112,7 +112,7 @@ ___ #### Defined in -[src/types/app-client.ts:1359](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1359) +[src/types/app-client.ts:1358](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1358) ___ @@ -122,7 +122,7 @@ ___ #### Defined in -[src/types/app-client.ts:1362](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1362) +[src/types/app-client.ts:1361](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1361) ___ @@ -132,7 +132,7 @@ ___ #### Defined in -[src/types/app-client.ts:1364](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1364) +[src/types/app-client.ts:1363](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1363) ___ @@ -142,7 +142,7 @@ ___ #### Defined in -[src/types/app-client.ts:1365](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1365) +[src/types/app-client.ts:1364](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1364) ___ @@ -152,7 +152,7 @@ ___ #### Defined in -[src/types/app-client.ts:1361](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1361) +[src/types/app-client.ts:1360](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1360) ___ @@ -162,7 +162,7 @@ ___ #### Defined in -[src/types/app-client.ts:1351](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1351) +[src/types/app-client.ts:1350](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1350) ___ @@ -172,7 +172,7 @@ ___ #### Defined in -[src/types/app-client.ts:1353](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1353) +[src/types/app-client.ts:1352](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1352) ___ @@ -182,7 +182,7 @@ ___ #### Defined in -[src/types/app-client.ts:1357](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1357) +[src/types/app-client.ts:1356](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1356) ___ @@ -192,7 +192,7 @@ ___ #### Defined in -[src/types/app-client.ts:1356](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1356) +[src/types/app-client.ts:1355](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1355) ___ @@ -202,7 +202,7 @@ ___ #### Defined in -[src/types/app-client.ts:1352](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1352) +[src/types/app-client.ts:1351](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1351) ___ @@ -212,7 +212,7 @@ ___ #### Defined in -[src/types/app-client.ts:1355](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1355) +[src/types/app-client.ts:1354](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1354) ___ @@ -222,13 +222,13 @@ ___ #### Defined in -[src/types/app-client.ts:1354](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1354) +[src/types/app-client.ts:1353](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1353) ## Methods ### call -▸ **call**(`call?`): `Promise`\<[`AppCallTransactionResult`](../interfaces/types_app.AppCallTransactionResult.md)\> +▸ **call**(`call?`): `Promise`\<[`AppCallTransactionResult`](../modules/types_app.md#appcalltransactionresult)\> #### Parameters @@ -238,7 +238,7 @@ ___ #### Returns -`Promise`\<[`AppCallTransactionResult`](../interfaces/types_app.AppCallTransactionResult.md)\> +`Promise`\<[`AppCallTransactionResult`](../modules/types_app.md#appcalltransactionresult)\> The result of the call @@ -250,13 +250,13 @@ Issues a no_op (normal) call to the app. #### Defined in -[src/types/app-client.ts:1702](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1702) +[src/types/app-client.ts:1701](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1701) ___ ### callOfType -▸ **callOfType**(`call?`, `callType`): `Promise`\<[`AppCallTransactionResult`](../interfaces/types_app.AppCallTransactionResult.md)\> +▸ **callOfType**(`call?`, `callType`): `Promise`\<[`AppCallTransactionResult`](../modules/types_app.md#appcalltransactionresult)\> #### Parameters @@ -267,7 +267,7 @@ ___ #### Returns -`Promise`\<[`AppCallTransactionResult`](../interfaces/types_app.AppCallTransactionResult.md)\> +`Promise`\<[`AppCallTransactionResult`](../modules/types_app.md#appcalltransactionresult)\> The result of the call @@ -279,13 +279,13 @@ Issues a call to the app with the given call type. #### Defined in -[src/types/app-client.ts:1785](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1785) +[src/types/app-client.ts:1784](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1784) ___ ### clearState -▸ **clearState**(`call?`): `Promise`\<[`AppCallTransactionResult`](../interfaces/types_app.AppCallTransactionResult.md)\> +▸ **clearState**(`call?`): `Promise`\<[`AppCallTransactionResult`](../modules/types_app.md#appcalltransactionresult)\> #### Parameters @@ -295,7 +295,7 @@ ___ #### Returns -`Promise`\<[`AppCallTransactionResult`](../interfaces/types_app.AppCallTransactionResult.md)\> +`Promise`\<[`AppCallTransactionResult`](../modules/types_app.md#appcalltransactionresult)\> The result of the call @@ -307,13 +307,13 @@ Issues a clear_state call to the app. #### Defined in -[src/types/app-client.ts:1762](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1762) +[src/types/app-client.ts:1761](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1761) ___ ### closeOut -▸ **closeOut**(`call?`): `Promise`\<[`AppCallTransactionResult`](../interfaces/types_app.AppCallTransactionResult.md)\> +▸ **closeOut**(`call?`): `Promise`\<[`AppCallTransactionResult`](../modules/types_app.md#appcalltransactionresult)\> #### Parameters @@ -323,7 +323,7 @@ ___ #### Returns -`Promise`\<[`AppCallTransactionResult`](../interfaces/types_app.AppCallTransactionResult.md)\> +`Promise`\<[`AppCallTransactionResult`](../modules/types_app.md#appcalltransactionresult)\> The result of the call @@ -335,7 +335,7 @@ Issues a close_out call to the app. #### Defined in -[src/types/app-client.ts:1751](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1751) +[src/types/app-client.ts:1750](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1750) ___ @@ -363,7 +363,7 @@ Compiles the approval and clear state programs and sets up the source map. #### Defined in -[src/types/app-client.ts:1416](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1416) +[src/types/app-client.ts:1415](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1415) ___ @@ -391,13 +391,13 @@ Creates a smart contract app, returns the details of the created app. #### Defined in -[src/types/app-client.ts:1596](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1596) +[src/types/app-client.ts:1595](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1595) ___ ### delete -▸ **delete**(`call?`): `Promise`\<[`AppCallTransactionResult`](../interfaces/types_app.AppCallTransactionResult.md)\> +▸ **delete**(`call?`): `Promise`\<[`AppCallTransactionResult`](../modules/types_app.md#appcalltransactionresult)\> #### Parameters @@ -407,7 +407,7 @@ ___ #### Returns -`Promise`\<[`AppCallTransactionResult`](../interfaces/types_app.AppCallTransactionResult.md)\> +`Promise`\<[`AppCallTransactionResult`](../modules/types_app.md#appcalltransactionresult)\> The result of the call @@ -419,7 +419,7 @@ Issues a delete_application call to the app. #### Defined in -[src/types/app-client.ts:1773](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1773) +[src/types/app-client.ts:1772](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1772) ___ @@ -453,7 +453,7 @@ To understand the architecture decisions behind this functionality please see ht #### Defined in -[src/types/app-client.ts:1484](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1484) +[src/types/app-client.ts:1483](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1483) ___ @@ -471,7 +471,7 @@ The source maps #### Defined in -[src/types/app-client.ts:1449](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1449) +[src/types/app-client.ts:1448](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1448) ___ @@ -498,7 +498,7 @@ The new error, or if there was no logic error or source map then the wrapped err #### Defined in -[src/types/app-client.ts:2109](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2109) +[src/types/app-client.ts:2108](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2108) ___ @@ -522,7 +522,7 @@ The result of the funding #### Defined in -[src/types/app-client.ts:1825](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1825) +[src/types/app-client.ts:1824](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1824) ___ @@ -546,7 +546,7 @@ The ABI method for the given method #### Defined in -[src/types/app-client.ts:2066](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2066) +[src/types/app-client.ts:2065](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2065) ___ @@ -574,7 +574,7 @@ Returns the ABI Method parameters for the given method name string for the app r #### Defined in -[src/types/app-client.ts:2044](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2044) +[src/types/app-client.ts:2043](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2043) ___ @@ -594,7 +594,7 @@ ___ #### Defined in -[src/types/app-client.ts:2126](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2126) +[src/types/app-client.ts:2125](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2125) ___ @@ -617,7 +617,7 @@ Gets the reference information for the current application instance. #### Defined in -[src/types/app-client.ts:2078](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2078) +[src/types/app-client.ts:2077](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2077) ___ @@ -635,7 +635,7 @@ The names of the boxes #### Defined in -[src/types/app-client.ts:1881](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1881) +[src/types/app-client.ts:1880](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1880) ___ @@ -659,7 +659,7 @@ The current box value as a byte array #### Defined in -[src/types/app-client.ts:1896](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1896) +[src/types/app-client.ts:1895](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1895) ___ @@ -684,7 +684,7 @@ The current box value as a byte array #### Defined in -[src/types/app-client.ts:1912](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1912) +[src/types/app-client.ts:1911](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1911) ___ @@ -709,7 +709,7 @@ The (name, value) pair of the boxes with values as raw byte arrays #### Defined in -[src/types/app-client.ts:1928](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1928) +[src/types/app-client.ts:1927](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1927) ___ @@ -735,7 +735,7 @@ The (name, value) pair of the boxes with values as the ABI Value #### Defined in -[src/types/app-client.ts:1950](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1950) +[src/types/app-client.ts:1949](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1949) ___ @@ -764,7 +764,7 @@ Returns the arguments for an app call for the given ABI method or raw method spe #### Defined in -[src/types/app-client.ts:1974](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1974) +[src/types/app-client.ts:1973](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1973) ___ @@ -782,7 +782,7 @@ The global state #### Defined in -[src/types/app-client.ts:1853](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1853) +[src/types/app-client.ts:1852](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1852) ___ @@ -806,7 +806,7 @@ The global state #### Defined in -[src/types/app-client.ts:1867](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1867) +[src/types/app-client.ts:1866](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1866) ___ @@ -828,13 +828,13 @@ Import source maps for the app. #### Defined in -[src/types/app-client.ts:1466](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1466) +[src/types/app-client.ts:1465](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1465) ___ ### optIn -▸ **optIn**(`call?`): `Promise`\<[`AppCallTransactionResult`](../interfaces/types_app.AppCallTransactionResult.md)\> +▸ **optIn**(`call?`): `Promise`\<[`AppCallTransactionResult`](../modules/types_app.md#appcalltransactionresult)\> #### Parameters @@ -844,7 +844,7 @@ ___ #### Returns -`Promise`\<[`AppCallTransactionResult`](../interfaces/types_app.AppCallTransactionResult.md)\> +`Promise`\<[`AppCallTransactionResult`](../modules/types_app.md#appcalltransactionresult)\> The result of the call @@ -856,7 +856,7 @@ Issues a opt_in call to the app. #### Defined in -[src/types/app-client.ts:1740](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1740) +[src/types/app-client.ts:1739](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1739) ___ @@ -884,4 +884,4 @@ Updates the smart contract app. #### Defined in -[src/types/app-client.ts:1661](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1661) +[src/types/app-client.ts:1660](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1660) diff --git a/docs/code/enums/types_app.OnSchemaBreak.md b/docs/code/enums/types_app.OnSchemaBreak.md index a8ede69e..cc883df6 100644 --- a/docs/code/enums/types_app.OnSchemaBreak.md +++ b/docs/code/enums/types_app.OnSchemaBreak.md @@ -24,7 +24,7 @@ Create a new app #### Defined in -[src/types/app.ts:306](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L306) +[src/types/app.ts:305](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L305) ___ @@ -36,7 +36,7 @@ Fail the deployment #### Defined in -[src/types/app.ts:302](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L302) +[src/types/app.ts:301](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L301) ___ @@ -48,4 +48,4 @@ Delete the app and create a new one in its place #### Defined in -[src/types/app.ts:304](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L304) +[src/types/app.ts:303](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L303) diff --git a/docs/code/enums/types_app.OnUpdate.md b/docs/code/enums/types_app.OnUpdate.md index 88a32ca2..5e4ce661 100644 --- a/docs/code/enums/types_app.OnUpdate.md +++ b/docs/code/enums/types_app.OnUpdate.md @@ -25,7 +25,7 @@ Create a new app #### Defined in -[src/types/app.ts:296](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L296) +[src/types/app.ts:295](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L295) ___ @@ -37,7 +37,7 @@ Fail the deployment #### Defined in -[src/types/app.ts:290](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L290) +[src/types/app.ts:289](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L289) ___ @@ -49,7 +49,7 @@ Delete the app and create a new one in its place #### Defined in -[src/types/app.ts:294](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L294) +[src/types/app.ts:293](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L293) ___ @@ -61,4 +61,4 @@ Update the app #### Defined in -[src/types/app.ts:292](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L292) +[src/types/app.ts:291](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L291) diff --git a/docs/code/interfaces/types_app.AppCallTransactionResult.md b/docs/code/interfaces/types_app.AppCallTransactionResult.md deleted file mode 100644 index 5c67836e..00000000 --- a/docs/code/interfaces/types_app.AppCallTransactionResult.md +++ /dev/null @@ -1,104 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app](../modules/types_app.md) / AppCallTransactionResult - -# Interface: AppCallTransactionResult - -[types/app](../modules/types_app.md).AppCallTransactionResult - -Result from calling an app - -## Hierarchy - -- [`AppCallTransactionResultOfType`](types_app.AppCallTransactionResultOfType.md)\<[`ABIReturn`](../modules/types_app.md#abireturn)\> - - ↳ **`AppCallTransactionResult`** - -## Table of contents - -### Properties - -- [confirmation](types_app.AppCallTransactionResult.md#confirmation) -- [confirmations](types_app.AppCallTransactionResult.md#confirmations) -- [return](types_app.AppCallTransactionResult.md#return) -- [transaction](types_app.AppCallTransactionResult.md#transaction) -- [transactions](types_app.AppCallTransactionResult.md#transactions) - -## Properties - -### confirmation - -• `Optional` **confirmation**: `PendingTransactionResponse` - -The response if the transaction was sent and waited for - -#### Inherited from - -[AppCallTransactionResultOfType](types_app.AppCallTransactionResultOfType.md).[confirmation](types_app.AppCallTransactionResultOfType.md#confirmation) - -#### Defined in - -[src/types/transaction.ts:57](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L57) - -___ - -### confirmations - -• `Optional` **confirmations**: `PendingTransactionResponse`[] - -The responses if the transactions were sent and waited for, -the index of the confirmation will match the index of the underlying transaction - -#### Inherited from - -[AppCallTransactionResultOfType](types_app.AppCallTransactionResultOfType.md).[confirmations](types_app.AppCallTransactionResultOfType.md#confirmations) - -#### Defined in - -[src/types/transaction.ts:67](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L67) - -___ - -### return - -• `Optional` **return**: [`ABIReturn`](../modules/types_app.md#abireturn) - -If an ABI method was called the processed return value - -#### Inherited from - -[AppCallTransactionResultOfType](types_app.AppCallTransactionResultOfType.md).[return](types_app.AppCallTransactionResultOfType.md#return) - -#### Defined in - -[src/types/app.ts:228](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L228) - -___ - -### transaction - -• **transaction**: `Transaction` - -The transaction - -#### Inherited from - -[AppCallTransactionResultOfType](types_app.AppCallTransactionResultOfType.md).[transaction](types_app.AppCallTransactionResultOfType.md#transaction) - -#### Defined in - -[src/types/transaction.ts:55](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L55) - -___ - -### transactions - -• **transactions**: `Transaction`[] - -The transactions that have been prepared and/or sent - -#### Inherited from - -[AppCallTransactionResultOfType](types_app.AppCallTransactionResultOfType.md).[transactions](types_app.AppCallTransactionResultOfType.md#transactions) - -#### Defined in - -[src/types/transaction.ts:63](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L63) diff --git a/docs/code/interfaces/types_app.AppCallTransactionResultOfType.md b/docs/code/interfaces/types_app.AppCallTransactionResultOfType.md index 4f5fe02c..b975c0db 100644 --- a/docs/code/interfaces/types_app.AppCallTransactionResultOfType.md +++ b/docs/code/interfaces/types_app.AppCallTransactionResultOfType.md @@ -20,8 +20,6 @@ The result of preparing and/or sending multiple transactions ↳ **`AppCallTransactionResultOfType`** - ↳↳ [`AppCallTransactionResult`](types_app.AppCallTransactionResult.md) - ## Table of contents ### Properties diff --git a/docs/code/interfaces/types_app.AppCompilationResult.md b/docs/code/interfaces/types_app.AppCompilationResult.md index 15b61874..824c9a10 100644 --- a/docs/code/interfaces/types_app.AppCompilationResult.md +++ b/docs/code/interfaces/types_app.AppCompilationResult.md @@ -23,7 +23,7 @@ The compilation result of approval #### Defined in -[src/types/app.ts:335](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L335) +[src/types/app.ts:334](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L334) ___ @@ -35,4 +35,4 @@ The compilation result of clear #### Defined in -[src/types/app.ts:337](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L337) +[src/types/app.ts:336](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L336) diff --git a/docs/code/interfaces/types_app.AppDeployMetadata.md b/docs/code/interfaces/types_app.AppDeployMetadata.md index 97f2a0b0..74d7eaf1 100644 --- a/docs/code/interfaces/types_app.AppDeployMetadata.md +++ b/docs/code/interfaces/types_app.AppDeployMetadata.md @@ -33,7 +33,7 @@ Whether or not the app is deletable / permanent / unspecified #### Defined in -[src/types/app.ts:253](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L253) +[src/types/app.ts:252](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L252) ___ @@ -45,7 +45,7 @@ The unique name identifier of the app within the creator account #### Defined in -[src/types/app.ts:249](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L249) +[src/types/app.ts:248](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L248) ___ @@ -57,7 +57,7 @@ Whether or not the app is updatable / immutable / unspecified #### Defined in -[src/types/app.ts:255](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L255) +[src/types/app.ts:254](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L254) ___ @@ -69,4 +69,4 @@ The version of app that is / will be deployed #### Defined in -[src/types/app.ts:251](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L251) +[src/types/app.ts:250](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L250) diff --git a/docs/code/interfaces/types_app.AppDeploymentParams.md b/docs/code/interfaces/types_app.AppDeploymentParams.md index 19247b01..72104ad5 100644 --- a/docs/code/interfaces/types_app.AppDeploymentParams.md +++ b/docs/code/interfaces/types_app.AppDeploymentParams.md @@ -78,7 +78,7 @@ Any args to pass to any create transaction that is issued as part of deployment #### Defined in -[src/types/app.ts:323](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L323) +[src/types/app.ts:322](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L322) ___ @@ -90,7 +90,7 @@ Override the on-completion action for the create call; defaults to NoOp #### Defined in -[src/types/app.ts:325](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L325) +[src/types/app.ts:324](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L324) ___ @@ -102,7 +102,7 @@ Any args to pass to any delete transaction that is issued as part of deployment #### Defined in -[src/types/app.ts:329](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L329) +[src/types/app.ts:328](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L328) ___ @@ -114,7 +114,7 @@ Any deploy-time parameters to replace in the TEAL code #### Defined in -[src/types/app.ts:315](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L315) +[src/types/app.ts:314](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L314) ___ @@ -126,7 +126,7 @@ Optional cached value of the existing apps for the given creator #### Defined in -[src/types/app.ts:321](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L321) +[src/types/app.ts:320](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L320) ___ @@ -202,7 +202,7 @@ The deployment metadata #### Defined in -[src/types/app.ts:313](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L313) +[src/types/app.ts:312](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L312) ___ @@ -214,7 +214,7 @@ What action to perform if a schema break is detected #### Defined in -[src/types/app.ts:317](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L317) +[src/types/app.ts:316](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L316) ___ @@ -226,7 +226,7 @@ What action to perform if a TEAL update is detected #### Defined in -[src/types/app.ts:319](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L319) +[src/types/app.ts:318](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L318) ___ @@ -302,4 +302,4 @@ Any args to pass to any update transaction that is issued as part of deployment #### Defined in -[src/types/app.ts:327](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L327) +[src/types/app.ts:326](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L326) diff --git a/docs/code/interfaces/types_app.AppLookup.md b/docs/code/interfaces/types_app.AppLookup.md index cdfe0176..3b289922 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 -[src/types/app.ts:273](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L273) +[src/types/app.ts:272](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L272) ___ @@ -31,4 +31,4 @@ ___ #### Defined in -[src/types/app.ts:272](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L272) +[src/types/app.ts:271](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L271) diff --git a/docs/code/interfaces/types_app.AppMetadata.md b/docs/code/interfaces/types_app.AppMetadata.md index 104f4f04..a7338fe3 100644 --- a/docs/code/interfaces/types_app.AppMetadata.md +++ b/docs/code/interfaces/types_app.AppMetadata.md @@ -71,7 +71,7 @@ The metadata when the app was created #### Defined in -[src/types/app.ts:265](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L265) +[src/types/app.ts:264](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L264) ___ @@ -83,7 +83,7 @@ The round the app was created #### Defined in -[src/types/app.ts:261](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L261) +[src/types/app.ts:260](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L260) ___ @@ -99,7 +99,7 @@ Whether or not the app is deletable / permanent / unspecified #### Defined in -[src/types/app.ts:253](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L253) +[src/types/app.ts:252](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L252) ___ @@ -111,7 +111,7 @@ Whether or not the app is deleted #### Defined in -[src/types/app.ts:267](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L267) +[src/types/app.ts:266](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L266) ___ @@ -127,7 +127,7 @@ The unique name identifier of the app within the creator account #### Defined in -[src/types/app.ts:249](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L249) +[src/types/app.ts:248](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L248) ___ @@ -143,7 +143,7 @@ Whether or not the app is updatable / immutable / unspecified #### Defined in -[src/types/app.ts:255](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L255) +[src/types/app.ts:254](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L254) ___ @@ -155,7 +155,7 @@ The last round that the app was updated #### Defined in -[src/types/app.ts:263](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L263) +[src/types/app.ts:262](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L262) ___ @@ -171,4 +171,4 @@ The version of app that is / will be deployed #### Defined in -[src/types/app.ts:251](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L251) +[src/types/app.ts:250](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L250) diff --git a/docs/code/interfaces/types_app.BoxName.md b/docs/code/interfaces/types_app.BoxName.md index 16dc8fda..e1a59441 100644 --- a/docs/code/interfaces/types_app.BoxName.md +++ b/docs/code/interfaces/types_app.BoxName.md @@ -24,7 +24,7 @@ Name in UTF-8 #### Defined in -[src/types/app.ts:387](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L387) +[src/types/app.ts:386](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L386) ___ @@ -36,7 +36,7 @@ Name in Base64 #### Defined in -[src/types/app.ts:391](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L391) +[src/types/app.ts:390](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L390) ___ @@ -48,4 +48,4 @@ Name in binary bytes #### Defined in -[src/types/app.ts:389](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L389) +[src/types/app.ts:388](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L388) diff --git a/docs/code/interfaces/types_app.BoxValueRequestParams.md b/docs/code/interfaces/types_app.BoxValueRequestParams.md index c9e6b693..ac975d79 100644 --- a/docs/code/interfaces/types_app.BoxValueRequestParams.md +++ b/docs/code/interfaces/types_app.BoxValueRequestParams.md @@ -27,7 +27,7 @@ The ID of the app return box names for #### Defined in -[src/types/app.ts:400](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L400) +[src/types/app.ts:399](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L399) ___ @@ -39,7 +39,7 @@ The name of the box to return either as a string, binary array or `BoxName` #### Defined in -[src/types/app.ts:402](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L402) +[src/types/app.ts:401](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L401) ___ @@ -51,4 +51,4 @@ The ABI type to decode the value using #### Defined in -[src/types/app.ts:404](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L404) +[src/types/app.ts:403](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L403) diff --git a/docs/code/interfaces/types_app.BoxValuesRequestParams.md b/docs/code/interfaces/types_app.BoxValuesRequestParams.md index df0fbfe6..92ebedc7 100644 --- a/docs/code/interfaces/types_app.BoxValuesRequestParams.md +++ b/docs/code/interfaces/types_app.BoxValuesRequestParams.md @@ -27,7 +27,7 @@ The ID of the app return box names for #### Defined in -[src/types/app.ts:413](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L413) +[src/types/app.ts:412](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L412) ___ @@ -39,7 +39,7 @@ The names of the boxes to return either as a string, binary array or BoxName` #### Defined in -[src/types/app.ts:415](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L415) +[src/types/app.ts:414](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L414) ___ @@ -51,4 +51,4 @@ The ABI type to decode the value using #### Defined in -[src/types/app.ts:417](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L417) +[src/types/app.ts:416](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L416) diff --git a/docs/code/interfaces/types_app.RawAppCallArgs.md b/docs/code/interfaces/types_app.RawAppCallArgs.md index b83ab613..dc3bcba0 100644 --- a/docs/code/interfaces/types_app.RawAppCallArgs.md +++ b/docs/code/interfaces/types_app.RawAppCallArgs.md @@ -12,8 +12,6 @@ App call args with non-ABI (raw) values (minus some processing like encoding str ↳ **`RawAppCallArgs`** - ↳↳ [`AppClientCallRawArgs`](types_app_client.AppClientCallRawArgs.md) - ## Table of contents ### Properties diff --git a/docs/code/interfaces/types_app_client.AppClientCallABIArgs.md b/docs/code/interfaces/types_app_client.AppClientCallABIArgs.md index 0f7628d2..3ab6c743 100644 --- a/docs/code/interfaces/types_app_client.AppClientCallABIArgs.md +++ b/docs/code/interfaces/types_app_client.AppClientCallABIArgs.md @@ -113,7 +113,7 @@ If calling an ABI method then either the name of the method, or the ABI signatur #### Defined in -[src/types/app-client.ts:199](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L199) +[src/types/app-client.ts:198](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L198) ___ diff --git a/docs/code/interfaces/types_app_client.AppClientCallCoreParams.md b/docs/code/interfaces/types_app_client.AppClientCallCoreParams.md index 14f7cc23..3145e4fd 100644 --- a/docs/code/interfaces/types_app_client.AppClientCallCoreParams.md +++ b/docs/code/interfaces/types_app_client.AppClientCallCoreParams.md @@ -24,7 +24,7 @@ The transaction note for the smart contract call #### Defined in -[src/types/app-client.ts:210](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L210) +[src/types/app-client.ts:209](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L209) ___ @@ -36,7 +36,7 @@ Parameters to control transaction sending #### Defined in -[src/types/app-client.ts:212](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L212) +[src/types/app-client.ts:211](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L211) ___ @@ -48,4 +48,4 @@ The optional sender to send the transaction from, will use the application clien #### Defined in -[src/types/app-client.ts:208](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L208) +[src/types/app-client.ts:207](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L207) diff --git a/docs/code/interfaces/types_app_client.AppClientCallRawArgs.md b/docs/code/interfaces/types_app_client.AppClientCallRawArgs.md deleted file mode 100644 index 0a183289..00000000 --- a/docs/code/interfaces/types_app_client.AppClientCallRawArgs.md +++ /dev/null @@ -1,156 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app-client](../modules/types_app_client.md) / AppClientCallRawArgs - -# Interface: AppClientCallRawArgs - -[types/app-client](../modules/types_app_client.md).AppClientCallRawArgs - -App call args with non-ABI (raw) values (minus some processing like encoding strings as binary) - -## Hierarchy - -- [`RawAppCallArgs`](types_app.RawAppCallArgs.md) - - ↳ **`AppClientCallRawArgs`** - -## Table of contents - -### Properties - -- [accounts](types_app_client.AppClientCallRawArgs.md#accounts) -- [appArgs](types_app_client.AppClientCallRawArgs.md#appargs) -- [apps](types_app_client.AppClientCallRawArgs.md#apps) -- [assets](types_app_client.AppClientCallRawArgs.md#assets) -- [boxes](types_app_client.AppClientCallRawArgs.md#boxes) -- [lease](types_app_client.AppClientCallRawArgs.md#lease) -- [method](types_app_client.AppClientCallRawArgs.md#method) -- [rekeyTo](types_app_client.AppClientCallRawArgs.md#rekeyto) - -## Properties - -### accounts - -• `Optional` **accounts**: (`string` \| `Address`)[] - -The address of any accounts to load in - -#### Inherited from - -[RawAppCallArgs](types_app.RawAppCallArgs.md).[accounts](types_app.RawAppCallArgs.md#accounts) - -#### Defined in - -[src/types/app.ts:79](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L79) - -___ - -### appArgs - -• `Optional` **appArgs**: (`string` \| `Uint8Array`)[] - -Any application arguments to pass through - -#### Inherited from - -[RawAppCallArgs](types_app.RawAppCallArgs.md).[appArgs](types_app.RawAppCallArgs.md#appargs) - -#### Defined in - -[src/types/app.ts:96](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L96) - -___ - -### apps - -• `Optional` **apps**: `number`[] - -IDs of any apps to load into the foreignApps array - -#### Inherited from - -[RawAppCallArgs](types_app.RawAppCallArgs.md).[apps](types_app.RawAppCallArgs.md#apps) - -#### Defined in - -[src/types/app.ts:81](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L81) - -___ - -### assets - -• `Optional` **assets**: `number`[] - -IDs of any assets to load into the foreignAssets array - -#### Inherited from - -[RawAppCallArgs](types_app.RawAppCallArgs.md).[assets](types_app.RawAppCallArgs.md#assets) - -#### Defined in - -[src/types/app.ts:83](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L83) - -___ - -### boxes - -• `Optional` **boxes**: ([`BoxReference`](types_app.BoxReference.md) \| [`BoxIdentifier`](../modules/types_app.md#boxidentifier) \| `BoxReference`)[] - -Any box references to load - -#### Inherited from - -[RawAppCallArgs](types_app.RawAppCallArgs.md).[boxes](types_app.RawAppCallArgs.md#boxes) - -#### Defined in - -[src/types/app.ts:77](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L77) - -___ - -### lease - -• `Optional` **lease**: `string` \| `Uint8Array` - -The optional lease for the transaction - -#### Inherited from - -[RawAppCallArgs](types_app.RawAppCallArgs.md).[lease](types_app.RawAppCallArgs.md#lease) - -#### Defined in - -[src/types/app.ts:75](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L75) - -___ - -### method - -• `Optional` **method**: `undefined` - -Property to aid intellisense - -#### Inherited from - -[RawAppCallArgs](types_app.RawAppCallArgs.md).[method](types_app.RawAppCallArgs.md#method) - -#### Defined in - -[src/types/app.ts:98](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L98) - -___ - -### rekeyTo - -• `Optional` **rekeyTo**: `string` \| [`SendTransactionFrom`](../modules/types_transaction.md#sendtransactionfrom) - -Optional account / account address that should be authorised to transact on behalf of the from account the app call is sent from after this transaction. - -**Note:** Use with extreme caution and review the [official rekey guidance](https://developer.algorand.org/docs/get-details/accounts/rekey/) first. - -#### Inherited from - -[RawAppCallArgs](types_app.RawAppCallArgs.md).[rekeyTo](types_app.RawAppCallArgs.md#rekeyto) - -#### Defined in - -[src/types/app.ts:88](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L88) diff --git a/docs/code/interfaces/types_app_client.AppClientCompilationParams.md b/docs/code/interfaces/types_app_client.AppClientCompilationParams.md index 298ce1d4..a6af2798 100644 --- a/docs/code/interfaces/types_app_client.AppClientCompilationParams.md +++ b/docs/code/interfaces/types_app_client.AppClientCompilationParams.md @@ -22,7 +22,7 @@ Whether or not the contract should have deploy-time permanence control set, unde #### Defined in -[src/types/app-client.ts:227](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L227) +[src/types/app-client.ts:226](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L226) ___ @@ -34,7 +34,7 @@ Any deploy-time parameters to replace in the TEAL code #### Defined in -[src/types/app-client.ts:223](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L223) +[src/types/app-client.ts:222](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L222) ___ @@ -46,4 +46,4 @@ Whether or not the contract should have deploy-time immutability control set, un #### Defined in -[src/types/app-client.ts:225](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L225) +[src/types/app-client.ts:224](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L224) diff --git a/docs/code/interfaces/types_app_client.AppClientParams.md b/docs/code/interfaces/types_app_client.AppClientParams.md index 9bc0cead..90ac72ce 100644 --- a/docs/code/interfaces/types_app_client.AppClientParams.md +++ b/docs/code/interfaces/types_app_client.AppClientParams.md @@ -28,7 +28,7 @@ An `AlgorandClient` instance #### Defined in -[src/types/app-client.ts:314](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L314) +[src/types/app-client.ts:313](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L313) ___ @@ -40,7 +40,7 @@ The ID of the app instance this client should make calls against. #### Defined in -[src/types/app-client.ts:304](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L304) +[src/types/app-client.ts:303](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L303) ___ @@ -53,7 +53,7 @@ Defaults to the ARC-32/ARC-56 app spec name #### Defined in -[src/types/app-client.ts:320](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L320) +[src/types/app-client.ts:319](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L319) ___ @@ -68,7 +68,7 @@ The ARC-56 or ARC-32 application spec as either: #### Defined in -[src/types/app-client.ts:311](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L311) +[src/types/app-client.ts:310](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L310) ___ @@ -80,7 +80,7 @@ Optional source map for the approval program #### Defined in -[src/types/app-client.ts:324](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L324) +[src/types/app-client.ts:323](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L323) ___ @@ -92,7 +92,7 @@ Optional source map for the clear state program #### Defined in -[src/types/app-client.ts:326](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L326) +[src/types/app-client.ts:325](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L325) ___ @@ -104,4 +104,4 @@ Optional address to use for the account to use as the default sender for calls. #### Defined in -[src/types/app-client.ts:322](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L322) +[src/types/app-client.ts:321](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L321) diff --git a/docs/code/interfaces/types_app_client.AppSourceMaps.md b/docs/code/interfaces/types_app_client.AppSourceMaps.md index 8afec5f5..c13c0d1f 100644 --- a/docs/code/interfaces/types_app_client.AppSourceMaps.md +++ b/docs/code/interfaces/types_app_client.AppSourceMaps.md @@ -23,7 +23,7 @@ The source map of the approval program #### Defined in -[src/types/app-client.ts:261](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L261) +[src/types/app-client.ts:260](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L260) ___ @@ -35,4 +35,4 @@ The source map of the clear program #### Defined in -[src/types/app-client.ts:263](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L263) +[src/types/app-client.ts:262](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L262) diff --git a/docs/code/interfaces/types_app_client.FundAppAccountParams.md b/docs/code/interfaces/types_app_client.FundAppAccountParams.md index ce929bcb..fb17cd10 100644 --- a/docs/code/interfaces/types_app_client.FundAppAccountParams.md +++ b/docs/code/interfaces/types_app_client.FundAppAccountParams.md @@ -23,7 +23,7 @@ Parameters for funding an app account #### Defined in -[src/types/app-client.ts:249](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L249) +[src/types/app-client.ts:248](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L248) ___ @@ -35,7 +35,7 @@ The transaction note for the smart contract call #### Defined in -[src/types/app-client.ts:253](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L253) +[src/types/app-client.ts:252](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L252) ___ @@ -47,7 +47,7 @@ Parameters to control transaction sending #### Defined in -[src/types/app-client.ts:255](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L255) +[src/types/app-client.ts:254](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L254) ___ @@ -59,4 +59,4 @@ The optional sender to send the transaction from, will use the application clien #### Defined in -[src/types/app-client.ts:251](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L251) +[src/types/app-client.ts:250](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L250) diff --git a/docs/code/interfaces/types_app_client.SourceMapExport.md b/docs/code/interfaces/types_app_client.SourceMapExport.md index b48b153c..92091e89 100644 --- a/docs/code/interfaces/types_app_client.SourceMapExport.md +++ b/docs/code/interfaces/types_app_client.SourceMapExport.md @@ -21,7 +21,7 @@ #### Defined in -[src/types/app-client.ts:270](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L270) +[src/types/app-client.ts:269](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L269) ___ @@ -31,7 +31,7 @@ ___ #### Defined in -[src/types/app-client.ts:269](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L269) +[src/types/app-client.ts:268](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L268) ___ @@ -41,7 +41,7 @@ ___ #### Defined in -[src/types/app-client.ts:268](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L268) +[src/types/app-client.ts:267](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L267) ___ @@ -51,4 +51,4 @@ ___ #### Defined in -[src/types/app-client.ts:267](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L267) +[src/types/app-client.ts:266](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L266) diff --git a/docs/code/interfaces/types_app_deployer.AppMetadata.md b/docs/code/interfaces/types_app_deployer.AppMetadata.md index 95f8f926..ee6925c7 100644 --- a/docs/code/interfaces/types_app_deployer.AppMetadata.md +++ b/docs/code/interfaces/types_app_deployer.AppMetadata.md @@ -89,7 +89,7 @@ Whether or not the app is deletable / permanent / unspecified #### Defined in -[src/types/app.ts:253](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L253) +[src/types/app.ts:252](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L252) ___ @@ -117,7 +117,7 @@ The unique name identifier of the app within the creator account #### Defined in -[src/types/app.ts:249](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L249) +[src/types/app.ts:248](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L248) ___ @@ -133,7 +133,7 @@ Whether or not the app is updatable / immutable / unspecified #### Defined in -[src/types/app.ts:255](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L255) +[src/types/app.ts:254](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L254) ___ @@ -161,4 +161,4 @@ The version of app that is / will be deployed #### Defined in -[src/types/app.ts:251](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L251) +[src/types/app.ts:250](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L250) diff --git a/docs/code/modules/index.md b/docs/code/modules/index.md index 39335c00..11fa0cea 100644 --- a/docs/code/modules/index.md +++ b/docs/code/modules/index.md @@ -416,7 +416,7 @@ ___ ### callApp -▸ **callApp**(`call`, `algod`): `Promise`\<[`AppCallTransactionResult`](../interfaces/types_app.AppCallTransactionResult.md)\> +▸ **callApp**(`call`, `algod`): `Promise`\<[`AppCallTransactionResult`](types_app.md#appcalltransactionresult)\> #### Parameters @@ -427,7 +427,7 @@ ___ #### Returns -`Promise`\<[`AppCallTransactionResult`](../interfaces/types_app.AppCallTransactionResult.md)\> +`Promise`\<[`AppCallTransactionResult`](types_app.md#appcalltransactionresult)\> The result of the call @@ -539,7 +539,7 @@ ___ ### createApp -▸ **createApp**(`create`, `algod`): `Promise`\<`Partial`\<[`AppCompilationResult`](../interfaces/types_app.AppCompilationResult.md)\> & [`AppCallTransactionResult`](../interfaces/types_app.AppCallTransactionResult.md) & [`AppReference`](../interfaces/types_app.AppReference.md)\> +▸ **createApp**(`create`, `algod`): `Promise`\<`Partial`\<[`AppCompilationResult`](../interfaces/types_app.AppCompilationResult.md)\> & [`AppCallTransactionResult`](types_app.md#appcalltransactionresult) & [`AppReference`](../interfaces/types_app.AppReference.md)\> #### Parameters @@ -550,7 +550,7 @@ ___ #### Returns -`Promise`\<`Partial`\<[`AppCompilationResult`](../interfaces/types_app.AppCompilationResult.md)\> & [`AppCallTransactionResult`](../interfaces/types_app.AppCallTransactionResult.md) & [`AppReference`](../interfaces/types_app.AppReference.md)\> +`Promise`\<`Partial`\<[`AppCompilationResult`](../interfaces/types_app.AppCompilationResult.md)\> & [`AppCallTransactionResult`](types_app.md#appcalltransactionresult) & [`AppReference`](../interfaces/types_app.AppReference.md)\> The details of the created app, or the transaction to create it if `skipSending` and the compilation result @@ -3064,7 +3064,7 @@ ___ ### updateApp -▸ **updateApp**(`update`, `algod`): `Promise`\<`Partial`\<[`AppCompilationResult`](../interfaces/types_app.AppCompilationResult.md)\> & [`AppCallTransactionResult`](../interfaces/types_app.AppCallTransactionResult.md)\> +▸ **updateApp**(`update`, `algod`): `Promise`\<`Partial`\<[`AppCompilationResult`](../interfaces/types_app.AppCompilationResult.md)\> & [`AppCallTransactionResult`](types_app.md#appcalltransactionresult)\> #### Parameters @@ -3075,7 +3075,7 @@ ___ #### Returns -`Promise`\<`Partial`\<[`AppCompilationResult`](../interfaces/types_app.AppCompilationResult.md)\> & [`AppCallTransactionResult`](../interfaces/types_app.AppCallTransactionResult.md)\> +`Promise`\<`Partial`\<[`AppCompilationResult`](../interfaces/types_app.AppCompilationResult.md)\> & [`AppCallTransactionResult`](types_app.md#appcalltransactionresult)\> The transaction send result and the compilation result diff --git a/docs/code/modules/types_app.md b/docs/code/modules/types_app.md index ca17b674..ad1e0b24 100644 --- a/docs/code/modules/types_app.md +++ b/docs/code/modules/types_app.md @@ -12,7 +12,6 @@ ### Interfaces - [AppCallParams](../interfaces/types_app.AppCallParams.md) -- [AppCallTransactionResult](../interfaces/types_app.AppCallTransactionResult.md) - [AppCallTransactionResultOfType](../interfaces/types_app.AppCallTransactionResultOfType.md) - [AppCompilationResult](../interfaces/types_app.AppCompilationResult.md) - [AppDeployMetadata](../interfaces/types_app.AppDeployMetadata.md) @@ -39,6 +38,7 @@ - [ABIAppCallArgs](types_app.md#abiappcallargs) - [ABIReturn](types_app.md#abireturn) - [AppCallArgs](types_app.md#appcallargs) +- [AppCallTransactionResult](types_app.md#appcalltransactionresult) - [AppCallType](types_app.md#appcalltype) - [AppReturn](types_app.md#appreturn) - [BoxIdentifier](types_app.md#boxidentifier) @@ -88,7 +88,7 @@ The return value of an ABI method call #### Defined in -[src/types/app.ts:236](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L236) +[src/types/app.ts:235](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L235) ___ @@ -106,6 +106,18 @@ Arguments to pass to an app call either: ___ +### AppCallTransactionResult + +Ƭ **AppCallTransactionResult**: [`AppCallTransactionResultOfType`](../interfaces/types_app.AppCallTransactionResultOfType.md)\<[`ABIReturn`](types_app.md#abireturn)\> + +Result from calling an app + +#### Defined in + +[src/types/app.ts:232](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L232) + +___ + ### AppCallType Ƭ **AppCallType**: ``"no_op"`` \| ``"opt_in"`` \| ``"close_out"`` \| ``"clear_state"`` \| ``"update_application"`` \| ``"delete_application"`` @@ -149,7 +161,7 @@ ___ #### Defined in -[src/types/app.ts:340](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L340) +[src/types/app.ts:339](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L339) ___ @@ -180,7 +192,7 @@ Result from sending a single app transaction. #### Defined in -[src/types/app.ts:357](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L357) +[src/types/app.ts:356](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L356) ___ @@ -192,7 +204,7 @@ Result from sending a single app transaction. #### Defined in -[src/types/app.ts:346](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L346) +[src/types/app.ts:345](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L345) ___ @@ -204,7 +216,7 @@ Result from sending a single app transaction. #### Defined in -[src/types/app.ts:354](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L354) +[src/types/app.ts:353](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L353) ## Variables diff --git a/docs/code/modules/types_app_client.md b/docs/code/modules/types_app_client.md index adc805ac..3bd5f626 100644 --- a/docs/code/modules/types_app_client.md +++ b/docs/code/modules/types_app_client.md @@ -13,7 +13,6 @@ - [AppClientCallABIArgs](../interfaces/types_app_client.AppClientCallABIArgs.md) - [AppClientCallCoreParams](../interfaces/types_app_client.AppClientCallCoreParams.md) -- [AppClientCallRawArgs](../interfaces/types_app_client.AppClientCallRawArgs.md) - [AppClientCompilationParams](../interfaces/types_app_client.AppClientCompilationParams.md) - [AppClientDeployCallInterfaceParams](../interfaces/types_app_client.AppClientDeployCallInterfaceParams.md) - [AppClientDeployCoreParams](../interfaces/types_app_client.AppClientDeployCoreParams.md) @@ -30,6 +29,7 @@ - [AppClientBareCallParams](types_app_client.md#appclientbarecallparams) - [AppClientCallArgs](types_app_client.md#appclientcallargs) - [AppClientCallParams](types_app_client.md#appclientcallparams) +- [AppClientCallRawArgs](types_app_client.md#appclientcallrawargs) - [AppClientClearStateParams](types_app_client.md#appclientclearstateparams) - [AppClientCreateOnComplete](types_app_client.md#appclientcreateoncomplete) - [AppClientCreateParams](types_app_client.md#appclientcreateparams) @@ -57,19 +57,19 @@ AppClient parameters for a bare app call #### Defined in -[src/types/app-client.ts:336](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L336) +[src/types/app-client.ts:335](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L335) ___ ### AppClientCallArgs -Ƭ **AppClientCallArgs**: [`AppClientCallRawArgs`](../interfaces/types_app_client.AppClientCallRawArgs.md) \| [`AppClientCallABIArgs`](../interfaces/types_app_client.AppClientCallABIArgs.md) +Ƭ **AppClientCallArgs**: [`AppClientCallRawArgs`](types_app_client.md#appclientcallrawargs) \| [`AppClientCallABIArgs`](../interfaces/types_app_client.AppClientCallABIArgs.md) The arguments to pass to an Application Client smart contract call #### Defined in -[src/types/app-client.ts:203](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L203) +[src/types/app-client.ts:202](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L202) ___ @@ -81,19 +81,29 @@ Parameters to construct a ApplicationClient contract call #### Defined in -[src/types/app-client.ts:216](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L216) +[src/types/app-client.ts:215](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L215) + +___ + +### AppClientCallRawArgs + +Ƭ **AppClientCallRawArgs**: [`RawAppCallArgs`](../interfaces/types_app.RawAppCallArgs.md) + +#### Defined in + +[src/types/app-client.ts:194](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L194) ___ ### AppClientClearStateParams -Ƭ **AppClientClearStateParams**: [`AppClientCallRawArgs`](../interfaces/types_app_client.AppClientCallRawArgs.md) & [`AppClientCallCoreParams`](../interfaces/types_app_client.AppClientCallCoreParams.md) +Ƭ **AppClientClearStateParams**: [`AppClientCallRawArgs`](types_app_client.md#appclientcallrawargs) & [`AppClientCallCoreParams`](../interfaces/types_app_client.AppClientCallCoreParams.md) Parameters to construct a ApplicationClient clear state contract call #### Defined in -[src/types/app-client.ts:219](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L219) +[src/types/app-client.ts:218](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L218) ___ @@ -111,7 +121,7 @@ On-complete action parameter for creating a contract using ApplicationClient #### Defined in -[src/types/app-client.ts:231](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L231) +[src/types/app-client.ts:230](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L230) ___ @@ -123,7 +133,7 @@ Parameters for creating a contract using ApplicationClient #### Defined in -[src/types/app-client.ts:237](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L237) +[src/types/app-client.ts:236](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L236) ___ @@ -135,7 +145,7 @@ AppClient parameters for an ABI method call #### Defined in -[src/types/app-client.ts:344](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L344) +[src/types/app-client.ts:343](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L343) ___ @@ -147,7 +157,7 @@ Parameters for updating a contract using ApplicationClient #### Defined in -[src/types/app-client.ts:245](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L245) +[src/types/app-client.ts:244](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L244) ___ @@ -251,7 +261,7 @@ onComplete parameter for a non-update app call #### Defined in -[src/types/app-client.ts:330](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L330) +[src/types/app-client.ts:329](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L329) ___ @@ -263,7 +273,7 @@ Parameters for funding an app account #### Defined in -[src/types/app-client.ts:368](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L368) +[src/types/app-client.ts:367](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L367) ___ @@ -307,4 +317,4 @@ Resolve an app client instance by looking up an app created by the given creator #### Defined in -[src/types/app-client.ts:377](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L377) +[src/types/app-client.ts:376](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L376) diff --git a/src/account/account.ts b/src/account/account.ts index 83053823..56ce04ee 100644 --- a/src/account/account.ts +++ b/src/account/account.ts @@ -170,8 +170,8 @@ export async function getAccountInformation(sender: string | SendTransactionFrom rewardBase: account.rewardBase ? Number(account.rewardBase) : undefined, totalBoxBytes: account.totalBoxBytes ? Number(account.totalBoxBytes) : undefined, totalBoxes: account.totalBoxes ? Number(account.totalBoxes) : undefined, - lastHeartbeat: Number(account.lastHeartbeat), - lastProposed: Number(account.lastProposed), + lastHeartbeat: Object.prototype.hasOwnProperty.call(account, 'lastHeartbeat') ? Number(account.lastHeartbeat) : undefined, + lastProposed: Object.prototype.hasOwnProperty.call(account, 'lastProposed') ? Number(account.lastProposed) : undefined, } } diff --git a/src/types/app-client.ts b/src/types/app-client.ts index cf9ea04f..76faa6ec 100644 --- a/src/types/app-client.ts +++ b/src/types/app-client.ts @@ -191,8 +191,7 @@ export interface AppClientDeployParams extends AppClientDeployCoreParams, AppCli schema?: Partial } -// eslint-disable-next-line @typescript-eslint/no-empty-interface, @typescript-eslint/no-empty-object-type -export interface AppClientCallRawArgs extends RawAppCallArgs {} +export type AppClientCallRawArgs = RawAppCallArgs export interface AppClientCallABIArgs extends Omit { /** If calling an ABI method then either the name of the method, or the ABI signature */ diff --git a/src/types/app.ts b/src/types/app.ts index 82e28a46..197efe78 100644 --- a/src/types/app.ts +++ b/src/types/app.ts @@ -229,8 +229,7 @@ export interface AppCallTransactionResultOfType extends SendTransactionResult } /** Result from calling an app */ -// eslint-disable-next-line @typescript-eslint/no-empty-interface, @typescript-eslint/no-empty-object-type -export interface AppCallTransactionResult extends AppCallTransactionResultOfType {} +export type AppCallTransactionResult = AppCallTransactionResultOfType /** The return value of an ABI method call */ export type ABIReturn =