Package org.bitcoinj.core
package org.bitcoinj.core
The core package contains classes for network messages like
Block and
Transaction, peer connectivity via PeerGroup,
and block chain management.
If what you're doing can be described as basic bitcoin tasks, the code is probably found here.
To learn more please consult the documentation on the website.-
ClassDescriptionAn AbstractBlockChain holds a series of
Blockobjects, links them together, and knows how to verify that the chain follows the rules of theNetworkParametersfor this chain.Indicates whether new Block was on the best chain or notBase class for addresses, e.g.This exception is thrown byBase58,Bech32and thePrefixedChecksummedByteshierarchy of classes when you try to decode data and a character isn't valid.This exception is thrown byBase58,Bech32and thePrefixedChecksummedByteshierarchy of classes when you try to decode data and the checksum isn't valid.This exception is thrown byBase58,Bech32and thePrefixedChecksummedByteshierarchy of classes when you try to decode data and the data isn't of the right size.This exception is thrown by thePrefixedChecksummedByteshierarchy of classes when you try and decode an address or private key with an invalid prefix (version header or human-readable part).This exception is thrown bySegwitAddresswhen you try to decode data and the witness version doesn't match the Bech32 encoding as per BIP350.This exception is thrown by thePrefixedChecksummedByteshierarchy of classes when you try and decode an address with a prefix (version header or human-readable part) that used by another network (usually: mainnet vs testnet).Represents an "addr" message on the P2P network, which contains broadcast IP addresses of other peers.Represents an "addrv2" message on the P2P network, which contains broadcast IP addresses of other peers.Base58 is a way to encode Bitcoin addresses (or arbitrary data) as alphanumeric strings.Implementation of the Bech32 encoding.Methods to serialize and de-serialize messages to the Bitcoin network format as defined in the protocol specification.A block is a group of transactions, and is one of the fundamental data structures of the Bitcoin system.Flags used to control which elements of block validation are done on received blocks.A BlockChain implements the simplified payment verification mode of the Bitcoin protocol.Represents Block Locator in GetBlocks and GetHeaders messagesA Bloom filter is a probabilistic data structure which can be sent to another client so that it can avoid sending us transactions that aren't relevant to our set of keys.The BLOOM_UPDATE_* constants control when the bloom filter is auto-updated by the peer using it as a filter, either never, for all outputs or only for P2PK outputs (default)Vends hard-codedStoredBlocks for blocks throughout the chain.Represents a Message type that can be contained within another Message.Represents a monetary Bitcoin value.The Context object holds various objects and pieces of configuration that are scoped to a specific instantiation of bitcoinj for a specific network.Parses and generates private keys in the form used by the Bitcoin "dumpprivkey" command.Represents an elliptic curve public and (optionally) private key, usable for digital signatures but not encryption.Groups the two components that make up a signature, and provides a way to encode to DER form, which is how ECDSA signatures are represented when embedded in other data structures in the Bitcoin protocol.Parent class for header only messages that don't have a payload.Represents an "feefilter" message on the P2P network, which instructs a peer to filter transaction invs for transactions that fall below the feerate provided.A FilteredBlock is used to relay a block with its transactions filtered using aBloomFilter.A FullPrunedBlockChain works in conjunction with aFullPrunedBlockStoreto verify all the rules of the Bitcoin system, with the downside being a large cost in system resources.Represents the "getaddr" P2P protocol message, which requests networkAddressMessages from a peer.Represents the "getblocks" P2P network message, which requests the hashes of the parts of the block chain we're missing.Represents the "getdata" P2P network message, which requests the contents of blocks or transactions given their hashes.The "getheaders" command is structurally identical to "getblocks", but has different meaning.This command is supported only by Bitcoin XT nodes, which advertise themselves using the second service bit flag.A protocol message that contains a repeated series of block headers, sent in response to the "getheaders" command.Thrown to indicate that you don't have enough money available to perform the requested operation.Represents the "inv" P2P network message.A Bitcoin address looks like 1MsScoe2fTJoq4ZPdQgqyhgWeoNamYPevy and is derived from an elliptic curve public key plus a set of network parameters.Abstract superclass of classes with list based payload, ie InventoryMessage and GetDataMessage.The "mempool" message asks a remote peer to announce all transactions in its memory pool, possibly restricted by any Bloom filter set on the connection.A Message is a data structure that can be serialized/deserialized using the Bitcoin serialization format.Generic interface for classes which serialize/deserialize messages.Classes implementing this interface represent a monetary value, such as a Bitcoin or fiat amount.NetworkParameters contains the data needed for working with an instantiation of a Bitcoin chain.Sent by a peer when a getdata request doesn't find the requested data in the mempool.A data structure that contains proofs of block inclusion for one or more transactions, in an efficient manner.A Peer handles the high level communication with a Bitcoin node, extending aPeerSocketHandlerwhich handles low-level message (de)serialization.A PeerAddress holds an IP address and port number representing the network location of a peer in the Bitcoin P2P network.Thrown when a problem occurs in communicating with a peer, and we should retry.An interface which provides the information required to properly filter data downloaded from Peers.Runs a set of connections to the P2P network, brings up connections to replace disconnected nodes and manages the interaction between them all.Handles high-level message (de)serialization for peers, acting as the bridge between theorg.bitcoinj.netclasses andPeer.Instances of this class are not safe for use by multiple threads.Instances of this class are not safe for use by multiple threads.The following format is often used to represent some type of data (e.g.PrunedException is thrown in cases where a fully verifying node has deleted (pruned) old block data that turned out to be necessary for handling a re-org.This exception is used by the TransactionBroadcast class to indicate that a broadcast Transaction has been rejected by the network, for example because it violates a protocol rule.A message sent by nodes when a message we sent was rejected (ie a transaction had too little fee/was invalid/etc).Implementation of native segwit addresses.Represents thesendaddrv2P2P protocol message, which indicates that a node can understand and prefers to receiveaddrv2messages instead ofaddrmessages.A new message, "sendheaders", which indicates that a node prefers to receive new block announcements via a "headers" message rather than an "inv".ASha256Hashwraps abyte[]so thatSha256Hash.equals(java.lang.Object)andSha256Hash.hashCode()work correctly, allowing it to be used as a key in a map.Wraps aBlockobject with extra data that can be derived from the block chain but is slow or inconvenient to calculate.Contains minimal data necessary to disconnect/connect the transactions in the stored block at will.A transaction represents the movement of coins from some addresses to some other addresses.This enum describes the underlying reason the transaction was created.These constants are a part of a scriptSig signature on the inputs.This interface is used to abstract theWalletand theTransactionRepresents a single transaction broadcast that we are performing.An interface for receiving progress information on the propagation of the tx, from 0.0 to 1.0A general interface which declares the ability to broadcast transactions.A TransactionConfidence object tracks data you can use to make a confidence decision about a transaction.Describes the state of the transaction in general terms.A confidence listener is informed when the level ofTransactionConfidenceis updated by something, like for example aWallet.An enum that describes why a transaction confidence listener is being invoked (i.e.Information about where the transaction was first seen (network, sent direct from peer, created by ourselves).A transfer of coins from one address to another creates a transaction in which the outputs can be claimed by the recipient in the input of another transaction.This message is a reference or pointer to an output of a different transaction.A TransactionOutput message contains a scriptPubKey that controls who is able to spend its value.TransactionOutputChanges represents a delta to the set of unspent outputs.Tracks transactions that are being announced across the network.Instances of this class are not safe for use by multiple threads.An unsynchronized implementation of ByteArrayOutputStream that will return the backing byte array if its length == size().A collection of various utility methods that are helpful for working with the Bitcoin protocol.A UTXO message contains the information necessary to check a spending transaction.A UTXOProvider encapsulates functionality for returning unspent transaction outputs, for use by the wallet or other code that crafts spends.Message representing a list of unspent transaction outputs ("utxos"), returned in response to sending aGetUTXOsMessage("getutxos").A variable-length encoded unsigned integer using Satoshi's encoding (a.k.a.The verack message, sent by a client accepting the version message they received from their peer.A VersionMessage holds information exchanged during connection setup with another peer.