bdk-jvm/org.bitcoindevkit

Package-level declarations

The functionality exposed in this package is in fact a combination of the bdk_wallet, bdk_core, bdk_electrum, bdk_esplora, bitcoin, and miniscript crates.

Types

Address

open class Address : Disposable, AutoCloseable, AddressInterface

A bitcoin address

AddressData

sealed class AddressData

The type of address.

AddressInfo

data class AddressInfo(var index: UInt, var address: Address, var keychain: KeychainKind) : Disposable

A derived address and the index it was found at.

AddressInterface

interface AddressInterface

A bitcoin address

AddressParseException

sealed class AddressParseException : Exception

Amount

open class Amount : Disposable, AutoCloseable, AmountInterface

The Amount type can be used to express Bitcoin amounts that support arithmetic and conversion to various denominations. The operations that Amount implements will panic when overflow or underflow occurs. Also note that since the internal representation of amounts is unsigned, subtracting below zero is considered an underflow and will cause a panic.

AmountInterface

interface AmountInterface

Balance

data class Balance( var immature: Amount, var trustedPending: Amount, var untrustedPending: Amount, var confirmed: Amount, var trustedSpendable: Amount, var total: Amount) : Disposable

Balance, differentiated into various categories.

Bip32Exception

sealed class Bip32Exception : Exception

Bip39Exception

sealed class Bip39Exception : Exception

BlockId

data class BlockId(var height: UInt, var hash: String)

BumpFeeTxBuilder

open class BumpFeeTxBuilder : Disposable, AutoCloseable, BumpFeeTxBuilderInterface

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.

BumpFeeTxBuilderInterface

interface BumpFeeTxBuilderInterface

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.

CalculateFeeException

sealed class CalculateFeeException : Exception

CannotConnectException

sealed class CannotConnectException : Exception

CanonicalTx

data class CanonicalTx(var transaction: Transaction, var chainPosition: ChainPosition) : Disposable

CbfBuilder

open class CbfBuilder : Disposable, AutoCloseable, CbfBuilderInterface

Build a BIP 157/158 light client to fetch transactions for a Wallet.

CbfBuilderException

sealed class CbfBuilderException : Exception

CbfBuilderInterface

interface CbfBuilderInterface

Build a BIP 157/158 light client to fetch transactions for a Wallet.

CbfClient

open class CbfClient : Disposable, AutoCloseable, CbfClientInterface

A `CbfClient` handles wallet updates from a `CbfNode`.

CbfClientInterface

interface CbfClientInterface

A `CbfClient` handles wallet updates from a `CbfNode`.

CbfComponents

data class CbfComponents(var client: CbfClient, var node: CbfNode) : Disposable

Receive a `CbfClient` and `CbfNode`.

CbfException

sealed class CbfException : Exception

CbfNode

open class CbfNode : Disposable, AutoCloseable, CbfNodeInterface

A `CbfNode` gathers transactions for a `Wallet`. To receive `Update` for `Wallet`, refer to the `CbfClient`. The `CbfNode` will run until instructed to stop.

CbfNodeInterface

interface CbfNodeInterface

A `CbfNode` gathers transactions for a `Wallet`. To receive `Update` for `Wallet`, refer to the `CbfClient`. The `CbfNode` will run until instructed to stop.

ChainPosition

sealed class ChainPosition

Represents the observed position of some chain data.

ChangeSet

open class ChangeSet : Disposable, AutoCloseable, ChangeSetInterface

A changeset for `Wallet`.

ChangeSetInterface

interface ChangeSetInterface

A changeset for `Wallet`.

ChangeSpendPolicy

enum ChangeSpendPolicy : Enum<ChangeSpendPolicy>

Policy regarding the use of change outputs when creating a transaction.

Condition

data class Condition(var csv: UInt?, var timelock: LockTime?)

ConfirmationBlockTime

data class ConfirmationBlockTime(var blockId: BlockId, var confirmationTime: ULong)

Connection

open class Connection : Disposable, AutoCloseable, ConnectionInterface

A connection to a SQLite database.

ConnectionInterface

interface ConnectionInterface

A connection to a SQLite database.

CreateTxException

sealed class CreateTxException : Exception

CreateWithPersistException

sealed class CreateWithPersistException : Exception

DerivationPath

open class DerivationPath : Disposable, AutoCloseable, DerivationPathInterface

DerivationPathInterface

interface DerivationPathInterface

Descriptor

