DappConfig | @dhealthdapps/backend

label: COMMON
interface: DappConfig
description: The dApp configuration object. This configuration object is used to determine general settings of this dApp runtime including its' name, its main public key or scopes that are enabled for the dApp in the backend runtime.

This interface is mainly used internally to restrict the configuration values provided to some modules or services and methods.
link: DappConfig
since: v0.1.0

Hierarchy

DappConfig

Index

Properties

backendApp

A Backend-end App configuration object. This property is mainly used to configure the generation OpenAPI specification.

example: { url: "http://a.b.c:1234", host: "a.b.c", port: 1234, https: false}
access: public
var: {AppConnectionPayload}

dappName

dappName: string

A public name for the dApp. This name is used across module implementations to describe the currently configured dApp.

example: "ELEVATE"
access: public
var: {string}

dappPublicKey

dappPublicKey: string

A public key that identifies the dApp's main account. This account may be used in scoped modules. It is recommended that a dApp's public key refers to an account that is not used in modules for doing payouts, etc.

example: "71BC0DB348A25D163290C44EF863B031FD5251D4E3674DCE37D78FE6C5F8E0FE"
access: public
var: {string}

database

database: DatabaseConfig

A database configuration object as defined in DatabaseConfig.

Note that modifying the content of this configuration field changes the database connection and may thereby affect the data loaded by the backend runtime.

example: { host: "a.b.c", port: 1234, name: "dbname", user: "root"}
access: public
var: {DatabaseConfig}

debugMode

debugMode: boolean

A boolean flag that determines whether debug mode must be enable globally or not.

Note that by enabling debug mode globally, logs will need much more RAM during runtime.

example: true
var: {boolean}

Optional discovery

discovery?: DiscoveryConfig

A configuration object related to the discovery module as defined DiscoveryConfig.

Note that modifying the content of this configuration field may slow down the synchronization process of the backend runtime.

see: DiscoveryConfig
access: public
var: {DiscoveryConfig}

frontendApp

frontendApp: AppConnectionPayload

A Front-end App configuration object. This property is mainly used to configure the access to the backend or restrict requests that are issued to it.

example: { url: "http://a.b.c:1234", host: "a.b.c", port: 1234, https: false}
access: public
var: {AppConnectionPayload}

scopes

scopes: string[]

An array of Scope that represents the enabled scopes for the runtime. Each scope may execute several modules, services and schedulers.

A scope typically also defines routes and DTOs that are published when the scope in enabled (opt-in).

example: ["database", "discovery"]
access: public
var: {Scope[]}