Package org.bitcoindevkit

Types

Address

class Address(address: String)

A bitcoin address.

AddressIndex

sealed class AddressIndex

The address index selection strategy to use to derive an address from the wallet’s external descriptor.

AddressInfo

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

A derived address and the index it was found at.

Auth

sealed class Auth

Authentication mechanism for RPC connection to full node.

Balance

data class Balance( var immature: ULong, var trustedPending: ULong, var untrustedPending: ULong, var confirmed: ULong, var spendable: ULong, var total: ULong)

Balance differentiated in various categories.

Blockchain

class Blockchain(config: BlockchainConfig)

A blockchain backend.

BlockchainConfig

sealed class BlockchainConfig

Type that can contain any of the blockchain configurations defined by the library.

BlockTime

data class BlockTime(var height: UInt, var timestamp: ULong)

Block height and timestamp of a block.

BumpFeeTxBuilder

class BumpFeeTxBuilder

The BumpFeeTxBuilder is used to bump the fee on a transaction that has been broadcast and has its RBF flag set to true.

DatabaseConfig

sealed class DatabaseConfig

Type that can contain any of the database configurations defined by the library.

DerivationPath

class DerivationPath(path: String)

A BIP-32 derivation path.

Descriptor

class Descriptor(descriptor: String, network: Network)

A output descriptor.

DescriptorPublicKey

class DescriptorPublicKey( network: Network, mnemonic: String, password: String?)

An extended public key.

DescriptorSecretKey

class DescriptorSecretKey( network: Network, mnemonic: Mnemonic, password: String?)

An extended secret key.

ElectrumConfig

data class ElectrumConfig( var url: String, var socks5: String?, var retry: UByte, var timeout: UByte?, var stopGap: ULong, var validateDomain: Boolean)

Configuration for an Electrum blockchain.

EsploraConfig

data class EsploraConfig( var baseUrl: String, var proxy: String?, var concurrency: UByte?, var stopGap: ULong, var timeout: ULong?)

Configuration for an Esplora blockchain.

KeychainKind

enum KeychainKind : Enum<KeychainKind>

Types of keychains.

LocalUtxo

data class LocalUtxo( var outpoint: OutPoint, var txout: TxOut, var keychain: KeychainKind, var isSpent: Boolean)

An unspent output owned by a Wallet.

Mnemonic

class Mnemonic(mnemonic: String)

Mnemonic phrases are a human-readable version of the private keys. Supported number of words are 12, 15, 18, 21 and 24.

Network

enum Network : Enum<Network>

The cryptocurrency to act on.

OutPoint

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

A reference to a transaction output.

PartiallySignedTransaction

class PartiallySignedTransaction(psbtBase64: String)

A partially signed bitcoin transaction.

Payload

sealed class Payload

The method used to produce an address.

Progress

class Progress

Class that logs at level INFO every update received (if any).

RcpSyncParams

data class RcpSyncParams( val startScriptCount: ULong, val startTime: <Error class: unknown class>, val forceStartTime: Boolean, val pollRateSec: ULong)

Sync parameters for Bitcoin Core RPC.

RpcConfig

data class RpcConfig( val url: String, val auth: Auth, val network: Network, val walletName: String, val syncParams: RcpSyncParams?)

RpcBlockchain configuration options

Script

class Script(rawOutputScript: List<UByte>)

A bitcoin script.

ScriptAmount

data class ScriptAmount(var script: Script, var amount: ULong)

A object holding a ScriptPubKey and an amount.

SignOptions

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

Options for a software signer.

SledDbConfiguration

data class SledDbConfiguration(var path: String, var treeName: String)

Configuration type for a SledDB database.

SqliteDbConfiguration

data class SqliteDbConfiguration(var path: String)

Configuration type for a SQLite database.

Transaction

class Transaction(transactionBytes: List<UByte>)

A bitcoin transaction.

TransactionDetails

data class TransactionDetails( var transaction: <Error class: unknown class>, Transaction: <Error class: unknown class>, var fee: ULong?, var received: ULong, var sent: ULong, var txid: String, var confirmationTime: BlockTime?)

A wallet transaction.

TxBuilder

class TxBuilder

A transaction builder.

TxBuilderResult

data class TxBuilderResult(var psbt: PartiallySignedTransaction, var transactionDetails: TransactionDetails)

The value returned from calling the .finish() method on the TxBuilder or BumpFeeTxBuilder.

TxIn

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

Bitcoin transaction input.

TxOut

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

A transaction output, which defines new coins to be created from old ones.

Wallet

class Wallet( descriptor: Descriptor, changeDescriptor: Descriptor?, network: Network, databaseConfig: DatabaseConfig)

A Bitcoin wallet. The Wallet acts as a way of coherently interfacing with output descriptors and related transactions. Its main components are:

WitnessVersion

enum WitnessVersion : Enum<WitnessVersion>

Version of the witness program.

WordCount

enum WordCount : Enum<WordCount>

An enum describing entropy length (aka word count) in the mnemonic.