open class Descriptor : Disposable, AutoCloseable, DescriptorInterface

DescriptorException

sealed class DescriptorException : Exception

DescriptorInterface

interface DescriptorInterface

DescriptorKeyException

sealed class DescriptorKeyException : Exception

DescriptorPublicKey

open class DescriptorPublicKey : Disposable, AutoCloseable, DescriptorPublicKeyInterface

DescriptorPublicKeyInterface

interface DescriptorPublicKeyInterface

DescriptorSecretKey

open class DescriptorSecretKey : Disposable, AutoCloseable, DescriptorSecretKeyInterface

DescriptorSecretKeyInterface

interface DescriptorSecretKeyInterface

Disposable

interface Disposable

ElectrumClient

open class ElectrumClient : Disposable, AutoCloseable, ElectrumClientInterface

Wrapper around an electrum_client::ElectrumApi which includes an internal in-memory transaction cache to avoid re-fetching already downloaded transactions.

ElectrumClientInterface

interface ElectrumClientInterface

Wrapper around an electrum_client::ElectrumApi which includes an internal in-memory transaction cache to avoid re-fetching already downloaded transactions.

ElectrumException

sealed class ElectrumException : Exception

EsploraClient

open class EsploraClient : Disposable, AutoCloseable, EsploraClientInterface

Wrapper around an esplora_client::BlockingClient which includes an internal in-memory transaction cache to avoid re-fetching already downloaded transactions.

EsploraClientInterface

interface EsploraClientInterface

Wrapper around an esplora_client::BlockingClient which includes an internal in-memory transaction cache to avoid re-fetching already downloaded transactions.

EsploraException

sealed class EsploraException : Exception

ExtractTxException

sealed class ExtractTxException : Exception

FeeRate

open class FeeRate : Disposable, AutoCloseable, FeeRateInterface

Represents fee rate.

FeeRateException

sealed class FeeRateException : Exception

FeeRateInterface

interface FeeRateInterface

Represents fee rate.

FinalizedPsbtResult

data class FinalizedPsbtResult(var psbt: Psbt, var couldFinalize: Boolean, var errors: List<PsbtFinalizeException>?) : Disposable

FromScriptException

sealed class FromScriptException : Exception

FullScanRequest

open class FullScanRequest : Disposable, AutoCloseable, FullScanRequestInterface

FullScanRequestBuilder

open class FullScanRequestBuilder : Disposable, AutoCloseable, FullScanRequestBuilderInterface

Builds a `FullScanRequest`.

FullScanRequestBuilderInterface

interface FullScanRequestBuilderInterface

Builds a `FullScanRequest`.

FullScanRequestInterface

interface FullScanRequestInterface

FullScanScriptInspector

interface FullScanScriptInspector

FullScanScriptInspectorImpl

open class FullScanScriptInspectorImpl : Disposable, AutoCloseable, FullScanScriptInspector

Header

data class Header(var version: Int, var prevBlockhash: String, var merkleRoot: String, var time: UInt, var bits: UInt, var nonce: UInt)

Bitcoin block header. Contains all the block’s information except the actual transactions, but including a root of a merkle tree committing to all transactions in the block.

HeaderNotification

data class HeaderNotification(var height: ULong, var header: Header)

Notification of a new block header.

InternalException

class InternalException(message: String) : Exception

IpAddress

open class IpAddress : Disposable, AutoCloseable, IpAddressInterface

An IP address to connect to over TCP.

IpAddressInterface

interface IpAddressInterface

An IP address to connect to over TCP.

KeychainAndIndex

data class KeychainAndIndex(var keychain: KeychainKind, var index: UInt)

KeychainKind

enum KeychainKind : Enum<KeychainKind>

Types of keychains

LoadWithPersistException

sealed class LoadWithPersistException : Exception

LocalOutput

data class LocalOutput( var outpoint: OutPoint, var txout: TxOut, var keychain: KeychainKind, var isSpent: Boolean, var derivationIndex: UInt, var chainPosition: ChainPosition) : Disposable

An unspent output owned by a `Wallet`.

LockTime

sealed class LockTime

Log

sealed class Log

A log message from the node.

LogLevel

enum LogLevel : Enum<LogLevel>

Select the category of messages for the node to emit.

MiniscriptException

sealed class MiniscriptException : Exception

Mnemonic

open class Mnemonic : Disposable, AutoCloseable, MnemonicInterface

MnemonicInterface

interface MnemonicInterface

Network

enum Network : Enum<Network>

