Packages

case class BitcoindRpcAppConfig(directory: Path, confs: Config*)(implicit system: ActorSystem) extends AppConfig with Product with Serializable

Configuration for a BitcoindRpcClient

directory

The data directory of the Bitcoin-S instance

confs

Optional sequence of configuration overrides

Linear Supertypes
Serializable, Product, Equals, AppConfig, Logging, StartStopAsync[Unit], StartStop[Future[Unit]], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BitcoindRpcAppConfig
  2. Serializable
  3. Product
  4. Equals
  5. AppConfig
  6. Logging
  7. StartStopAsync
  8. StartStop
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new BitcoindRpcAppConfig(directory: Path, confs: Config*)(implicit system: ActorSystem)

    directory

    The data directory of the Bitcoin-S instance

    confs

    Optional sequence of configuration overrides

Type Members

  1. type ConfigType = BitcoindRpcAppConfig

    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
    BitcoindRpcAppConfig → AppConfig

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 DEFAULT_BINARY_PATH: Option[File]
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. lazy val authCredentials: BitcoindAuthCredentials
  7. 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
    BitcoindRpcAppConfig → AppConfig
  8. lazy val binaryOpt: Option[File]
  9. lazy val bitcoindDataDir: File
  10. lazy val bitcoindInstance: BitcoindInstance
  11. lazy val chain: BitcoinChainParams

    Chain parameters for the blockchain we're on

    Chain parameters for the blockchain we're on

    Definition Classes
    AppConfig
  12. lazy val clientF: Future[BitcoindRpcClient]

    Creates a bitcoind rpc client based on the bitcoindInstance configured

  13. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  14. lazy val config: Config
    Attributes
    protected
    Definition Classes
    AppConfig
  15. 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
    BitcoindRpcAppConfig → AppConfig
  16. lazy val datadir: Path

    The network specific data directory.

    The network specific data directory.

    Definition Classes
    AppConfig
  17. def debug(mkr: Marker, msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  18. def debug(msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  19. def debug(msg: => Any): Unit
    Attributes
    protected
    Definition Classes
    Logging
  20. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. def error(mkr: Marker, msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  22. def error(msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  23. def error(msg: => Any): Unit
    Attributes
    protected
    Definition Classes
    Logging
  24. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  25. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  26. def getConfigString(path: String): String
    Definition Classes
    AppConfig
  27. def getConfigStringOpt(path: String): Option[String]
    Definition Classes
    AppConfig
  28. lazy val host: URI
  29. def info(mkr: Marker, msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  30. def info(msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  31. def info(msg: => Any): Unit
    Attributes
    protected
    Definition Classes
    Logging
  32. def isDebugEnabled: Boolean
    Attributes
    protected
    Definition Classes
    Logging
  33. def isErrorEnabled: Boolean
    Attributes
    protected
    Definition Classes
    Logging
  34. def isInfoEnabled: Boolean
    Attributes
    protected
    Definition Classes
    Logging
  35. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  36. lazy val isRemote: Boolean
  37. def isTraceEnabled: Boolean
    Attributes
    protected
    Definition Classes
    Logging
  38. def isWarnEnabled: Boolean
    Attributes
    protected
    Definition Classes
    Logging
  39. def logger: Logger
    Attributes
    protected
    Definition Classes
    Logging
  40. def loggerName: String
    Attributes
    protected
    Definition Classes
    Logging
  41. def moduleName: String

    Name of the module.

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

    Attributes
    protected[bitcoins]
    Definition Classes
    BitcoindRpcAppConfig → AppConfig
  42. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  43. lazy val network: BitcoinNetwork

    The blockchain network we're on

    The blockchain network we're on

    Definition Classes
    AppConfig
  44. def newConfigOfType(configs: Seq[Config]): BitcoindRpcAppConfig

    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
    BitcoindRpcAppConfig → AppConfig
  45. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  46. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  47. lazy val port: Int
  48. def productElementNames: Iterator[String]
    Definition Classes
    Product
  49. lazy val rpcHost: URI
  50. lazy val rpcPassword: Option[String]
  51. lazy val rpcPort: Int
  52. lazy val rpcUri: URI
  53. lazy val rpcUser: Option[String]
  54. lazy val socks5ProxyParams: Option[Socks5ProxyParams]
  55. 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
    BitcoindRpcAppConfig → AppConfig → StartStop
  56. def stop(): Future[Unit]
    Definition Classes
    BitcoindRpcAppConfig → StartStop
  57. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  58. implicit val system: ActorSystem
  59. lazy val torConf: TorAppConfig
  60. def trace(mkr: Marker, msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  61. def trace(msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  62. def trace(msg: => Any): Unit
    Attributes
    protected
    Definition Classes
    Logging
  63. lazy val uri: URI
  64. lazy val versionOpt: Option[BitcoindVersion]
  65. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  66. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  67. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  68. def warn(mkr: Marker, msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  69. def warn(msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  70. def warn(msg: => Any): Unit
    Attributes
    protected
    Definition Classes
    Logging
  71. 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
  72. lazy val zmqConfig: ZmqConfig
  73. lazy val zmqHashBlock: Option[InetSocketAddress]
  74. lazy val zmqHashTx: Option[InetSocketAddress]
  75. lazy val zmqRawBlock: Option[InetSocketAddress]
  76. lazy val zmqRawTx: Option[InetSocketAddress]

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AppConfig

Inherited from Logging

Inherited from StartStopAsync[Unit]

Inherited from StartStop[Future[Unit]]

Inherited from AnyRef

Inherited from Any

Ungrouped