Package org.bitcoinj.store

Class LevelDBFullPrunedBlockStore

java.lang.Object

org.bitcoinj.store.LevelDBFullPrunedBlockStore

All Implemented Interfaces:

UTXOProvider, BlockStore, FullPrunedBlockStore

public class LevelDBFullPrunedBlockStore
extends Object
implements FullPrunedBlockStore

An implementation of a Fully Pruned Block Store using a leveldb implementation as the backing data store.

Includes number of caches to optimise the initial blockchain download.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	LevelDBFullPrunedBlockStore.LRUCache

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	autoCommit
protected org.bitcoinj.store.LevelDBFullPrunedBlockStore.BloomFilter	bloom
protected StoredBlock	chainHeadBlock
protected Sha256Hash	chainHeadHash
protected String	filename
protected int	fullStoreDepth
protected long	hit
protected boolean	instrument
protected long	leveldbReadCache
protected int	leveldbWriteCache
protected long	miss
protected int	openOutCache
protected Map<ByteBuffer,UTXO>	utxoCache
protected Map<ByteBuffer,UTXO>	utxoUncommittedCache
protected Set<ByteBuffer>	utxoUncommittedDeletedCache
protected StoredBlock	verifiedChainHeadBlock
protected Sha256Hash	verifiedChainHeadHash

Constructor Summary

Constructors

Constructor	Description
LevelDBFullPrunedBlockStore(NetworkParameters params, String filename, int blockCount)
LevelDBFullPrunedBlockStore(NetworkParameters params, String filename, int blockCount, long leveldbReadCache, int leveldbWriteCache, int openOutCache, boolean instrument, int exitBlock)

Method Summary

Modifier and Type	Method	Description
void	abortDatabaseBatchWrite()
void	addUnspentTransactionOutput(UTXO out)	Adds a UTXO to the list of unspent TransactionOutputs
void	beginDatabaseBatchWrite()	Begins/Commits/Aborts a database transaction.
void	close()	Closes the store.
void	commitDatabaseBatchWrite()
StoredBlock	get(Sha256Hash hash)	Returns the StoredBlock given a hash.
StoredBlock	get(Sha256Hash hash, boolean wasUndoableOnly)
StoredBlock	getChainHead()	Returns the StoredBlock that represents the top of the chain of greatest total work.
int	getChainHeadHeight()	Get the height of the chain head.
StoredBlock	getOnceUndoableStoredBlock(Sha256Hash hash)	Returns the StoredBlock that was added as a StoredUndoableBlock given a hash.
List<UTXO>	getOpenTransactionOutputs(List<ECKey> keys)	Get the list of UTXO's for given keys.
NetworkParameters	getParams()	Get the NetworkParameters of this store.
UTXO	getTransactionOutput(Sha256Hash hash, long index)	Gets a UTXO with the given hash and index, or null if none is found
StoredUndoableBlock	getUndoBlock(Sha256Hash hash)	Returns a StoredUndoableBlock whose block.getHash() method will be equal to the parameter.
StoredBlock	getVerifiedChainHead()	Returns the StoredBlock that represents the top of the chain of greatest total work that has been fully verified and the point in the chain at which the unspent transaction output set in this store represents.
boolean	hasUnspentOutputs(Sha256Hash hash, int numOutputs)	True if this store has any unspent outputs from a transaction with a hash equal to the first parameter
void	put(StoredBlock block)	Saves the given block header+extra data.
void	put(StoredBlock storedBlock, StoredUndoableBlock undoableBlock)	Saves the given StoredUndoableBlock and StoredBlock.
protected void	putUpdateStoredBlock(StoredBlock storedBlock, boolean wasUndoable)
void	removeUnspentTransactionOutput(UTXO out)	Removes a UTXO from the list of unspent TransactionOutputs Note that the coinbase of the genesis block should NEVER be spendable and thus never in the list.
void	resetStore()
void	setChainHead(StoredBlock chainHead)	Sets the StoredBlock that represents the top of the chain of greatest total work.
void	setVerifiedChainHead(StoredBlock chainHead)	Sets the StoredBlock that represents the top of the chain of greatest total work that has been fully verified.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

chainHeadHash

protected Sha256Hash chainHeadHash

chainHeadBlock

protected StoredBlock chainHeadBlock

verifiedChainHeadHash

protected Sha256Hash verifiedChainHeadHash

verifiedChainHeadBlock

protected StoredBlock verifiedChainHeadBlock

fullStoreDepth

protected int fullStoreDepth

instrument

protected boolean instrument

hit

protected long hit

miss

protected long miss

utxoCache

protected Map<ByteBuffer,UTXO> utxoCache

utxoUncommittedCache

protected Map<ByteBuffer,UTXO> utxoUncommittedCache

