Skip to content

Commit f0a3cb7

Browse files
docs: add bdk-jvm 1.2 Javadoc docs
1 parent c1d8f00 commit f0a3cb7

File tree

502 files changed

+3327
-1684
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

502 files changed

+3327
-1684
lines changed

docs/.vuepress/public/java/allclasses.html

+20-18
Original file line numberDiff line numberDiff line change
@@ -37,13 +37,21 @@ <h1 class="bar">All Classes</h1>
3737

3838
<li><a href=org/bitcoindevkit/BumpFeeTxBuilder.html>BumpFeeTxBuilder</a></li>
3939

40-
<li><a href=org/bitcoindevkit/ChangeSetInterface.html>ChangeSetInterface</a></li>
40+
<li><a href=org/bitcoindevkit/CbfBuilderInterface.html>CbfBuilderInterface</a></li>
4141

42-
<li><a href=org/bitcoindevkit/ChangeSet.html>ChangeSet</a></li>
42+
<li><a href=org/bitcoindevkit/CbfBuilder.html>CbfBuilder</a></li>
43+
44+
<li><a href=org/bitcoindevkit/CbfClientInterface.html>CbfClientInterface</a></li>
45+
46+
<li><a href=org/bitcoindevkit/CbfClient.html>CbfClient</a></li>
47+
48+
<li><a href=org/bitcoindevkit/CbfNodeInterface.html>CbfNodeInterface</a></li>
4349

44-
<li><a href=org/bitcoindevkit/ClientInterface.html>ClientInterface</a></li>
50+
<li><a href=org/bitcoindevkit/CbfNode.html>CbfNode</a></li>
4551

46-
<li><a href=org/bitcoindevkit/Client.html>Client</a></li>
52+
<li><a href=org/bitcoindevkit/ChangeSetInterface.html>ChangeSetInterface</a></li>
53+
54+
<li><a href=org/bitcoindevkit/ChangeSet.html>ChangeSet</a></li>
4755

4856
<li><a href=org/bitcoindevkit/ConnectionInterface.html>ConnectionInterface</a></li>
4957

@@ -93,14 +101,6 @@ <h1 class="bar">All Classes</h1>
93101

94102
<li><a href=org/bitcoindevkit/IpAddress.html>IpAddress</a></li>
95103

96-
<li><a href=org/bitcoindevkit/LightClientBuilderInterface.html>LightClientBuilderInterface</a></li>
97-
98-
<li><a href=org/bitcoindevkit/LightClientBuilder.html>LightClientBuilder</a></li>
99-
100-
<li><a href=org/bitcoindevkit/LightNodeInterface.html>LightNodeInterface</a></li>
101-
102-
<li><a href=org/bitcoindevkit/LightNode.html>LightNode</a></li>
103-
104104
<li><a href=org/bitcoindevkit/MnemonicInterface.html>MnemonicInterface</a></li>
105105

106106
<li><a href=org/bitcoindevkit/Mnemonic.html>Mnemonic</a></li>
@@ -153,6 +153,8 @@ <h1 class="bar">All Classes</h1>
153153

154154
<li><a href=org/bitcoindevkit/CanonicalTx.html>CanonicalTx</a></li>
155155

156+
<li><a href=org/bitcoindevkit/CbfComponents.html>CbfComponents</a></li>
157+
156158
<li><a href=org/bitcoindevkit/Condition.html>Condition</a></li>
157159

158160
<li><a href=org/bitcoindevkit/ConfirmationBlockTime.html>ConfirmationBlockTime</a></li>
@@ -165,8 +167,6 @@ <h1 class="bar">All Classes</h1>
165167

166168
<li><a href=org/bitcoindevkit/KeychainAndIndex.html>KeychainAndIndex</a></li>
167169

168-
<li><a href=org/bitcoindevkit/LightClient.html>LightClient</a></li>
169-
170170
<li><a href=org/bitcoindevkit/LocalOutput.html>LocalOutput</a></li>
171171

172172
<li><a href=org/bitcoindevkit/OutPoint.html>OutPoint</a></li>
@@ -205,6 +205,10 @@ <h1 class="bar">All Classes</h1>
205205

206206
<li><a href=org/bitcoindevkit/CannotConnectException.html>CannotConnectException</a></li>
207207

208+
<li><a href=org/bitcoindevkit/CbfBuilderException.html>CbfBuilderException</a></li>
209+
210+
<li><a href=org/bitcoindevkit/CbfException.html>CbfException</a></li>
211+
208212
<li><a href=org/bitcoindevkit/ChainPosition.html>ChainPosition</a></li>
209213

210214
<li><a href=org/bitcoindevkit/ChangeSpendPolicy.html>ChangeSpendPolicy</a></li>
@@ -229,16 +233,14 @@ <h1 class="bar">All Classes</h1>
229233

