Skip to content

Commit

Permalink
feat: Updated to latest ARC-56 spec
Browse files Browse the repository at this point in the history
  • Loading branch information
@robdmoore
robdmoore committed Sep 27, 2024
1 parent c92a4e3 commit 8f7c52c
Show file tree
Hide file tree
Showing 32 changed files with 613 additions and 377 deletions.
2 changes: 1 addition & 1 deletion docs/code/classes/types_app_arc56.Arc56Method.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ algosdk.ABIMethod.constructor

### args

• `Readonly` **args**: \{ `defaultValue?`: `string` ; `desc?`: `string` ; `name?`: `string` ; `struct?`: `string` ; `type`: `ABIArgumentType` }[]
• `Readonly` **args**: \{ `defaultValue?`: \{ `data`: `string` \| `number` ; `source`: ``"box"`` \| ``"global"`` \| ``"local"`` \| ``"literal"`` ; `type`: `string` } ; `desc?`: `string` ; `name?`: `string` ; `struct?`: `string` ; `type`: `ABIArgumentType` }[]

#### Overrides

Expand Down
100 changes: 50 additions & 50 deletions docs/code/classes/types_app_client.AppClient.md
View file

Large diffs are not rendered by default.

80 changes: 40 additions & 40 deletions docs/code/classes/types_app_client.ApplicationClient.md
View file
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:1409](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1409)
[src/types/app-client.ts:1458](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1458)

## Properties

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

#### Defined in

[src/types/app-client.ts:1392](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1392)
[src/types/app-client.ts:1441](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1441)

___

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

#### Defined in

[src/types/app-client.ts:1391](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1391)
[src/types/app-client.ts:1440](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1440)

___

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

#### Defined in

[src/types/app-client.ts:1394](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1394)
[src/types/app-client.ts:1443](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1443)

___

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

#### Defined in

[src/types/app-client.ts:1396](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1396)
[src/types/app-client.ts:1445](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1445)

___

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

#### Defined in

[src/types/app-client.ts:1397](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1397)
[src/types/app-client.ts:1446](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1446)

___

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

#### Defined in

[src/types/app-client.ts:1393](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1393)
[src/types/app-client.ts:1442](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1442)

___

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

#### Defined in

[src/types/app-client.ts:1383](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1383)
[src/types/app-client.ts:1432](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1432)

___

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

#### Defined in

[src/types/app-client.ts:1385](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1385)
[src/types/app-client.ts:1434](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1434)

___

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

#### Defined in

[src/types/app-client.ts:1389](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1389)
[src/types/app-client.ts:1438](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1438)

___

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

#### Defined in

[src/types/app-client.ts:1388](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1388)
[src/types/app-client.ts:1437](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1437)

___

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

#### Defined in

[src/types/app-client.ts:1384](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1384)
[src/types/app-client.ts:1433](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1433)

___

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

#### Defined in

[src/types/app-client.ts:1387](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1387)
[src/types/app-client.ts:1436](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1436)

___

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

#### Defined in

[src/types/app-client.ts:1386](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1386)
[src/types/app-client.ts:1435](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1435)

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

___

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:1820](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1820)
[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 @@ -307,7 +307,7 @@ Issues a clear_state call to the app.

#### Defined in

[src/types/app-client.ts:1797](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1797)
[src/types/app-client.ts:1846](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1846)

___

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

#### Defined in

[src/types/app-client.ts:1786](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1786)
[src/types/app-client.ts:1835](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1835)

___

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

___

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

___

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

#### Defined in

[src/types/app-client.ts:1808](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1808)
[src/types/app-client.ts:1857](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1857)

___

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

___

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

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

___

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

___

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

#### Defined in

[src/types/app-client.ts:1860](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1860)
[src/types/app-client.ts:1909](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1909)

___

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

#### Defined in

[src/types/app-client.ts:2101](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2101)
[src/types/app-client.ts:2150](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2150)

___

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

___

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

#### Defined in

[src/types/app-client.ts:2161](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2161)
[src/types/app-client.ts:2210](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2210)

___

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

#### Defined in

[src/types/app-client.ts:2113](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2113)
[src/types/app-client.ts:2162](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2162)

___

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

#### Defined in

[src/types/app-client.ts:1916](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1916)
[src/types/app-client.ts:1965](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1965)

___

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

#### Defined in

[src/types/app-client.ts:1931](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1931)
[src/types/app-client.ts:1980](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1980)

___

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

#### Defined in

[src/types/app-client.ts:1947](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1947)
[src/types/app-client.ts:1996](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1996)

___

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

___

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

___

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

___

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

#### Defined in

[src/types/app-client.ts:1888](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1888)
[src/types/app-client.ts:1937](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1937)

___

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

#### Defined in

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

___

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

#### Defined in

[src/types/app-client.ts:1501](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1501)
[src/types/app-client.ts:1550](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1550)

___

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

#### Defined in

[src/types/app-client.ts:1775](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1775)
[src/types/app-client.ts:1824](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1824)

___

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

#### Defined in

[src/types/app-client.ts:1696](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1696)
[src/types/app-client.ts:1745](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1745)
Loading

0 comments on commit 8f7c52c

Please sign in to comment.