utxoUncommittedDeletedCache

protected Set<ByteBuffer> utxoUncommittedDeletedCache

filename

protected String filename

autoCommit

protected boolean autoCommit

leveldbReadCache

protected long leveldbReadCache

leveldbWriteCache

protected int leveldbWriteCache

openOutCache

protected int openOutCache

bloom

protected org.bitcoinj.store.LevelDBFullPrunedBlockStore.BloomFilter bloom

Constructor Details

LevelDBFullPrunedBlockStore

public LevelDBFullPrunedBlockStore(NetworkParameters params,
 String filename,
 int blockCount)

LevelDBFullPrunedBlockStore

public LevelDBFullPrunedBlockStore(NetworkParameters params,
 String filename,
 int blockCount,
 long leveldbReadCache,
 int leveldbWriteCache,
 int openOutCache,
 boolean instrument,
 int exitBlock)

Method Details

put

public void put(StoredBlock block)
         throws BlockStoreException

Description copied from interface: BlockStore

Saves the given block header+extra data. The key isn't specified explicitly as it can be calculated from the StoredBlock directly. Can throw if there is a problem with the underlying storage layer such as running out of disk space.

Specified by:

put in interface BlockStore

Throws:

BlockStoreException

getChainHead

public StoredBlock getChainHead()
                         throws BlockStoreException

Description copied from interface: BlockStore

Returns the StoredBlock that represents the top of the chain of greatest total work. Note that this can be arbitrarily expensive, you probably should use AbstractBlockChain.getChainHead() or perhaps AbstractBlockChain.getBestChainHeight() which will run in constant time and not take any heavyweight locks.

Specified by:

getChainHead in interface BlockStore

Throws:

BlockStoreException

setChainHead

public void setChainHead(StoredBlock chainHead)
                  throws BlockStoreException

Description copied from interface: BlockStore

Sets the StoredBlock that represents the top of the chain of greatest total work.

Specified by:

setChainHead in interface BlockStore

Throws:

BlockStoreException

close

public void close()
           throws BlockStoreException

Description copied from interface: BlockStore

Closes the store.

Specified by:

close in interface BlockStore

Throws:

BlockStoreException

getParams

public NetworkParameters getParams()

Description copied from interface: BlockStore

Get the NetworkParameters of this store.

Specified by:

getParams in interface BlockStore

Specified by:

getParams in interface UTXOProvider

Returns:

The network params.

getOpenTransactionOutputs

public List<UTXO> getOpenTransactionOutputs(List<ECKey> keys)
                                     throws UTXOProviderException

Description copied from interface: UTXOProvider

Get the list of UTXO's for given keys.

Specified by:

getOpenTransactionOutputs in interface UTXOProvider

Parameters:

keys - List of keys.

Returns:

The list of transaction outputs.

Throws:

UTXOProviderException - If there is an error.

getChainHeadHeight

public int getChainHeadHeight()
                       throws UTXOProviderException

Description copied from interface: UTXOProvider

Get the height of the chain head.

Specified by:

getChainHeadHeight in interface UTXOProvider

Returns:

The chain head height.

Throws:

UTXOProviderException - If there is an error.

putUpdateStoredBlock

protected void putUpdateStoredBlock(StoredBlock storedBlock,
 boolean wasUndoable)

put

public void put(StoredBlock storedBlock,
 StoredUndoableBlock undoableBlock)
         throws BlockStoreException

Description copied from interface: FullPrunedBlockStore

Saves the given StoredUndoableBlock and StoredBlock. Calculates keys from the StoredBlock

Though not required for proper function of a FullPrunedBlockStore, any user of a FullPrunedBlockStore should ensure that a StoredUndoableBlock for each block up to the fully verified chain head has been added to this block store using this function (not put(StoredBlock)), so that the ability to perform reorgs is maintained.

Specified by:

put in interface FullPrunedBlockStore

Throws:

BlockStoreException - if there is a problem with the underlying storage layer, such as running out of disk space.

getOnceUndoableStoredBlock

public StoredBlock getOnceUndoableStoredBlock(Sha256Hash hash)
                                       throws BlockStoreException

Description copied from interface: FullPrunedBlockStore

Returns the StoredBlock that was added as a StoredUndoableBlock given a hash. The returned values block.getHash() method will be equal to the parameter. If no such block is found, returns null.

Specified by:

getOnceUndoableStoredBlock in interface FullPrunedBlockStore

Throws:

BlockStoreException

get

public StoredBlock get(Sha256Hash hash)
                throws BlockStoreException

Description copied from interface: BlockStore

Returns the StoredBlock given a hash. The returned values block.getHash() method will be equal to the parameter. If no such block is found, returns null.

Specified by:

get in interface BlockStore

Throws:

BlockStoreException

