bitcoin-s/api/org/bitcoins/testkit/node/NodeUnitTest$.html

9 lines
109 KiB
HTML
Raw Normal View History

<!DOCTYPE html ><html><head><meta http-equiv="X-UA-Compatible" content="IE=edge"/><meta content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no" name="viewport"/><title></title><meta content="" name="description"/><meta content="" name="keywords"/><meta http-equiv="content-type" content="text/html; charset=UTF-8"/><link href="../../../../lib/index.css" media="screen" type="text/css" rel="stylesheet"/><link href="../../../../lib/template.css" media="screen" type="text/css" rel="stylesheet"/><link href="../../../../lib/print.css" media="print" type="text/css" rel="stylesheet"/><link href="../../../../lib/diagrams.css" media="screen" type="text/css" rel="stylesheet" id="diagrams-css"/><script type="text/javascript" src="../../../../lib/jquery.min.js"></script><script type="text/javascript" src="../../../../lib/index.js"></script><script type="text/javascript" src="../../../../index.js"></script><script type="text/javascript" src="../../../../lib/scheduler.js"></script><script type="text/javascript" src="../../../../lib/template.js"></script><script type="text/javascript">/* this variable can be used by the JS to determine the path to the root document */
var toRoot = '../../../../';</script></head><body><div id="search"><span id="doc-title"><span id="doc-version"></span></span> <span class="close-results"><span class="left">&lt;</span> Back</span><div id="textfilter"><span class="input"><input autocapitalize="none" placeholder="Search" id="index-input" type="text" accesskey="/"/><i class="clear material-icons"></i><i id="search-icon" class="material-icons"></i></span></div></div><div id="search-results"><div id="search-progress"><div id="progress-fill"></div></div><div id="results-content"><div id="entity-results"></div><div id="member-results"></div></div></div><div id="content-scroll-container" style="-webkit-overflow-scrolling: touch;"><div id="content-container" style="-webkit-overflow-scrolling: touch;"><div id="subpackage-spacer"><div id="packages"><h1>Packages</h1><ul><li class="indented0 " name="_root_.root" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="_root_" class="anchorToMember"></a><a id="root:_root_" class="anchorToMember"></a> <span class="permalink"><a href="../../../../index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../../../../index.html" title=""><span class="name">root</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../../index.html" name="_root_" id="_root_" class="extype">root</a></dd></dl></div></li><li class="indented1 " name="_root_.org" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="org" class="anchorToMember"></a><a id="org:org" class="anchorToMember"></a> <span class="permalink"><a href="../../../../org/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../../../index.html" title=""><span class="name">org</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../../index.html" name="_root_" id="_root_" class="extype">root</a></dd></dl></div></li><li class="indented2 " name="org.bitcoins" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="bitcoins" class="anchorToMember"></a><a id="bitcoins:bitcoins" class="anchorToMember"></a> <span class="permalink"><a href="../../../../org/bitcoins/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../../index.html" title=""><span class="name">bitcoins</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../index.html" name="org" id="org" class="extype">org</a></dd></dl></div></li><li class="indented3 " name="org.bitcoins.testkit" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="testkit" class="anchorToMember"></a><a id="testkit:testkit" class="anchorToMember"></a> <span class="permalink"><a href="../../../../org/bitcoins/testkit/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../index.html" title=""><span class="name">testkit</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../index.html" name="org.bitcoins" id="org.bitcoins" class="extype">bitcoins</a></dd></dl></div></li><li class="indented4 " name="org.bitcoins.testkit.node" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="node" class="anchorToMember"></a><a id="node:node" class="anchorToMember"></a> <span class="permalink"><a href="../../../../org/bitcoins/testkit/node/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class=
also calls <span name="org.bitcoins.node.Node.start()" class="extype">start</span> to start the node
</p></li><li class="indented0 " name="org.bitcoins.testkit.node.NodeUnitTest#createNeutrinoNode" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="createNeutrinoNode(bitcoind:org.bitcoins.rpc.client.common.BitcoindRpcClient,walletCreationTimeOpt:Option[java.time.Instant])(implicitsystem:akka.actor.ActorSystem,implicitchainAppConfig:org.bitcoins.chain.config.ChainAppConfig,implicitnodeAppConfig:org.bitcoins.node.config.NodeAppConfig):scala.concurrent.Future[org.bitcoins.node.NeutrinoNode]" class="anchorToMember"></a><a id="createNeutrinoNode(BitcoindRpcClient,Option[Instant])(ActorSystem,ChainAppConfig,NodeAppConfig):Future[NeutrinoNode]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../org/bitcoins/testkit/node/NodeUnitTest$.html#createNeutrinoNode(bitcoind:org.bitcoins.rpc.client.common.BitcoindRpcClient,walletCreationTimeOpt:Option[java.time.Instant])(implicitsystem:akka.actor.ActorSystem,implicitchainAppConfig:org.bitcoins.chain.config.ChainAppConfig,implicitnodeAppConfig:org.bitcoins.node.config.NodeAppConfig):scala.concurrent.Future[org.bitcoins.node.NeutrinoNode]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">createNeutrinoNode</span><span class="params">(<span name="bitcoind">bitcoind: <a href="../../rpc/client/common/BitcoindRpcClient.html" name="org.bitcoins.rpc.client.common.BitcoindRpcClient" id="org.bitcoins.rpc.client.common.BitcoindRpcClient" class="extype">BitcoindRpcClient</a></span>, <span name="walletCreationTimeOpt">walletCreationTimeOpt: <a href="https://www.scala-lang.org/api/2.13.8/scala/Option.html#scala.Option" name="scala.Option" id="scala.Option" class="extype">Option</a>[<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java/time/Instant.html#java.time.Instant" name="java.time.Instant" id="java.time.Instant" class="extype">Instant</a>]</span>)</span><span class="params">(<span class="implicit">implicit </span><span name="system">system: <a href="https://doc.akka.io/api/akka/2.6.19/akka/actor/ActorSystem.html#akka.actor.ActorSystem" name="akka.actor.ActorSystem" id="akka.actor.ActorSystem" class="extype">ActorSystem</a></span>, <span name="chainAppConfig">chainAppConfig: <a href="../../chain/config/ChainAppConfig.html" name="org.bitcoins.chain.config.ChainAppConfig" id="org.bitcoins.chain.config.ChainAppConfig" class="extype">ChainAppConfig</a></span>, <span name="nodeAppConfig">nodeAppConfig: <a href="../../node/config/NodeAppConfig.html" name="org.bitcoins.node.config.NodeAppConfig" id="org.bitcoins.node.config.NodeAppConfig" class="extype">NodeAppConfig</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="../../node/NeutrinoNode.html" name="org.bitcoins.node.NeutrinoNode" id="org.bitcoins.node.NeutrinoNode" class="extype">NeutrinoNode</a>]</span></span><p class="shortcomment cmt">Creates a Neutrino node peered with the given bitcoind client, this method
also calls <span name="org.bitcoins.node.Node.start()" class="extype">start</span> to start the node
</p></li><li class="indented0 " name="org.bitcoins.testkit.node.NodeUnitTest#createNeutrinoNodeFundedWalletBitcoind" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="createNeutrinoNodeFundedWalletBitcoind(bip39PasswordOpt:Option[String],versionOpt:Option[org.bitcoins.rpc.client.common.BitcoindVersion],walletCallbacks:org.bitcoins.wallet.WalletCallbacks)(implicitsystem:akka.actor.ActorSystem,implicitappConfig:org.bitcoins.server.BitcoinSAppConfig):scala.concurrent.Future[org.bitcoins.testkit.node.NeutrinoNodeFundedWalletBitcoind]" class="anchorToMember"></a><a id="createNeutrinoNodeFundedWalletBitcoind(Option[String],Option[BitcoindVersion],WalletCallbacks)(ActorSystem,BitcoinSAppConfig):Future[NeutrinoNodeFundedWalletBitcoind]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../org/bitcoins/testkit/node/NodeUnitTest$.html#createNeutrinoNodeFundedWalletBitcoind(bip39PasswordOpt:Option[String],versionOpt:Option[org.bitcoins.rpc.client.common.BitcoindVersion],walletCallbacks:org.bitcoins.wallet.WalletCallbacks)(implicitsystem:akka.actor.ActorSystem,implicitappConfig:org.bitcoins.server.BitcoinSAppConfig):scala.concurrent.Future[org.bitcoins.testkit.node.NeutrinoNodeFundedWalletBitcoind]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">createNeutrinoNodeFundedWalletBitcoind</span><span class="params">(<span name="bip39PasswordOpt">bip39PasswordOpt: <a href="https://www.scala-lang.org/api/2.13.8/scala/Option.html#scala.Option" name="scala.Option" id="scala.Option" class="extype">Option</a>[<span name="scala.Predef.String" class="extype">String</span>]</span>, <span name="versionOpt">versionOpt: <a href="https://www.scala-lang.org/api/2.13.8/scala/Option.html#scala.Option" name="scala.Option" id="scala.Option" class="extype">Option</a>[<a href="../../rpc/client/common/BitcoindVersion.html" name="org.bitcoins.rpc.client.common.BitcoindVersion" id="org.bitcoins.rpc.client.common.BitcoindVersion" class="extype">BitcoindVersion</a>]</span>, <span name="walletCallbacks">walletCallbacks: <a href="../../wallet/WalletCallbacks.html" name="org.bitcoins.wallet.WalletCallbacks" id="org.bitcoins.wallet.WalletCallbacks" class="extype">WalletCallbacks</a></span>)</span><span class="params">(<span class="implicit">implicit </span><span name="system">system: <a href="https://doc.akka.io/api/akka/2.6.19/akka/actor/ActorSystem.html#akka.actor.ActorSystem" name="akka.actor.ActorSystem" id="akka.actor.ActorSystem" class="extype">ActorSystem</a></span>, <span name="appConfig">appConfig: <a href="../../server/BitcoinSAppConfig.html" name="org.bitcoins.server.BitcoinSAppConfig" id="org.bitcoins.server.BitcoinSAppConfig" class="extype">BitcoinSAppConfig</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="NeutrinoNodeFundedWalletBitcoind.html" name="org.bitcoins.testkit.node.NeutrinoNodeFundedWalletBitcoind" id="org.bitcoins.testkit.node.NeutrinoNodeFundedWalletBitcoind" class="extype">NeutrinoNodeFundedWalletBitcoind</a>]</span></span><p class="shortcomment cmt">Creates a neutrino node, a funded bitcoin-s wallet, all of which are connected to bitcoind</p></li><li class="indented0 " name="org.bitcoins.testkit.node.NodeUnitTest#createNeutrinoNodeFundedWalletFromBitcoind" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="createNeutrinoNodeFundedWalletFromBitcoind(bip39PasswordOpt:Option[String],bitcoind:org.bitcoins.rpc.client.common.BitcoindRpcClient,walletCallbacks:org.bitcoins.wallet.WalletCallbacks)(implicitsystem:akka.actor.ActorSystem,implicitappConfig:org.bitcoins.server.BitcoinSAppConfig):scala.concurrent.Future[org.bitcoins.testkit.node.NeutrinoNodeFundedWalletBitcoind]" class="anchorToMember"></a><a id="createNeutrinoNodeFundedWalletFromBitcoind
This does NOT start the spv node
</p></li><li class="indented0 " name="org.bitcoins.testkit.node.NodeUnitTest#createSpvNodeFundedWalletBitcoind" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="createSpvNodeFundedWalletBitcoind(walletCallbacks:org.bitcoins.wallet.WalletCallbacks,bip39PasswordOpt:Option[String],versionOpt:Option[org.bitcoins.rpc.client.common.BitcoindVersion])(implicitsystem:akka.actor.ActorSystem,implicitappConfig:org.bitcoins.server.BitcoinSAppConfig):scala.concurrent.Future[org.bitcoins.testkit.node.SpvNodeFundedWalletBitcoind]" class="anchorToMember"></a><a id="createSpvNodeFundedWalletBitcoind(WalletCallbacks,Option[String],Option[BitcoindVersion])(ActorSystem,BitcoinSAppConfig):Future[SpvNodeFundedWalletBitcoind]" class="anchorToMember"></a> <span class="permalink"><a href="../../../../org/bitcoins/testkit/node/NodeUnitTest$.html#createSpvNodeFundedWalletBitcoind(walletCallbacks:org.bitcoins.wallet.WalletCallbacks,bip39PasswordOpt:Option[String],versionOpt:Option[org.bitcoins.rpc.client.common.BitcoindVersion])(implicitsystem:akka.actor.ActorSystem,implicitappConfig:org.bitcoins.server.BitcoinSAppConfig):scala.concurrent.Future[org.bitcoins.testkit.node.SpvNodeFundedWalletBitcoind]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">createSpvNodeFundedWalletBitcoind</span><span class="params">(<span name="walletCallbacks">walletCallbacks: <a href="../../wallet/WalletCallbacks.html" name="org.bitcoins.wallet.WalletCallbacks" id="org.bitcoins.wallet.WalletCallbacks" class="extype">WalletCallbacks</a></span>, <span name="bip39PasswordOpt">bip39PasswordOpt: <a href="https://www.scala-lang.org/api/2.13.8/scala/Option.html#scala.Option" name="scala.Option" id="scala.Option" class="extype">Option</a>[<span name="scala.Predef.String" class="extype">String</span>]</span>, <span name="versionOpt">versionOpt: <a href="https://www.scala-lang.org/api/2.13.8/scala/Option.html#scala.Option" name="scala.Option" id="scala.Option" class="extype">Option</a>[<a href="../../rpc/client/common/BitcoindVersion.html" name="org.bitcoins.rpc.client.common.BitcoindVersion" id="org.bitcoins.rpc.client.common.BitcoindVersion" class="extype">BitcoindVersion</a>] = <span class="symbol"><span class="name"><a href="../../../../scala/index.html">None</a></span></span></span>)</span><span class="params">(<span class="implicit">implicit </span><span name="system">system: <a href="https://doc.akka.io/api/akka/2.6.19/akka/actor/ActorSystem.html#akka.actor.ActorSystem" name="akka.actor.ActorSystem" id="akka.actor.ActorSystem" class="extype">ActorSystem</a></span>, <span name="appConfig">appConfig: <a href="../../server/BitcoinSAppConfig.html" name="org.bitcoins.server.BitcoinSAppConfig" id="org.bitcoins.server.BitcoinSAppConfig" class="extype">BitcoinSAppConfig</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="SpvNodeFundedWalletBitcoind.html" name="org.bitcoins.testkit.node.SpvNodeFundedWalletBitcoind" id="org.bitcoins.testkit.node.SpvNodeFundedWalletBitcoind" class="extype">SpvNodeFundedWalletBitcoind</a>]</span></span><p class="shortcomment cmt">Creates a spv node, a funded bitcoin-s wallet, all of which are connected to bitcoind</p></li><li class="indented0 " name="org.bitcoins.testkit.node.NodeUnitTest#createSpvNodeFundedWalletFromBitcoind" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="createSpvNodeFundedWalletFromBitcoind(walletCallbacks:org.bitcoins.wallet.WalletCallbacks,bip39PasswordOpt:Option[String],bitcoind:org.bitcoins.rpc.client.common.BitcoindRpcClient)(implicitsystem:akka.actor.ActorSystem,implicitappConfig:org.bitcoins.server.BitcoinSAppConfig):scala.concurrent.Future[org.bitcoins.testkit.node.SpvNodeFundedWalletBitcoind]" class="anchorToMember"></a><a id="createSpvNodeFunde