Packages

trait Client extends BitcoinSLogger 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. BitcoinSLogger
  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: Vector[String]

    The command to start the daemon on the underlying OS

    The command to start the daemon on the underlying OS

    Definition Classes
    ClientNativeProcessFactory
  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. implicit val eCPrivateKeyBytesWrites: Writes[ECPrivateKeyBytes]
  11. implicit val eCPrivateKeyWrites: Writes[ECPrivateKey]
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. implicit val executionContext: ExecutionContext
    Attributes
    protected
    Definition Classes
    ClientNativeProcessFactory
  15. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def getDaemon: BitcoindInstance
  18. 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
  19. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  20. implicit val importMultiAddressWrites: Writes[ImportMultiAddress]
  21. implicit val importMultiRequestWrites: Writes[ImportMultiRequest]
  22. def isAlive(): Boolean
    Definition Classes
    NativeProcessFactory
  23. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  24. def isStartedF: Future[Boolean]

    Checks whether the underlying bitcoind daemon is running

  25. 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

  26. 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

  27. def logger: Logger
    Definition Classes
    BitcoinSLogger
  28. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  29. implicit val network: NetworkParameters
    Attributes
    protected
  30. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  31. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  32. def ping(): Future[Unit]
  33. def sendRequest(req: HttpRequest): Future[HttpResponse]
    Attributes
    protected
  34. 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
    ClientStartStop
  35. def startBinary(): Future[Unit]

    Starts the binary by spinning up a new process

    Starts the binary by spinning up a new process

    Definition Classes
    NativeProcessFactory
  36. 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
    ClientStartStop
  37. def stopBinary(): Future[Unit]

    Stops the binary by destroying the underlying operating system process

    Stops the binary by destroying the underlying operating system process

    If the client is a remote client (not started on the host operating system) this method is a no-op

    Definition Classes
    NativeProcessFactory
  38. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  39. def toString(): String
    Definition Classes
    AnyRef → Any
  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. def walletExtension(walletName: String): String
    Attributes
    protected
  44. implicit object ECPrivateKeyBytesWrites extends Writes[ECPrivateKeyBytes]

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

  45. 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 BitcoinSLogger

Inherited from AnyRef

Inherited from Any

Ungrouped