Skip to content

Commit

Permalink
feat: Readonly calls from app client now don't invoke signing (#321)
Browse files Browse the repository at this point in the history
feat: AlgoKitComposer.simulate() now has a `skipSignatures` option to opt-out of signing for the simulate call
feat: Added a `defaultSigner` to `AppClient` and `AppFactory`
feat: `AppClient` now has an `algorand` property so you don't need to pass `AlgorandClient` around everywhere if you have a client
feat: `AppFactory` now has an `algorand` property so you don't need to pass `AlgorandClient` around everywhere if you have a factory
feat: `AppFactory` now has `appName` and `appSpec` properties so if you want this information it's exposed rather than private
feat: `appFactory.deploy` now allows you to override `appName` so if you want to create multiple contracts from a factory with different names you can

BREAKING CHANGE: AppClient.compile (and appClient.compile, and appFactory.compile) return `compiledApproval` and `compiledClear` again
This reverted the last commit after a reflection that the more explicit naming was actually confusing since it meant
the return of this method different from the return from create/update calls and consistency was better. The fact there is now jsdoc
comments means that the property names from the compile method are able to be quickly understood.
  • Loading branch information
robdmoore authored Oct 5, 2024
1 parent ced7cb8 commit 9c3897e
Show file tree
Hide file tree
Showing 29 changed files with 620 additions and 401 deletions.
190 changes: 123 additions & 67 deletions docs/code/classes/types_app_client.AppClient.md

Large diffs are not rendered by default.

80 changes: 40 additions & 40 deletions docs/code/classes/types_app_client.ApplicationClient.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ Create a new ApplicationClient instance

#### 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:1506](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1506)

## Properties

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

#### Defined in

[src/types/app-client.ts:1467](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1467)
[src/types/app-client.ts:1489](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1489)

___

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

#### 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:1488](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1488)

___

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

#### Defined in

[src/types/app-client.ts:1469](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1469)
[src/types/app-client.ts:1491](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1491)

___

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

#### Defined in

[src/types/app-client.ts:1471](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1471)
[src/types/app-client.ts:1493](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1493)

___

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

#### Defined in

[src/types/app-client.ts:1472](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1472)
[src/types/app-client.ts:1494](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1494)

___

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

#### Defined in

[src/types/app-client.ts:1468](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1468)
[src/types/app-client.ts:1490](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1490)

___

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

#### Defined in

[src/types/app-client.ts:1458](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1458)
[src/types/app-client.ts:1480](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1480)

___

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

#### Defined in

[src/types/app-client.ts:1460](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1460)
[src/types/app-client.ts:1482](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1482)

___

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

#### Defined in

[src/types/app-client.ts:1464](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1464)
[src/types/app-client.ts:1486](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1486)

___

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

#### Defined in

[src/types/app-client.ts:1463](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1463)
[src/types/app-client.ts:1485](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1485)

___

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

#### Defined in

[src/types/app-client.ts:1459](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1459)
[src/types/app-client.ts:1481](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1481)

___

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

#### Defined in

[src/types/app-client.ts:1462](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1462)
[src/types/app-client.ts:1484](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1484)

___

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

#### Defined in

[src/types/app-client.ts:1461](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1461)
[src/types/app-client.ts:1483](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1483)

## Methods

Expand Down Expand Up @@ -250,7 +250,7 @@ Issues a no_op (normal) call to the app.

#### Defined in

[src/types/app-client.ts:1809](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1809)
[src/types/app-client.ts:1831](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1831)

___

Expand Down Expand Up @@ -279,7 +279,7 @@ Issues a call to the app with the given call type.

#### Defined in

[src/types/app-client.ts:1892](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1892)
[src/types/app-client.ts:1914](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1914)

___

Expand Down Expand Up @@ -307,7 +307,7 @@ Issues a clear_state call to the app.

#### Defined in

[src/types/app-client.ts:1869](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1869)
[src/types/app-client.ts:1891](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1891)

___

Expand Down Expand Up @@ -335,7 +335,7 @@ Issues a close_out call to the app.

#### Defined in

[src/types/app-client.ts:1858](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1858)
[src/types/app-client.ts:1880](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1880)