get

public StoredBlock get(Sha256Hash hash,
 boolean wasUndoableOnly)
                throws BlockStoreException

Throws:

BlockStoreException

getUndoBlock

public StoredUndoableBlock getUndoBlock(Sha256Hash hash)
                                 throws BlockStoreException

Description copied from interface: FullPrunedBlockStore

Returns a StoredUndoableBlock whose block.getHash() method will be equal to the parameter. If no such block is found, returns null. Note that this may return null more often than get(Sha256Hash hash) as not all StoredBlocks have a StoredUndoableBlock copy stored as well.

Specified by:

getUndoBlock in interface FullPrunedBlockStore

Throws:

BlockStoreException

getTransactionOutput

public UTXO getTransactionOutput(Sha256Hash hash,
 long index)
                          throws BlockStoreException

Description copied from interface: FullPrunedBlockStore

Gets a UTXO with the given hash and index, or null if none is found

Specified by:

getTransactionOutput in interface FullPrunedBlockStore

Throws:

BlockStoreException

addUnspentTransactionOutput

public void addUnspentTransactionOutput(UTXO out)
                                 throws BlockStoreException

Description copied from interface: FullPrunedBlockStore

Adds a UTXO to the list of unspent TransactionOutputs

Specified by:

addUnspentTransactionOutput in interface FullPrunedBlockStore

Throws:

BlockStoreException

removeUnspentTransactionOutput

public void removeUnspentTransactionOutput(UTXO out)
                                    throws BlockStoreException

Description copied from interface: FullPrunedBlockStore

Removes a UTXO from the list of unspent TransactionOutputs Note that the coinbase of the genesis block should NEVER be spendable and thus never in the list.

Specified by:

removeUnspentTransactionOutput in interface FullPrunedBlockStore

Throws:

BlockStoreException - if there is an underlying storage issue, or out was not in the list.

hasUnspentOutputs

public boolean hasUnspentOutputs(Sha256Hash hash,
 int numOutputs)
                          throws BlockStoreException

Description copied from interface: FullPrunedBlockStore

True if this store has any unspent outputs from a transaction with a hash equal to the first parameter

Specified by:

hasUnspentOutputs in interface FullPrunedBlockStore

numOutputs - the number of outputs the given transaction has

Throws:

BlockStoreException

getVerifiedChainHead

public StoredBlock getVerifiedChainHead()
                                 throws BlockStoreException

Description copied from interface: FullPrunedBlockStore

Returns the StoredBlock that represents the top of the chain of greatest total work that has been fully verified and the point in the chain at which the unspent transaction output set in this store represents.

Specified by:

getVerifiedChainHead in interface FullPrunedBlockStore

Throws:

BlockStoreException

setVerifiedChainHead

public void setVerifiedChainHead(StoredBlock chainHead)
                          throws BlockStoreException

Description copied from interface: FullPrunedBlockStore

Sets the StoredBlock that represents the top of the chain of greatest total work that has been fully verified. It should generally be set after a batch of updates to the transaction unspent output set, before a call to commitDatabaseBatchWrite. If chainHead has a greater height than the non-verified chain head (ie that set with BlockStore.setChainHead(org.bitcoinj.core.StoredBlock)) the non-verified chain head should be set to the one set here. In this way a class using a FullPrunedBlockStore only in full-verification mode can ignore the regular BlockStore functions implemented as a part of a FullPrunedBlockStore.

Specified by:

setVerifiedChainHead in interface FullPrunedBlockStore

Throws:

BlockStoreException

beginDatabaseBatchWrite

public void beginDatabaseBatchWrite()
                             throws BlockStoreException

Description copied from interface: FullPrunedBlockStore

Begins/Commits/Aborts a database transaction.

If abortDatabaseBatchWrite() is called by the same thread that called beginDatabaseBatchWrite(), any data writes between this call and abortDatabaseBatchWrite() made by the same thread should be discarded.

Furthermore, any data written after a call to beginDatabaseBatchWrite() should not be readable by any other threads until commitDatabaseBatchWrite() has been called by this thread. Multiple calls to beginDatabaseBatchWrite() in any given thread should be ignored and treated as one call.

Specified by:

beginDatabaseBatchWrite in interface FullPrunedBlockStore

Throws:

BlockStoreException

commitDatabaseBatchWrite

public void commitDatabaseBatchWrite()
                              throws BlockStoreException

Specified by:

commitDatabaseBatchWrite in interface FullPrunedBlockStore

Throws:

BlockStoreException

abortDatabaseBatchWrite

public void abortDatabaseBatchWrite()
                             throws BlockStoreException

Specified by:

abortDatabaseBatchWrite in interface FullPrunedBlockStore

Throws:

BlockStoreException

resetStore

public void resetStore()