org.bitcoinj.core

Class FilteredBlock

java.lang.Object

org.bitcoinj.core.Message

org.bitcoinj.core.FilteredBlock

public class FilteredBlock
extends Message

A FilteredBlock is used to relay a block with its transactions filtered using a BloomFilter. It consists of the block header and a PartialMerkleTree which contains the transactions which matched the filter.

Instances of this class are not safe for use by multiple threads.

Field Summary

Fields inherited from class org.bitcoinj.core.Message

cursor, length, MAX_SIZE, offset, params, payload, protocolVersion, recached, serializer, UNKNOWN_LENGTH

Constructor Summary

Constructors

Constructor and Description
FilteredBlock(NetworkParameters params, Block header, PartialMerkleTree pmt)
FilteredBlock(NetworkParameters params, byte[] payloadBytes)

Method Summary

Modifier and Type	Method and Description
void	bitcoinSerializeToStream(java.io.OutputStream stream) Serializes this message to the provided stream.
boolean	equals(java.lang.Object o)
java.util.Map<Sha256Hash,Transaction>	getAssociatedTransactions() Gets the set of transactions which were provided using provideTransaction() which match in getTransactionHashes()
Block	getBlockHeader() Gets a copy of the block header
Sha256Hash	getHash() Gets the hash of the block represented in this Filtered Block
PartialMerkleTree	getPartialMerkleTree() Returns the PartialMerkleTree object that provides the mathematical proof of transaction inclusion in the block.
int	getTransactionCount() Number of transactions in this block, before it was filtered
java.util.List<Sha256Hash>	getTransactionHashes() Gets a list of leaf hashes which are contained in the partial merkle tree in this filtered block
int	hashCode()
protected void	parse()
boolean	provideTransaction(Transaction tx) Provide this FilteredBlock with a transaction which is in its Merkle tree.
java.lang.String	toString()

Methods inherited from class org.bitcoinj.core.Message

adjustLength, bitcoinSerialize, bitcoinSerialize, getMessageSize, getParams, hasMoreBytes, isCached, isRecached, readByteArray, readBytes, readHash, readInt64, readStr, readUint32, readUint64, readVarInt, readVarInt, unCache, unsafeBitcoinSerialize

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FilteredBlock

public FilteredBlock(NetworkParameters params,
                     byte[] payloadBytes)
              throws ProtocolException

Throws:

ProtocolException

FilteredBlock

public FilteredBlock(NetworkParameters params,
                     Block header,
                     PartialMerkleTree pmt)

Method Detail

bitcoinSerializeToStream

public void bitcoinSerializeToStream(java.io.OutputStream stream)
                              throws java.io.IOException

Description copied from class: Message

Serializes this message to the provided stream. If you just want the raw bytes use bitcoinSerialize().

Overrides:

bitcoinSerializeToStream in class Message

Throws:

java.io.IOException

parse

protected void parse()
              throws ProtocolException

Specified by:

parse in class Message

Throws:

ProtocolException

getTransactionHashes

public java.util.List<Sha256Hash> getTransactionHashes()
                                                throws VerificationException

Gets a list of leaf hashes which are contained in the partial merkle tree in this filtered block

Throws:

ProtocolException - If the partial merkle block is invalid or the merkle root of the partial merkle block doesn't match the block header

VerificationException

getBlockHeader

public Block getBlockHeader()

Gets a copy of the block header

getHash

public Sha256Hash getHash()

Gets the hash of the block represented in this Filtered Block

Overrides:

getHash in class Message

provideTransaction

public boolean provideTransaction(Transaction tx)
                           throws VerificationException

Provide this FilteredBlock with a transaction which is in its Merkle tree.

Returns:

false if the tx is not relevant to this FilteredBlock

Throws:

VerificationException

getPartialMerkleTree

public PartialMerkleTree getPartialMerkleTree()

Returns the PartialMerkleTree object that provides the mathematical proof of transaction inclusion in the block.

getAssociatedTransactions

public java.util.Map<Sha256Hash,Transaction> getAssociatedTransactions()

Gets the set of transactions which were provided using provideTransaction() which match in getTransactionHashes()

getTransactionCount

public int getTransactionCount()

Number of transactions in this block, before it was filtered

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object