Packages

trait Client extends Logging with StartStopAsync[BitcoindRpcClient] with NativeProcessFactory

This is the base trait for Bitcoin Core RPC clients. It defines no RPC calls except for the a ping. It contains functionality and utilities useful when working with an RPC client, like data directories, log files and whether or not the client is started.

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Client
  2. NativeProcessFactory
  3. StartStopAsync
  4. StartStop
  5. Logging
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract val instance: BitcoindInstance
    Attributes
    protected
  2. implicit abstract val system: ActorSystem
    Attributes
    protected
  3. abstract def version: Future[BitcoindVersion]

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. def bitcoindCall[T](command: String, parameters: List[JsValue] = List.empty, printError: Boolean = true, uriExtensionOpt: Option[String] = None)(implicit reader: Reads[T]): Future[T]
    Attributes
    protected
  6. def buildRequest(instance: BitcoindInstance, methodName: String, params: JsArray, uriExtensionOpt: Option[String] = None): HttpRequest
    Attributes
    protected
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. lazy val cmd: String
    Definition Classes
    Client → NativeProcessFactory
  9. lazy val confFileOpt: Option[Path]

    The configuration file of the Bitcoin Core daemon This returns the conf file is the underlying instance is BitcoindInstanceLocal and None if the underlying instance is BitcoindInstanceRemote

  10. def debug(mkr: Marker, msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  11. def debug(msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  12. def debug(msg: => Any): Unit
    Attributes
    protected
    Definition Classes
    Logging
  13. implicit val eCPrivateKeyBytesWrites: Writes[ECPrivateKeyBytes]
  14. implicit val eCPrivateKeyWrites: Writes[ECPrivateKey]
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  17. def error(mkr: Marker, msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  18. def error(msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  19. def error(msg: => Any): Unit
    Attributes
    protected
    Definition Classes
    Logging
  20. implicit val executionContext: ExecutionContext
    Attributes
    protected
    Definition Classes
    Client → NativeProcessFactory
  21. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  22. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  23. def getDaemon: BitcoindInstance
  24. def getPayload(response: HttpResponse): Future[JsValue]

    Parses the payload of the given response into JSON.

    Parses the payload of the given response into JSON.

    The command, parameters and request are given as debug parameters, and only used for printing diagnostics if things go belly-up.

    Attributes
    protected
  25. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  26. implicit val importMultiAddressWrites: Writes[ImportMultiAddress]
  27. implicit val importMultiRequestWrites: Writes[ImportMultiRequest]
  28. def info(mkr: Marker, msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  29. def info(msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  30. def info(msg: => Any): Unit
    Attributes
    protected
    Definition Classes
    Logging
  31. def isAlive(): Boolean
    Definition Classes
    NativeProcessFactory
  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. def isStartedF: Future[Boolean]

    Checks whether the underlying bitcoind daemon is running

  37. def isStoppedF: Future[Boolean]

    Checks whether the underlyind bitcoind daemon is stopped

    Checks whether the underlyind bitcoind daemon is stopped

    returns

    A future boolean which represents isstopped or not

  38. def isTraceEnabled: Boolean
    Attributes
    protected
    Definition Classes
    Logging
  39. def isWarnEnabled: Boolean
    Attributes
    protected
    Definition Classes
    Logging
  40. lazy val logFileOpt: Option[Path]

    The log file of the Bitcoin Core daemon.

    The log file of the Bitcoin Core daemon. This returns the log file if the underlying instance is org.bitcoins.rpc.config.BitcoindInstanceLocal, and None if the underlying instance is BitcoindInstanceRemote

  41. def logger: Logger
    Attributes
    protected
    Definition Classes
    Logging
  42. def loggerName: String
    Attributes
    protected
    Definition Classes
    Logging
  43. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  44. implicit val network: NetworkParameters
    Attributes
    protected
  45. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  46. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  47. def ping(): Future[Unit]
  48. def sendRequest(req: HttpRequest): Future[HttpResponse]
    Attributes
    protected
  49. def start(): Future[BitcoindRpcClient]

    Starts bitcoind on the local system.

    Starts bitcoind on the local system.

    returns

    a future that completes when bitcoind is fully started. This future times out after 60 seconds if the client cannot be started

    Definition Classes
    Client → StartStop
  50. def startBinary(): Future[Unit]
    Definition Classes
    NativeProcessFactory
  51. def stop(): Future[BitcoindRpcClient]

    Stop method for BitcoindRpcClient that is stopped, inherits from the StartStop trait

    Stop method for BitcoindRpcClient that is stopped, inherits from the StartStop trait

    returns

    A future stopped bitcoindRPC client

    Definition Classes
    Client → StartStop
  52. def stopBinary(): Future[Unit]
    Definition Classes
    NativeProcessFactory
  53. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  54. def toString(): String
    Definition Classes
    AnyRef → Any
  55. def trace(mkr: Marker, msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  56. def trace(msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  57. def trace(msg: => Any): Unit
    Attributes
    protected
    Definition Classes
    Logging
  58. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  59. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  60. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  61. def walletExtension(walletName: String): String
    Attributes
    protected
  62. def warn(mkr: Marker, msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  63. def warn(msg: => Any, t: => Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  64. def warn(msg: => Any): Unit
    Attributes
    protected
    Definition Classes
    Logging
  65. implicit object ECPrivateKeyBytesWrites extends Writes[ECPrivateKeyBytes]

    This is here (and not in JsonWrriters) so that the implicit network val is accessible

  66. implicit object ECPrivateKeyWrites extends Writes[ECPrivateKey]

    This is here (and not in JsonWrriters) so that the implicit network val is accessible

Inherited from NativeProcessFactory

Inherited from Logging

Inherited from AnyRef

Inherited from Any

Ungrouped