types/indexer
@algorandfoundation/algokit-utils / types/indexer
Table of contents
Section titled “Table of contents”Enumerations
Section titled “Enumerations”Interfaces
Section titled “Interfaces”Type Aliases
Section titled “Type Aliases”- AccountLookupResult
- AccountParticipation
- AccountResult
- AccountStateDelta
- AppLocalState
- ApplicationCreatedLookupResult
- ApplicationLookupResult
- ApplicationParams
- ApplicationResult
- ApplicationTransactionResult
- AssetBalancesLookupResult
- AssetConfigTransactionResult
- AssetFreezeTransactionResult
- AssetHolding
- AssetLookupResult
- AssetParams
- AssetResult
- AssetTransferTransactionResult
- AssetsCreatedLookupResult
- AssetsLookupResult
- EvalDelta
- EvalDeltaKeyValue
- KeyRegistrationTransactionResult
- LogicTransactionSignature
- MerkleArrayProof
- MiniAssetHolding
- MultisigTransactionSignature
- MultisigTransactionSubSignature
- PaymentTransactionResult
- StateDelta
- StateProofTransactionResult
- StateSchema
- TransactionLookupResult
- TransactionResult
- TransactionSearchResults
- TransactionSignature
Type Aliases
Section titled “Type Aliases”AccountLookupResult
Section titled “AccountLookupResult”Ƭ AccountLookupResult: indexerModels.AccountResponse
Deprecated
Use algosdk.indexerModels.AccountResponse. Indexer result for an account lookup, https://dev.algorand.co/reference/rest-apis/indexer#get-v2accountsaccount-id
Defined in
Section titled “Defined in”AccountParticipation
Section titled “AccountParticipation”Ƭ AccountParticipation: indexerModels.AccountParticipation
Deprecated
Use algosdk.indexerModels.AccountParticipation. Indexer AccountParticipation describes the parameters used by this account in consensus protocol. https://dev.algorand.co/reference/rest-apis/indexer#accountparticipation
Defined in
Section titled “Defined in”AccountResult
Section titled “AccountResult”Ƭ AccountResult: indexerModels.Account
Deprecated
Use algosdk.indexerModels.Account. Indexer Account information at a given round https://dev.algorand.co/reference/rest-apis/indexer#account
Defined in
Section titled “Defined in”AccountStateDelta
Section titled “AccountStateDelta”Ƭ AccountStateDelta: indexerModels.AccountStateDelta
Deprecated
Use algosdk.indexerModels.AccountStateDelta.
Defined in
Section titled “Defined in”AppLocalState
Section titled “AppLocalState”Ƭ AppLocalState: indexerModels.ApplicationLocalState
Deprecated
Use algosdk.indexerModels.ApplicationLocalState. Indexer Stores local state associated with an application. https://dev.algorand.co/reference/rest-apis/indexer#applicationlocalstate
Defined in
Section titled “Defined in”ApplicationCreatedLookupResult
Section titled “ApplicationCreatedLookupResult”Ƭ ApplicationCreatedLookupResult: indexerModels.ApplicationsResponse
Deprecated
Use algosdk.indexerModels.ApplicationsResponse. Indexer result for an account’s created applications, https://dev.algorand.co/reference/rest-apis/indexer#get-v2accountsaccount-idcreated-applications
Defined in
Section titled “Defined in”ApplicationLookupResult
Section titled “ApplicationLookupResult”Ƭ ApplicationLookupResult: indexerModels.ApplicationResponse
Deprecated
Use algosdk.indexerModels.ApplicationResponse. Indexer result for an application lookup, https://dev.algorand.co/reference/rest-apis/indexer#get-v2applicationsapplication-id
Defined in
Section titled “Defined in”ApplicationParams
Section titled “ApplicationParams”Ƭ ApplicationParams: indexerModels.ApplicationParams
Deprecated
Use algosdk.indexerModels.ApplicationParams. Indexer Stores the global information associated with an application https://dev.algorand.co/reference/rest-apis/indexer#applicationparams
Defined in
Section titled “Defined in”ApplicationResult
Section titled “ApplicationResult”Ƭ ApplicationResult: indexerModels.Application
Deprecated
Use algosdk.indexerModels.Application. Indexer result of looking up an application
Defined in
Section titled “Defined in”ApplicationTransactionResult
Section titled “ApplicationTransactionResult”Ƭ ApplicationTransactionResult: indexerModels.TransactionApplication
Deprecated
Use algosdk.indexerModels.TransactionApplication. Indexer Fields for an application transaction https://dev.algorand.co/reference/rest-apis/indexer#transactionapplication
Defined in
Section titled “Defined in”AssetBalancesLookupResult
Section titled “AssetBalancesLookupResult”Ƭ AssetBalancesLookupResult: indexerModels.AssetBalancesResponse
Deprecated
Use algosdk.indexerModels.AssetBalancesResponse. Indexer result for an asset’s account holdings, https://dev.algorand.co/reference/rest-apis/indexer#get-v2assetsasset-idbalances
Defined in
Section titled “Defined in”AssetConfigTransactionResult
Section titled “AssetConfigTransactionResult”Ƭ AssetConfigTransactionResult: indexerModels.TransactionAssetConfig
Deprecated
Use algosdk.indexerModels.TransactionAssetConfig. Indexer Fields for asset allocation, re-configuration, and destruction.
https://dev.algorand.co/reference/rest-apis/indexer#transactionassetconfig
A zero value for asset-id indicates asset creation. A zero value for the params indicates asset destruction.
Defined in
Section titled “Defined in”AssetFreezeTransactionResult
Section titled “AssetFreezeTransactionResult”Ƭ AssetFreezeTransactionResult: indexerModels.TransactionAssetFreeze
Deprecated
Use algosdk.indexerModels.TransactionAssetFreeze. Indexer Fields for an asset freeze transaction. https://dev.algorand.co/reference/rest-apis/indexer#transactionassetfreeze
Defined in
Section titled “Defined in”AssetHolding
Section titled “AssetHolding”Ƭ AssetHolding: indexerModels.AssetHolding
Deprecated
Use algosdk.indexerModels.AssetHolding. Indexer Describes an asset held by an account. https://dev.algorand.co/reference/rest-apis/indexer#assetholding
Defined in
Section titled “Defined in”AssetLookupResult
Section titled “AssetLookupResult”Ƭ AssetLookupResult: indexerModels.AssetResponse
Deprecated
Use algosdk.indexerModels.AssetResponse. Indexer result for an asset lookup, https://dev.algorand.co/reference/rest-apis/indexer#get-v2assetsasset-id
Defined in
Section titled “Defined in”AssetParams
Section titled “AssetParams”Ƭ AssetParams: indexerModels.AssetParams
Deprecated
Use algosdk.indexerModels.AssetParams. Indexer AssetParams specifies the parameters for an asset. https://dev.algorand.co/reference/rest-apis/indexer#assetparams
Defined in
Section titled “Defined in”AssetResult
Section titled “AssetResult”Ƭ AssetResult: indexerModels.Asset
Deprecated
Use algosdk.indexerModels.Asset. Indexer Fields to specify both the unique identifier and the parameters for an asset. https://dev.algorand.co/reference/rest-apis/indexer#asset
Defined in
Section titled “Defined in”AssetTransferTransactionResult
Section titled “AssetTransferTransactionResult”Ƭ AssetTransferTransactionResult: indexerModels.TransactionAssetTransfer
Deprecated
Use algosdk.indexerModels.TransactionAssetTransfer. Indexer Fields for an asset transfer transaction. https://dev.algorand.co/reference/rest-apis/indexer#transactionassettransfer
Defined in
Section titled “Defined in”AssetsCreatedLookupResult
Section titled “AssetsCreatedLookupResult”Ƭ AssetsCreatedLookupResult: indexerModels.AssetsResponse
Deprecated
Use algosdk.indexerModels.AssetsResponse. Indexer result for an account’s created assets, https://dev.algorand.co/reference/rest-apis/indexer#get-v2accountsaccount-idcreated-assets
Defined in
Section titled “Defined in”AssetsLookupResult
Section titled “AssetsLookupResult”Ƭ AssetsLookupResult: indexerModels.AssetHoldingsResponse
Deprecated
Use algosdk.indexerModels.AssetHoldingsResponse. Indexer result for an account’s asset holdings, https://dev.algorand.co/reference/rest-apis/indexer#get-v2accountsaccount-idassets
Defined in
Section titled “Defined in”EvalDelta
Section titled “EvalDelta”Ƭ EvalDelta: indexerModels.EvalDelta
Deprecated
Use algosdk.indexerModels.EvalDelta. Indexer Represents a TEAL value delta. https://dev.algorand.co/reference/rest-apis/indexer#evaldelta
Defined in
Section titled “Defined in”EvalDeltaKeyValue
Section titled “EvalDeltaKeyValue”Ƭ EvalDeltaKeyValue: indexerModels.EvalDeltaKeyValue
Deprecated
Use algosdk.indexerModels.EvalDeltaKeyValue.
Defined in
Section titled “Defined in”KeyRegistrationTransactionResult
Section titled “KeyRegistrationTransactionResult”Ƭ KeyRegistrationTransactionResult: indexerModels.TransactionKeyreg
Deprecated
Use algosdk.indexerModels.TransactionKeyreg. Indexer Fields for a keyreg transaction https://dev.algorand.co/reference/rest-apis/indexer#transactionkeyreg
Defined in
Section titled “Defined in”LogicTransactionSignature
Section titled “LogicTransactionSignature”Ƭ LogicTransactionSignature: indexerModels.TransactionSignatureLogicsig
Deprecated
Use algosdk.indexerModels.TransactionSignatureLogicsig. Indexer [lsig] Programatic transaction signature.
https://dev.algorand.co/reference/rest-apis/indexer#transactionsignaturelogicsig
https://dev.algorand.co/concepts/smart-contracts/logic-sigs
Defined in
Section titled “Defined in”MerkleArrayProof
Section titled “MerkleArrayProof”Ƭ MerkleArrayProof: indexerModels.MerkleArrayProof
Deprecated
Use algosdk.indexerModels.MerkleArrayProof. Indexer 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) = 4You 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/2Defined in
Section titled “Defined in”MiniAssetHolding
Section titled “MiniAssetHolding”Ƭ MiniAssetHolding: indexerModels.MiniAssetHolding
Deprecated
Use algosdk.indexerModels.MiniAssetHolding. Indexer Describes an asset holding for an account of a known asset. https://dev.algorand.co/reference/rest-apis/indexer#miniassetholding
Defined in
Section titled “Defined in”MultisigTransactionSignature
Section titled “MultisigTransactionSignature”Ƭ MultisigTransactionSignature: indexerModels.TransactionSignatureMultisig
Deprecated
Use algosdk.indexerModels.TransactionSignatureMultisig. Indexer [msig] structure holding multiple subsignatures. https://dev.algorand.co/reference/rest-apis/indexer#transactionsignaturemultisig
Defined in
Section titled “Defined in”MultisigTransactionSubSignature
Section titled “MultisigTransactionSubSignature”Ƭ MultisigTransactionSubSignature: indexerModels.TransactionSignatureMultisigSubsignature
Deprecated
Use algosdk.indexerModels.TransactionSignatureMultisigSubsignature. Indexer Sub-signature for a multisig signature https://dev.algorand.co/reference/rest-apis/indexer#transactionsignaturemultisigsubsignature
Defined in
Section titled “Defined in”PaymentTransactionResult
Section titled “PaymentTransactionResult”Ƭ PaymentTransactionResult: indexerModels.TransactionPayment
Deprecated
Use algosdk.indexerModels.TransactionPayment. Indexer Fields for a payment transaction https://dev.algorand.co/reference/rest-apis/indexer#transactionpayment
Defined in
Section titled “Defined in”StateDelta
Section titled “StateDelta”Ƭ StateDelta: EvalDeltaKeyValue[]
Deprecated
Use algosdk.indexerModels.EvalDeltaKeyValue[].
Defined in
Section titled “Defined in”StateProofTransactionResult
Section titled “StateProofTransactionResult”Ƭ StateProofTransactionResult: indexerModels.TransactionStateProof
Deprecated
Use algosdk.indexerModels.TransactionStateProof. Indexer Fields for a state proof transaction https://dev.algorand.co/reference/rest-apis/indexer#transactionstateproof.
See also https://dev.algorand.co/concepts/protocol/state-proofs/, 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://dev.algorand.co/reference/rest-apis/algod/#stateproof.
Defined in
Section titled “Defined in”StateSchema
Section titled “StateSchema”Ƭ StateSchema: indexerModels.StateSchema
Deprecated
Use algosdk.indexerModels.StateSchema. Indexer Represents a [apls] local-state or [apgs] global-state schema.
https://dev.algorand.co/reference/rest-apis/indexer#stateschema
These schemas determine how much storage may be used in a local-state or global-state for an application.
The more space used, the larger minimum balance must be maintained in the account holding the data.
Defined in
Section titled “Defined in”TransactionLookupResult
Section titled “TransactionLookupResult”Ƭ TransactionLookupResult: indexerModels.TransactionResponse
Deprecated
Use algosdk.indexerModels.TransactionResponse. Indexer result for a transaction lookup, https://dev.algorand.co/reference/rest-apis/indexer#get-v2transactionstxid
Defined in
Section titled “Defined in”TransactionResult
Section titled “TransactionResult”Ƭ TransactionResult: indexerModels.Transaction
Deprecated
Use algosdk.indexerModels.Transaction. Indexer result for a transaction, https://dev.algorand.co/reference/rest-apis/indexer#transaction
Defined in
Section titled “Defined in”TransactionSearchResults
Section titled “TransactionSearchResults”Ƭ TransactionSearchResults: indexerModels.TransactionsResponse
Deprecated
Use algosdk.indexerModels.TransactionsResponse. Indexer result for a transaction search, https://dev.algorand.co/reference/rest-apis/indexer#get-v2transactions
Defined in
Section titled “Defined in”TransactionSignature
Section titled “TransactionSignature”Ƭ TransactionSignature: indexerModels.TransactionSignature
Deprecated
Use algosdk.indexerModels.TransactionSignature. Indexer Validation signature associated with some data. Only one of the signatures should be provided. https://dev.algorand.co/reference/rest-apis/indexer#transactionsignature