Contents:
WalletThis document describes the Python API for the Bitcoin Development Kit (BDK).
-Bases: object
Get as many descriptors as different paths in this descriptor.
-For multipath descriptors it will return as many descriptors as there is -“parallel” paths. For regular descriptors it will just return itself.
-Bases: object
Bases: object
Bases: object
A TxBuilder is created by calling build_tx on a wallet. After assigning it, you set options on it until finally -calling finish to consume the builder and generate the transaction.
- - -Fill-in the PSBT_GLOBAL_XPUB field with the extended keys contained in both the external and internal -descriptors.
-This is useful for offline signers that take part to a multisig. Some hardware wallets like BitBox and ColdCard -are known to require this.
-Add a recipient to the internal list of recipients.
-Add a utxo to the internal list of unspendable utxos.
-It’s important to note that the “must-be-spent” utxos added with TxBuilder::add_utxo have priority over this.
-Add a utxo to the internal list of utxos that must be spent.
-These have priority over the “unspendable” utxos, meaning that if a utxo is present both in the “utxos” and the -“unspendable” list, it will be spent.
-Set whether or not the dust limit is checked.
-Note: by avoiding a dust limit check you may end up with a transaction that is non-standard.
-Set a specific ChangeSpendPolicy. See TxBuilder::do_not_spend_change and TxBuilder::only_spend_change for -some shortcuts. This method assumes the presence of an internal keychain, otherwise it has no effect.
-Set the current blockchain height.
-This will be used to:
-1. Set the nLockTime for preventing fee sniping. Note: This will be ignored if you manually specify a -nlocktime using TxBuilder::nlocktime.
-2. Decide whether coinbase outputs are mature or not. If the coinbase outputs are not mature at current_height, -we ignore them in the coin selection. If you want to create a transaction that spends immature coinbase inputs, -manually add them using TxBuilder::add_utxos. -In both cases, if you don’t provide a current height, we use the last sync height.
-Do not spend change outputs.
-This effectively adds all the change outputs to the “unspendable” list. See TxBuilder::unspendable. This method -assumes the presence of an internal keychain, otherwise it has no effect.
-Sets the address to drain excess coins to.
-Usually, when there are excess coins they are sent to a change address generated by the wallet. This option -replaces the usual change address with an arbitrary script_pubkey of your choosing. Just as with a change output, -if the drain output is not needed (the excess coins are too small) it will not be included in the resulting -transaction. The only difference is that it is valid to use drain_to without setting any ordinary recipients -with add_recipient (but it is perfectly fine to add recipients as well).
-If you choose not to set any recipients, you should provide the utxos that the transaction should spend via -add_utxos. drain_to is very useful for draining all the coins in a wallet with drain_wallet to a single -address.
-Spend all the available inputs. This respects filters like TxBuilder::unspendable and the change policy.
-Set an absolute fee The fee_absolute method refers to the absolute transaction fee in Amount. If anyone sets -both the fee_absolute method and the fee_rate method, the FeePolicy enum will be set by whichever method was -called last, as the FeeRate and FeeAmount are mutually exclusive.
-Note that this is really a minimum absolute fee – it’s possible to overshoot it slightly since adding a change output to drain the remaining excess might not be viable.
-Set a custom fee rate.
-This method sets the mining fee paid by the transaction as a rate on its size. This means that the total fee paid -is equal to fee_rate times the size of the transaction. Default is 1 sat/vB in accordance with Bitcoin Core’s -default relay policy.
-Note that this is really a minimum feerate – it’s possible to overshoot it slightly since adding a change output -to drain the remaining excess might not be viable.
-Finish building the transaction.
-Uses the thread-local random number generator (rng).
-Returns a new Psbt per BIP174.
-WARNING: To avoid change address reuse you must persist the changes resulting from one or more calls to this -method before closing the wallet. See Wallet::reveal_next_address.
-Only spend utxos added by TxBuilder::add_utxo.
-The wallet will not add additional utxos to the transaction even if they are needed to make the transaction valid.
-Use a specific nLockTime while creating the transaction.
-This can cause conflicts if the wallet’s descriptors contain an “after” (OP_CLTV) operator.
-Only spend change outputs.
-This effectively adds all the non-change outputs to the “unspendable” list. See TxBuilder::unspendable. This -method assumes the presence of an internal keychain, otherwise it has no effect.
-The TxBuilder::policy_path is a complex API. See the Rust docs for complete information: https://docs.rs/bdk_wallet/latest/bdk_wallet/struct.TxBuilder.html#method.policy_path
-Set an exact nSequence value.
-This can cause conflicts if the wallet’s descriptors contain an “older” (OP_CSV) operator and the given -nsequence is lower than the CSV value.
-Replace the recipients already added with a new list of recipients.
-Bases: object
A BumpFeeTxBuilder is created by calling build_fee_bump on a wallet. After assigning it, you set options on it -until finally calling finish to consume the builder and generate the transaction.
-Set whether or not the dust limit is checked.
-Note: by avoiding a dust limit check you may end up with a transaction that is non-standard.
-Set the current blockchain height.
-This will be used to:
-1. Set the nLockTime for preventing fee sniping. Note: This will be ignored if you manually specify a -nlocktime using TxBuilder::nlocktime.
-2. Decide whether coinbase outputs are mature or not. If the coinbase outputs are not mature at current_height, -we ignore them in the coin selection. If you want to create a transaction that spends immature coinbase inputs, -manually add them using TxBuilder::add_utxos. -In both cases, if you don’t provide a current height, we use the last sync height.
-Finish building the transaction.
-Uses the thread-local random number generator (rng).
-Returns a new Psbt per BIP174.
-WARNING: To avoid change address reuse you must persist the changes resulting from one or more calls to this -method before closing the wallet. See Wallet::reveal_next_address.
-Use a specific nLockTime while creating the transaction.
-This can cause conflicts if the wallet’s descriptors contain an “after” (OP_CLTV) operator.
-Set an exact nSequence value.
-This can cause conflicts if the wallet’s descriptors contain an “older” (OP_CSV) operator and the given -nsequence is lower than the CSV value.
-Build a transaction with a specific version.
-The version should always be greater than 0 and greater than 1 if the wallet’s descriptors contain an “older” -(OP_CSV) operator.
-Bases: object
Bases: object
Applies an update to the wallet and stages the changes (but does not persist them).
-Usually you create an update by interacting with some blockchain data source and inserting -transactions related to your wallet into it.
-After applying updates you should persist the staged wallet changes. For an example of how -to persist staged wallet changes see [Wallet::reveal_next_address].
-Return the balance, separated into available, trusted-pending, untrusted-pending and immature -values.
-Calculates the fee of a given transaction. Returns [Amount::ZERO] if tx is a coinbase transaction.
-To calculate the fee for a [Transaction] with inputs not owned by this wallet you must -manually insert the TxOut(s) into the tx graph using the [insert_txout] function.
-Note tx does not have to be in the graph for this to work.
-Calculate the [FeeRate] for a given transaction.
-To calculate the fee rate for a [Transaction] with inputs not owned by this wallet you must -manually insert the TxOut(s) into the tx graph using the [insert_txout] function.
-Note tx does not have to be in the graph for this to work.
-Informs the wallet that you no longer intend to broadcast a tx that was built from it.
-This frees up the change address used when creating the tx for use in future transactions.
-The derivation index of this wallet. It will return None if it has not derived any addresses. -Otherwise, it will return the index of the highest address it has derived.
-Finds how the wallet derived the script pubkey spk.
-Will only return Some(_) if the wallet has given out the spk.
-Return the checksum of the public descriptor associated to keychain
-Internally calls [Self::public_descriptor] to fetch the right descriptor
-Finalize a PSBT, i.e., for each input determine if sufficient data is available to pass -validation and construct the respective scriptSig or scriptWitness. Please refer to -[BIP174](https://github.com/bitcoin/bips/blob/master/bip-0174.mediawiki#Input_Finalizer), -and [BIP371](https://github.com/bitcoin/bips/blob/master/bip-0371.mediawiki) -for further information.
-Returns true if the PSBT could be finalized, and false otherwise.
-The [SignOptions] can be used to tweak the behavior of the finalizer.
-Get a single transaction from the wallet as a [WalletTx] (if the transaction exists).
-WalletTx contains the full transaction alongside meta-data such as: -* Blocks that the transaction is [Anchor]ed in. These may or may not be blocks that exist
---in the best chain.
-
The [ChainPosition] of the transaction in the best chain - whether the transaction is -confirmed or unconfirmed. If the transaction is confirmed, the anchor which proves the -confirmation is provided. If the transaction is unconfirmed, the unix timestamp of when -the transaction was last seen in the mempool is provided.
Returns the utxo owned by this wallet corresponding to outpoint if it exists in the -wallet’s database.
-Return whether or not a script is part of this wallet (either internal or external)
-List all relevant outputs (includes both spent and unspent, confirmed and unconfirmed).
-To list only unspent outputs (UTXOs), use [Wallet::list_unspent] instead.
-List addresses that are revealed but unused.
-Note if the returned iterator is empty you can reveal more addresses -by using [reveal_next_address](Self::reveal_next_address) or -[reveal_addresses_to](Self::reveal_addresses_to).
-Marks an address used of the given keychain at index.
-Returns whether the given index was present and then removed from the unused set.
-The index of the next address that you would get if you were to ask the wallet for a new address
-Get the next unused address for the given keychain, i.e. the address with the lowest -derivation index that hasn’t been used.
-This will attempt to derive and reveal a new address if no newly revealed addresses -are available. See also [reveal_next_address](Self::reveal_next_address).
-WARNING: To avoid address reuse you must persist the changes resulting from one or more -calls to this method before closing the wallet. See [Wallet::reveal_next_address].
-Peek an address of the given keychain at index without revealing it.
-For non-wildcard descriptors this returns the same address at every provided index.
-# Panics
-This panics when the caller requests for an address of derivation index greater than the -[BIP32](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki) max index.
-Reveal addresses up to and including the target index and return an iterator -of newly revealed addresses.
-If the target index is unreachable, we make a best effort to reveal up to the last -possible index. If all addresses up to the given index are already revealed, then -no new addresses are returned.
-WARNING: To avoid address reuse you must persist the changes resulting from one or more -calls to this method before closing the wallet. See [Wallet::reveal_next_address].
-Attempt to reveal the next address of the given keychain.
-This will increment the keychain’s derivation index. If the keychain’s descriptor doesn’t -contain a wildcard or every address is already revealed up to the maximum derivation -index defined in [BIP32](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki), -then the last revealed address will be returned.
-Compute the tx’s sent and received [Amount]s.
-This method returns a tuple (sent, received). Sent is the sum of the txin amounts -that spend from previous txouts tracked by this wallet. Received is the summation -of this tx’s outputs that send to script pubkeys tracked by this wallet.
-Sign a transaction with all the wallet’s signers, in the order specified by every signer’s -[SignerOrdering]. This function returns the Result type with an encapsulated bool that has the value true if the PSBT was finalized, or false otherwise.
-The [SignOptions] can be used to tweak the behavior of the software signers, and the way -the transaction is finalized at the end. Note that it can’t be guaranteed that every -signers will follow the options, but the “software signers” (WIF keys and xprv) defined -in this library will.
-Create a [`FullScanRequest] for this wallet.
-This is the first step when performing a spk-based wallet full scan, the returned -[`FullScanRequest] collects iterators for the wallet’s keychain script pub keys needed to -start a blockchain full scan with a spk based blockchain client.
-This operation is generally only used when importing or restoring a previously used wallet -in which the list of used scripts is not known.
-Create a partial [SyncRequest] for this wallet for all revealed spks.
-This is the first step when performing a spk-based wallet partial sync, the returned -[SyncRequest] collects all revealed script pubkeys from the wallet keychain needed to -start a blockchain sync with a spk based blockchain client.
-Contents:
@@ -74,436 +73,8 @@| - | - |
| - | - |
| - | - |
| - | - |
| - | - |
| - | - |
| - | - |
| - | - |
| - |
| - | - |
| - | - |
| - |
| - | - |
| - | - |
| - | - |
| - | - |
| - |
| - |
| - |
Contents:
@@ -79,13 +78,6 @@Contents:
diff --git a/bdk-python/docs/_build/html/searchindex.js b/bdk-python/docs/_build/html/searchindex.js index 7962f3d7..0221ba7d 100644 --- a/bdk-python/docs/_build/html/searchindex.js +++ b/bdk-python/docs/_build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({"alltitles": {"API Reference": [[0, "api-reference"]], "Addresses and Scripts": [[0, "addresses-and-scripts"]], "BDK Python API Reference": [[0, null]], "Basic Wallet Usage": [[0, "basic-wallet-usage"]], "Bdk Module": [[0, "bdk-module"]], "Bitcoin Module": [[0, "bitcoin-module"]], "Blockchain Clients": [[0, "blockchain-clients"]], "Contents:": [[1, null]], "Core Types": [[0, "core-types"]], "Descriptors": [[0, "descriptors"]], "Examples": [[0, "examples"]], "Exceptions": [[0, "exceptions"]], "Indices and tables": [[1, "indices-and-tables"]], "Transaction Building": [[0, "transaction-building"]], "Utilities": [[0, "utilities"]], "Wallet": [[0, "wallet"]], "Wallet Operations": [[0, "wallet-operations"]], "Welcome to BDK Python\u2019s documentation!": [[1, null]]}, "docnames": ["api", "index"], "envversion": {"sphinx": 62, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1}, "filenames": ["api.rst", "index.rst"], "indexentries": {"add_data() (bdkpython.txbuilder method)": [[0, "bdkpython.TxBuilder.add_data", false]], "add_global_xpubs() (bdkpython.txbuilder method)": [[0, "bdkpython.TxBuilder.add_global_xpubs", false]], "add_recipient() (bdkpython.txbuilder method)": [[0, "bdkpython.TxBuilder.add_recipient", false]], "add_unspendable() (bdkpython.txbuilder method)": [[0, "bdkpython.TxBuilder.add_unspendable", false]], "add_utxo() (bdkpython.txbuilder method)": [[0, "bdkpython.TxBuilder.add_utxo", false]], "address (class in bdkpython)": [[0, "bdkpython.Address", false]], "allow_dust() (bdkpython.bumpfeetxbuilder method)": [[0, "bdkpython.BumpFeeTxBuilder.allow_dust", false]], "allow_dust() (bdkpython.txbuilder method)": [[0, "bdkpython.TxBuilder.allow_dust", false]], "apply_update() (bdkpython.wallet method)": [[0, "bdkpython.Wallet.apply_update", false]], "as_public() (bdkpython.descriptorsecretkey method)": [[0, "bdkpython.DescriptorSecretKey.as_public", false]], "as_string() (bdkpython.descriptorpublickey method)": [[0, "bdkpython.DescriptorPublicKey.as_string", false]], "as_string() (bdkpython.descriptorsecretkey method)": [[0, "bdkpython.DescriptorSecretKey.as_string", false]], "balance() (bdkpython.wallet method)": [[0, "bdkpython.Wallet.balance", false]], "broadcast() (bdkpython.electrumclient method)": [[0, "bdkpython.ElectrumClient.broadcast", false]], "broadcast() (bdkpython.esploraclient method)": [[0, "bdkpython.EsploraClient.broadcast", false]], "bumpfeetxbuilder (class in bdkpython)": [[0, "bdkpython.BumpFeeTxBuilder", false]], "calculate_fee() (bdkpython.wallet method)": [[0, "bdkpython.Wallet.calculate_fee", false]], "calculate_fee_rate() (bdkpython.wallet method)": [[0, "bdkpython.Wallet.calculate_fee_rate", false]], "cancel_tx() (bdkpython.wallet method)": [[0, "bdkpython.Wallet.cancel_tx", false]], "change_policy() (bdkpython.txbuilder method)": [[0, "bdkpython.TxBuilder.change_policy", false]], "combine() (bdkpython.psbt method)": [[0, "bdkpython.Psbt.combine", false]], "current_height() (bdkpython.bumpfeetxbuilder method)": [[0, "bdkpython.BumpFeeTxBuilder.current_height", false]], "current_height() (bdkpython.txbuilder method)": [[0, "bdkpython.TxBuilder.current_height", false]], "derivation_index() (bdkpython.wallet method)": [[0, "bdkpython.Wallet.derivation_index", false]], "derivation_of_spk() (bdkpython.wallet method)": [[0, "bdkpython.Wallet.derivation_of_spk", false]], "derivationpath (class in bdkpython)": [[0, "bdkpython.DerivationPath", false]], "derive() (bdkpython.descriptorpublickey method)": [[0, "bdkpython.DescriptorPublicKey.derive", false]], "derive() (bdkpython.descriptorsecretkey method)": [[0, "bdkpython.DescriptorSecretKey.derive", false]], "descriptor (class in bdkpython)": [[0, "bdkpython.Descriptor", false]], "descriptor_checksum() (bdkpython.wallet method)": [[0, "bdkpython.Wallet.descriptor_checksum", false]], "descriptorpublickey (class in bdkpython)": [[0, "bdkpython.DescriptorPublicKey", false]], "descriptorsecretkey (class in bdkpython)": [[0, "bdkpython.DescriptorSecretKey", false]], "do_not_spend_change() (bdkpython.txbuilder method)": [[0, "bdkpython.TxBuilder.do_not_spend_change", false]], "drain_to() (bdkpython.txbuilder method)": [[0, "bdkpython.TxBuilder.drain_to", false]], "drain_wallet() (bdkpython.txbuilder method)": [[0, "bdkpython.TxBuilder.drain_wallet", false]], "electrumclient (class in bdkpython)": [[0, "bdkpython.ElectrumClient", false]], "esploraclient (class in bdkpython)": [[0, "bdkpython.EsploraClient", false]], "extend() (bdkpython.descriptorpublickey method)": [[0, "bdkpython.DescriptorPublicKey.extend", false]], "extend() (bdkpython.descriptorsecretkey method)": [[0, "bdkpython.DescriptorSecretKey.extend", false]], "extract_tx() (bdkpython.psbt method)": [[0, "bdkpython.Psbt.extract_tx", false]], "fee() (bdkpython.psbt method)": [[0, "bdkpython.Psbt.fee", false]], "fee_absolute() (bdkpython.txbuilder method)": [[0, "bdkpython.TxBuilder.fee_absolute", false]], "fee_rate() (bdkpython.txbuilder method)": [[0, "bdkpython.TxBuilder.fee_rate", false]], "finalize() (bdkpython.psbt method)": [[0, "bdkpython.Psbt.finalize", false]], "finalize_psbt() (bdkpython.wallet method)": [[0, "bdkpython.Wallet.finalize_psbt", false]], "finish() (bdkpython.bumpfeetxbuilder method)": [[0, "bdkpython.BumpFeeTxBuilder.finish", false]], "finish() (bdkpython.txbuilder method)": [[0, "bdkpython.TxBuilder.finish", false]], "from_entropy() (bdkpython.mnemonic class method)": [[0, "bdkpython.Mnemonic.from_entropy", false]], "from_script() (bdkpython.address class method)": [[0, "bdkpython.Address.from_script", false]], "from_string() (bdkpython.descriptorpublickey class method)": [[0, "bdkpython.DescriptorPublicKey.from_string", false]], "from_string() (bdkpython.descriptorsecretkey class method)": [[0, "bdkpython.DescriptorSecretKey.from_string", false]], "from_string() (bdkpython.mnemonic class method)": [[0, "bdkpython.Mnemonic.from_string", false]], "full_scan() (bdkpython.electrumclient method)": [[0, "bdkpython.ElectrumClient.full_scan", false]], "full_scan() (bdkpython.esploraclient method)": [[0, "bdkpython.EsploraClient.full_scan", false]], "get_height() (bdkpython.esploraclient method)": [[0, "bdkpython.EsploraClient.get_height", false]], "get_tx() (bdkpython.esploraclient method)": [[0, "bdkpython.EsploraClient.get_tx", false]], "get_tx() (bdkpython.wallet method)": [[0, "bdkpython.Wallet.get_tx", false]], "get_utxo() (bdkpython.wallet method)": [[0, "bdkpython.Wallet.get_utxo", false]], "internalerror": [[0, "bdkpython.InternalError", false]], "is_mine() (bdkpython.wallet method)": [[0, "bdkpython.Wallet.is_mine", false]], "is_multipath() (bdkpython.descriptor method)": [[0, "bdkpython.Descriptor.is_multipath", false]], "is_multipath() (bdkpython.descriptorpublickey method)": [[0, "bdkpython.DescriptorPublicKey.is_multipath", false]], "is_valid_for_network() (bdkpython.address method)": [[0, "bdkpython.Address.is_valid_for_network", false]], "json_serialize() (bdkpython.psbt method)": [[0, "bdkpython.Psbt.json_serialize", false]], "list_output() (bdkpython.wallet method)": [[0, "bdkpython.Wallet.list_output", false]], "list_unspent() (bdkpython.wallet method)": [[0, "bdkpython.Wallet.list_unspent", false]], "list_unused_addresses() (bdkpython.wallet method)": [[0, "bdkpython.Wallet.list_unused_addresses", false]], "load() (bdkpython.wallet class method)": [[0, "bdkpython.Wallet.load", false]], "manually_selected_only() (bdkpython.txbuilder method)": [[0, "bdkpython.TxBuilder.manually_selected_only", false]], "mark_used() (bdkpython.wallet method)": [[0, "bdkpython.Wallet.mark_used", false]], "master_fingerprint() (bdkpython.descriptorpublickey method)": [[0, "bdkpython.DescriptorPublicKey.master_fingerprint", false]], "mnemonic (class in bdkpython)": [[0, "bdkpython.Mnemonic", false]], "network() (bdkpython.wallet method)": [[0, "bdkpython.Wallet.network", false]], "new_bip44() (bdkpython.descriptor class method)": [[0, "bdkpython.Descriptor.new_bip44", false]], "new_bip44_public() (bdkpython.descriptor class method)": [[0, "bdkpython.Descriptor.new_bip44_public", false]], "new_bip49() (bdkpython.descriptor class method)": [[0, "bdkpython.Descriptor.new_bip49", false]], "new_bip49_public() (bdkpython.descriptor class method)": [[0, "bdkpython.Descriptor.new_bip49_public", false]], "new_bip84() (bdkpython.descriptor class method)": [[0, "bdkpython.Descriptor.new_bip84", false]], "new_bip84_public() (bdkpython.descriptor class method)": [[0, "bdkpython.Descriptor.new_bip84_public", false]], "new_bip86() (bdkpython.descriptor class method)": [[0, "bdkpython.Descriptor.new_bip86", false]], "new_bip86_public() (bdkpython.descriptor class method)": [[0, "bdkpython.Descriptor.new_bip86_public", false]], "next_derivation_index() (bdkpython.wallet method)": [[0, "bdkpython.Wallet.next_derivation_index", false]], "next_unused_address() (bdkpython.wallet method)": [[0, "bdkpython.Wallet.next_unused_address", false]], "nlocktime() (bdkpython.bumpfeetxbuilder method)": [[0, "bdkpython.BumpFeeTxBuilder.nlocktime", false]], "nlocktime() (bdkpython.txbuilder method)": [[0, "bdkpython.TxBuilder.nlocktime", false]], "only_spend_change() (bdkpython.txbuilder method)": [[0, "bdkpython.TxBuilder.only_spend_change", false]], "peek_address() (bdkpython.wallet method)": [[0, "bdkpython.Wallet.peek_address", false]], "persist() (bdkpython.wallet method)": [[0, "bdkpython.Wallet.persist", false]], "policies() (bdkpython.wallet method)": [[0, "bdkpython.Wallet.policies", false]], "policy_path() (bdkpython.txbuilder method)": [[0, "bdkpython.TxBuilder.policy_path", false]], "psbt (class in bdkpython)": [[0, "bdkpython.Psbt", false]], "reveal_addresses_to() (bdkpython.wallet method)": [[0, "bdkpython.Wallet.reveal_addresses_to", false]], "reveal_next_address() (bdkpython.wallet method)": [[0, "bdkpython.Wallet.reveal_next_address", false]], "script_pubkey() (bdkpython.address method)": [[0, "bdkpython.Address.script_pubkey", false]], "secret_bytes() (bdkpython.descriptorsecretkey method)": [[0, "bdkpython.DescriptorSecretKey.secret_bytes", false]], "sent_and_received() (bdkpython.wallet method)": [[0, "bdkpython.Wallet.sent_and_received", false]], "serialize() (bdkpython.psbt method)": [[0, "bdkpython.Psbt.serialize", false]], "set_exact_sequence() (bdkpython.bumpfeetxbuilder method)": [[0, "bdkpython.BumpFeeTxBuilder.set_exact_sequence", false]], "set_exact_sequence() (bdkpython.txbuilder method)": [[0, "bdkpython.TxBuilder.set_exact_sequence", false]], "set_recipients() (bdkpython.txbuilder method)": [[0, "bdkpython.TxBuilder.set_recipients", false]], "sign() (bdkpython.wallet method)": [[0, "bdkpython.Wallet.sign", false]], "start_full_scan() (bdkpython.wallet method)": [[0, "bdkpython.Wallet.start_full_scan", false]], "start_sync_with_revealed_spks() (bdkpython.wallet method)": [[0, "bdkpython.Wallet.start_sync_with_revealed_spks", false]], "sync() (bdkpython.electrumclient method)": [[0, "bdkpython.ElectrumClient.sync", false]], "sync() (bdkpython.esploraclient method)": [[0, "bdkpython.EsploraClient.sync", false]], "to_qr_uri() (bdkpython.address method)": [[0, "bdkpython.Address.to_qr_uri", false]], "to_single_descriptors() (bdkpython.descriptor method)": [[0, "bdkpython.Descriptor.to_single_descriptors", false]], "to_string_with_secret() (bdkpython.descriptor method)": [[0, "bdkpython.Descriptor.to_string_with_secret", false]], "transactions() (bdkpython.wallet method)": [[0, "bdkpython.Wallet.transactions", false]], "txbuilder (class in bdkpython)": [[0, "bdkpython.TxBuilder", false]], "unspendable() (bdkpython.txbuilder method)": [[0, "bdkpython.TxBuilder.unspendable", false]], "version() (bdkpython.bumpfeetxbuilder method)": [[0, "bdkpython.BumpFeeTxBuilder.version", false]], "version() (bdkpython.txbuilder method)": [[0, "bdkpython.TxBuilder.version", false]], "wallet (class in bdkpython)": [[0, "bdkpython.Wallet", false]]}, "objects": {"bdkpython": [[0, 0, 1, "", "Address"], [0, 0, 1, "", "BumpFeeTxBuilder"], [0, 0, 1, "", "DerivationPath"], [0, 0, 1, "", "Descriptor"], [0, 0, 1, "", "DescriptorPublicKey"], [0, 0, 1, "", "DescriptorSecretKey"], [0, 0, 1, "", "ElectrumClient"], [0, 0, 1, "", "EsploraClient"], [0, 2, 1, "", "InternalError"], [0, 0, 1, "", "Mnemonic"], [0, 0, 1, "", "Psbt"], [0, 0, 1, "", "TxBuilder"], [0, 0, 1, "", "Wallet"]], "bdkpython.Address": [[0, 1, 1, "", "from_script"], [0, 1, 1, "", "is_valid_for_network"], [0, 1, 1, "", "script_pubkey"], [0, 1, 1, "", "to_qr_uri"]], "bdkpython.BumpFeeTxBuilder": [[0, 1, 1, "", "allow_dust"], [0, 1, 1, "", "current_height"], [0, 1, 1, "", "finish"], [0, 1, 1, "", "nlocktime"], [0, 1, 1, "", "set_exact_sequence"], [0, 1, 1, "", "version"]], "bdkpython.Descriptor": [[0, 1, 1, "", "is_multipath"], [0, 1, 1, "", "new_bip44"], [0, 1, 1, "", "new_bip44_public"], [0, 1, 1, "", "new_bip49"], [0, 1, 1, "", "new_bip49_public"], [0, 1, 1, "", "new_bip84"], [0, 1, 1, "", "new_bip84_public"], [0, 1, 1, "", "new_bip86"], [0, 1, 1, "", "new_bip86_public"], [0, 1, 1, "", "to_single_descriptors"], [0, 1, 1, "", "to_string_with_secret"]], "bdkpython.DescriptorPublicKey": [[0, 1, 1, "", "as_string"], [0, 1, 1, "", "derive"], [0, 1, 1, "", "extend"], [0, 1, 1, "", "from_string"], [0, 1, 1, "", "is_multipath"], [0, 1, 1, "", "master_fingerprint"]], "bdkpython.DescriptorSecretKey": [[0, 1, 1, "", "as_public"], [0, 1, 1, "", "as_string"], [0, 1, 1, "", "derive"], [0, 1, 1, "", "extend"], [0, 1, 1, "", "from_string"], [0, 1, 1, "", "secret_bytes"]], "bdkpython.ElectrumClient": [[0, 1, 1, "", "broadcast"], [0, 1, 1, "", "full_scan"], [0, 1, 1, "", "sync"]], "bdkpython.EsploraClient": [[0, 1, 1, "", "broadcast"], [0, 1, 1, "", "full_scan"], [0, 1, 1, "", "get_height"], [0, 1, 1, "", "get_tx"], [0, 1, 1, "", "sync"]], "bdkpython.Mnemonic": [[0, 1, 1, "", "from_entropy"], [0, 1, 1, "", "from_string"]], "bdkpython.Psbt": [[0, 1, 1, "", "combine"], [0, 1, 1, "", "extract_tx"], [0, 1, 1, "", "fee"], [0, 1, 1, "", "finalize"], [0, 1, 1, "", "json_serialize"], [0, 1, 1, "", "serialize"]], "bdkpython.TxBuilder": [[0, 1, 1, "", "add_data"], [0, 1, 1, "", "add_global_xpubs"], [0, 1, 1, "", "add_recipient"], [0, 1, 1, "", "add_unspendable"], [0, 1, 1, "", "add_utxo"], [0, 1, 1, "", "allow_dust"], [0, 1, 1, "", "change_policy"], [0, 1, 1, "", "current_height"], [0, 1, 1, "", "do_not_spend_change"], [0, 1, 1, "", "drain_to"], [0, 1, 1, "", "drain_wallet"], [0, 1, 1, "", "fee_absolute"], [0, 1, 1, "", "fee_rate"], [0, 1, 1, "", "finish"], [0, 1, 1, "", "manually_selected_only"], [0, 1, 1, "", "nlocktime"], [0, 1, 1, "", "only_spend_change"], [0, 1, 1, "", "policy_path"], [0, 1, 1, "", "set_exact_sequence"], [0, 1, 1, "", "set_recipients"], [0, 1, 1, "", "unspendable"], [0, 1, 1, "", "version"]], "bdkpython.Wallet": [[0, 1, 1, "", "apply_update"], [0, 1, 1, "", "balance"], [0, 1, 1, "", "calculate_fee"], [0, 1, 1, "", "calculate_fee_rate"], [0, 1, 1, "", "cancel_tx"], [0, 1, 1, "", "derivation_index"], [0, 1, 1, "", "derivation_of_spk"], [0, 1, 1, "", "descriptor_checksum"], [0, 1, 1, "", "finalize_psbt"], [0, 1, 1, "", "get_tx"], [0, 1, 1, "", "get_utxo"], [0, 1, 1, "", "is_mine"], [0, 1, 1, "", "list_output"], [0, 1, 1, "", "list_unspent"], [0, 1, 1, "", "list_unused_addresses"], [0, 1, 1, "", "load"], [0, 1, 1, "", "mark_used"], [0, 1, 1, "", "network"], [0, 1, 1, "", "next_derivation_index"], [0, 1, 1, "", "next_unused_address"], [0, 1, 1, "", "peek_address"], [0, 1, 1, "", "persist"], [0, 1, 1, "", "policies"], [0, 1, 1, "", "reveal_addresses_to"], [0, 1, 1, "", "reveal_next_address"], [0, 1, 1, "", "sent_and_received"], [0, 1, 1, "", "sign"], [0, 1, 1, "", "start_full_scan"], [0, 1, 1, "", "start_sync_with_revealed_spks"], [0, 1, 1, "", "transactions"]]}, "objnames": {"0": ["py", "class", "Python class"], "1": ["py", "method", "Python method"], "2": ["py", "exception", "Python exception"]}, "objtypes": {"0": "py:class", "1": "py:method", "2": "py:exception"}, "terms": {"": 0, "0": 0, "0032": 0, "0174": 0, "0371": 0, "0x00000000": 0, "1": 0, "2": 0, "A": 0, "For": 0, "If": 0, "In": 0, "It": 0, "The": 0, "These": 0, "To": 0, "Will": 0, "_": 0, "absolut": 0, "accord": 0, "ad": 0, "add": 0, "add_data": 0, "add_global_xpub": 0, "add_recipi": 0, "add_unspend": 0, "add_utxo": 0, "addit": 0, "addressinfo": 0, "after": 0, "all": 0, "allow_dust": 0, "alongsid": 0, "alreadi": 0, "also": 0, "alwai": 0, "amount": 0, "an": 0, "anchor": 0, "ani": 0, "anyon": 0, "api": 1, "appli": 0, "apply_upd": 0, "ar": 0, "arbitrari": 0, "arg": 0, "as_publ": 0, "as_str": 0, "ask": 0, "assign": 0, "associ": 0, "assum": 0, "attempt": 0, "avail": 0, "avoid": 0, "balanc": 0, "base": 0, "batch_siz": 0, "bdk_wallet": 0, "bdkpython": 0, "been": 0, "befor": 0, "behavior": 0, "best": 0, "bip": 0, "bip174": 0, "bip32": 0, "bip371": 0, "bitbox": 0, "bitcoin": 1, "blob": 0, "block": 0, "blockchain": [], "blockstream": 0, "bool": 0, "both": 0, "broadcast": 0, "build_fee_bump": 0, "build_tx": 0, "builder": 0, "built": 0, "bumpfeetxbuild": 0, "calcul": 0, "calculate_fe": 0, "calculate_fee_r": 0, "call": 0, "caller": 0, "can": 0, "cancel_tx": 0, "canonicaltx": 0, "case": 0, "caus": 0, "chain": 0, "chainposit": 0, "chang": 0, "change_descriptor": 0, "change_polici": 0, "changespendpolici": 0, "check": 0, "checksum": 0, "choos": 0, "class": 0, "classmethod": 0, "close": 0, "coin": 0, "coinbas": 0, "coldcard": 0, "collect": 0, "com": 0, "combin": 0, "complet": 0, "complex": 0, "comput": 0, "confirm": 0, "conflict": 0, "connect": 0, "construct": 0, "consum": 0, "contain": 0, "core": 1, "correspond": 0, "could": 0, "creat": 0, "csv": 0, "current": 0, "current_height": 0, "custom": 0, "data": 0, "databas": 0, "decid": 0, "default": 0, "defin": 0, "deriv": 0, "derivation_index": 0, "derivation_of_spk": 0, "derivationpath": 0, "describ": 0, "descriptor": [], "descriptor_checksum": 0, "descriptorpublickei": 0, "descriptorsecretkei": 0, "determin": 0, "develop": 0, "dict": 0, "differ": 0, "do": 0, "do_not_spend_chang": 0, "doc": 0, "document": 0, "doe": 0, "doesn": 0, "don": 0, "drain": 0, "drain_to": 0, "drain_wallet": 0, "dust": 0, "e": 0, "each": 0, "ed": 0, "effect": 0, "effort": 0, "either": 0, "electrumcli": 0, "empti": 0, "encapsul": 0, "end": 0, "entropi": 0, "enum": 0, "equal": 0, "esploracli": 0, "even": 0, "everi": 0, "exact": 0, "exampl": 1, "except": 1, "excess": 0, "exclus": 0, "exist": 0, "extend": 0, "extern": 0, "extract_tx": 0, "f": 0, "fals": 0, "fee": 0, "fee_absolut": 0, "fee_rat": 0, "feeamount": 0, "feepolici": 0, "feerat": 0, "fetch": 0, "fetch_prev_txout": 0, "field": 0, "fill": 0, "filter": 0, "final": 0, "finalize_psbt": 0, "finalizedpsbtresult": 0, "find": 0, "fine": 0, "fingerprint": 0, "finish": 0, "first": 0, "follow": 0, "free": 0, "from": 0, "from_entropi": 0, "from_script": 0, "from_str": 0, "full": 0, "full_scan": 0, "full_scan_request": 0, "fullscanrequest": 0, "fullscanrequestbuild": 0, "function": 0, "further": 0, "futur": 0, "gener": 0, "get": 0, "get_bal": 0, "get_height": 0, "get_tx": 0, "get_utxo": 0, "github": 0, "given": 0, "graph": 0, "greater": 0, "guarante": 0, "ha": 0, "hardwar": 0, "hasn": 0, "have": 0, "height": 0, "here": 0, "highest": 0, "how": 0, "html": 0, "http": 0, "i": 0, "ignor": 0, "immatur": 0, "import": 0, "includ": 0, "increment": 0, "index": [0, 1], "info": 0, "inform": 0, "input": 0, "input_fin": 0, "insert": 0, "insert_txout": 0, "instead": 0, "int": 0, "intend": 0, "interact": 0, "intern": 0, "internalerror": 0, "is_min": 0, "is_multipath": 0, "is_valid_for_network": 0, "iter": 0, "its": 0, "itself": 0, "json_seri": 0, "just": 0, "kei": 0, "keychain": 0, "keychainandindex": 0, "keychainkind": 0, "kit": 0, "known": 0, "kwarg": 0, "last": 0, "latest": 0, "librari": 0, "like": 0, "limit": 0, "list": 0, "list_output": 0, "list_unsp": 0, "list_unused_address": 0, "load": 0, "local": 0, "localoutput": 0, "locktim": 0, "longer": 0, "lower": 0, "lowest": 0, "mai": 0, "make": 0, "mani": 0, "manual": 0, "manually_selected_onli": 0, "mark": 0, "mark_us": 0, "master": 0, "master_fingerprint": 0, "matur": 0, "max": 0, "maximum": 0, "mean": 0, "mediawiki": 0, "mempool": 0, "meta": 0, "method": 0, "might": 0, "mine": 0, "minimum": 0, "mnemon": 0, "modul": 1, "more": 0, "multipath": 0, "multipl": 0, "multisig": 0, "must": 0, "mutual": 0, "need": 0, "network": 0, "new": 0, "new_bip44": 0, "new_bip44_publ": 0, "new_bip49": 0, "new_bip49_publ": 0, "new_bip84": 0, "new_bip84_publ": 0, "new_bip86": 0, "new_bip86_publ": 0, "newli": 0, "next": 0, "next_derivation_index": 0, "next_unused_address": 0, "nlocktim": 0, "non": 0, "none": 0, "note": 0, "nsequenc": 0, "number": 0, "object": 0, "offlin": 0, "older": 0, "one": 0, "onli": 0, "only_spend_chang": 0, "op": 0, "op_cltv": 0, "op_csv": 0, "op_return": 0, "oper": 1, "option": 0, "order": 0, "ordinari": 0, "other": 0, "otherwis": 0, "out": 0, "outpoint": 0, "output": 0, "over": 0, "overshoot": 0, "own": 0, "page": 1, "paid": 0, "panic": 0, "parallel": 0, "parallel_request": 0, "part": 0, "partial": 0, "pass": 0, "password": 0, "path": 0, "peek": 0, "peek_address": 0, "pend": 0, "per": 0, "perfectli": 0, "perform": 0, "persist": 0, "pleas": 0, "polici": 0, "policy_path": 0, "possibl": 0, "presenc": 0, "present": 0, "prevent": 0, "previou": 0, "previous": 0, "print": 0, "prioriti": 0, "prove": 0, "provid": 0, "psbt": 0, "psbt_base64": 0, "psbt_global_xpub": 0, "pub": 0, "pubkei": 0, "public": 0, "public_descriptor": 0, "public_kei": 0, "r": 0, "random": 0, "rate": 0, "realli": 0, "receiv": 0, "recipi": 0, "refer": 1, "regular": 0, "relai": 0, "relat": 0, "relev": 0, "remain": 0, "remov": 0, "replac": 0, "request": 0, "requir": 0, "respect": 0, "restor": 0, "result": 0, "return": 0, "reus": 0, "reveal": 0, "reveal_addresses_to": 0, "reveal_next_address": 0, "right": 0, "rng": 0, "rust": 0, "same": 0, "sat": 0, "scan": 0, "script_pubkei": 0, "scriptamount": 0, "scriptsig": 0, "scriptwit": 0, "search": 1, "secret_byt": 0, "secret_kei": 0, "see": 0, "seen": 0, "select": 0, "self": 0, "send": 0, "sent": 0, "sent_and_receiv": 0, "sentandreceivedvalu": 0, "separ": 0, "serial": 0, "set": 0, "set_exact_sequ": 0, "set_recipi": 0, "shortcut": 0, "should": 0, "sign": 0, "signer": 0, "signerord": 0, "signopt": 0, "sinc": 0, "singl": 0, "size": 0, "slightli": 0, "small": 0, "snipe": 0, "softwar": 0, "some": 0, "sourc": 0, "specif": 0, "specifi": 0, "spend": 0, "spent": 0, "spk": 0, "stage": 0, "standard": 0, "start": 0, "start_full_scan": 0, "start_sync_with_revealed_spk": 0, "step": 0, "stop_gap": 0, "str": 0, "struct": 0, "suffici": 0, "sum": 0, "summat": 0, "sync": 0, "sync_request": 0, "syncrequest": 0, "syncrequestbuild": 0, "t": 0, "take": 0, "target": 0, "testnet": 0, "than": 0, "thei": 0, "them": 0, "thi": 0, "thread": 0, "time": 0, "timestamp": 0, "to_qr_uri": 0, "to_single_descriptor": 0, "to_string_with_secret": 0, "too": 0, "total": 0, "track": 0, "true": 0, "trust": 0, "tupl": 0, "tweak": 0, "tx": 0, "txbuilder": 0, "txid": 0, "txin": 0, "txout": 0, "type": 1, "unconfirm": 0, "unix": 0, "unreach": 0, "unspend": 0, "unspent": 0, "until": 0, "untrust": 0, "unus": 0, "up": 0, "updat": 0, "url": 0, "us": 0, "usual": 0, "util": 1, "utxo": 0, "valid": 0, "valu": 0, "vb": 0, "veri": 0, "version": 0, "via": 0, "viabl": 0, "wa": 0, "wai": 0, "wallet": 1, "wallettx": 0, "want": 0, "warn": 0, "we": 0, "well": 0, "were": 0, "when": 0, "whether": 0, "which": 0, "whichev": 0, "while": 0, "wif": 0, "wildcard": 0, "without": 0, "word_count": 0, "wordcount": 0, "work": 0, "would": 0, "wpkh": 0, "xprv": 0, "you": 0, "your": 0, "zero": 0}, "titles": ["BDK Python API Reference", "Welcome to BDK Python\u2019s documentation!"], "titleterms": {"": 1, "address": 0, "amount": [], "api": 0, "basic": 0, "bdk": [0, 1], "bitcoin": 0, "blockchain": 0, "build": 0, "client": 0, "content": 1, "core": 0, "descriptor": 0, "document": 1, "exampl": 0, "except": 0, "fee": [], "indic": 1, "modul": 0, "oper": 0, "python": [0, 1], "refer": 0, "script": 0, "tabl": 1, "transact": 0, "type": 0, "usag": 0, "util": 0, "wallet": 0, "welcom": 1}}) \ No newline at end of file +Search.setIndex({"alltitles": {"BDK Python API Reference": [[0, null]], "Basic Wallet Usage": [[0, "basic-wallet-usage"]], "Bdk Module": [[0, "bdk-module"]], "Bitcoin Module": [[0, "bitcoin-module"]], "Contents:": [[1, null]], "Examples": [[0, "examples"]], "Indices and tables": [[1, "indices-and-tables"]], "Welcome to BDK Python\u2019s documentation!": [[1, null]]}, "docnames": ["api", "index"], "envversion": {"sphinx": 62, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1}, "filenames": ["api.rst", "index.rst"], "indexentries": {}, "objects": {}, "objnames": {}, "objtypes": {}, "terms": {"": [], "0": [], "0032": [], "0174": [], "0371": [], "0x00000000": [], "1": [], "2": [], "A": [], "For": [], "If": [], "In": [], "It": [], "The": [], "These": [], "To": [], "Will": [], "_": [], "absolut": [], "accord": [], "ad": [], "add": [], "add_data": [], "add_global_xpub": [], "add_recipi": [], "add_unspend": [], "add_utxo": [], "addit": [], "addressinfo": [], "after": [], "all": [], "allow_dust": [], "alongsid": [], "alreadi": [], "also": [], "alwai": [], "amount": [], "an": [], "anchor": [], "ani": [], "anyon": [], "api": 1, "appli": [], "apply_upd": [], "ar": [], "arbitrari": [], "arg": [], "as_publ": [], "as_str": [], "ask": [], "assign": [], "associ": [], "assum": [], "attempt": [], "avail": [], "avoid": [], "balanc": 0, "base": [], "batch_siz": [], "bdk_wallet": [], "bdkpython": 0, "been": [], "befor": [], "behavior": [], "best": [], "bip": [], "bip174": [], "bip32": [], "bip371": [], "bitbox": [], "bitcoin": 1, "blob": [], "block": [], "blockchain": 0, "blockstream": 0, "bool": [], "both": [], "broadcast": [], "build_fee_bump": [], "build_tx": [], "builder": [], "built": [], "bumpfeetxbuild": [], "calcul": [], "calculate_fe": [], "calculate_fee_r": [], "call": [], "caller": [], "can": [], "cancel_tx": [], "canonicaltx": [], "case": [], "caus": [], "chain": [], "chainposit": [], "chang": [], "change_descriptor": [], "change_polici": [], "changespendpolici": [], "check": [], "checksum": [], "choos": [], "class": [], "classmethod": [], "close": [], "coin": [], "coinbas": [], "coldcard": [], "collect": [], "com": [], "combin": [], "complet": [], "complex": [], "comput": [], "confirm": 0, "conflict": [], "connect": [], "construct": [], "consum": [], "contain": [], "core": [], "correspond": [], "could": [], "creat": 0, "csv": [], "current": [], "current_height": [], "custom": [], "data": [], "databas": [], "decid": [], "default": [], "defin": [], "deriv": [], "derivation_index": [], "derivation_of_spk": [], "derivationpath": [], "describ": 0, "descriptor": 0, "descriptor_checksum": [], "descriptorpublickei": [], "descriptorsecretkei": [], "determin": [], "develop": 0, "dict": [], "differ": [], "do": [], "do_not_spend_chang": [], "doc": [], "document": 0, "doe": [], "doesn": [], "don": [], "drain": [], "drain_to": [], "drain_wallet": [], "dust": [], "e": [], "each": [], "ed": [], "effect": [], "effort": [], "either": [], "electrumcli": [], "empti": [], "encapsul": [], "end": [], "entropi": [], "enum": [], "equal": [], "esploracli": [], "even": [], "everi": [], "exact": [], "exampl": 1, "except": [], "excess": [], "exclus": [], "exist": [], "extend": [], "extern": [], "extract_tx": [], "f": 0, "fals": [], "fee": [], "fee_absolut": [], "fee_rat": [], "feeamount": [], "feepolici": [], "feerat": [], "fetch": [], "fetch_prev_txout": [], "field": [], "fill": [], "filter": [], "final": [], "finalize_psbt": [], "finalizedpsbtresult": [], "find": [], "fine": [], "fingerprint": [], "finish": [], "first": [], "follow": [], "free": [], "from": 0, "from_entropi": [], "from_script": [], "from_str": [], "full": [], "full_scan": [], "full_scan_request": [], "fullscanrequest": [], "fullscanrequestbuild": [], "function": [], "further": [], "futur": [], "gener": [], "get": 0, "get_bal": 0, "get_height": [], "get_tx": [], "get_utxo": [], "github": [], "given": [], "graph": [], "greater": [], "guarante": [], "ha": [], "hardwar": [], "hasn": [], "have": [], "height": [], "here": 0, "highest": [], "how": [], "html": [], "http": 0, "i": [], "ignor": [], "immatur": [], "import": 0, "includ": [], "increment": [], "index": 1, "info": 0, "inform": [], "input": [], "input_fin": [], "insert": [], "insert_txout": [], "instead": [], "int": [], "intend": [], "interact": [], "intern": [], "internalerror": [], "is_min": [], "is_multipath": [], "is_valid_for_network": [], "iter": [], "its": [], "itself": [], "json_seri": [], "just": [], "kei": [], "keychain": [], "keychainandindex": [], "keychainkind": [], "kit": 0, "known": [], "kwarg": [], "last": [], "latest": [], "librari": [], "like": [], "limit": [], "list": [], "list_output": [], "list_unsp": [], "list_unused_address": [], "load": [], "local": [], "localoutput": [], "locktim": [], "longer": [], "lower": [], "lowest": [], "mai": [], "make": [], "mani": [], "manual": [], "manually_selected_onli": [], "mark": [], "mark_us": [], "master": [], "master_fingerprint": [], "matur": [], "max": [], "maximum": [], "mean": [], "mediawiki": [], "mempool": [], "meta": [], "method": [], "might": [], "mine": [], "minimum": [], "mnemon": [], "modul": 1, "more": [], "multipath": [], "multipl": [], "multisig": [], "must": [], "mutual": [], "need": [], "network": 0, "new": 0, "new_bip44": [], "new_bip44_publ": [], "new_bip49": [], "new_bip49_publ": [], "new_bip84": [], "new_bip84_publ": [], "new_bip86": [], "new_bip86_publ": [], "newli": [], "next": [], "next_derivation_index": [], "next_unused_address": [], "nlocktim": [], "non": [], "none": [], "note": [], "nsequenc": [], "number": [], "object": [], "offlin": [], "older": [], "one": [], "onli": [], "only_spend_chang": [], "op": [], "op_cltv": [], "op_csv": [], "op_return": [], "oper": [], "option": [], "order": [], "ordinari": [], "other": [], "otherwis": [], "out": [], "outpoint": [], "output": [], "over": [], "overshoot": [], "own": [], "page": 1, "paid": [], "panic": [], "parallel": [], "parallel_request": [], "part": [], "partial": [], "pass": [], "password": [], "path": [], "peek": [], "peek_address": [], "pend": [], "per": [], "perfectli": [], "perform": [], "persist": [], "pleas": [], "polici": [], "policy_path": [], "possibl": [], "presenc": [], "present": [], "prevent": [], "previou": [], "previous": [], "print": 0, "prioriti": [], "prove": [], "provid": [], "psbt": [], "psbt_base64": [], "psbt_global_xpub": [], "pub": [], "pubkei": [], "public": [], "public_descriptor": [], "public_kei": [], "r": [], "random": [], "rate": [], "realli": [], "receiv": [], "recipi": [], "refer": 1, "regular": [], "relai": [], "relat": [], "relev": [], "remain": [], "remov": [], "replac": [], "request": [], "requir": [], "respect": [], "restor": [], "result": [], "return": [], "reus": [], "reveal": [], "reveal_addresses_to": [], "reveal_next_address": [], "right": [], "rng": [], "rust": [], "same": [], "sat": [], "scan": [], "script_pubkei": [], "scriptamount": [], "scriptsig": [], "scriptwit": [], "search": 1, "secret_byt": [], "secret_kei": [], "see": [], "seen": [], "select": [], "self": [], "send": [], "sent": [], "sent_and_receiv": [], "sentandreceivedvalu": [], "separ": [], "serial": [], "set": [], "set_exact_sequ": [], "set_recipi": [], "shortcut": [], "should": [], "sign": [], "signer": [], "signerord": [], "signopt": [], "sinc": [], "singl": [], "size": [], "slightli": [], "small": [], "snipe": [], "softwar": [], "some": [], "sourc": [], "specif": [], "specifi": [], "spend": [], "spent": [], "spk": [], "stage": [], "standard": [], "start": [], "start_full_scan": [], "start_sync_with_revealed_spk": [], "step": [], "stop_gap": [], "str": [], "struct": [], "suffici": [], "sum": [], "summat": [], "sync": 0, "sync_request": [], "syncrequest": [], "syncrequestbuild": [], "t": [], "take": [], "target": [], "testnet": 0, "than": [], "thei": [], "them": [], "thi": 0, "thread": [], "time": [], "timestamp": [], "to_qr_uri": [], "to_single_descriptor": [], "to_string_with_secret": [], "too": [], "total": [], "track": [], "true": [], "trust": [], "tupl": [], "tweak": [], "tx": [], "txbuilder": [], "txid": [], "txin": [], "txout": [], "type": [], "unconfirm": [], "unix": [], "unreach": [], "unspend": [], "unspent": [], "until": [], "untrust": [], "unus": [], "up": [], "updat": [], "url": [], "us": [], "usual": [], "util": [], "utxo": [], "valid": [], "valu": [], "vb": [], "veri": [], "version": [], "via": [], "viabl": [], "wa": [], "wai": [], "wallet": [], "wallettx": [], "want": [], "warn": [], "we": [], "well": [], "were": [], "when": [], "whether": [], "which": [], "whichev": [], "while": [], "wif": [], "wildcard": [], "without": [], "word_count": [], "wordcount": [], "work": [], "would": [], "wpkh": 0, "xprv": [], "you": [], "your": 0, "zero": []}, "titles": ["BDK Python API Reference", "Welcome to BDK Python\u2019s documentation!"], "titleterms": {"": 1, "address": [], "amount": [], "api": 0, "basic": 0, "bdk": [0, 1], "bitcoin": 0, "blockchain": [], "build": [], "client": [], "content": 1, "core": [], "descriptor": [], "document": 1, "exampl": 0, "except": [], "fee": [], "indic": 1, "modul": 0, "oper": [], "python": [0, 1], "refer": 0, "script": [], "tabl": 1, "transact": [], "type": [], "usag": 0, "util": [], "wallet": 0, "welcom": 1}}) \ No newline at end of file diff --git a/bdk-python/docs/api.rst b/bdk-python/docs/api.rst index 2389b668..d154c06d 100644 --- a/bdk-python/docs/api.rst +++ b/bdk-python/docs/api.rst @@ -1,99 +1,8 @@ BDK Python API Reference -========================== +===================== This document describes the Python API for the Bitcoin Development Kit (BDK). -API Reference -============== - -.. currentmodule:: bdkpython - -Core Types ------------- - -Addresses and Scripts -~~~~~~~~~~~~~~~~~~~~~~ -.. autoclass:: Address - :members: - :undoc-members: - :show-inheritance: - - -Descriptors -~~~~~~~~~~~~ -.. autoclass:: Descriptor - :members: - :undoc-members: - :show-inheritance: - -.. autoclass:: DescriptorPublicKey - :members: - :undoc-members: - :show-inheritance: - -.. autoclass:: DescriptorSecretKey - :members: - :undoc-members: - :show-inheritance: - -.. autoclass:: DerivationPath - :members: - :undoc-members: - :show-inheritance: - -Wallet Operations ------------------- - -Transaction Building -~~~~~~~~~~~~~~~~~~~~~ -.. autoclass:: TxBuilder - :members: - :undoc-members: - :show-inheritance: - -.. autoclass:: BumpFeeTxBuilder - :members: - :undoc-members: - :show-inheritance: - -.. autoclass:: Psbt - :members: - :undoc-members: - :show-inheritance: - -Blockchain Clients -~~~~~~~~~~~~~~~~~~~ -.. autoclass:: ElectrumClient - :members: - :undoc-members: - :show-inheritance: - -.. autoclass:: EsploraClient - :members: - :undoc-members: - :show-inheritance: - -Wallet -~~~~~~ -.. autoclass:: Wallet - :members: - :undoc-members: - :show-inheritance: - -Utilities ----------- -.. autoclass:: Mnemonic - :members: - :undoc-members: - :show-inheritance: - -Exceptions ------------ -.. autoexception:: InternalError - :members: - :show-inheritance: - - Bdk Module ========== Bitcoin Module @@ -103,7 +12,7 @@ Examples -------- Basic Wallet Usage -~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~ .. code-block:: python