NodeState

enum NodeState : Enum<NodeState>

The state of the node with respect to connected peers.

OutPoint

data class OutPoint(var txid: String, var vout: UInt)

ParseAmountException

sealed class ParseAmountException : Exception

Peer

data class Peer(var address: IpAddress, var port: UShort?, var v2Transport: Boolean) : Disposable

A peer to connect to over the Bitcoin peer-to-peer network.

PersistenceException

sealed class PersistenceException : Exception

PkOrF

sealed class PkOrF

Policy

open class Policy : Disposable, AutoCloseable, PolicyInterface

PolicyInterface

interface PolicyInterface

Psbt

open class Psbt : Disposable, AutoCloseable, PsbtInterface

A Partially Signed Transaction.

PsbtException

sealed class PsbtException : Exception

PsbtFinalizeException

sealed class PsbtFinalizeException : Exception

PsbtInterface

interface PsbtInterface

A Partially Signed Transaction.

PsbtParseException

sealed class PsbtParseException : Exception

RequestBuilderException

sealed class RequestBuilderException : Exception

Satisfaction

sealed class Satisfaction

SatisfiableItem

sealed class SatisfiableItem : Disposable

ScanType

sealed class ScanType

Sync a wallet from the last known block hash, recover a wallet from a specified height, or perform an expedited block header download for a new wallet.

Script

open class Script : Disposable, AutoCloseable, ScriptInterface

A bitcoin script: https://en.bitcoin.it/wiki/Script

ScriptAmount

data class ScriptAmount(var script: Script, var amount: Amount) : Disposable

ScriptInterface

interface ScriptInterface

A bitcoin script: https://en.bitcoin.it/wiki/Script

SentAndReceivedValues

data class SentAndReceivedValues(var sent: Amount, var received: Amount) : Disposable

ServerFeaturesRes

data class ServerFeaturesRes( var serverVersion: String, var genesisHash: String, var protocolMin: String, var protocolMax: String, var hashFunction: String?, var pruning: Long?)

Response to an ElectrumClient.server_features request.

SignerException

sealed class SignerException : Exception

SignOptions

data class SignOptions( var trustWitnessUtxo: Boolean, var assumeHeight: UInt?, var allowAllSighashes: Boolean, var tryFinalize: Boolean, var signWithTapInternalKey: Boolean, var allowGrinding: Boolean)

Options for a software signer.

SqliteException

sealed class SqliteException : Exception

SyncRequest

open class SyncRequest : Disposable, AutoCloseable, SyncRequestInterface

SyncRequestBuilder

open class SyncRequestBuilder : Disposable, AutoCloseable, SyncRequestBuilderInterface

Builds a `SyncRequest`.

SyncRequestBuilderInterface

interface SyncRequestBuilderInterface

Builds a `SyncRequest`.

SyncRequestInterface

interface SyncRequestInterface

SyncScriptInspector

interface SyncScriptInspector

SyncScriptInspectorImpl

open class SyncScriptInspectorImpl : Disposable, AutoCloseable, SyncScriptInspector

Transaction

open class Transaction : Disposable, AutoCloseable, TransactionInterface

Bitcoin transaction. An authenticated movement of coins.

TransactionException

sealed class TransactionException : Exception

TransactionInterface

interface TransactionInterface

Bitcoin transaction. An authenticated movement of coins.

data class Tx(var txid: String, var version: Int, var locktime: UInt, var size: ULong, var weight: ULong, var fee: ULong, var status: TxStatus)

TxBuilder

open class TxBuilder : Disposable, AutoCloseable, TxBuilderInterface

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.

TxBuilderInterface

interface TxBuilderInterface

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.

TxidParseException

sealed class TxidParseException : Exception

TxIn

data class TxIn(var previousOutput: OutPoint, var scriptSig: Script, var sequence: UInt, var witness: List<List<UByte>>) : Disposable

TxOut

data class TxOut(var value: ULong, var scriptPubkey: Script) : Disposable

Bitcoin transaction output.

TxStatus

data class TxStatus(var confirmed: Boolean, var blockHeight: UInt?, var blockHash: String?, var blockTime: ULong?)

UnconfirmedTx

data class UnconfirmedTx(var tx: Transaction, var lastSeen: ULong) : Disposable

This type replaces the Rust tuple (tx, last_seen) used in the Wallet::apply_unconfirmed_txsmethod, where last_seenis the timestamp of when the transaction tx` was last seen in the mempool.