230234
<li><a href=org/bitcoindevkit/KeychainKind.html>KeychainKind</a></li>
231235

232-
<li><a href=org/bitcoindevkit/LightClientBuilderException.html>LightClientBuilderException</a></li>
233-
234-
<li><a href=org/bitcoindevkit/LightClientException.html>LightClientException</a></li>
235-
236236
<li><a href=org/bitcoindevkit/LoadWithPersistException.html>LoadWithPersistException</a></li>
237237

238238
<li><a href=org/bitcoindevkit/LockTime.html>LockTime</a></li>
239239

240240
<li><a href=org/bitcoindevkit/Log.html>Log</a></li>
241241

242+
<li><a href=org/bitcoindevkit/LogLevel.html>LogLevel</a></li>
243+
242244
<li><a href=org/bitcoindevkit/MiniscriptException.html>MiniscriptException</a></li>
243245

244246
<li><a href=org/bitcoindevkit/Network.html>Network</a></li>

docs/.vuepress/public/java/element-list

+8-7
Original file line numberDiff line numberDiff line change
@@ -42,11 +42,17 @@ $dokka.location:org.bitcoindevkit/CalculateFeeException.MissingTxOut///PointingT
4242
$dokka.location:org.bitcoindevkit/CalculateFeeException.NegativeFee///PointingToDeclaration/org/bitcoindevkit/CalculateFeeException.NegativeFee.html
4343
$dokka.location:org.bitcoindevkit/CannotConnectException.ErrorHandler///PointingToDeclaration/org/bitcoindevkit/CannotConnectException.ErrorHandler.html
4444
$dokka.location:org.bitcoindevkit/CannotConnectException.Include///PointingToDeclaration/org/bitcoindevkit/CannotConnectException.Include.html
45+
$dokka.location:org.bitcoindevkit/CbfBuilderException.DatabaseException///PointingToDeclaration/org/bitcoindevkit/CbfBuilderException.DatabaseException.html
46+
$dokka.location:org.bitcoindevkit/CbfBuilderException.ErrorHandler///PointingToDeclaration/org/bitcoindevkit/CbfBuilderException.ErrorHandler.html
47+
$dokka.location:org.bitcoindevkit/CbfBuilderInterface.Companion///PointingToDeclaration/org/bitcoindevkit/CbfBuilderInterface.Companion.html
48+
$dokka.location:org.bitcoindevkit/CbfClientInterface.Companion///PointingToDeclaration/org/bitcoindevkit/CbfClientInterface.Companion.html
49+
$dokka.location:org.bitcoindevkit/CbfException.ErrorHandler///PointingToDeclaration/org/bitcoindevkit/CbfException.ErrorHandler.html
50+
$dokka.location:org.bitcoindevkit/CbfException.NodeStopped///PointingToDeclaration/org/bitcoindevkit/CbfException.NodeStopped.html
51+
$dokka.location:org.bitcoindevkit/CbfNodeInterface.Companion///PointingToDeclaration/org/bitcoindevkit/CbfNodeInterface.Companion.html
4552
$dokka.location:org.bitcoindevkit/ChainPosition.Confirmed///PointingToDeclaration/org/bitcoindevkit/ChainPosition.Confirmed.html
4653
$dokka.location:org.bitcoindevkit/ChainPosition.Unconfirmed///PointingToDeclaration/org/bitcoindevkit/ChainPosition.Unconfirmed.html
4754
$dokka.location:org.bitcoindevkit/ChangeSetInterface.Companion///PointingToDeclaration/org/bitcoindevkit/ChangeSetInterface.Companion.html
4855
$dokka.location:org.bitcoindevkit/ChangeSpendPolicy.Companion///PointingToDeclaration/org/bitcoindevkit/ChangeSpendPolicy.Companion.html
49-
$dokka.location:org.bitcoindevkit/ClientInterface.Companion///PointingToDeclaration/org/bitcoindevkit/ClientInterface.Companion.html
5056
$dokka.location:org.bitcoindevkit/Connection.Companion///PointingToDeclaration/org/bitcoindevkit/Connection.Companion.html
5157
$dokka.location:org.bitcoindevkit/ConnectionInterface.Companion///PointingToDeclaration/org/bitcoindevkit/ConnectionInterface.Companion.html
5258
$dokka.location:org.bitcoindevkit/CreateTxException.ChangePolicyDescriptor///PointingToDeclaration/org/bitcoindevkit/CreateTxException.ChangePolicyDescriptor.html
@@ -157,12 +163,6 @@ $dokka.location:org.bitcoindevkit/FullScanScriptInspector.Companion///PointingTo
157163
$dokka.location:org.bitcoindevkit/IpAddress.Companion///PointingToDeclaration/org/bitcoindevkit/IpAddress.Companion.html
158164
$dokka.location:org.bitcoindevkit/IpAddressInterface.Companion///PointingToDeclaration/org/bitcoindevkit/IpAddressInterface.Companion.html
159165
$dokka.location:org.bitcoindevkit/KeychainKind.Companion///PointingToDeclaration/org/bitcoindevkit/KeychainKind.Companion.html
160-
$dokka.location:org.bitcoindevkit/LightClientBuilderException.DatabaseException///PointingToDeclaration/org/bitcoindevkit/LightClientBuilderException.DatabaseException.html
161-
$dokka.location:org.bitcoindevkit/LightClientBuilderException.ErrorHandler///PointingToDeclaration/org/bitcoindevkit/LightClientBuilderException.ErrorHandler.html
162-
$dokka.location:org.bitcoindevkit/LightClientBuilderInterface.Companion///PointingToDeclaration/org/bitcoindevkit/LightClientBuilderInterface.Companion.html
163-
$dokka.location:org.bitcoindevkit/LightClientException.ErrorHandler///PointingToDeclaration/org/bitcoindevkit/LightClientException.ErrorHandler.html
164-
$dokka.location:org.bitcoindevkit/LightClientException.NodeStopped///PointingToDeclaration/org/bitcoindevkit/LightClientException.NodeStopped.html
165-
$dokka.location:org.bitcoindevkit/LightNodeInterface.Companion///PointingToDeclaration/org/bitcoindevkit/LightNodeInterface.Companion.html
166166
$dokka.location:org.bitcoindevkit/LoadWithPersistException.CouldNotLoad///PointingToDeclaration/org/bitcoindevkit/LoadWithPersistException.CouldNotLoad.html
167167
$dokka.location:org.bitcoindevkit/LoadWithPersistException.ErrorHandler///PointingToDeclaration/org/bitcoindevkit/LoadWithPersistException.ErrorHandler.html
168168
$dokka.location:org.bitcoindevkit/LoadWithPersistException.InvalidChangeSet///PointingToDeclaration/org/bitcoindevkit/LoadWithPersistException.InvalidChangeSet.html
@@ -174,6 +174,7 @@ $dokka.location:org.bitcoindevkit/Log.Debug///PointingToDeclaration/org/bitcoin
174174
$dokka.location:org.bitcoindevkit/Log.Progress///PointingToDeclaration/org/bitcoindevkit/Log.Progress.html
175175
$dokka.location:org.bitcoindevkit/Log.StateUpdate///PointingToDeclaration/org/bitcoindevkit/Log.StateUpdate.html
176176
$dokka.location:org.bitcoindevkit/Log.TxSent///PointingToDeclaration/org/bitcoindevkit/Log.TxSent.html
177+
$dokka.location:org.bitcoindevkit/LogLevel.Companion///PointingToDeclaration/org/bitcoindevkit/LogLevel.Companion.html
177178
$dokka.location:org.bitcoindevkit/MiniscriptException.AbsoluteLockTime///PointingToDeclaration/org/bitcoindevkit/MiniscriptException.AbsoluteLockTime.html
178179
$dokka.location:org.bitcoindevkit/MiniscriptException.AddrException///PointingToDeclaration/org/bitcoindevkit/MiniscriptException.AddrException.html
179180
$dokka.location:org.bitcoindevkit/MiniscriptException.AddrP2shException///PointingToDeclaration/org/bitcoindevkit/MiniscriptException.AddrP2shException.html

