Skip to content

Commit

Permalink
feat(app): Better supporting transactions as ABI arguments
Browse files Browse the repository at this point in the history
  • Loading branch information
@robdmoore
robdmoore committed Mar 23, 2023
1 parent d498cf5 commit 6745408
Show file tree
Hide file tree
Showing 22 changed files with 150 additions and 121 deletions.
46 changes: 23 additions & 23 deletions docs/code/classes/types_application_client.ApplicationClient.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Create a new ApplicationClient instance

#### Defined in

[types/application-client.ts:146](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L146)
[types/application-client.ts:147](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L147)

## Properties

Expand All @@ -67,7 +67,7 @@ Create a new ApplicationClient instance

#### Defined in

[types/application-client.ts:136](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L136)
[types/application-client.ts:137](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L137)

___

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

#### Defined in

[types/application-client.ts:135](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L135)
[types/application-client.ts:136](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L136)

___

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

#### Defined in

[types/application-client.ts:138](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L138)
[types/application-client.ts:139](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L139)

___

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

#### Defined in

[types/application-client.ts:137](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L137)
[types/application-client.ts:138](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L138)

___

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

#### Defined in

[types/application-client.ts:128](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L128)
[types/application-client.ts:129](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L129)

___

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

#### Defined in

[types/application-client.ts:130](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L130)
[types/application-client.ts:131](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L131)

___

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

#### Defined in

[types/application-client.ts:133](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L133)
[types/application-client.ts:134](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L134)

___

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

#### Defined in

[types/application-client.ts:129](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L129)
[types/application-client.ts:130](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L130)

___

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

#### Defined in

[types/application-client.ts:132](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L132)
[types/application-client.ts:133](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L133)

___

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

#### Defined in

[types/application-client.ts:131](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L131)
[types/application-client.ts:132](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L132)

## Methods

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

#### Defined in

[types/application-client.ts:382](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L382)
[types/application-client.ts:383](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L383)

___

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

#### Defined in

[types/application-client.ts:362](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L362)
[types/application-client.ts:363](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L363)

___

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

#### Defined in

[types/application-client.ts:374](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L374)
[types/application-client.ts:375](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L375)

___

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

#### Defined in

[types/application-client.ts:370](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L370)
[types/application-client.ts:371](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L371)

___

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

#### Defined in

[types/application-client.ts:281](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L281)
[types/application-client.ts:282](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L282)

___

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

#### Defined in

[types/application-client.ts:378](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L378)
[types/application-client.ts:379](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L379)

___

Expand Down Expand Up @@ -312,7 +312,7 @@ The metadata and transaction result(s) of the deployment, or just the metadata i

#### Defined in

[types/application-client.ts:190](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L190)
[types/application-client.ts:191](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L191)

___

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

#### Defined in

[types/application-client.ts:433](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L433)
[types/application-client.ts:434](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L434)

___

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

#### Defined in

[types/application-client.ts:448](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L448)
[types/application-client.ts:449](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L449)

___

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

#### Defined in

[types/application-client.ts:413](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L413)
[types/application-client.ts:414](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L414)

___

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

#### Defined in

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

___

Expand All @@ -406,4 +406,4 @@ ___

#### Defined in

[types/application-client.ts:327](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L327)
[types/application-client.ts:328](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/application-client.ts#L328)
4 changes: 2 additions & 2 deletions docs/code/enums/types_app.OnSchemaBreak.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Fail the deployment

#### Defined in

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

___

Expand All @@ -35,4 +35,4 @@ Delete the app and create a new one in its place

#### Defined in

[types/app.ts:224](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L224)
[types/app.ts:226](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L226)
6 changes: 3 additions & 3 deletions docs/code/enums/types_app.OnUpdate.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Fail the deployment

#### Defined in

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

___

Expand All @@ -36,7 +36,7 @@ Delete the app and create a new one in its place

#### Defined in

[types/app.ts:216](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L216)
[types/app.ts:218](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L218)

___

Expand All @@ -48,4 +48,4 @@ Update the app

#### Defined in

[types/app.ts:214](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L214)
[types/app.ts:216](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L216)
10 changes: 5 additions & 5 deletions docs/code/interfaces/types_app.ABIAppCallArgs.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,13 @@ App call args for an ABI call

### args

• **args**: `ABIArgument`[]
• **args**: [`ABIAppCallArg`](../modules/types_app.md#abiappcallarg)[]

The ABI args to pass in

#### Defined in

[types/app.ts:69](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L69)
[types/app.ts:71](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L71)

___

Expand All @@ -37,7 +37,7 @@ Any box references to load

#### Defined in

[types/app.ts:73](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L73)
[types/app.ts:75](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L75)

___

Expand All @@ -49,7 +49,7 @@ The optional lease for the transaction

#### Defined in

[types/app.ts:71](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L71)
[types/app.ts:73](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L73)

___

Expand All @@ -63,4 +63,4 @@ The ABI method to call, either:

#### Defined in

[types/app.ts:67](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L67)
[types/app.ts:69](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L69)
12 changes: 6 additions & 6 deletions docs/code/interfaces/types_app.AppCallParams.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ The id of the app to call

#### Defined in

[types/app.ts:112](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L112)
[types/app.ts:114](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L114)

___

Expand All @@ -51,7 +51,7 @@ The arguments passed in to the app call

#### Defined in

[types/app.ts:122](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L122)
[types/app.ts:124](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L124)

___

Expand All @@ -63,7 +63,7 @@ The type of call, everything except create (@see createApp ) and update (@see up

#### Defined in

[types/app.ts:114](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L114)
[types/app.ts:116](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L116)

___

Expand Down Expand Up @@ -91,7 +91,7 @@ The account to make the call from

#### Defined in

[types/app.ts:116](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L116)
[types/app.ts:118](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L118)

___

Expand Down Expand Up @@ -135,7 +135,7 @@ The (optional) transaction note

#### Defined in

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

___

Expand Down Expand Up @@ -196,4 +196,4 @@ Optional transaction parameters

#### Defined in

[types/app.ts:118](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L118)
[types/app.ts:120](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L120)
2 changes: 1 addition & 1 deletion docs/code/interfaces/types_app.AppCallTransactionResult.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ If an ABI method was called the processed return value

#### Defined in

[types/app.ts:154](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L154)
[types/app.ts:156](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L156)

___

Expand Down
8 changes: 4 additions & 4 deletions docs/code/interfaces/types_app.AppDeployMetadata.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Whether or not the app is deletable / permanent / unspecified

#### Defined in

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

___

Expand All @@ -47,7 +47,7 @@ The unique name identifier of the app within the creator account

#### Defined in

[types/app.ts:171](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L171)
[types/app.ts:173](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L173)

___

Expand All @@ -59,7 +59,7 @@ Whether or not the app is updatable / immutable / unspecified

#### Defined in

[types/app.ts:177](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L177)
[types/app.ts:179](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L179)

___

Expand All @@ -71,4 +71,4 @@ The version of app that is / will be deployed

#### Defined in

[types/app.ts:173](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L173)
[types/app.ts:175](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L175)
Loading

0 comments on commit 6745408

Please sign in to comment.