Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Abi return handling #322

Merged
merged 2 commits into from
Oct 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@
"source.organizeImports": "explicit"
},
"jest.jestCommandLine": "npm run test --",
"jest.autoRun": {},
"jest.runMode": "on-demand",
"dotenv.enableAutocloaking": false
}
40 changes: 20 additions & 20 deletions docs/code/classes/types_app_manager.AppManager.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Creates an `AppManager`

#### Defined in

[src/types/app-manager.ts:105](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L105)
[src/types/app-manager.ts:106](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L106)

## Properties

Expand All @@ -67,7 +67,7 @@ Creates an `AppManager`

#### Defined in

[src/types/app-manager.ts:98](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L98)
[src/types/app-manager.ts:99](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L99)

___

Expand All @@ -77,7 +77,7 @@ ___

#### Defined in

[src/types/app-manager.ts:99](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L99)
[src/types/app-manager.ts:100](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L100)

## Methods

Expand Down Expand Up @@ -106,7 +106,7 @@ The information about the compiled file

#### Defined in

[src/types/app-manager.ts:120](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L120)
[src/types/app-manager.ts:121](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L121)

___

Expand Down Expand Up @@ -140,7 +140,7 @@ The information about the compiled code

#### Defined in

[src/types/app-manager.ts:152](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L152)
[src/types/app-manager.ts:153](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L153)

___

Expand All @@ -164,7 +164,7 @@ The current box names

#### Defined in

[src/types/app-manager.ts:240](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L240)
[src/types/app-manager.ts:241](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L241)

___

Expand All @@ -189,7 +189,7 @@ The current box value as a byte array

#### Defined in

[src/types/app-manager.ts:257](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L257)
[src/types/app-manager.ts:258](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L258)

___

Expand All @@ -213,7 +213,7 @@ The current box value as an ABI value

#### Defined in

[src/types/app-manager.ts:278](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L278)
[src/types/app-manager.ts:279](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L279)

___

Expand All @@ -238,7 +238,7 @@ The current box values as a byte array in the same order as the passed in box na

#### Defined in

[src/types/app-manager.ts:269](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L269)
[src/types/app-manager.ts:270](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L270)

___

Expand All @@ -262,7 +262,7 @@ The current box values as an ABI value in the same order as the passed in box na

#### Defined in

[src/types/app-manager.ts:289](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L289)
[src/types/app-manager.ts:290](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L290)

___

Expand Down Expand Up @@ -292,7 +292,7 @@ const appInfo = await appManager.getById(12353n);

#### Defined in

[src/types/app-manager.ts:189](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L189)
[src/types/app-manager.ts:190](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L190)

___

Expand All @@ -317,7 +317,7 @@ The information about the previously compiled file

#### Defined in

[src/types/app-manager.ts:174](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L174)
[src/types/app-manager.ts:175](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L175)

___

Expand All @@ -341,7 +341,7 @@ The current global state for the given app

#### Defined in

[src/types/app-manager.ts:212](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L212)
[src/types/app-manager.ts:213](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L213)

___

Expand All @@ -366,7 +366,7 @@ The current local state for the given (app, account) combination

#### Defined in

[src/types/app-manager.ts:223](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L223)
[src/types/app-manager.ts:224](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L224)

___

Expand All @@ -391,7 +391,7 @@ An object keyeed by the UTF-8 representation of the key with various parsings of

#### Defined in

[src/types/app-manager.ts:318](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L318)
[src/types/app-manager.ts:319](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L319)

___

Expand All @@ -416,7 +416,7 @@ The return value for the method call

#### Defined in

[src/types/app-manager.ts:366](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L366)
[src/types/app-manager.ts:367](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L367)

___

Expand All @@ -440,7 +440,7 @@ The box reference ready to pass into a `algosdk.Transaction`

#### Defined in

[src/types/app-manager.ts:299](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L299)
[src/types/app-manager.ts:300](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L300)

___

Expand Down Expand Up @@ -473,7 +473,7 @@ The replaced TEAL code

#### Defined in

[src/types/app-manager.ts:408](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L408)
[src/types/app-manager.ts:397](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L397)

___

Expand All @@ -500,7 +500,7 @@ The TEAL code with replacements

#### Defined in

[src/types/app-manager.ts:439](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L439)
[src/types/app-manager.ts:428](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L428)

___

Expand All @@ -524,4 +524,4 @@ The TEAL without comments

#### Defined in

[src/types/app-manager.ts:473](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L473)
[src/types/app-manager.ts:462](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L462)
6 changes: 3 additions & 3 deletions docs/code/enums/types_app.OnSchemaBreak.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:307](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L307)

___

Expand All @@ -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:303](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L303)

___

Expand All @@ -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:305](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L305)
8 changes: 4 additions & 4 deletions docs/code/enums/types_app.OnUpdate.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:297](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L297)

___

Expand All @@ -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:291](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L291)

___

Expand All @@ -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:295](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L295)

___

Expand All @@ -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:293](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L293)
4 changes: 2 additions & 2 deletions docs/code/interfaces/types_app.AppCompilationResult.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:336](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L336)

___

Expand All @@ -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:338](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L338)
8 changes: 4 additions & 4 deletions docs/code/interfaces/types_app.AppDeployMetadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:254](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L254)

___

Expand All @@ -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:250](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L250)

___

Expand All @@ -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:256](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L256)

___

Expand All @@ -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:252](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L252)
18 changes: 9 additions & 9 deletions docs/code/interfaces/types_app.AppDeploymentParams.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:324](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L324)

___

Expand All @@ -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:326](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L326)

___

Expand All @@ -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:330](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L330)

___

Expand All @@ -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:316](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L316)

___

Expand All @@ -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:322](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L322)

___

Expand Down Expand Up @@ -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:314](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L314)

___

Expand All @@ -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:318](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L318)

___

Expand All @@ -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:320](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L320)

___

Expand Down Expand Up @@ -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:328](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L328)
4 changes: 2 additions & 2 deletions docs/code/interfaces/types_app.AppLookup.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:274](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L274)

___

Expand All @@ -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:273](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L273)
Loading
Loading