docs/.vuepress/public/java/index-files/index-1.html

+38-12
Original file line numberDiff line numberDiff line change
@@ -230,7 +230,7 @@ <h2 class="title">A</h2>
230230

231231

232232
</dt>
233-
<dd>&nbsp;</dd>
233+
<dd>A bitcoin address</dd>
234234

235235

236236
<dt>
@@ -256,7 +256,7 @@ <h2 class="title">A</h2>
256256

257257

258258
</dt>
259-
<dd>&nbsp;</dd>
259+
<dd>The type of address.</dd>
260260

261261

262262
<dt>
@@ -269,7 +269,7 @@ <h2 class="title">A</h2>
269269

270270

271271
</dt>
272-
<dd>&nbsp;</dd>
272+
<dd>Legacy.</dd>
273273

274274

275275
<dt>
@@ -282,7 +282,7 @@ <h2 class="title">A</h2>
282282

283283

284284
</dt>
285-
<dd>&nbsp;</dd>
285+
<dd>Wrapped Segwit</dd>
286286

287287

288288
<dt>
@@ -295,7 +295,7 @@ <h2 class="title">A</h2>
295295

296296

297297
</dt>
298-
<dd>&nbsp;</dd>
298+
<dd>Segwit</dd>
299299

300300

301301
<dt>
@@ -321,7 +321,7 @@ <h2 class="title">A</h2>
321321

