Optional
blockThe size of the queue for preloading blocks from Tezos node RPC for faster indexing.
An integer with a minimum 1
.
5
Optional
contractBoost causes Dappetizer to only index blocks where the configured contracts are used.
Optional
apiThe REST API endpoint of the TzKT instance that should be used for the boost.
An absolute URL string.
'https://api.tzkt.io/'
(only for mainnet
) or undefined
(otherwise in order to avoid inconsistencies)
Optional
type?: "disabled" | "tzkt"Specifies what type of boost should be used.
'disabled'
Optional
contractThe time in milliseconds for how long Contract instances are cached. The expiration is sliding according to the last contract usage. The caching is needed because contract are downloaded from Tezos node which takes quite some time.
An integer with minimum 0
.
600_000
Optional
contractsThe selective indexing of particular smart contracts. If an non-empty array is specified, then ContractIndexer-s from all IndexerModule-s are executed only when particular contracts are encountered.
undefined
The level of Tezos block from which the indexing should start.
An integer with a minimum 0
.
Optional
headThe offset to delay HEAD block level. It is useful for Tenderbake protocols with many reorganizations on HEAD block.
An integer with a minimum 0
.
1
Optional
healthConfigures reporting of health status of the indexing.
Optional
lastThe maximum age of the last successfully indexed block when indexing is considered Healthy
.
If it gets older, then the related health check is changed to Degraded
, then Unhealthy
.
Optional
degradedThe age in milliseconds when related health check turns Degraded
.
An integer with minimum 1
.
300_000
Optional
unhealthyThe age in milliseconds when related health check turns Unhealthy
.
An integer with minimum 1
.
600_000
Optional
retryThe array which configures how many times the entire block indexing is retried when it fails. An array item is a sleep delay is milliseconds until the retry.
[100, 1_000, 5_000, 60_000]
Optional
retryIndicates if the entire block indexing should be retried indefinitely when it fails The sleep delay between retries is the last one from retryDelaysMillis or zero.
true
Optional
smartThe selective indexing of particular smart rollups. If an non-empty array is specified, then SmartRollupIndexer-s from all IndexerModule-s are executed only when particular contracts are encountered.
[]
Optional
toThe last level of Tezos block which should be indexed.
If undefined
then indexing continues with fresh new blocks from Tezos monitor.
An integer with a minimum fromBlockLevel.
undefined
Generated using TypeDoc
Configures actual indexing. This is used as a part of DappetizerConfigUsingDb.
Example
Sample usage (all properties specified explicitly) within
dappetizer.config.ts
file: