org.bitcoinj.store

Class LevelDBBlockStore

java.lang.Object

org.bitcoinj.store.LevelDBBlockStore

All Implemented Interfaces:

BlockStore

public class LevelDBBlockStore
extends Object
implements BlockStore

An SPV block store that writes every header it sees to a LevelDB. This allows for fast lookup of block headers by block hash at the expense of more costly inserts and higher disk usage than the SPVBlockStore. If all you want is a regular wallet you don't need this class: it exists for specialised applications where you need to quickly verify a standalone SPV proof.

Constructor Summary

Constructors

Constructor and Description
LevelDBBlockStore(Context context, File directory) Creates a LevelDB SPV block store using the JNI/C++ version of LevelDB.
LevelDBBlockStore(Context context, File directory, org.iq80.leveldb.DBFactory dbFactory) Creates a LevelDB SPV block store using the given factory, which is useful if you want a pure Java version.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the store.
void	destroy()
StoredBlock	get(Sha256Hash hash) Returns the StoredBlock given a hash.
StoredBlock	getChainHead() Returns the StoredBlock that represents the top of the chain of greatest total work.
NetworkParameters	getParams() Get the NetworkParameters of this store.
void	put(StoredBlock block) Saves the given block header+extra data.
void	reset() Erases the contents of the database (but NOT the underlying files themselves) and then reinitialises with the genesis block.
void	setChainHead(StoredBlock chainHead) Sets the StoredBlock that represents the top of the chain of greatest total work.

Methods inherited from class java.lang.Object

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

Constructor Detail

LevelDBBlockStore

public LevelDBBlockStore(Context context,
                         File directory)
                  throws BlockStoreException

Creates a LevelDB SPV block store using the JNI/C++ version of LevelDB.

Throws:

BlockStoreException

LevelDBBlockStore

public LevelDBBlockStore(Context context,
                         File directory,
                         org.iq80.leveldb.DBFactory dbFactory)
                  throws BlockStoreException

Creates a LevelDB SPV block store using the given factory, which is useful if you want a pure Java version.

Throws:

BlockStoreException

Method Detail

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

get

@Nullable
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

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

reset

public void reset()
           throws BlockStoreException

Erases the contents of the database (but NOT the underlying files themselves) and then reinitialises with the genesis block.

Throws:

BlockStoreException

destroy

public void destroy()
             throws IOException

Throws:

IOException

getParams

public NetworkParameters getParams()

Description copied from interface: BlockStore

Get the NetworkParameters of this store.

Specified by:

getParams in interface BlockStore

Returns:

The network params.