322322

323323
</dt>
324-
<dd>&nbsp;</dd>
324+
<dd>A bitcoin address</dd>
325325

326326

327327
<dt>
@@ -497,9 +497,9 @@ <h2 class="title">A</h2>
497497

498498
<span class="memberNameLink">
499499

500-
<a href="../org/bitcoindevkit/Client.html#addRevealedScripts(org.bitcoindevkit.Wallet)">addRevealedScripts(org.bitcoindevkit.Wallet)</a>
500+
<a href="../org/bitcoindevkit/CbfClient.html#addRevealedScripts(org.bitcoindevkit.Wallet)">addRevealedScripts(org.bitcoindevkit.Wallet)</a>
501501

502-
</span> - function in org.bitcoindevkit.<a href=../org/bitcoindevkit/Client.html>Client</a>
502+
</span> - function in org.bitcoindevkit.<a href=../org/bitcoindevkit/CbfClient.html>CbfClient</a>
503503

504504

505505
</dt>
@@ -510,9 +510,9 @@ <h2 class="title">A</h2>
510510

511511
<span class="memberNameLink">
512512

513-
<a href="../org/bitcoindevkit/ClientInterface.html#addRevealedScripts(org.bitcoindevkit.Wallet)">addRevealedScripts(org.bitcoindevkit.Wallet)</a>
513+
<a href="../org/bitcoindevkit/CbfClientInterface.html#addRevealedScripts(org.bitcoindevkit.Wallet)">addRevealedScripts(org.bitcoindevkit.Wallet)</a>
514514

515-
</span> - function in org.bitcoindevkit.<a href=../org/bitcoindevkit/ClientInterface.html>ClientInterface</a>
515+
</span> - function in org.bitcoindevkit.<a href=../org/bitcoindevkit/CbfClientInterface.html>CbfClientInterface</a>
516516

517517

518518
</dt>
@@ -610,6 +610,32 @@ <h2 class="title">A</h2>
610610
<dd>Add the list of outpoints to the internal list of UTXOs that must be spent.</dd>
611611

612612

613+
<dt>
614+
615+
<span class="memberNameLink">
616+
617+
<a href="../org/bitcoindevkit/BumpFeeTxBuilder.html#allowDust(java.lang.Boolean)">allowDust(java.lang.Boolean)</a>
618+
619+
</span> - function in org.bitcoindevkit.<a href=../org/bitcoindevkit/BumpFeeTxBuilder.html>BumpFeeTxBuilder</a>
620+
621+
622+
</dt>
623+
<dd>Set whether the dust limit is checked.</dd>
624+
625+
626+
<dt>
627+
628+
<span class="memberNameLink">
629+
630+
<a href="../org/bitcoindevkit/BumpFeeTxBuilderInterface.html#allowDust(java.lang.Boolean)">allowDust(java.lang.Boolean)</a>
631+
632+
</span> - function in org.bitcoindevkit.<a href=../org/bitcoindevkit/BumpFeeTxBuilderInterface.html>BumpFeeTxBuilderInterface</a>
633+
634+
635+
</dt>
636+
<dd>Set whether the dust limit is checked.</dd>
637+
638+
613639
<dt>
614640

615641
<span class="memberNameLink">
@@ -646,7 +672,7 @@ <h2 class="title">A</h2>
646672

647673

648674
</dt>
649-
<dd>&nbsp;</dd>
675+
<dd>The Amount type can be used to express Bitcoin amounts that support arithmetic and conversion to various denominations.</dd>
650676

651677

652678
<dt>
@@ -672,7 +698,7 @@ <h2 class="title">A</h2>
672698

673699

674700
</dt>
675-
<dd>&nbsp;</dd>
701+
<dd>The Amount type can be used to express Bitcoin amounts that support arithmetic and conversion to various denominations.</dd>
676702

677703

678704
<dt>

docs/.vuepress/public/java/index-files/index-10.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ <h2 class="title">J</h2>
152152

153153

154154
</dt>
155-
<dd>&nbsp;</dd>
155+
<dd>Serializes the PSBT into a JSON string representation.</dd>
156156

157157

158158
<dt>
@@ -165,7 +165,7 @@ <h2 class="title">J</h2>
165165

166166

167167
</dt>
168-
<dd>&nbsp;</dd>
168+
<dd>Serializes the PSBT into a JSON string representation.</dd>
169169

170170

171171
</dl>

0 commit comments

Comments
 (0)