fix: local and global state delta types (#297)

* fix: local and global state delta types
algorandfoundation · Jul 12, 2024 · 8f804ad · 8f804ad
1 parent 05b8a73
commit 8f804ad
Show file tree

Hide file tree

Showing 17 changed files with 164 additions and 72 deletions.
diff --git a/docs/code/enums/types_indexer.AccountStatus.md b/docs/code/enums/types_indexer.AccountStatus.md
@@ -24,7 +24,7 @@ Indicates that the associated account is neither a delegator nor a delegate
 
 #### Defined in
 
-[src/types/indexer.ts:794](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L794)
+[src/types/indexer.ts:806](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L806)
 
 ___
 
@@ -36,7 +36,7 @@ Indicates that the associated account is delegated
 
 #### Defined in
 
-[src/types/indexer.ts:790](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L790)
+[src/types/indexer.ts:802](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L802)
 
 ___
 
@@ -48,4 +48,4 @@ Indicates that the associated account used as part of the delegation pool
 
 #### Defined in
 
-[src/types/indexer.ts:792](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L792)
+[src/types/indexer.ts:804](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L804)
diff --git a/docs/code/enums/types_indexer.ApplicationOnComplete.md b/docs/code/enums/types_indexer.ApplicationOnComplete.md
@@ -25,7 +25,7 @@ Defines the what additional actions occur with the transaction https://developer
 
 #### Defined in
 
-[src/types/indexer.ts:697](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L697)
+[src/types/indexer.ts:709](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L709)
 
 ___
 
@@ -35,7 +35,7 @@ ___
 
 #### Defined in
 
-[src/types/indexer.ts:696](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L696)
+[src/types/indexer.ts:708](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L708)
 
 ___
 
@@ -45,7 +45,7 @@ ___
 
 #### Defined in
 
-[src/types/indexer.ts:699](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L699)
+[src/types/indexer.ts:711](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L711)
 
 ___
 
@@ -55,7 +55,7 @@ ___
 
 #### Defined in
 
-[src/types/indexer.ts:694](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L694)
+[src/types/indexer.ts:706](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L706)
 
 ___
 
@@ -65,7 +65,7 @@ ___
 
 #### Defined in
 
-[src/types/indexer.ts:695](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L695)
+[src/types/indexer.ts:707](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L707)
 
 ___
 
@@ -75,4 +75,4 @@ ___
 
 #### Defined in
 
-[src/types/indexer.ts:698](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L698)
+[src/types/indexer.ts:710](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L710)
diff --git a/docs/code/enums/types_indexer.SignatureType.md b/docs/code/enums/types_indexer.SignatureType.md
@@ -24,7 +24,7 @@ Logic signature
 
 #### Defined in
 
-[src/types/indexer.ts:784](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L784)
+[src/types/indexer.ts:796](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L796)
 
 ___
 
@@ -36,7 +36,7 @@ Multisig
 
 #### Defined in
 
-[src/types/indexer.ts:782](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L782)
+[src/types/indexer.ts:794](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L794)
 
 ___
 
@@ -48,4 +48,4 @@ Normal signature
 
 #### Defined in
 
-[src/types/indexer.ts:780](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L780)
+[src/types/indexer.ts:792](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L792)
diff --git a/docs/code/interfaces/types_indexer.AccountParticipation.md b/docs/code/interfaces/types_indexer.AccountParticipation.md
@@ -29,7 +29,7 @@ AccountParticipation describes the parameters used by this account in consensus
 
 #### Defined in
 
-[src/types/indexer.ts:803](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L803)
+[src/types/indexer.ts:815](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L815)
 
 ___
 
@@ -43,7 +43,7 @@ ___
 
 #### Defined in
 
-[src/types/indexer.ts:808](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L808)
+[src/types/indexer.ts:820](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L820)
 
 ___
 
@@ -55,7 +55,7 @@ ___
 
 #### Defined in
 
-[src/types/indexer.ts:810](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L810)
+[src/types/indexer.ts:822](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L822)
 
 ___
 
@@ -67,7 +67,7 @@ ___
 
 #### Defined in
 
-[src/types/indexer.ts:812](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L812)
+[src/types/indexer.ts:824](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L824)
 
 ___
 
@@ -79,7 +79,7 @@ ___
 
 #### Defined in
 
-[src/types/indexer.ts:814](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L814)
+[src/types/indexer.ts:826](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L826)
 
 ___
 
@@ -93,4 +93,4 @@ ___
 
 #### Defined in
 
-[src/types/indexer.ts:819](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L819)
+[src/types/indexer.ts:831](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L831)
diff --git a/docs/code/interfaces/types_indexer.AccountStateDelta.md b/docs/code/interfaces/types_indexer.AccountStateDelta.md
@@ -0,0 +1,32 @@
+[@algorandfoundation/algokit-utils](../README.md) / [types/indexer](../modules/types_indexer.md) / AccountStateDelta
+
+# Interface: AccountStateDelta
+
+[types/indexer](../modules/types_indexer.md).AccountStateDelta
+
+## Table of contents
+
+### Properties
+
+- [address](types_indexer.AccountStateDelta.md#address)
+- [delta](types_indexer.AccountStateDelta.md#delta)
+
+## Properties
+
+### address
+
+• **address**: `string`
+
+#### Defined in
+
+[src/types/indexer.ts:640](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L640)
+
+___
+
+### delta
+
+• **delta**: [`StateDelta`](../modules/types_indexer.md#statedelta)
+
+#### Defined in
+
+[src/types/indexer.ts:641](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L641)
diff --git a/docs/code/interfaces/types_indexer.AppLocalState.md b/docs/code/interfaces/types_indexer.AppLocalState.md
@@ -27,7 +27,7 @@ Round when account closed out of the application.
 
 #### Defined in
 
-[src/types/indexer.ts:825](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L825)
+[src/types/indexer.ts:837](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L837)
 
 ___
 
@@ -39,7 +39,7 @@ Whether or not the application local state is currently deleted from its account
 
 #### Defined in
 
-[src/types/indexer.ts:827](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L827)
+[src/types/indexer.ts:839](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L839)
 
 ___
 
@@ -51,7 +51,7 @@ The application which this local state is for.
 
 #### Defined in
 
-[src/types/indexer.ts:829](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L829)
+[src/types/indexer.ts:841](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L841)
 
 ___
 
@@ -63,7 +63,7 @@ ___
 
 #### Defined in
 
-[src/types/indexer.ts:831](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L831)
+[src/types/indexer.ts:843](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L843)
 
 ___
 
@@ -75,7 +75,7 @@ Round when the account opted into the application.
 
 #### Defined in
 
-[src/types/indexer.ts:833](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L833)
+[src/types/indexer.ts:845](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L845)
 
 ___
 
@@ -87,4 +87,4 @@ ___
 
 #### Defined in
 
-[src/types/indexer.ts:835](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L835)
+[src/types/indexer.ts:847](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L847)
diff --git a/docs/code/interfaces/types_indexer.ApplicationParams.md b/docs/code/interfaces/types_indexer.ApplicationParams.md
@@ -34,7 +34,7 @@ Approval programs may reject the transaction.
 
 #### Defined in
 
-[src/types/indexer.ts:657](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L657)
+[src/types/indexer.ts:669](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L669)
 
 ___
 
@@ -52,7 +52,7 @@ Clear state programs cannot reject the transaction.
 
 #### Defined in
 
-[src/types/indexer.ts:667](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L667)
+[src/types/indexer.ts:679](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L679)
 
 ___
 
@@ -64,7 +64,7 @@ The address that created this application. This is the address where the paramet
 
 #### Defined in
 
-[src/types/indexer.ts:647](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L647)
+[src/types/indexer.ts:659](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L659)
 
 ___
 
@@ -76,7 +76,7 @@ ___
 
 #### Defined in
 
-[src/types/indexer.ts:669](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L669)
+[src/types/indexer.ts:681](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L681)
 
 ___
 
@@ -88,7 +88,7 @@ ___
 
 #### Defined in
 
-[src/types/indexer.ts:671](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L671)
+[src/types/indexer.ts:683](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L683)
 
 ___
 
@@ -100,7 +100,7 @@ ___
 
 #### Defined in
 
-[src/types/indexer.ts:673](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L673)
+[src/types/indexer.ts:685](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L685)
 
 ___
 
@@ -112,4 +112,4 @@ ___
 
 #### Defined in
 
-[src/types/indexer.ts:675](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L675)
+[src/types/indexer.ts:687](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L687)
diff --git a/docs/code/interfaces/types_indexer.ApplicationTransactionResult.md b/docs/code/interfaces/types_indexer.ApplicationTransactionResult.md
@@ -84,7 +84,7 @@ Omit.approval-program
 
 #### Defined in
 
-[src/types/indexer.ts:657](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L657)
+[src/types/indexer.ts:669](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L669)
 
 ___
 
@@ -106,7 +106,7 @@ Omit.clear-state-program
 
 #### Defined in
 
-[src/types/indexer.ts:667](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L667)
+[src/types/indexer.ts:679](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L679)
 
 ___
 
@@ -122,7 +122,7 @@ Omit.extra-program-pages
 
 #### Defined in
 
-[src/types/indexer.ts:669](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L669)
+[src/types/indexer.ts:681](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L681)
 
 ___
 
@@ -162,7 +162,7 @@ Omit.global-state-schema
 
 #### Defined in
 
-[src/types/indexer.ts:673](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L673)
+[src/types/indexer.ts:685](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L685)
 
 ___
 
@@ -178,7 +178,7 @@ Omit.local-state-schema
 
 #### Defined in
 
-[src/types/indexer.ts:675](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L675)
+[src/types/indexer.ts:687](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L687)
 
 ___
 

diff --git a/docs/code/interfaces/types_indexer.AssetHolding.md b/docs/code/interfaces/types_indexer.AssetHolding.md
@@ -27,7 +27,7 @@ Describes an asset held by an account. https://developer.algorand.org/docs/rest-
 
 #### Defined in
 
-[src/types/indexer.ts:843](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L843)
+[src/types/indexer.ts:855](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L855)
 
 ___
 
@@ -39,7 +39,7 @@ Asset ID of the holding.
 
 #### Defined in
 
-[src/types/indexer.ts:847](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L847)
+[src/types/indexer.ts:859](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L859)
 
 ___
 
@@ -51,7 +51,7 @@ Whether or not the asset holding is currently deleted from its account.
 
 #### Defined in
 
-[src/types/indexer.ts:849](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L849)
+[src/types/indexer.ts:861](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L861)
 
 ___
 
@@ -63,7 +63,7 @@ ___
 
 #### Defined in
 
-[src/types/indexer.ts:853](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L853)
+[src/types/indexer.ts:865](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L865)
 
 ___
 
@@ -75,7 +75,7 @@ Round during which the account opted into this asset holding.
 
 #### Defined in
 
-[src/types/indexer.ts:855](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L855)
+[src/types/indexer.ts:867](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L867)
 
 ___
 
@@ -87,4 +87,4 @@ Round during which the account opted out of this asset holding.
 
 #### Defined in
 
-[src/types/indexer.ts:857](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L857)
+[src/types/indexer.ts:869](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L869)