Packages

case class WalletAppConfig(directory: Path, conf: Config*)(implicit ec: ExecutionContext) extends DbAppConfig with WalletDbManagement with JdbcProfileComponent[WalletAppConfig] with Product with Serializable

Configuration for the Bitcoin-S wallet

directory

The data directory of the wallet

conf

Optional sequence of configuration overrides

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WalletAppConfig
  2. Serializable
  3. Product
  4. Equals
  5. JdbcProfileComponent
  6. WalletDbManagement
  7. DbManagement
  8. DbAppConfig
  9. AppConfig
  10. Logging
  11. StartStopAsync
  12. StartStop
  13. AnyRef
  14. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new WalletAppConfig(directory: Path, conf: Config*)(implicit ec: ExecutionContext)

    directory

    The data directory of the wallet

    conf

    Optional sequence of configuration overrides

Type Members

  1. type ConfigType = WalletAppConfig

    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]
    Definition Classes
    WalletAppConfigAppConfig

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. def addCallbacks(newCallbacks: WalletCallbacks): WalletCallbacks
  5. lazy val addressGapLimit: Int
  6. def addressQueueSize: Int

    How much elements we can have in org.bitcoins.wallet.internal.AddressHandling.addressRequestQueue before we throw an exception

  7. def addressQueueTimeout: Duration

    How long we wait while generating an address in org.bitcoins.wallet.internal.AddressHandling.addressRequestQueue before we timeout

  8. lazy val aesPasswordOpt: Option[AesPassword]
  9. lazy val allTables: List[slick.jdbc.JdbcProfile.API.TableQuery[slick.jdbc.JdbcProfile.API.Table[_]]]
    Definition Classes
    WalletDbManagementDbManagement
  10. def appConfig: WalletAppConfig
  11. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  12. def baseDatadir: Path

    The base data directory.

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

    Attributes
    protected[bitcoins]
    Definition Classes
    WalletAppConfigAppConfig
  13. lazy val bip39PasswordOpt: Option[String]
  14. lazy val bloomFalsePositiveRate: Double
  15. lazy val chain: BitcoinChainParams

    Chain parameters for the blockchain we're on

    Chain parameters for the blockchain we're on

    Definition Classes
    AppConfig
  16. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  17. lazy val config: Config
    Attributes
    protected
    Definition Classes
    AppConfig
  18. def configOverrides: List[Config]

    List of user-provided configs that should override defaults

    List of user-provided configs that should override defaults

    Attributes
    protected[bitcoins]
    Definition Classes
    WalletAppConfigAppConfig
  19. def createHDWallet(nodeApi: NodeApi, chainQueryApi: ChainQueryApi, feeRateApi: FeeRateApi)(implicit ec: ExecutionContext): Future[Wallet]

    Creates a wallet based on this WalletAppConfig

  20. def createSchema(createIfNotExists: Boolean = true)(implicit ec: ExecutionContext): Future[Unit]
    Definition Classes
    DbManagement
  21. def createTable(table: slick.jdbc.JdbcProfile.API.TableQuery[_ <: slick.jdbc.JdbcProfile.API.Table[_]], createIfNotExists: Boolean = true)(implicit ec: ExecutionContext): Future[Unit]

    Creates the given table

    Creates the given table

    Definition Classes
    DbManagement
  22. lazy val database: slick.jdbc.JdbcProfile.API.Database

    The database we are connecting to

    The database we are connecting to

    Definition Classes
    JdbcProfileComponent
  23. lazy val datadir: Path

    The network specific data directory.

    The network specific data directory.

    Definition Classes
    AppConfig
  24. lazy val dbConfig: DatabaseConfig[JdbcProfile]

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

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

    Definition Classes
    JdbcProfileComponent
  25. lazy val dbHost: String

    The host of our postgresql database

    The host of our postgresql database

    Definition Classes
    DbAppConfig
  26. lazy val dbName: String

    The name of our database

    The name of our database

    Definition Classes
    DbAppConfig
  27. lazy val dbPath: Path

    The path where our DB is located

    The path where our DB is located

    Definition Classes
    WalletAppConfigDbAppConfig
  28. lazy val dbPort: Int

    The port number of our postgresql database

    The port number of our postgresql database

    Definition Classes
    DbAppConfig
  29. def debug(mkr: Marker, msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  30. def debug(msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  31. def debug(msg: => Any): Unit
    Attributes
    protected
    Definition Classes
    Logging
  32. lazy val defaultAccount: HDAccount
  33. lazy val defaultAccountKind: HDPurpose
  34. lazy val defaultAddressType: AddressType
  35. lazy val discoveryBatchSize: Int
  36. lazy val driver: DatabaseDriver
    Definition Classes
    DbAppConfig
  37. def dropAll()(implicit ec: ExecutionContext): Future[Unit]
    Definition Classes
    DbManagement
  38. def dropTable(tableName: String)(implicit ec: ExecutionContext): Future[Int]
    Definition Classes
    DbManagement
  39. def dropTable(table: slick.jdbc.JdbcProfile.API.TableQuery[slick.jdbc.JdbcProfile.API.Table[_]]): Future[Unit]
    Definition Classes
    DbManagement
  40. implicit val ec: ExecutionContext
    Definition Classes
    WalletAppConfigWalletDbManagement
  41. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  42. def error(mkr: Marker, msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  43. def error(msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  44. def error(msg: => Any): Unit
    Attributes
    protected
    Definition Classes
    Logging
  45. lazy val feeProviderNameOpt: Option[String]
  46. lazy val feeProviderTargetOpt: Option[Int]
  47. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  48. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  49. def getConfigString(path: String): String
    Definition Classes
    AppConfig
  50. def getConfigStringOpt(path: String): Option[String]
    Definition Classes
    AppConfig
  51. def hasWallet()(implicit walletConf: WalletAppConfig, ec: ExecutionContext): Future[Boolean]

    Checks if the following exist

    Checks if the following exist

    1. A seed exists 2. wallet exists 3. The account exists
  52. lazy val hikariLoggingInterval: Option[Duration]

    Gets how often we should log hikari connection pool stats if None, this means isHikariLoggingEnabled is not enabled

    Gets how often we should log hikari connection pool stats if None, this means isHikariLoggingEnabled is not enabled

    Definition Classes
    DbAppConfig
  53. def info(): MigrationInfoService

    Returns flyway information about the state of migrations

    Returns flyway information about the state of migrations

    Definition Classes
    DbManagement
    See also

    https://flywaydb.org/documentation/command/info

  54. def info(mkr: Marker, msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  55. def info(msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  56. def info(msg: => Any): Unit
    Attributes
    protected
    Definition Classes
    Logging
  57. def isDebugEnabled: Boolean
    Attributes
    protected
    Definition Classes
    Logging
  58. def isErrorEnabled: Boolean
    Attributes
    protected
    Definition Classes
    Logging
  59. lazy val isHikariLoggingEnabled: Boolean
    Definition Classes
    DbAppConfig
  60. def isInfoEnabled: Boolean
    Attributes
    protected
    Definition Classes
    Logging
  61. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  62. def isTraceEnabled: Boolean
    Attributes
    protected
    Definition Classes
    Logging
  63. def isWarnEnabled: Boolean
    Attributes
    protected
    Definition Classes
    Logging
  64. lazy val jdbcUrl: String
    Definition Classes
    DbAppConfig
  65. lazy val kmConf: KeyManagerAppConfig
  66. def kmParams: KeyManagerParams
  67. def logger: Logger
    Attributes
    protected
    Definition Classes
    Logging
  68. def loggerName: String
    Attributes
    protected
    Definition Classes
    Logging
  69. def migrate(): Int

    Executes migrations related to this database

    Executes migrations related to this database

    Definition Classes
    DbManagement
    See also

    https://flywaydb.org/documentation/api/#programmatic-configuration-java

  70. def migrationsApplied(): Int
    Definition Classes
    DbManagement
  71. def moduleName: String

    Name of the module.

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

    Attributes
    protected[bitcoins]
    Definition Classes
    WalletAppConfigAppConfig
  72. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  73. lazy val network: BitcoinNetwork

    The blockchain network we're on

    The blockchain network we're on

    Definition Classes
    AppConfig
  74. def newConfigOfType(configs: Seq[Config]): WalletAppConfig

    Constructor to make a new instance of this config type

    Constructor to make a new instance of this config type

    Attributes
    protected[bitcoins]
    Definition Classes
    WalletAppConfigAppConfig
  75. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  76. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  77. lazy val numThreads: Int
    Definition Classes
    JdbcProfileComponent
  78. lazy val password: String
    Definition Classes
    JdbcProfileComponent
  79. def productElementNames: Iterator[String]
    Definition Classes
    Product
  80. lazy val profile: JdbcProfile
    Definition Classes
    JdbcProfileComponent
  81. lazy val rebroadcastFrequency: Duration
  82. lazy val requiredConfirmations: Int
  83. lazy val schemaName: Option[String]
    Definition Classes
    WalletAppConfigDbAppConfig
  84. def seedExists(): Boolean

    Checks if our wallet as a mnemonic seed associated with it

  85. lazy val slickDbConfig: DatabaseConfig[JdbcProfile]
    Definition Classes
    DbAppConfig
  86. 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
    WalletAppConfigAppConfigStartStop
  87. def startHikariLogger(interval: Duration): HikariLogging

    Starts the background logger for hikari

    Starts the background logger for hikari

    interval

    - how often hikari logs database connection pool information

    Attributes
    protected
    Definition Classes
    JdbcProfileComponent
  88. def startRebroadcastTxsScheduler(wallet: Wallet): Unit

    Starts the wallet's rebroadcast transaction scheduler

  89. def stop(): Future[Unit]

    Releases the thread pool associated with this AppConfig's DB

    Releases the thread pool associated with this AppConfig's DB

    Definition Classes
    WalletAppConfigDbAppConfigStartStop
  90. def stopHikariLogger(): Unit
    Attributes
    protected
    Definition Classes
    JdbcProfileComponent
  91. def stopRebroadcastTxsScheduler(): Unit

    Kills the wallet's rebroadcast transaction scheduler

  92. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  93. implicit def tableQueryToWithSchema(tableQuery: slick.jdbc.JdbcProfile.API.TableQuery[_]): slick.jdbc.JdbcProfile.API.TableQuery[slick.jdbc.JdbcProfile.API.Table[_]]

    Internally, slick defines the schema member as

    Internally, slick defines the schema member as

    def schema: SchemaDescription = buildTableSchemaDescription(q.shaped.value.asInstanceOf[Table[_]])

    we need to cast between TableQuery's of specific table types to the more generic TableQuery[Table[_]] to get methods in this trait working as they require schema (which essentially does this cast anyway)

    This cast is needed because TableQuery is not covariant in its type parameter. However, since Query is covariant in its first type parameter, I believe the cast from TableQuery[T1] to TableQuery[T2] will always be safe so long as T1 is a subtype of T2 AND T1#TableElementType is equal to T2#TableElementType.

    The above conditions are always the case when this is called in the current code base and will stay that way so long as no one tries anything too fancy.

    Attributes
    protected
    Definition Classes
    DbManagement
  94. def trace(mkr: Marker, msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  95. def trace(msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  96. def trace(msg: => Any): Unit
    Attributes
    protected
    Definition Classes
    Logging
  97. lazy val username: String
    Definition Classes
    JdbcProfileComponent
  98. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  99. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  100. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  101. def walletCallbacks: WalletCallbacks
  102. lazy val walletNameOpt: Option[String]
  103. def warn(mkr: Marker, msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  104. def warn(msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  105. def warn(msg: => Any): Unit
    Attributes
    protected
    Definition Classes
    Logging
  106. def withOverrides(config: Config, configs: 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

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from WalletDbManagement

Inherited from DbManagement

Inherited from DbAppConfig

Inherited from AppConfig

Inherited from Logging

Inherited from StartStopAsync[Unit]

Inherited from StartStop[Future[Unit]]

Inherited from AnyRef

Inherited from Any

Ungrouped