diff --git a/docs/code/enums/types_indexer.AccountStatus.md b/docs/code/enums/types_indexer.AccountStatus.md index 9f5e87b7..78298ba5 100644 --- 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:594](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L594) +[src/types/indexer.ts:774](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L774) ___ @@ -36,7 +36,7 @@ Indicates that the associated account is delegated #### Defined in -[src/types/indexer.ts:590](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L590) +[src/types/indexer.ts:770](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L770) ___ @@ -48,4 +48,4 @@ Indicates that the associated account used as part of the delegation pool #### Defined in -[src/types/indexer.ts:592](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L592) +[src/types/indexer.ts:772](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L772) diff --git a/docs/code/enums/types_indexer.ApplicationOnComplete.md b/docs/code/enums/types_indexer.ApplicationOnComplete.md index 992a5854..39313dff 100644 --- 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:497](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L497) +[src/types/indexer.ts:677](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L677) ___ @@ -35,7 +35,7 @@ ___ #### Defined in -[src/types/indexer.ts:496](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L496) +[src/types/indexer.ts:676](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L676) ___ @@ -45,7 +45,7 @@ ___ #### Defined in -[src/types/indexer.ts:499](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L499) +[src/types/indexer.ts:679](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L679) ___ @@ -55,7 +55,7 @@ ___ #### Defined in -[src/types/indexer.ts:494](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L494) +[src/types/indexer.ts:674](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L674) ___ @@ -65,7 +65,7 @@ ___ #### Defined in -[src/types/indexer.ts:495](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L495) +[src/types/indexer.ts:675](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L675) ___ @@ -75,4 +75,4 @@ ___ #### Defined in -[src/types/indexer.ts:498](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L498) +[src/types/indexer.ts:678](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L678) diff --git a/docs/code/enums/types_indexer.SignatureType.md b/docs/code/enums/types_indexer.SignatureType.md index e1b4276c..95e93392 100644 --- 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:584](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L584) +[src/types/indexer.ts:764](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L764) ___ @@ -36,7 +36,7 @@ Multisig #### Defined in -[src/types/indexer.ts:582](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L582) +[src/types/indexer.ts:762](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L762) ___ @@ -48,4 +48,4 @@ Normal signature #### Defined in -[src/types/indexer.ts:580](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L580) +[src/types/indexer.ts:760](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L760) diff --git a/docs/code/interfaces/types_indexer.AccountParticipation.md b/docs/code/interfaces/types_indexer.AccountParticipation.md index 87ac8b11..46dd58f4 100644 --- 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:603](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L603) +[src/types/indexer.ts:783](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L783) ___ @@ -43,7 +43,7 @@ ___ #### Defined in -[src/types/indexer.ts:608](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L608) +[src/types/indexer.ts:788](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L788) ___ @@ -55,7 +55,7 @@ ___ #### Defined in -[src/types/indexer.ts:610](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L610) +[src/types/indexer.ts:790](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L790) ___ @@ -67,7 +67,7 @@ ___ #### Defined in -[src/types/indexer.ts:612](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L612) +[src/types/indexer.ts:792](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L792) ___ @@ -79,7 +79,7 @@ ___ #### Defined in -[src/types/indexer.ts:614](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L614) +[src/types/indexer.ts:794](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L794) ___ @@ -93,4 +93,4 @@ ___ #### Defined in -[src/types/indexer.ts:619](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L619) +[src/types/indexer.ts:799](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L799) diff --git a/docs/code/interfaces/types_indexer.AccountResult.md b/docs/code/interfaces/types_indexer.AccountResult.md index 5e040ae2..04e79ad4 100644 --- a/docs/code/interfaces/types_indexer.AccountResult.md +++ b/docs/code/interfaces/types_indexer.AccountResult.md @@ -53,7 +53,7 @@ the account public key #### Defined in -[src/types/indexer.ts:181](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L181) +[src/types/indexer.ts:192](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L192) ___ @@ -65,7 +65,7 @@ ___ #### Defined in -[src/types/indexer.ts:183](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L183) +[src/types/indexer.ts:194](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L194) ___ @@ -77,7 +77,7 @@ specifies the amount of MicroAlgos in the account, without the pending rewards. #### Defined in -[src/types/indexer.ts:185](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L185) +[src/types/indexer.ts:196](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L196) ___ @@ -91,7 +91,7 @@ Note the raw object uses map[int] -> AppLocalState for this type. #### Defined in -[src/types/indexer.ts:190](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L190) +[src/types/indexer.ts:201](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L201) ___ @@ -103,7 +103,7 @@ ___ #### Defined in -[src/types/indexer.ts:192](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L192) +[src/types/indexer.ts:203](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L203) ___ @@ -117,7 +117,7 @@ Note: the raw account uses StateSchema for this type. #### Defined in -[src/types/indexer.ts:197](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L197) +[src/types/indexer.ts:208](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L208) ___ @@ -131,7 +131,7 @@ Note the raw object uses map[int] -> AssetHolding for this type. #### Defined in -[src/types/indexer.ts:202](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L202) +[src/types/indexer.ts:213](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L213) ___ @@ -147,7 +147,7 @@ This field can be updated in any transaction by setting the RekeyTo field. #### Defined in -[src/types/indexer.ts:209](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L209) +[src/types/indexer.ts:220](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L220) ___ @@ -159,7 +159,7 @@ Round during which this account was most recently closed. #### Defined in -[src/types/indexer.ts:211](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L211) +[src/types/indexer.ts:222](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L222) ___ @@ -173,7 +173,7 @@ Note: the raw account uses map[int] -> AppParams for this type. #### Defined in -[src/types/indexer.ts:216](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L216) +[src/types/indexer.ts:227](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L227) ___ @@ -187,7 +187,7 @@ Note: the raw account uses map[int] -> Asset for this type. #### Defined in -[src/types/indexer.ts:221](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L221) +[src/types/indexer.ts:232](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L232) ___ @@ -199,7 +199,7 @@ Round during which this account first appeared in a transaction. #### Defined in -[src/types/indexer.ts:223](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L223) +[src/types/indexer.ts:234](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L234) ___ @@ -211,7 +211,7 @@ Whether or not this account is currently closed. #### Defined in -[src/types/indexer.ts:225](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L225) +[src/types/indexer.ts:236](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L236) ___ @@ -223,7 +223,7 @@ If participating in consensus, the parameters used by this account in the consen #### Defined in -[src/types/indexer.ts:227](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L227) +[src/types/indexer.ts:238](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L238) ___ @@ -235,7 +235,7 @@ amount of MicroAlgos of pending rewards in this account. #### Defined in -[src/types/indexer.ts:229](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L229) +[src/types/indexer.ts:240](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L240) ___ @@ -247,7 +247,7 @@ ___ #### Defined in -[src/types/indexer.ts:231](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L231) +[src/types/indexer.ts:242](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L242) ___ @@ -259,7 +259,7 @@ ___ #### Defined in -[src/types/indexer.ts:233](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L233) +[src/types/indexer.ts:244](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L244) ___ @@ -271,7 +271,7 @@ The round for which this information is relevant. #### Defined in -[src/types/indexer.ts:235](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L235) +[src/types/indexer.ts:246](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L246) ___ @@ -283,7 +283,7 @@ Indicates what type of signature is used by this account #### Defined in -[src/types/indexer.ts:237](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L237) +[src/types/indexer.ts:248](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L248) ___ @@ -295,7 +295,7 @@ ___ #### Defined in -[src/types/indexer.ts:239](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L239) +[src/types/indexer.ts:250](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L250) ___ @@ -307,7 +307,7 @@ The count of all applications that have been opted in, equivalent to the count o #### Defined in -[src/types/indexer.ts:241](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L241) +[src/types/indexer.ts:252](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L252) ___ @@ -319,7 +319,7 @@ The count of all assets that have been opted in, equivalent to the count of Asse #### Defined in -[src/types/indexer.ts:243](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L243) +[src/types/indexer.ts:254](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L254) ___ @@ -331,7 +331,7 @@ For app-accounts only. The total number of bytes allocated for the keys and valu #### Defined in -[src/types/indexer.ts:245](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L245) +[src/types/indexer.ts:256](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L256) ___ @@ -343,7 +343,7 @@ For app-accounts only. The total number of boxes which belong to the associated #### Defined in -[src/types/indexer.ts:247](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L247) +[src/types/indexer.ts:258](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L258) ___ @@ -355,7 +355,7 @@ The count of all apps (AppParams objects) created by this account. #### Defined in -[src/types/indexer.ts:249](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L249) +[src/types/indexer.ts:260](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L260) ___ @@ -367,4 +367,4 @@ The count of all assets (AssetParams objects) created by this account. #### Defined in -[src/types/indexer.ts:251](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L251) +[src/types/indexer.ts:262](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L262) diff --git a/docs/code/interfaces/types_indexer.AppLocalState.md b/docs/code/interfaces/types_indexer.AppLocalState.md index 12a4f4ca..9ef2089a 100644 --- 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:625](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L625) +[src/types/indexer.ts:805](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L805) ___ @@ -39,7 +39,7 @@ Whether or not the application local state is currently deleted from its account #### Defined in -[src/types/indexer.ts:627](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L627) +[src/types/indexer.ts:807](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L807) ___ @@ -51,7 +51,7 @@ The application which this local state is for. #### Defined in -[src/types/indexer.ts:629](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L629) +[src/types/indexer.ts:809](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L809) ___ @@ -63,7 +63,7 @@ ___ #### Defined in -[src/types/indexer.ts:631](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L631) +[src/types/indexer.ts:811](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L811) ___ @@ -75,7 +75,7 @@ Round when the account opted into the application. #### Defined in -[src/types/indexer.ts:633](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L633) +[src/types/indexer.ts:813](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L813) ___ @@ -87,4 +87,4 @@ ___ #### Defined in -[src/types/indexer.ts:635](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L635) +[src/types/indexer.ts:815](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L815) diff --git a/docs/code/interfaces/types_indexer.ApplicationParams.md b/docs/code/interfaces/types_indexer.ApplicationParams.md index 72f6b09c..aac5f45a 100644 --- 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:457](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L457) +[src/types/indexer.ts:637](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L637) ___ @@ -52,7 +52,7 @@ Clear state programs cannot reject the transaction. #### Defined in -[src/types/indexer.ts:467](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L467) +[src/types/indexer.ts:647](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L647) ___ @@ -64,7 +64,7 @@ The address that created this application. This is the address where the paramet #### Defined in -[src/types/indexer.ts:447](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L447) +[src/types/indexer.ts:627](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L627) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[src/types/indexer.ts:469](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L469) +[src/types/indexer.ts:649](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L649) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[src/types/indexer.ts:471](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L471) +[src/types/indexer.ts:651](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L651) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[src/types/indexer.ts:473](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L473) +[src/types/indexer.ts:653](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L653) ___ @@ -112,4 +112,4 @@ ___ #### Defined in -[src/types/indexer.ts:475](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L475) +[src/types/indexer.ts:655](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L655) diff --git a/docs/code/interfaces/types_indexer.ApplicationResult.md b/docs/code/interfaces/types_indexer.ApplicationResult.md index d060419b..ad4f6351 100644 --- a/docs/code/interfaces/types_indexer.ApplicationResult.md +++ b/docs/code/interfaces/types_indexer.ApplicationResult.md @@ -24,7 +24,7 @@ The result of looking up an application #### Defined in -[src/types/indexer.ts:367](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L367) +[src/types/indexer.ts:547](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L547) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[src/types/indexer.ts:368](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L368) +[src/types/indexer.ts:548](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L548) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[src/types/indexer.ts:369](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L369) +[src/types/indexer.ts:549](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L549) ___ @@ -54,7 +54,7 @@ ___ #### Defined in -[src/types/indexer.ts:365](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L365) +[src/types/indexer.ts:545](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L545) ___ @@ -64,4 +64,4 @@ ___ #### Defined in -[src/types/indexer.ts:366](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L366) +[src/types/indexer.ts:546](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L546) diff --git a/docs/code/interfaces/types_indexer.ApplicationTransactionResult.md b/docs/code/interfaces/types_indexer.ApplicationTransactionResult.md index 8f62ab42..fac56cb8 100644 --- a/docs/code/interfaces/types_indexer.ApplicationTransactionResult.md +++ b/docs/code/interfaces/types_indexer.ApplicationTransactionResult.md @@ -38,7 +38,7 @@ Fields for an application transaction https://developer.algorand.org/docs/rest-a #### Defined in -[src/types/indexer.ts:269](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L269) +[src/types/indexer.ts:449](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L449) ___ @@ -50,7 +50,7 @@ ___ #### Defined in -[src/types/indexer.ts:271](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L271) +[src/types/indexer.ts:451](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L451) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[src/types/indexer.ts:273](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L273) +[src/types/indexer.ts:453](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L453) ___ @@ -84,7 +84,7 @@ Omit.approval-program #### Defined in -[src/types/indexer.ts:457](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L457) +[src/types/indexer.ts:637](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L637) ___ @@ -106,7 +106,7 @@ Omit.clear-state-program #### Defined in -[src/types/indexer.ts:467](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L467) +[src/types/indexer.ts:647](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L647) ___ @@ -122,7 +122,7 @@ Omit.extra-program-pages #### Defined in -[src/types/indexer.ts:469](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L469) +[src/types/indexer.ts:649](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L649) ___ @@ -134,7 +134,7 @@ ___ #### Defined in -[src/types/indexer.ts:275](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L275) +[src/types/indexer.ts:455](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L455) ___ @@ -146,7 +146,7 @@ ___ #### Defined in -[src/types/indexer.ts:277](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L277) +[src/types/indexer.ts:457](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L457) ___ @@ -162,7 +162,7 @@ Omit.global-state-schema #### Defined in -[src/types/indexer.ts:473](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L473) +[src/types/indexer.ts:653](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L653) ___ @@ -178,7 +178,7 @@ Omit.local-state-schema #### Defined in -[src/types/indexer.ts:475](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L475) +[src/types/indexer.ts:655](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L655) ___ @@ -190,4 +190,4 @@ ___ #### Defined in -[src/types/indexer.ts:279](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L279) +[src/types/indexer.ts:459](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L459) diff --git a/docs/code/interfaces/types_indexer.AssetConfigTransactionResult.md b/docs/code/interfaces/types_indexer.AssetConfigTransactionResult.md index 498e8751..220ba2d8 100644 --- a/docs/code/interfaces/types_indexer.AssetConfigTransactionResult.md +++ b/docs/code/interfaces/types_indexer.AssetConfigTransactionResult.md @@ -26,7 +26,7 @@ A zero value for asset-id indicates asset creation. A zero value for the params #### Defined in -[src/types/indexer.ts:289](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L289) +[src/types/indexer.ts:469](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L469) ___ @@ -38,4 +38,4 @@ ___ #### Defined in -[src/types/indexer.ts:291](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L291) +[src/types/indexer.ts:471](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L471) diff --git a/docs/code/interfaces/types_indexer.AssetFreezeTransactionResult.md b/docs/code/interfaces/types_indexer.AssetFreezeTransactionResult.md index 139cbeb8..0bb5344b 100644 --- a/docs/code/interfaces/types_indexer.AssetFreezeTransactionResult.md +++ b/docs/code/interfaces/types_indexer.AssetFreezeTransactionResult.md @@ -24,7 +24,7 @@ Fields for an asset freeze transaction. https://developer.algorand.org/docs/rest #### Defined in -[src/types/indexer.ts:297](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L297) +[src/types/indexer.ts:477](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L477) ___ @@ -36,7 +36,7 @@ ___ #### Defined in -[src/types/indexer.ts:299](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L299) +[src/types/indexer.ts:479](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L479) ___ @@ -48,4 +48,4 @@ ___ #### Defined in -[src/types/indexer.ts:301](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L301) +[src/types/indexer.ts:481](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L481) diff --git a/docs/code/interfaces/types_indexer.AssetHolding.md b/docs/code/interfaces/types_indexer.AssetHolding.md index 0b8f5d3f..15d0f05f 100644 --- 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:643](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L643) +[src/types/indexer.ts:823](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L823) ___ @@ -39,7 +39,7 @@ Asset ID of the holding. #### 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:827](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L827) ___ @@ -51,7 +51,7 @@ Whether or not the asset holding is currently deleted from its account. #### Defined in -[src/types/indexer.ts:649](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L649) +[src/types/indexer.ts:829](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L829) ___ @@ -63,7 +63,7 @@ ___ #### Defined in -[src/types/indexer.ts:653](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L653) +[src/types/indexer.ts:833](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L833) ___ @@ -75,7 +75,7 @@ Round during which the account opted into this asset holding. #### Defined in -[src/types/indexer.ts:655](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L655) +[src/types/indexer.ts:835](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L835) ___ @@ -87,4 +87,4 @@ Round during which the account opted out of this asset holding. #### 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:837](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L837) diff --git a/docs/code/interfaces/types_indexer.AssetParams.md b/docs/code/interfaces/types_indexer.AssetParams.md index d2a5c9bb..edc1ccff 100644 --- a/docs/code/interfaces/types_indexer.AssetParams.md +++ b/docs/code/interfaces/types_indexer.AssetParams.md @@ -37,7 +37,7 @@ clawback is not permitted. #### Defined in -[src/types/indexer.ts:525](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L525) +[src/types/indexer.ts:705](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L705) ___ @@ -51,7 +51,7 @@ be sent in the worst case. #### Defined in -[src/types/indexer.ts:509](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L509) +[src/types/indexer.ts:689](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L689) ___ @@ -66,7 +66,7 @@ must be between 0 and 19 (inclusive). #### Defined in -[src/types/indexer.ts:516](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L516) +[src/types/indexer.ts:696](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L696) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[src/types/indexer.ts:529](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L529) +[src/types/indexer.ts:709](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L709) ___ @@ -91,7 +91,7 @@ is not permitted. #### Defined in -[src/types/indexer.ts:534](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L534) +[src/types/indexer.ts:714](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L714) ___ @@ -103,7 +103,7 @@ ___ #### Defined in -[src/types/indexer.ts:538](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L538) +[src/types/indexer.ts:718](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L718) ___ @@ -116,7 +116,7 @@ metadata is up to the application. #### Defined in -[src/types/indexer.ts:543](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L543) +[src/types/indexer.ts:723](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L723) ___ @@ -129,7 +129,7 @@ asset name is composed of printable utf-8 characters. #### Defined in -[src/types/indexer.ts:548](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L548) +[src/types/indexer.ts:728](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L728) ___ @@ -141,7 +141,7 @@ Base64 encoded name of this asset, as supplied by the creator. #### Defined in -[src/types/indexer.ts:552](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L552) +[src/types/indexer.ts:732](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L732) ___ @@ -153,7 +153,7 @@ ___ #### Defined in -[src/types/indexer.ts:556](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L556) +[src/types/indexer.ts:736](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L736) ___ @@ -165,7 +165,7 @@ ___ #### Defined in -[src/types/indexer.ts:520](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L520) +[src/types/indexer.ts:700](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L700) ___ @@ -178,7 +178,7 @@ when the name of a unit of this asset is composed of printable utf-8 characters. #### Defined in -[src/types/indexer.ts:561](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L561) +[src/types/indexer.ts:741](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L741) ___ @@ -190,7 +190,7 @@ Base64 encoded name of a unit of this asset, as supplied by the creator. #### Defined in -[src/types/indexer.ts:565](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L565) +[src/types/indexer.ts:745](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L745) ___ @@ -203,7 +203,7 @@ when the URL is composed of printable utf-8 characters. #### Defined in -[src/types/indexer.ts:570](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L570) +[src/types/indexer.ts:750](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L750) ___ @@ -215,4 +215,4 @@ Base64 encoded URL where more information about the asset can be retrieved. #### Defined in -[src/types/indexer.ts:574](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L574) +[src/types/indexer.ts:754](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L754) diff --git a/docs/code/interfaces/types_indexer.AssetResult.md b/docs/code/interfaces/types_indexer.AssetResult.md index 92d9978f..78b9e954 100644 --- a/docs/code/interfaces/types_indexer.AssetResult.md +++ b/docs/code/interfaces/types_indexer.AssetResult.md @@ -26,7 +26,7 @@ Round during which this asset was created. #### Defined in -[src/types/indexer.ts:354](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L354) +[src/types/indexer.ts:534](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L534) ___ @@ -38,7 +38,7 @@ Whether or not this asset is currently deleted. #### Defined in -[src/types/indexer.ts:352](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L352) +[src/types/indexer.ts:532](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L532) ___ @@ -50,7 +50,7 @@ Round during which this asset was destroyed. #### Defined in -[src/types/indexer.ts:356](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L356) +[src/types/indexer.ts:536](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L536) ___ @@ -62,7 +62,7 @@ Unique asset identifier. #### Defined in -[src/types/indexer.ts:350](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L350) +[src/types/indexer.ts:530](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L530) ___ @@ -74,4 +74,4 @@ The parameters for the asset #### Defined in -[src/types/indexer.ts:358](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L358) +[src/types/indexer.ts:538](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L538) diff --git a/docs/code/interfaces/types_indexer.AssetTransferTransactionResult.md b/docs/code/interfaces/types_indexer.AssetTransferTransactionResult.md index 5a2906bc..2d2da900 100644 --- a/docs/code/interfaces/types_indexer.AssetTransferTransactionResult.md +++ b/docs/code/interfaces/types_indexer.AssetTransferTransactionResult.md @@ -27,7 +27,7 @@ Fields for an asset transfer transaction. https://developer.algorand.org/docs/re #### Defined in -[src/types/indexer.ts:307](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L307) +[src/types/indexer.ts:487](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L487) ___ @@ -39,7 +39,7 @@ ___ #### Defined in -[src/types/indexer.ts:309](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L309) +[src/types/indexer.ts:489](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L489) ___ @@ -51,7 +51,7 @@ Number of assets transfered to the close-to account as part of the transaction. #### Defined in -[src/types/indexer.ts:311](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L311) +[src/types/indexer.ts:491](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L491) ___ @@ -63,7 +63,7 @@ ___ #### Defined in -[src/types/indexer.ts:313](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L313) +[src/types/indexer.ts:493](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L493) ___ @@ -75,7 +75,7 @@ ___ #### Defined in -[src/types/indexer.ts:315](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L315) +[src/types/indexer.ts:495](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L495) ___ @@ -87,4 +87,4 @@ ___ #### Defined in -[src/types/indexer.ts:317](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L317) +[src/types/indexer.ts:497](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L497) diff --git a/docs/code/interfaces/types_indexer.EvalDelta.md b/docs/code/interfaces/types_indexer.EvalDelta.md index c9c8017f..ba30d477 100644 --- a/docs/code/interfaces/types_indexer.EvalDelta.md +++ b/docs/code/interfaces/types_indexer.EvalDelta.md @@ -24,7 +24,7 @@ Represents a TEAL value delta. https://developer.algorand.org/docs/rest-apis/ind #### Defined in -[src/types/indexer.ts:437](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L437) +[src/types/indexer.ts:617](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L617) ___ @@ -36,7 +36,7 @@ ___ #### Defined in -[src/types/indexer.ts:439](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L439) +[src/types/indexer.ts:619](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L619) ___ @@ -48,4 +48,4 @@ ___ #### Defined in -[src/types/indexer.ts:441](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L441) +[src/types/indexer.ts:621](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L621) diff --git a/docs/code/interfaces/types_indexer.KeyRegistrationTransactionResult.md b/docs/code/interfaces/types_indexer.KeyRegistrationTransactionResult.md index 3f342ea2..a7aad56d 100644 --- a/docs/code/interfaces/types_indexer.KeyRegistrationTransactionResult.md +++ b/docs/code/interfaces/types_indexer.KeyRegistrationTransactionResult.md @@ -28,7 +28,7 @@ Fields for a `keyreg` transaction https://developer.algorand.org/docs/rest-apis/ #### Defined in -[src/types/indexer.ts:323](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L323) +[src/types/indexer.ts:503](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L503) ___ @@ -42,7 +42,7 @@ ___ #### Defined in -[src/types/indexer.ts:328](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L328) +[src/types/indexer.ts:508](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L508) ___ @@ -56,7 +56,7 @@ ___ #### Defined in -[src/types/indexer.ts:333](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L333) +[src/types/indexer.ts:513](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L513) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[src/types/indexer.ts:335](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L335) +[src/types/indexer.ts:515](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L515) ___ @@ -80,7 +80,7 @@ ___ #### Defined in -[src/types/indexer.ts:337](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L337) +[src/types/indexer.ts:517](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L517) ___ @@ -92,7 +92,7 @@ ___ #### Defined in -[src/types/indexer.ts:339](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L339) +[src/types/indexer.ts:519](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L519) ___ @@ -106,4 +106,4 @@ ___ #### Defined in -[src/types/indexer.ts:344](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L344) +[src/types/indexer.ts:524](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L524) diff --git a/docs/code/interfaces/types_indexer.LogicTransactionSignature.md b/docs/code/interfaces/types_indexer.LogicTransactionSignature.md index 53bf369f..327fbf82 100644 --- a/docs/code/interfaces/types_indexer.LogicTransactionSignature.md +++ b/docs/code/interfaces/types_indexer.LogicTransactionSignature.md @@ -29,7 +29,7 @@ https://developer.algorand.org/docs/get-details/transactions/signatures/#logic-s #### Defined in -[src/types/indexer.ts:393](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L393) +[src/types/indexer.ts:573](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L573) ___ @@ -45,7 +45,7 @@ Base64 encoded TEAL program. #### Defined in -[src/types/indexer.ts:400](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L400) +[src/types/indexer.ts:580](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L580) ___ @@ -57,7 +57,7 @@ The signature of the multisig the logic signature delegating the logicsig. https #### Defined in -[src/types/indexer.ts:402](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L402) +[src/types/indexer.ts:582](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L582) ___ @@ -71,4 +71,4 @@ ___ #### Defined in -[src/types/indexer.ts:407](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L407) +[src/types/indexer.ts:587](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L587) diff --git a/docs/code/interfaces/types_indexer.MerkleArrayProof.md b/docs/code/interfaces/types_indexer.MerkleArrayProof.md new file mode 100644 index 00000000..bd13badf --- /dev/null +++ b/docs/code/interfaces/types_indexer.MerkleArrayProof.md @@ -0,0 +1,94 @@ +[@algorandfoundation/algokit-utils](../README.md) / [types/indexer](../modules/types_indexer.md) / MerkleArrayProof + +# Interface: MerkleArrayProof + +[types/indexer](../modules/types_indexer.md).MerkleArrayProof + +Merkle array Proof. + +Proof is used to convince a verifier about membership of leaves: h0,h1...hn +at indexes i0,i1...in on a tree. The verifier has a trusted value of the tree +root hash. + +Path is bounded by MaxNumLeaves since there could be multiple reveals, and +given the distribution of the elt positions and the depth of the tree, +the path length can increase up to 2^MaxTreeDepth / 2 + +Consider two different reveals for the same tree: +``` +. z5 +. z3 z4 +. y z z1 z2 +. q r s t u v w x +. a b c d e f g h i j k l m n o p +. ^ +. hints: [a, r, z, z4] +. len(hints) = 4 +``` +You need a to combine with b to get q, need r to combine with the computed q and get y, and so on. + +The worst case is this: +``` +. z5 +. z3 z4 +. y z z1 z2 +. q r s t u v w x +. a b c d e f g h i j k l m n o p +. ^ ^ ^ ^ ^ ^ ^ ^ +. +. hints: [b, d, e, g, j, l, m, o] +. len(hints) = 2^4/2 +``` + +## Table of contents + +### Properties + +- [hash-factory](types_indexer.MerkleArrayProof.md#hash-factory) +- [path](types_indexer.MerkleArrayProof.md#path) +- [tree-depth](types_indexer.MerkleArrayProof.md#tree-depth) + +## Properties + +### hash-factory + +• **hash-factory**: `Object` + +[hsh] The metadata of the hash factory that was used to hash the proofs + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `hash-type` | `number` | [t] The type of hash https://github.com/algorand/go-algorand/blob/master/crypto/hashes.go#L42 | + +#### Defined in + +[src/types/indexer.ts:431](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L431) + +___ + +### path + +• **path**: `string`[] + +[pth] Path is bounded by MaxNumLeavesOnEncodedTree since there could be multiple reveals, and +given the distribution of the elt positions and the depth of the tree, +the path length can increase up to 2^MaxEncodedTreeDepth / 2 + +#### Defined in + +[src/types/indexer.ts:439](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L439) + +___ + +### tree-depth + +• **tree-depth**: `number` + +[td] TreeDepth represents the depth of the tree that is being proven. +It is the number of edges from the root to a leaf. + +#### Defined in + +[src/types/indexer.ts:443](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L443) diff --git a/docs/code/interfaces/types_indexer.MultisigTransactionSignature.md b/docs/code/interfaces/types_indexer.MultisigTransactionSignature.md index 7bab8c39..372ab495 100644 --- a/docs/code/interfaces/types_indexer.MultisigTransactionSignature.md +++ b/docs/code/interfaces/types_indexer.MultisigTransactionSignature.md @@ -24,7 +24,7 @@ #### Defined in -[src/types/indexer.ts:413](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L413) +[src/types/indexer.ts:593](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L593) ___ @@ -36,7 +36,7 @@ ___ #### Defined in -[src/types/indexer.ts:415](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L415) +[src/types/indexer.ts:595](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L595) ___ @@ -48,4 +48,4 @@ ___ #### Defined in -[src/types/indexer.ts:417](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L417) +[src/types/indexer.ts:597](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L597) diff --git a/docs/code/interfaces/types_indexer.MultisigTransactionSubSignature.md b/docs/code/interfaces/types_indexer.MultisigTransactionSubSignature.md index 7f907ade..bc46a787 100644 --- a/docs/code/interfaces/types_indexer.MultisigTransactionSubSignature.md +++ b/docs/code/interfaces/types_indexer.MultisigTransactionSubSignature.md @@ -25,7 +25,7 @@ Sub-signature for a multisig signature https://developer.algorand.org/docs/rest- #### Defined in -[src/types/indexer.ts:426](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L426) +[src/types/indexer.ts:606](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L606) ___ @@ -39,4 +39,4 @@ ___ #### Defined in -[src/types/indexer.ts:431](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L431) +[src/types/indexer.ts:611](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L611) diff --git a/docs/code/interfaces/types_indexer.PaymentTransactionResult.md b/docs/code/interfaces/types_indexer.PaymentTransactionResult.md index 133f5652..1a6ed1a8 100644 --- a/docs/code/interfaces/types_indexer.PaymentTransactionResult.md +++ b/docs/code/interfaces/types_indexer.PaymentTransactionResult.md @@ -25,7 +25,7 @@ Fields for a payment transaction https://developer.algorand.org/docs/rest-apis/i #### Defined in -[src/types/indexer.ts:257](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L257) +[src/types/indexer.ts:268](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L268) ___ @@ -37,7 +37,7 @@ Number of MicroAlgos that were sent to the close-remainder-to address when closi #### Defined in -[src/types/indexer.ts:259](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L259) +[src/types/indexer.ts:270](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L270) ___ @@ -49,7 +49,7 @@ ___ #### Defined in -[src/types/indexer.ts:261](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L261) +[src/types/indexer.ts:272](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L272) ___ @@ -61,4 +61,4 @@ ___ #### Defined in -[src/types/indexer.ts:263](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L263) +[src/types/indexer.ts:274](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L274) diff --git a/docs/code/interfaces/types_indexer.StateProofTransactionResult.md b/docs/code/interfaces/types_indexer.StateProofTransactionResult.md new file mode 100644 index 00000000..d5a03dea --- /dev/null +++ b/docs/code/interfaces/types_indexer.StateProofTransactionResult.md @@ -0,0 +1,88 @@ +[@algorandfoundation/algokit-utils](../README.md) / [types/indexer](../modules/types_indexer.md) / StateProofTransactionResult + +# Interface: StateProofTransactionResult + +[types/indexer](../modules/types_indexer.md).StateProofTransactionResult + +Fields for a state proof transaction https://developer.algorand.org/docs/rest-apis/indexer/#transactionstateproof. + +See also https://developer.algorand.org/docs/get-details/stateproofs/, +https://developer.algorand.org/docs/get-details/stateproofs/light_client/, +https://github.com/algorand/go-algorand/blob/master/data/transactions/stateproof.go, +https://github.com/algorand/go-algorand/blob/master/crypto/stateproof/structs.go, +https://github.com/algorand/go-algorand/blob/master/data/stateproofmsg/message.go, and +https://developer.algorand.org/docs/rest-apis/algod/#stateproof. + +## Table of contents + +### Properties + +- [message](types_indexer.StateProofTransactionResult.md#message) +- [state-proof](types_indexer.StateProofTransactionResult.md#state-proof) +- [state-proof-type](types_indexer.StateProofTransactionResult.md#state-proof-type) + +## Properties + +### message + +• **message**: `Object` + +[spmsg] State proof message + +Message represents the message that the state proofs are attesting to. This message can be +used by lightweight client and gives it the ability to verify proofs on the Algorand's state. + +In addition to that proof, this message also contains fields that +are needed in order to verify the next state proofs (VotersCommitment and LnProvenWeight). + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `block-headers-commitment` | `string` | [b] BlockHeadersCommitment contains a commitment on all light block headers within a state proof interval. | +| `first-attested-round` | `number` | [f] First round the message attests to | +| `latest-attested-round` | `number` | [l] Last round the message attests to | +| `ln-proven-weight` | `number` | [P] An integer value representing the natural log of the proven weight with 16 bits of precision. This value would be used to verify the next state proof. | +| `voters-commitment` | `string` | [v] The vector commitment root of the top N accounts to sign the next StateProof. Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\\|[A-Za-z0-9+/]{3}=)?$" | + +#### Defined in + +[src/types/indexer.ts:295](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L295) + +___ + +### state-proof + +• **state-proof**: `Object` + +[sp] a proof on Algorand's state + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `part-proofs` | [`MerkleArrayProof`](types_indexer.MerkleArrayProof.md) | [P] Part proofs that make up the overall proof | +| `positions-to-reveal` | `number`[] | [pr] The positions that are revealed | +| `reveals` | \{ `participant`: \{ `verifier`: \{ `commitment`: `string` ; `key-lifetime`: `number` } ; `weight`: `number` } ; `position`: `number` ; `sig-slot`: \{ `lower-sig-weight`: `number` ; `signature`: \{ `falcon-signature`: `string` ; `merkle-array-index`: `number` ; `proof`: [`MerkleArrayProof`](types_indexer.MerkleArrayProof.md) ; `verifying-key`: `string` } } }[] | [r] Reveals is a sparse map from the position being revealed to the corresponding elements from the sigs and participants arrays. | +| `salt-version` | `number` | [v] Merkle signature salt version | +| `sig-commit` | `string` | [c] Digest of the signature commit | +| `sig-proofs` | [`MerkleArrayProof`](types_indexer.MerkleArrayProof.md) | [S] Proofs for the signature | +| `signed-weight` | `number` | [w] The combined weight of the signatures | + +#### Defined in + +[src/types/indexer.ts:310](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L310) + +___ + +### state-proof-type + +• **state-proof-type**: `number` + +[sptype] State proof type, per https://github.com/algorand/go-algorand/blob/master/protocol/stateproof.go#L24 + + * 0: StateProofBasic is our initial state proof setup. using falcon keys and subset-sum hash + +#### Defined in + +[src/types/indexer.ts:389](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L389) diff --git a/docs/code/interfaces/types_indexer.StateSchema.md b/docs/code/interfaces/types_indexer.StateSchema.md index 1bb1e95d..4c35defb 100644 --- a/docs/code/interfaces/types_indexer.StateSchema.md +++ b/docs/code/interfaces/types_indexer.StateSchema.md @@ -28,7 +28,7 @@ Maximum number of TEAL byte slices that may be stored in the key/value store. #### Defined in -[src/types/indexer.ts:487](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L487) +[src/types/indexer.ts:667](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L667) ___ @@ -40,4 +40,4 @@ Maximum number of TEAL uints that may be stored in the key/value store. #### Defined in -[src/types/indexer.ts:489](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L489) +[src/types/indexer.ts:669](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L669) diff --git a/docs/code/interfaces/types_indexer.TransactionResult.md b/docs/code/interfaces/types_indexer.TransactionResult.md index 13d34d62..a636de33 100644 --- a/docs/code/interfaces/types_indexer.TransactionResult.md +++ b/docs/code/interfaces/types_indexer.TransactionResult.md @@ -48,6 +48,7 @@ Indexer result for a transaction, https://developer.algorand.org/docs/rest-apis/ - [sender](types_indexer.TransactionResult.md#sender) - [sender-rewards](types_indexer.TransactionResult.md#sender-rewards) - [signature](types_indexer.TransactionResult.md#signature) +- [state-proof-transaction](types_indexer.TransactionResult.md#state-proof-transaction) - [tx-type](types_indexer.TransactionResult.md#tx-type) ## Properties @@ -60,7 +61,7 @@ If the transaction is an `appl` transaction this will be populated see `tx-type` #### Defined in -[src/types/indexer.ts:117](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L117) +[src/types/indexer.ts:126](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L126) ___ @@ -72,7 +73,7 @@ If the transaction is an `acfg` transaction this will be populated see `tx-type` #### Defined in -[src/types/indexer.ts:123](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L123) +[src/types/indexer.ts:132](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L132) ___ @@ -84,7 +85,7 @@ If the transaction is an `afrz` transaction this will be populated see `tx-type` #### Defined in -[src/types/indexer.ts:129](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L129) +[src/types/indexer.ts:138](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L138) ___ @@ -96,7 +97,7 @@ If the transaction is an `axfer` transaction this will be populated see `tx-type #### Defined in -[src/types/indexer.ts:131](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L131) +[src/types/indexer.ts:140](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L140) ___ @@ -109,7 +110,7 @@ The backend can use this to ensure that auth addr is equal to the accounts auth #### Defined in -[src/types/indexer.ts:139](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L139) +[src/types/indexer.ts:150](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L150) ___ @@ -121,7 +122,7 @@ ___ #### Defined in -[src/types/indexer.ts:174](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L174) +[src/types/indexer.ts:185](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L185) ___ @@ -133,7 +134,7 @@ ___ #### Defined in -[src/types/indexer.ts:141](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L141) +[src/types/indexer.ts:152](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L152) ___ @@ -145,7 +146,7 @@ Round when the transaction was confirmed. #### Defined in -[src/types/indexer.ts:93](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L93) +[src/types/indexer.ts:102](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L102) ___ @@ -158,7 +159,7 @@ specifies the application index (ID) of that application. #### Defined in -[src/types/indexer.ts:121](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L121) +[src/types/indexer.ts:130](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L130) ___ @@ -171,7 +172,7 @@ specifies the asset index (ID) of that asset. #### Defined in -[src/types/indexer.ts:127](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L127) +[src/types/indexer.ts:136](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L136) ___ @@ -183,7 +184,7 @@ ___ #### Defined in -[src/types/indexer.ts:85](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L85) +[src/types/indexer.ts:94](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L94) ___ @@ -195,7 +196,7 @@ ___ #### Defined in -[src/types/indexer.ts:89](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L89) +[src/types/indexer.ts:98](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L98) ___ @@ -209,7 +210,7 @@ ___ #### Defined in -[src/types/indexer.ts:146](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L146) +[src/types/indexer.ts:157](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L157) ___ @@ -221,7 +222,7 @@ ___ #### Defined in -[src/types/indexer.ts:148](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L148) +[src/types/indexer.ts:159](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L159) ___ @@ -233,7 +234,7 @@ ___ #### Defined in -[src/types/indexer.ts:168](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L168) +[src/types/indexer.ts:179](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L179) ___ @@ -250,7 +251,7 @@ When present indicates that this transaction is part of a transaction group #### Defined in -[src/types/indexer.ts:101](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L101) +[src/types/indexer.ts:110](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L110) ___ @@ -274,7 +275,7 @@ Inner transactions produced by application execution. #### Defined in -[src/types/indexer.ts:150](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L150) +[src/types/indexer.ts:161](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L161) ___ @@ -286,7 +287,7 @@ Offset into the round where this transaction was confirmed. #### Defined in -[src/types/indexer.ts:113](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L113) +[src/types/indexer.ts:122](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L122) ___ @@ -298,7 +299,7 @@ If the transaction is a `keyreg` transaction this will be populated see `tx-type #### Defined in -[src/types/indexer.ts:133](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L133) +[src/types/indexer.ts:142](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L142) ___ @@ -310,7 +311,7 @@ ___ #### Defined in -[src/types/indexer.ts:91](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L91) +[src/types/indexer.ts:100](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L100) ___ @@ -329,7 +330,7 @@ While this transaction possesses the lease, no other transaction specifying this #### Defined in -[src/types/indexer.ts:164](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L164) +[src/types/indexer.ts:175](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L175) ___ @@ -341,7 +342,7 @@ ___ #### Defined in -[src/types/indexer.ts:166](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L166) +[src/types/indexer.ts:177](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L177) ___ @@ -353,7 +354,7 @@ ___ #### Defined in -[src/types/indexer.ts:109](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L109) +[src/types/indexer.ts:118](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L118) ___ @@ -367,7 +368,7 @@ ___ #### Defined in -[src/types/indexer.ts:107](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L107) +[src/types/indexer.ts:116](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L116) ___ @@ -379,7 +380,7 @@ If the transaction is a `pay` transaction this will be populated see `tx-type` #### Defined in -[src/types/indexer.ts:135](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L135) +[src/types/indexer.ts:144](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L144) ___ @@ -391,7 +392,7 @@ ___ #### Defined in -[src/types/indexer.ts:170](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L170) +[src/types/indexer.ts:181](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L181) ___ @@ -404,7 +405,7 @@ this value and future signatures must be signed with the key represented by this #### Defined in -[src/types/indexer.ts:154](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L154) +[src/types/indexer.ts:165](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L165) ___ @@ -416,7 +417,7 @@ Time when the block this transaction is in was confirmed. #### Defined in -[src/types/indexer.ts:111](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L111) +[src/types/indexer.ts:120](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L120) ___ @@ -428,7 +429,7 @@ ___ #### Defined in -[src/types/indexer.ts:87](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L87) +[src/types/indexer.ts:96](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L96) ___ @@ -440,7 +441,7 @@ ___ #### Defined in -[src/types/indexer.ts:172](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L172) +[src/types/indexer.ts:183](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L183) ___ @@ -452,7 +453,19 @@ Signature of the transaction #### Defined in -[src/types/indexer.ts:115](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L115) +[src/types/indexer.ts:124](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L124) + +___ + +### state-proof-transaction + +• `Optional` **state-proof-transaction**: [`StateProofTransactionResult`](types_indexer.StateProofTransactionResult.md) + +If the transaction is a `stpf` transaction this will be populated see `tx-type` + +#### Defined in + +[src/types/indexer.ts:146](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L146) ___ @@ -461,7 +474,15 @@ ___ • **tx-type**: `TransactionType` [type] Indicates what type of transaction this is. Different types have different fields. +Valid types, and where their fields are stored: + * [pay] payment-transaction + * [keyreg] keyreg-transaction + * [acfg] asset-config-transaction + * [axfer] asset-transfer-transaction + * [afrz] asset-freeze-transaction + * [appl] application-transaction + * [stpf] state-proof-transaction #### Defined in -[src/types/indexer.ts:83](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L83) +[src/types/indexer.ts:92](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L92) diff --git a/docs/code/interfaces/types_indexer.TransactionSignature.md b/docs/code/interfaces/types_indexer.TransactionSignature.md index 2dc02772..991f80b8 100644 --- a/docs/code/interfaces/types_indexer.TransactionSignature.md +++ b/docs/code/interfaces/types_indexer.TransactionSignature.md @@ -24,7 +24,7 @@ Logicsig signature #### Defined in -[src/types/indexer.ts:375](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L375) +[src/types/indexer.ts:555](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L555) ___ @@ -36,7 +36,7 @@ Multisig signature #### Defined in -[src/types/indexer.ts:377](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L377) +[src/types/indexer.ts:557](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L557) ___ @@ -50,4 +50,4 @@ ___ #### Defined in -[src/types/indexer.ts:382](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L382) +[src/types/indexer.ts:562](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L562) diff --git a/docs/code/modules/types_indexer.md b/docs/code/modules/types_indexer.md index 531325fe..47402ef2 100644 --- a/docs/code/modules/types_indexer.md +++ b/docs/code/modules/types_indexer.md @@ -33,9 +33,11 @@ - [EvalDelta](../interfaces/types_indexer.EvalDelta.md) - [KeyRegistrationTransactionResult](../interfaces/types_indexer.KeyRegistrationTransactionResult.md) - [LogicTransactionSignature](../interfaces/types_indexer.LogicTransactionSignature.md) +- [MerkleArrayProof](../interfaces/types_indexer.MerkleArrayProof.md) - [MultisigTransactionSignature](../interfaces/types_indexer.MultisigTransactionSignature.md) - [MultisigTransactionSubSignature](../interfaces/types_indexer.MultisigTransactionSubSignature.md) - [PaymentTransactionResult](../interfaces/types_indexer.PaymentTransactionResult.md) +- [StateProofTransactionResult](../interfaces/types_indexer.StateProofTransactionResult.md) - [StateSchema](../interfaces/types_indexer.StateSchema.md) - [TransactionLookupResult](../interfaces/types_indexer.TransactionLookupResult.md) - [TransactionResult](../interfaces/types_indexer.TransactionResult.md) diff --git a/src/types/indexer.ts b/src/types/indexer.ts index 42ec8b7a..86a0bf2f 100644 --- a/src/types/indexer.ts +++ b/src/types/indexer.ts @@ -79,7 +79,16 @@ export interface ApplicationLookupResult { export interface TransactionResult extends Record { /** Transaction ID */ id: string - /** [type] Indicates what type of transaction this is. Different types have different fields. */ + /** [type] Indicates what type of transaction this is. Different types have different fields. + * Valid types, and where their fields are stored: + * * [pay] payment-transaction + * * [keyreg] keyreg-transaction + * * [acfg] asset-config-transaction + * * [axfer] asset-transfer-transaction + * * [afrz] asset-freeze-transaction + * * [appl] application-transaction + * * [stpf] state-proof-transaction + */ 'tx-type': TransactionType /** [fee] Transaction fee. */ fee: number @@ -133,6 +142,8 @@ export interface TransactionResult extends Record { 'keyreg-transaction'?: KeyRegistrationTransactionResult /** If the transaction is a `pay` transaction this will be populated see `tx-type` */ 'payment-transaction'?: PaymentTransactionResult + /** If the transaction is a `stpf` transaction this will be populated see `tx-type` */ + 'state-proof-transaction'?: StateProofTransactionResult /** [sgnr] this is included with signed transactions when the signing address does not equal the sender. * The backend can use this to ensure that auth addr is equal to the accounts auth addr. */ @@ -263,6 +274,175 @@ export interface PaymentTransactionResult { receiver: string } +/** Fields for a state proof transaction https://developer.algorand.org/docs/rest-apis/indexer/#transactionstateproof. + * + * See also https://developer.algorand.org/docs/get-details/stateproofs/, + * https://developer.algorand.org/docs/get-details/stateproofs/light_client/, + * https://github.com/algorand/go-algorand/blob/master/data/transactions/stateproof.go, + * https://github.com/algorand/go-algorand/blob/master/crypto/stateproof/structs.go, + * https://github.com/algorand/go-algorand/blob/master/data/stateproofmsg/message.go, and + * https://developer.algorand.org/docs/rest-apis/algod/#stateproof. + */ +export interface StateProofTransactionResult { + /** [spmsg] State proof message + * + * Message represents the message that the state proofs are attesting to. This message can be + * used by lightweight client and gives it the ability to verify proofs on the Algorand's state. + * + * In addition to that proof, this message also contains fields that + * are needed in order to verify the next state proofs (VotersCommitment and LnProvenWeight). + */ + message: { + /** [b] BlockHeadersCommitment contains a commitment on all light block headers within a state proof interval. */ + 'block-headers-commitment': string + /** [f] First round the message attests to */ + 'first-attested-round': number + /** [l] Last round the message attests to */ + 'latest-attested-round': number + /** [P] An integer value representing the natural log of the proven weight with 16 bits of precision. This value would be used to verify the next state proof. */ + 'ln-proven-weight': number + /** [v] The vector commitment root of the top N accounts to sign the next StateProof. + * + * Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$" */ + 'voters-commitment': string + } + /** [sp] a proof on Algorand's state */ + 'state-proof': { + /** [P] Part proofs that make up the overall proof */ + 'part-proofs': MerkleArrayProof + /** [pr] The positions that are revealed */ + 'positions-to-reveal': number[] + /** [r] Reveals is a sparse map from the position being revealed + * to the corresponding elements from the sigs and participants + * arrays. + */ + reveals: { + /** The position being revealed */ + position: number + /** [p] Participant + * + * A Participant corresponds to an account whose AccountData.Status + * is Online, and for which the expected sigRound satisfies + * AccountData.VoteFirstValid <= sigRound <= AccountData.VoteLastValid. + * + * In the Algorand ledger, it is possible for multiple accounts to have + * the same PK. Thus, the PK is not necessarily unique among Participants. + * However, each account will produce a unique Participant struct, to avoid + * potential DoS attacks where one account claims to have the same VoteID PK + * as another account. + */ + participant: { + /** [p] PK is the identifier used to verify the signature for a specific participant + * + * Verifier is used to verify a merklesignature.Signature produced by merklesignature.Secrets. + */ + verifier: { + /** [cmt] Commitment represents the root of the vector commitment tree built upon the MSS keys. */ + commitment: string + /** [lf] The lifetime of the key */ + 'key-lifetime': number + } + /** [w] Weight is AccountData.MicroAlgos. */ + weight: number + } + /** [s] A sigslotCommit is a single slot in the sigs array that forms the state proof. */ + 'sig-slot': { + /** [l] L is the total weight of signatures in lower-numbered slots. + * This is initialized once the builder has collected a sufficient + * number of signatures. + */ + 'lower-sig-weight': number + /** [s] Sig is a signature by the participant on the expected message. + * + * Signature represents a signature in the Merkle signature scheme using falcon signatures as an underlying crypto scheme. + * It consists of an ephemeral public key, a signature, a Merkle verification path and an index. + * The Merkle signature considered valid only if the Signature is verified under the ephemeral public key and + * the Merkle verification path verifies that the ephemeral public key is located at the given index of the tree + * (for the root given in the long-term public key). + * More details can be found on Algorand's spec + */ + signature: { + /** [sig] Signature in the Merkle signature scheme using falcon signatures */ + 'falcon-signature': string + /** [idx] Merkle array index */ + 'merkle-array-index': number + /** [prf] Merkle verification path */ + proof: MerkleArrayProof + /** [vkey] Falcon verifier key */ + 'verifying-key': string + } + } + }[] + /** [v] Merkle signature salt version */ + 'salt-version': number + /** [c] Digest of the signature commit */ + 'sig-commit': string + /** [S] Proofs for the signature */ + 'sig-proofs': MerkleArrayProof + /** [w] The combined weight of the signatures */ + 'signed-weight': number + } + /** [sptype] State proof type, per https://github.com/algorand/go-algorand/blob/master/protocol/stateproof.go#L24 + * + * * 0: StateProofBasic is our initial state proof setup. using falcon keys and subset-sum hash + */ + 'state-proof-type': number +} + +/** + * Merkle array Proof. + * + * Proof is used to convince a verifier about membership of leaves: h0,h1...hn + * at indexes i0,i1...in on a tree. The verifier has a trusted value of the tree + * root hash. + * + * Path is bounded by MaxNumLeaves since there could be multiple reveals, and + * given the distribution of the elt positions and the depth of the tree, + * the path length can increase up to 2^MaxTreeDepth / 2 + * + * Consider two different reveals for the same tree: + * ``` + * . z5 + * . z3 z4 + * . y z z1 z2 + * . q r s t u v w x + * . a b c d e f g h i j k l m n o p + * . ^ + * . hints: [a, r, z, z4] + * . len(hints) = 4 + * ``` + * You need a to combine with b to get q, need r to combine with the computed q and get y, and so on. + * + * The worst case is this: + * ``` + * . z5 + * . z3 z4 + * . y z z1 z2 + * . q r s t u v w x + * . a b c d e f g h i j k l m n o p + * . ^ ^ ^ ^ ^ ^ ^ ^ + * . + * . hints: [b, d, e, g, j, l, m, o] + * . len(hints) = 2^4/2 + * ``` + */ +export interface MerkleArrayProof { + /** [hsh] The metadata of the hash factory that was used to hash the proofs */ + 'hash-factory': { + /** [t] The type of hash https://github.com/algorand/go-algorand/blob/master/crypto/hashes.go#L42 */ + 'hash-type': number + } + /** [pth] Path is bounded by MaxNumLeavesOnEncodedTree since there could be multiple reveals, and + * given the distribution of the elt positions and the depth of the tree, + * the path length can increase up to 2^MaxEncodedTreeDepth / 2 + */ + path: string[] + /** [td] TreeDepth represents the depth of the tree that is being proven. + * It is the number of edges from the root to a leaf. + */ + 'tree-depth': number +} + /** Fields for an application transaction https://developer.algorand.org/docs/rest-apis/indexer/#transactionapplication */ export interface ApplicationTransactionResult extends Omit { /** [apat] List of accounts in addition to the sender that may be accessed from the application's approval-program and clear-state-program. */