___

Expand Down Expand Up @@ -363,7 +363,7 @@ Compiles the approval and clear state programs and sets up the source map.

#### Defined in

[src/types/app-client.ts:1523](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1523)
[src/types/app-client.ts:1545](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1545)

___

Expand Down Expand Up @@ -391,7 +391,7 @@ Creates a smart contract app, returns the details of the created app.

#### Defined in

[src/types/app-client.ts:1703](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1703)
[src/types/app-client.ts:1725](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1725)

___

Expand Down Expand Up @@ -419,7 +419,7 @@ Issues a delete_application call to the app.

#### Defined in

[src/types/app-client.ts:1880](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1880)
[src/types/app-client.ts:1902](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1902)

___

Expand Down Expand Up @@ -453,7 +453,7 @@ To understand the architecture decisions behind this functionality please see ht

#### Defined in

[src/types/app-client.ts:1591](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1591)
[src/types/app-client.ts:1613](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1613)

___

Expand All @@ -471,7 +471,7 @@ The source maps

#### Defined in

[src/types/app-client.ts:1556](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1556)
[src/types/app-client.ts:1578](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1578)

___

Expand All @@ -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:2216](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2216)
[src/types/app-client.ts:2238](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2238)

___

Expand All @@ -522,7 +522,7 @@ The result of the funding

#### Defined in

[src/types/app-client.ts:1932](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1932)
[src/types/app-client.ts:1954](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1954)

___

Expand All @@ -546,7 +546,7 @@ The ABI method for the given method

#### Defined in

[src/types/app-client.ts:2173](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2173)
[src/types/app-client.ts:2195](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2195)

___

Expand Down Expand Up @@ -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:2151](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2151)
[src/types/app-client.ts:2173](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2173)

___

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

#### Defined in

[src/types/app-client.ts:2233](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2233)
[src/types/app-client.ts:2255](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2255)

___

Expand All @@ -617,7 +617,7 @@ Gets the reference information for the current application instance.

#### Defined in

[src/types/app-client.ts:2185](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2185)
[src/types/app-client.ts:2207](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2207)

___

Expand All @@ -635,7 +635,7 @@ The names of the boxes

#### Defined in

[src/types/app-client.ts:1988](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1988)
[src/types/app-client.ts:2010](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2010)

___

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

#### Defined in

[src/types/app-client.ts:2003](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2003)
[src/types/app-client.ts:2025](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2025)

___

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

#### Defined in

[src/types/app-client.ts:2019](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2019)
[src/types/app-client.ts:2041](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2041)

___

Expand All @@ -709,7 +709,7 @@ The (name, value) pair of the boxes with values as raw byte arrays

#### Defined in

[src/types/app-client.ts:2035](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2035)
[src/types/app-client.ts:2057](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2057)

___

Expand All @@ -735,7 +735,7 @@ The (name, value) pair of the boxes with values as the ABI Value

#### Defined in

[src/types/app-client.ts:2057](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2057)
[src/types/app-client.ts:2079](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2079)

___

Expand Down Expand Up @@ -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:2081](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2081)
[src/types/app-client.ts:2103](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2103)

___

Expand All @@ -782,7 +782,7 @@ The global state

#### Defined in

[src/types/app-client.ts:1960](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1960)
[src/types/app-client.ts:1982](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1982)

___

Expand All @@ -806,7 +806,7 @@ The global state

#### 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:1996](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1996)

___

Expand All @@ -828,7 +828,7 @@ Import source maps for the app.

#### Defined in

[src/types/app-client.ts:1573](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1573)
[src/types/app-client.ts:1595](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1595)

___

Expand Down Expand Up @@ -856,7 +856,7 @@ Issues a opt_in call to the app.

#### Defined in

[src/types/app-client.ts:1847](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1847)
[src/types/app-client.ts:1869](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1869)

___

Expand Down Expand Up @@ -884,4 +884,4 @@ Updates the smart contract app.

#### Defined in

[src/types/app-client.ts:1768](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1768)
[src/types/app-client.ts:1790](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1790)
Loading

0 comments on commit 9c3897e

Please sign in to comment.