Interface HasuraDappetizerConfig

Configures Hasura for the indexer app. This is used as a part of DappetizerConfigUsingDb.

Example

Sample usage (all properties specified explicitly) within dappetizer.config.ts file:

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

const config: DappetizerConfigUsingDb = {
    hasura: {
       dropExistingTracking: false,
       autotrackEntities: true,
       url: 'http://localhost:8080',
       adminSecret: 'secret',
       customMappings: [
           {
               tableName: 'current_balance',   // useful for views tracking
               graphQLTypeName: 'CurrentBalance',
               graphQLFieldName: 'currentBalance',
               columns: [
                   { columnName: 'owner_address', graphQLName: 'ownerAddress' },
                   { columnName: 'amount', graphQLName: 'amount' },
                   { columnName: 'token_id', graphQLName: 'tokenId' },
               ],
               relationships: [
                   {
                       name: 'token',
                       type: 'manyToOne',
                       columns: ['token_id'],
                       referencedTableName: 'token',
                       referencedColumns: ['id'],
                   },
               ],
           }
       ],
       autotrackedMappings: [
           {
               entityName: 'DbAction',
               graphQLTypeName: 'Action',
               graphQLFieldName: 'action',
               columns: [
                   { propertyName: 'type', graphQLName: 'actionType' },
               ],
           },
           {
               entityName: 'DbToken',
               graphQLTypeName: 'Token',
               graphQLFieldName: 'token',
           },
           {
               entityName: 'DbContract',
               graphQLTypeName: 'Contract',
               graphQLFieldName: 'contract',
               relationships: [
                   {
                       name: 'tokens',
                       type: 'oneToMany',
                       columns: ['address'],
                       referencedTableName: 'token',
                       referencedColumns: ['contract_address'],
                   },
                   {
                       name: 'contractFeatures',
                       type: 'oneToMany',
                       columns: ['address'],
                       referencedTableName: 'contract_feature',
                       referencedColumns: ['contract_address'],
                   },
               ],
           },
       ],
       selectLimit: 1000,
       allowAggregations: true,
       namingStyle: 'noTransformation',
    },
    ... // Other config parts.
};

export default config;