Packages

abstract class AppConfig extends StartStopAsync[Unit] with BitcoinSLogger

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

See also

configuration.md for more information.

Linear Supertypes
BitcoinSLogger, StartStopAsync[Unit], StartStop[Future[Unit]], AnyRef, Any
Known Subclasses
ChainAppConfig, DbAppConfig, DLCNodeAppConfig, DLCOracleAppConfig, DLCAppConfig, KeyManagerAppConfig, NodeAppConfig, BitcoindRpcAppConfig, TestAppConfig, TorAppConfig, WalletAppConfig
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AppConfig
  2. BitcoinSLogger
  3. StartStopAsync
  4. StartStop
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new AppConfig()

Type Members

  1. abstract type ConfigType <: AppConfig

    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[bitcoins]

Abstract Value Members

  1. abstract def baseDatadir: Path

    The base data directory.

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

    Attributes
    protected[bitcoins]
  2. abstract def configOverrides: Vector[Config]

    List of user-provided configs that should override defaults

    List of user-provided configs that should override defaults

    Attributes
    protected[bitcoins]
  3. abstract def newConfigOfType(configOverrides: Vector[Config]): ConfigType

    Constructor to make a new instance of this config type

    Constructor to make a new instance of this config type

    Attributes
    protected[bitcoins]
  4. abstract def stop(): Future[Unit]
    Definition Classes
    StartStop

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. lazy val chain: BitcoinChainParams

    Chain parameters for the blockchain we're on

  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  7. lazy val config: Config
    Attributes
    protected
  8. def configFileName: String
  9. lazy val datadir: Path

    The network specific data directory.

  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  12. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. def getConfigString(path: String): String
  15. def getConfigStringOpt(path: String): Option[String]
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. def logger: Logger
    Definition Classes
    BitcoinSLogger
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. lazy val network: BitcoinNetwork

    The blockchain network we're on

  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. def start(): Future[Unit]

    Starts this project.

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

    Starting may include creating database tables, making directories or files needed later or something else entirely.

    Definition Classes
    AppConfig → StartStop
  24. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  25. def toString(): String
    Definition Classes
    AnyRef → Any
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  29. def withOverrides(configOverrides: Vector[Config]): ConfigType

    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.

  30. def withOverrides(configOverrides: Config): ConfigType

Inherited from BitcoinSLogger

Inherited from StartStopAsync[Unit]

Inherited from StartStop[Future[Unit]]

Inherited from AnyRef

Inherited from Any

Ungrouped