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.
- Alphabetic
- By Inheritance
- Client
- NativeProcessFactory
- StartStopAsync
- StartStop
- Logging
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract val instance: BitcoindInstance
- Attributes
- protected
- implicit abstract val system: ActorSystem
- Attributes
- protected
- abstract def version: Future[BitcoindVersion]
Concrete 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
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- 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
- def buildRequest(instance: BitcoindInstance, methodName: String, params: JsArray, uriExtensionOpt: Option[String] = None): HttpRequest
- Attributes
- protected
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- lazy val cmd: String
- Definition Classes
- Client → NativeProcessFactory
- 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
- def debug(mkr: Marker, msg: => Any, t: => Throwable): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def debug(msg: => Any, t: => Throwable): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def debug(msg: => Any): Unit
- Attributes
- protected
- Definition Classes
- Logging
- implicit val eCPrivateKeyBytesWrites: Writes[ECPrivateKeyBytes]
- implicit val eCPrivateKeyWrites: Writes[ECPrivateKey]
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def error(mkr: Marker, msg: => Any, t: => Throwable): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def error(msg: => Any, t: => Throwable): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def error(msg: => Any): Unit
- Attributes
- protected
- Definition Classes
- Logging
- implicit val executionContext: ExecutionContext
- Attributes
- protected
- Definition Classes
- Client → NativeProcessFactory
- 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 getDaemon: BitcoindInstance
- 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
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- implicit val importMultiAddressWrites: Writes[ImportMultiAddress]
- implicit val importMultiRequestWrites: Writes[ImportMultiRequest]
- def info(mkr: Marker, msg: => Any, t: => Throwable): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def info(msg: => Any, t: => Throwable): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def info(msg: => Any): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def isAlive(): Boolean
- Definition Classes
- NativeProcessFactory
- def isDebugEnabled: Boolean
- Attributes
- protected
- Definition Classes
- Logging
- def isErrorEnabled: Boolean
- Attributes
- protected
- Definition Classes
- Logging
- def isInfoEnabled: Boolean
- Attributes
- protected
- Definition Classes
- Logging
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isStartedF: Future[Boolean]
Checks whether the underlying bitcoind daemon is running
- 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
- def isTraceEnabled: Boolean
- Attributes
- protected
- Definition Classes
- Logging
- def isWarnEnabled: Boolean
- Attributes
- protected
- Definition Classes
- Logging
- 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
- def logger: Logger
- Attributes
- protected
- Definition Classes
- Logging
- def loggerName: String
- Attributes
- protected
- Definition Classes
- Logging
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- implicit val network: NetworkParameters
- Attributes
- protected
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def ping(): Future[Unit]
- def sendRequest(req: HttpRequest): Future[HttpResponse]
- Attributes
- protected
- 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
- def startBinary(): Future[Unit]
- Definition Classes
- NativeProcessFactory
- 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
- def stopBinary(): Future[Unit]
- Definition Classes
- NativeProcessFactory
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- def trace(mkr: Marker, msg: => Any, t: => Throwable): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def trace(msg: => Any, t: => Throwable): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def trace(msg: => Any): Unit
- Attributes
- protected
- Definition Classes
- Logging
- 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()
- def walletExtension(walletName: String): String
- Attributes
- protected
- def warn(mkr: Marker, msg: => Any, t: => Throwable): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def warn(msg: => Any, t: => Throwable): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def warn(msg: => Any): Unit
- Attributes
- protected
- Definition Classes
- Logging
- implicit object ECPrivateKeyBytesWrites extends Writes[ECPrivateKeyBytes]
This is here (and not in JsonWrriters) so that the implicit network val is accessible
- implicit object ECPrivateKeyWrites extends Writes[ECPrivateKey]
This is here (and not in JsonWrriters) so that the implicit network val is accessible