-
Notifications
You must be signed in to change notification settings - Fork 45
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
13 changed files
with
1,408 additions
and
339 deletions.
There are no files selected for viewing
Binary file not shown.
Binary file not shown.
136 changes: 26 additions & 110 deletions
136
bdk-python/docs/_build/html/_modules/bdkpython/bdk.html
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,31 +1,97 @@ | ||
BDK Python API Reference | ||
===================== | ||
|
||
This document describes the Python API for the Bitcoin Development Kit (BDK). | ||
|
||
Bdk Module | ||
========== | ||
Bitcoin Module | ||
============== | ||
|
||
Examples | ||
-------- | ||
|
||
Basic Wallet Usage | ||
~~~~~~~~~~~~~~~~ | ||
|
||
.. code-block:: python | ||
from bdkpython import * | ||
# Create a new wallet | ||
descriptor = "wpkh(...)" # Your descriptor here | ||
wallet = Wallet(descriptor, network=Network.TESTNET) | ||
# Sync wallet | ||
blockchain = Blockchain("https://blockstream.info/testnet/api") | ||
wallet.sync(blockchain) | ||
# Get balance | ||
balance = wallet.get_balance() | ||
print(f"Confirmed balance: {balance.confirmed}") | ||
API Reference | ||
============ | ||
|
||
.. currentmodule:: bdkpython | ||
|
||
Core Types | ||
---------- | ||
|
||
.. autoclass:: Amount | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
.. autoclass:: FeeRate | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
.. autoclass:: Address | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
.. autoclass:: Script | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
.. autoclass:: OutPoint | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
Wallet Operations | ||
----------------- | ||
|
||
.. autoclass:: TxBuilder | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
.. autoclass:: BumpFeeTxBuilder | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
.. autoclass:: Psbt | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
.. autoclass:: ElectrumClient | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
.. autoclass:: EsploraClient | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
.. autoclass:: Wallet | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
Utilities | ||
--------- | ||
|
||
.. autoclass:: Mnemonic | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
.. autoclass:: Network | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
Exceptions | ||
---------- | ||
|
||
.. autoclass:: InternalError | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
.. autoclass:: FeeRateError | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
.. autoclass:: ParseAmountError | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
Large diffs are not rendered by default.
Oops, something went wrong.
Oops, something went wrong.