Options
All
  • Public
  • Public/Protected
  • All
Menu

Entire config for an indexer app built using Dappetizer with standard Dappetizer DbContext. It corresponds to the value exported from a config file, see candidateConfigFileNames.

Compared to DappetizerConfig, it adds database property which specifies TypeORM connection.

example

Sample dappetizer.config.ts file with only mandatory values specified:

import { DappetizerConfigUsingDb } from '@tezos-dappetizer/database';

const config: DappetizerConfigUsingDb = {
modules: [
{
id: 'your-node-module-or-relative-path',
config: 'module-config',
},
],
networks: {
mainnet: {
indexing: {
fromBlockLevel: 1796556,
},
tezosNode: {
url: 'https://mainnet-tezos.giganode.io',
},
},
testnet: {
indexing: {
fromBlockLevel: 856123,
},
tezosNode: {
url: 'https://testnet-tezos.giganode.io',
},
},
},
database: {
type: 'sqlite',
database: 'data/db.sqlite',
},
};

export default config;

Hierarchy

Index

Properties

database: ConnectionOptions

Configures database connection.

limits

Regular TypeORM connection.

example

Sample value if you want to use SQLite:

{
type: 'sqlite',
database: 'data/db.sqlite',
}
example

Sample value if you want to use PostgreSQL:

{
type: 'postgres',
host: 'localhost',
port: 5432,
username: 'postgres',
password: 'postgrespassword',
database: 'postgres',
schema: 'indexer',
}

Configures Hasura for the indexer app.

Configures HTTP server of this indexer app mainly for monitoring.

Configures connections to IPFS for metadata retrieval.

Configures logging of app execution.

modules: NonEmptyArray<{ config?: unknown; id: string }>

The non-empty array of IndexerModule to be executed for indexing.

networks: {}

The indexing config specific for particular Tezos networks e.g. mainnet.

Type declaration

Configures generic time related features.

Generated using TypeDoc