Packages

case class KeyManagerAppConfig(baseDatadir: Path, configOverrides: Vector[Config], walletNameOverride: Option[ArgumentSource[String]] = None, aesPasswordOverride: Option[ArgumentSource[AesPassword]] = None, bip39PasswordOverride: Option[String] = None)(implicit ec: ExecutionContext) extends AppConfig with Product with Serializable

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. KeyManagerAppConfig
  2. Serializable
  3. Product
  4. Equals
  5. AppConfig
  6. BitcoinSLogger
  7. StartStopAsync
  8. StartStop
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new KeyManagerAppConfig(baseDatadir: Path, configOverrides: Vector[Config], walletNameOverride: Option[ArgumentSource[String]] = None, aesPasswordOverride: Option[ArgumentSource[AesPassword]] = None, bip39PasswordOverride: Option[String] = None)(implicit ec: ExecutionContext)

Type Members

  1. type ConfigType = KeyManagerAppConfig

    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

    Definition Classes
    KeyManagerAppConfigAppConfig

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. lazy val aesPasswordOpt: Option[AesPassword]
  5. val aesPasswordOverride: Option[ArgumentSource[AesPassword]]
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. val baseDatadir: Path

    The base data directory.

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

    Definition Classes
    KeyManagerAppConfigAppConfig
  8. lazy val bip39PasswordOpt: Option[String]
  9. val bip39PasswordOverride: Option[String]
  10. lazy val chain: BitcoinChainParams

    Chain parameters for the blockchain we're on

    Chain parameters for the blockchain we're on

    Definition Classes
    AppConfig
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  12. lazy val config: Config
    Attributes
    protected
    Definition Classes
    AppConfig
  13. def configFileName: String
    Definition Classes
    AppConfig
  14. val configOverrides: Vector[Config]

    List of user-provided configs that should override defaults

    List of user-provided configs that should override defaults

    Definition Classes
    KeyManagerAppConfigAppConfig
  15. def creationTime: Instant

    The creation time of the mnemonic seed If we cannot decrypt the seed because of invalid passwords, we return None

  16. lazy val datadir: Path

    The network specific data directory.

    The network specific data directory.

    Definition Classes
    AppConfig
  17. implicit val ec: ExecutionContext
  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  20. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  21. def getConfigString(path: String): String
    Definition Classes
    AppConfig
  22. def getConfigStringOpt(path: String): Option[String]
    Definition Classes
    AppConfig
  23. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  24. def logger: Logger
    Definition Classes
    BitcoinSLogger
  25. def moduleName: String

    Name of the module.

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

    Definition Classes
    KeyManagerAppConfigAppConfig
  26. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. lazy val network: BitcoinNetwork

    The blockchain network we're on

    The blockchain network we're on

    Definition Classes
    AppConfig
  28. lazy val networkParameters: NetworkParameters
  29. def newConfigOfType(configs: Vector[Config]): KeyManagerAppConfig

    Constructor to make a new instance of this config type

    Constructor to make a new instance of this config type

    Definition Classes
    KeyManagerAppConfigAppConfig
  30. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  31. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  32. def productElementNames: Iterator[String]
    Definition Classes
    Product
  33. def seedExists(): Boolean

    Checks if our key manager as a mnemonic seed associated with it

  34. lazy val seedFolder: Path
  35. lazy val seedPath: Path

    The path to our encrypted mnemonic seed

  36. 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
    KeyManagerAppConfigAppConfigStartStop
  37. def stop(): Future[Unit]
    Definition Classes
    KeyManagerAppConfigStartStop
  38. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  39. def toBip39KeyManager: BIP39KeyManager

    Creates a BIP39KeyManager from the seed referenced by this KeyManagerAppConfig with the given wallet purpose

  40. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  41. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  42. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  43. lazy val walletName: String
  44. val walletNameOverride: Option[ArgumentSource[String]]
  45. 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.

    Definition Classes
    AppConfig
  46. def withOverrides(configOverrides: Config): ConfigType
    Definition Classes
    AppConfig

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AppConfig

Inherited from BitcoinSLogger

Inherited from StartStopAsync[Unit]

Inherited from StartStop[Future[Unit]]

Inherited from AnyRef

Inherited from Any

Ungrouped