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
- Alphabetic
- By Inheritance
- KeyManagerAppConfig
- Serializable
- Product
- Equals
- AppConfig
- BitcoinSLogger
- StartStopAsync
- StartStop
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- 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
- type ConfigType = KeyManagerAppConfig
Sub members of AppConfig should override this type with the type of themselves, ensuring
withOverrides
return the correct typeSub members of AppConfig should override this type with the type of themselves, ensuring
withOverrides
return the correct type- Definition Classes
- KeyManagerAppConfig → AppConfig
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- lazy val aesPasswordOpt: Option[AesPassword]
- val aesPasswordOverride: Option[ArgumentSource[AesPassword]]
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- val baseDatadir: Path
The base data directory.
The base data directory. This is where we look for a configuration file
- Definition Classes
- KeyManagerAppConfig → AppConfig
- lazy val bip39PasswordOpt: Option[String]
- val bip39PasswordOverride: Option[String]
- lazy val chain: BitcoinChainParams
Chain parameters for the blockchain we're on
Chain parameters for the blockchain we're on
- Definition Classes
- AppConfig
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- lazy val config: Config
- Attributes
- protected
- Definition Classes
- AppConfig
- def configFileName: String
- Definition Classes
- AppConfig
- val configOverrides: Vector[Config]
List of user-provided configs that should override defaults
List of user-provided configs that should override defaults
- Definition Classes
- KeyManagerAppConfig → AppConfig
- def creationTime: Instant
The creation time of the mnemonic seed If we cannot decrypt the seed because of invalid passwords, we return None
- lazy val datadir: Path
The network specific data directory.
The network specific data directory.
- Definition Classes
- AppConfig
- lazy val defaultPurpose: HDPurpose
- implicit val ec: ExecutionContext
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def getConfigString(path: String): String
- Definition Classes
- AppConfig
- def getConfigStringOpt(path: String): Option[String]
- Definition Classes
- AppConfig
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def logger: Logger
- Definition Classes
- BitcoinSLogger
- def moduleName: String
Name of the module.
Name of the module.
chain
,wallet
,node
etc.- Definition Classes
- KeyManagerAppConfig → AppConfig
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- lazy val network: BitcoinNetwork
The blockchain network we're on
The blockchain network we're on
- Definition Classes
- AppConfig
- lazy val networkParameters: NetworkParameters
- 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
- KeyManagerAppConfig → AppConfig
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- def seedExists(): Boolean
Checks if our key manager as a mnemonic seed associated with it
- lazy val seedFolder: Path
- lazy val seedPath: Path
The path to our encrypted mnemonic seed
- 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
- KeyManagerAppConfig → AppConfig → StartStop
- def stop(): Future[Unit]
- Definition Classes
- KeyManagerAppConfig → StartStop
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toBip39KeyManager: BIP39KeyManager
Creates a BIP39KeyManager from the seed referenced by this KeyManagerAppConfig with the given wallet purpose
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- lazy val walletName: String
- val walletNameOverride: Option[ArgumentSource[String]]
- def withOverrides(configOverrides: Vector[Config]): ConfigType
This method returns a new
AppConfig
, where every key underbitcoin-s
overrides the configuration picked up by other means (thereference.conf
provided by bitcoin-s and theapplication.conf
provided by the user).This method returns a new
AppConfig
, where every key underbitcoin-s
overrides the configuration picked up by other means (thereference.conf
provided by bitcoin-s and theapplication.conf
provided by the user). If you pass in configs with overlapping keys (e.g. several configs with the keybitcoin-s.network
), the latter config overrides the first.- Definition Classes
- AppConfig
- def withOverrides(configOverrides: Config): ConfigType
- Definition Classes
- AppConfig