Class/Object

org.bitcoins.db

AppConfig

Related Docs: object AppConfig | package db

Permalink

abstract class AppConfig extends BitcoinSLogger

Everything needed to configure functionality of bitcoin-s applications is found in here.

See also

configuration.md for more information.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AppConfig
  2. BitcoinSLogger
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new AppConfig()

    Permalink

Type Members

  1. abstract type ConfigType <: AppConfig

    Permalink

    Sub members of AppConfig should override this type with the type of themselves, ensuring withOverrides return the correct type

    Sub members of AppConfig should override this type with the type of themselves, ensuring withOverrides return the correct type

    Attributes
    protected[org.bitcoins]

Abstract Value Members

  1. abstract def baseDatadir: Path

    Permalink

    The base data directory.

    The base data directory. This is where we look for a configuration file

    Attributes
    protected[org.bitcoins]
  2. abstract def initialize()(implicit ec: ExecutionContext): Future[Unit]

    Permalink

    Initializes this project.

    Initializes this project. After this future resolves, all operations should be able to be performed correctly.

    Initializing may include creating database tables, making directories or files needed latern or something else entirely.

  3. abstract def moduleName: String

    Permalink

    Name of the module.

    Name of the module. chain, wallet, node etc.

    Attributes
    protected[org.bitcoins]
  4. abstract def newConfigOfType(configOverrides: Seq[Config]): ConfigType

    Permalink

    Constructor to make a new instance of this config type

    Constructor to make a new instance of this config type

    Attributes
    protected[org.bitcoins]

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. lazy val chain: ChainParams

    Permalink

    Chain parameters for the blockchain we're on

  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. def configOverrides: List[Config]

    Permalink

    List of user-provided configs that should override defaults

    List of user-provided configs that should override defaults

    Attributes
    protected[org.bitcoins]
  8. lazy val database: slick.jdbc.JdbcProfile.API.Database

    Permalink

    The database we are connecting to

  9. lazy val databaseLogLevel: Level

    Permalink

    Logging level for database interactions

  10. val datadir: Path

    Permalink

    The network specific data directory.

  11. lazy val dbConfig: DatabaseConfig[SQLiteProfile]

    Permalink

    The configuration details for connecting/using the database for our projects that require datbase connections

  12. lazy val dbName: String

    Permalink

    The name of our database

  13. lazy val dbPath: Path

    Permalink

    The path where our DB is located

  14. lazy val disableConsoleLogging: Boolean

    Permalink

    Whether or not we should log to stdout

  15. lazy val disableFileLogging: Boolean

    Permalink

    Whether or not we should log to file

  16. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  17. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  18. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  20. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  21. lazy val httpLogLevel: Level

    Permalink

    Logging level for HTTP RPC server

  22. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  23. lazy val jdbcUrl: String

    Permalink
  24. lazy val keyHandlingLogLevel: Level

    Permalink

    The logging level for our key handling logger

  25. lazy val logLevel: Level

    Permalink

    The default logging level

  26. lazy val logger: Logger

    Permalink
    Definition Classes
    BitcoinSLogger
  27. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  28. lazy val network: NetworkParameters

    Permalink

    The blockchain network we're on

  29. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  30. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  31. lazy val p2pLogLevel: Level

    Permalink

    The logging level for our P2P logger

  32. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  33. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  34. lazy val verificationLogLevel: Level

    Permalink

    The logging level for our chain verification logger

  35. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. lazy val walletLogLeveL: Level

    Permalink

    Logging level for wallet

  39. def withOverrides(config: Config, configs: Config*): ConfigType

    Permalink

    This method returns a new AppConfig, where every key under bitcoin-s overrides the configuration picked up by other means (the reference.conf provided by bitcoin-s and the application.conf provided by the user).

    This method returns a new AppConfig, where every key under bitcoin-s overrides the configuration picked up by other means (the reference.conf provided by bitcoin-s and the application.conf provided by the user). If you pass in configs with overlapping keys (e.g. several configs with the key bitcoin-s.network), the latter config overrides the first.

Inherited from BitcoinSLogger

Inherited from AnyRef

Inherited from Any

Ungrouped