The BlockchainDB backing store interface declaration/contract. More...

#include <blockchain_db.h>

Inheritance diagram for cryptonote::BlockchainDB:

Collaboration diagram for cryptonote::BlockchainDB:

Public Member Functions
	BlockchainDB ()
	An empty constructor. More...

virtual	~BlockchainDB ()
	An empty destructor. More...

void	reset_stats ()
	reset profiling stats More...

void	show_stats ()
	show profiling stats More...

virtual void	open (const std::string &filename, const int db_flags=0)=0
	open a db, or create it if necessary. More...

bool	is_open () const
	Gets the current open/ready state of the BlockchainDB. More...

virtual void	close ()=0
	close the BlockchainDB More...

virtual void	sync ()=0
	sync the BlockchainDB with disk More...

virtual void	safesyncmode (const bool onoff)=0
	toggle safe syncs for the DB More...

virtual void	reset ()=0
	Remove everything from the BlockchainDB. More...

virtual std::vector< std::string >	get_filenames () const =0
	get all files used by the BlockchainDB (if any) More...

virtual bool	remove_data_file (const std::string &folder) const =0
	remove file(s) storing the database More...

virtual std::string	get_db_name () const =0
	gets the name of the folder the BlockchainDB's file(s) should be in More...

virtual bool	lock ()=0
	acquires the BlockchainDB lock More...

virtual void	unlock ()=0
	This function releases the BlockchainDB lock. More...

virtual bool	batch_start (uint64_t batch_num_blocks=0, uint64_t batch_bytes=0)=0
	tells the BlockchainDB to start a new "batch" of blocks More...

virtual void	batch_stop ()=0
	ends a batch transaction More...

virtual void	batch_abort ()=0
	aborts a batch transaction More...

virtual void	set_batch_transactions (bool)=0
	sets whether or not to batch transactions More...

virtual void	block_wtxn_start ()=0

virtual void	block_wtxn_stop ()=0

virtual void	block_wtxn_abort ()=0

virtual bool	block_rtxn_start () const =0

virtual void	block_rtxn_stop () const =0

virtual void	block_rtxn_abort () const =0

virtual void	set_hard_fork (HardFork *hf)

virtual uint64_t	add_block (const std::pair< block, blobdata > &blk, size_t block_weight, uint64_t long_term_block_weight, const difficulty_type &cumulative_difficulty, const uint64_t &coins_generated, const std::vector< std::pair< transaction, blobdata >> &txs)
	handles the addition of a new block to BlockchainDB More...

virtual bool	block_exists (const crypto::hash &h, uint64_t *height=NULL) const =0
	checks if a block exists More...

virtual cryptonote::blobdata	get_block_blob (const crypto::hash &h) const =0
	fetches the block with the given hash More...

virtual block	get_block (const crypto::hash &h) const
	fetches the block with the given hash More...

virtual uint64_t	get_block_height (const crypto::hash &h) const =0
	gets the height of the block with a given hash More...

virtual block_header	get_block_header (const crypto::hash &h) const =0
	fetch a block header More...

virtual cryptonote::blobdata	get_block_blob_from_height (const uint64_t &height) const =0
	fetch a block blob by height More...

virtual block	get_block_from_height (const uint64_t &height) const
	fetch a block by height More...

virtual uint64_t	get_block_timestamp (const uint64_t &height) const =0
	fetch a block's timestamp More...

virtual std::vector< uint64_t >	get_block_cumulative_rct_outputs (const std::vector< uint64_t > &heights) const =0
	fetch a block's cumulative number of rct outputs More...

virtual uint64_t	get_top_block_timestamp () const =0
	fetch the top block's timestamp More...

virtual size_t	get_block_weight (const uint64_t &height) const =0
	fetch a block's weight More...

virtual std::vector< uint64_t >	get_block_weights (uint64_t start_height, size_t count) const =0
	fetch the last N blocks' weights More...

virtual void	set_block_cumulative_difficulty (uint64_t height, difficulty_type diff)=0
	sets a block's cumulative difficulty More...

virtual difficulty_type	get_block_cumulative_difficulty (const uint64_t &height) const =0
	fetch a block's cumulative difficulty More...

virtual difficulty_type	get_block_difficulty (const uint64_t &height) const =0
	fetch a block's difficulty More...

virtual uint64_t	get_block_already_generated_coins (const uint64_t &height) const =0
	fetch a block's already generated coins More...

virtual uint64_t	get_block_long_term_weight (const uint64_t &height) const =0
	fetch a block's long term weight More...

virtual std::vector< uint64_t >	get_long_term_block_weights (uint64_t start_height, size_t count) const =0
	fetch the last N blocks' long term weights More...

virtual crypto::hash	get_block_hash_from_height (const uint64_t &height) const =0
	fetch a block's hash More...

virtual std::vector< block >	get_blocks_range (const uint64_t &h1, const uint64_t &h2) const =0
	fetch a list of blocks More...

virtual std::vector< crypto::hash >	get_hashes_range (const uint64_t &h1, const uint64_t &h2) const =0
	fetch a list of block hashes More...

virtual crypto::hash	top_block_hash (uint64_t *block_height=NULL) const =0
	fetch the top block's hash More...

virtual block	get_top_block () const =0
	fetch the top block More...

virtual uint64_t	height () const =0
	fetch the current blockchain height More...

virtual void	pop_block (block &blk, std::vector< transaction > &txs)
	pops the top block off the blockchain More...

virtual bool	tx_exists (const crypto::hash &h) const =0
	check if a transaction with a given hash exists More...

virtual bool	tx_exists (const crypto::hash &h, uint64_t &tx_id) const =0

virtual uint64_t	get_tx_unlock_time (const crypto::hash &h) const =0
	fetch a transaction's unlock time/height More...

virtual transaction	get_tx (const crypto::hash &h) const
	fetches the transaction with the given hash More...

virtual transaction	get_pruned_tx (const crypto::hash &h) const
	fetches the transaction base with the given hash More...

virtual bool	get_tx (const crypto::hash &h, transaction &tx) const
	fetches the transaction with the given hash More...

virtual bool	get_pruned_tx (const crypto::hash &h, transaction &tx) const
	fetches the transaction base with the given hash More...

virtual bool	get_tx_blob (const crypto::hash &h, cryptonote::blobdata &tx) const =0
	fetches the transaction blob with the given hash More...

virtual bool	get_pruned_tx_blob (const crypto::hash &h, cryptonote::blobdata &tx) const =0
	fetches the pruned transaction blob with the given hash More...

virtual bool	get_prunable_tx_blob (const crypto::hash &h, cryptonote::blobdata &tx) const =0
	fetches the prunable transaction blob with the given hash More...

virtual bool	get_prunable_tx_hash (const crypto::hash &tx_hash, crypto::hash &prunable_hash) const =0
	fetches the prunable transaction hash More...

virtual uint64_t	get_tx_count () const =0
	fetches the total number of transactions ever More...

virtual std::vector< transaction >	get_tx_list (const std::vector< crypto::hash > &hlist) const =0
	fetches a list of transactions based on their hashes More...

virtual uint64_t	get_tx_block_height (const crypto::hash &h) const =0
	fetches the height of a transaction's block More...

virtual uint64_t	get_num_outputs (const uint64_t &amount) const =0
	fetches the number of outputs of a given amount More...

virtual uint64_t	get_indexing_base () const
	return index of the first element (should be hidden, but isn't) More...

virtual output_data_t	get_output_key (const uint64_t &amount, const uint64_t &index, bool include_commitmemt=true) const =0
	get some of an output's data More...

virtual tx_out_index	get_output_tx_and_index_from_global (const uint64_t &index) const =0
	gets an output's tx hash and index More...

virtual tx_out_index	get_output_tx_and_index (const uint64_t &amount, const uint64_t &index) const =0
	gets an output's tx hash and index More...

virtual void	get_output_tx_and_index (const uint64_t &amount, const std::vector< uint64_t > &offsets, std::vector< tx_out_index > &indices) const =0
	gets some outputs' tx hashes and indices More...

virtual void	get_output_key (const epee::span< const uint64_t > &amounts, const std::vector< uint64_t > &offsets, std::vector< output_data_t > &outputs, bool allow_partial=false) const =0
	gets outputs' data More...

virtual bool	can_thread_bulk_indices () const =0

virtual std::vector< std::vector< uint64_t > >	get_tx_amount_output_indices (const uint64_t tx_id, size_t n_txes=1) const =0
	gets output indices (amount-specific) for a transaction's outputs More...

virtual bool	has_key_image (const crypto::key_image &img) const =0
	check if a key image is stored as spent More...

virtual void	add_txpool_tx (const crypto::hash &txid, const cryptonote::blobdata &blob, const txpool_tx_meta_t &details)=0
	add a txpool transaction More...

virtual void	update_txpool_tx (const crypto::hash &txid, const txpool_tx_meta_t &details)=0
	update a txpool transaction's metadata More...

virtual uint64_t	get_txpool_tx_count (bool include_unrelayed_txes=true) const =0
	get the number of transactions in the txpool More...

virtual bool	txpool_has_tx (const crypto::hash &txid) const =0
	check whether a txid is in the txpool More...

virtual void	remove_txpool_tx (const crypto::hash &txid)=0
	remove a txpool transaction More...

virtual bool	get_txpool_tx_meta (const crypto::hash &txid, txpool_tx_meta_t &meta) const =0
	get a txpool transaction's metadata More...

virtual bool	get_txpool_tx_blob (const crypto::hash &txid, cryptonote::blobdata &bd) const =0
	get a txpool transaction's blob More...

virtual cryptonote::blobdata	get_txpool_tx_blob (const crypto::hash &txid) const =0
	get a txpool transaction's blob More...

virtual void	prune_outputs (uint64_t amount)=0
	prune output data for the given amount More...

virtual uint32_t	get_blockchain_pruning_seed () const =0
	get the blockchain pruning seed More...

virtual bool	prune_blockchain (uint32_t pruning_seed=0)=0
	prunes the blockchain More...

virtual bool	update_pruning ()=0
	prunes recent blockchain changes as needed, iff pruning is enabled More...

virtual bool	check_pruning ()=0
	checks pruning was done correctly, iff enabled More...

virtual uint64_t	get_max_block_size ()=0
	get the max block size More...

virtual void	add_max_block_size (uint64_t sz)=0
	add a new max block size More...

virtual bool	for_all_txpool_txes (std::function< bool(const crypto::hash &, const txpool_tx_meta_t &, const cryptonote::blobdata *)>, bool include_blob=false, bool include_unrelayed_txes=true) const =0
	runs a function over all txpool transactions More...

virtual bool	for_all_key_images (std::function< bool(const crypto::key_image &)>) const =0
	runs a function over all key images stored More...

virtual bool	for_blocks_range (const uint64_t &h1, const uint64_t &h2, std::function< bool(uint64_t, const crypto::hash &, const cryptonote::block &)>) const =0
	runs a function over a range of blocks More...

virtual bool	for_all_transactions (std::function< bool(const crypto::hash &, const cryptonote::transaction &)>, bool pruned) const =0
	runs a function over all transactions stored More...

virtual bool	for_all_outputs (std::function< bool(uint64_t amount, const crypto::hash &tx_hash, uint64_t height, size_t tx_idx)> f) const =0
	runs a function over all outputs stored More...

virtual bool	for_all_outputs (uint64_t amount, const std::function< bool(uint64_t height)> &f) const =0

virtual void	set_hard_fork_version (uint64_t height, uint8_t version)=0
	sets which hardfork version a height is on More...

virtual uint8_t	get_hard_fork_version (uint64_t height) const =0
	checks which hardfork version a height is on More...

virtual void	set_validator_list (std::string, uint32_t expiration_date)=0

virtual std::string	get_validator_list () const =0

virtual void	check_hard_fork_info ()=0
	verify hard fork info in database More...

virtual void	drop_hard_fork_info ()=0
	delete hard fork info from database More...

virtual std::map< uint64_t, std::tuple< uint64_t, uint64_t, uint64_t > >	get_output_histogram (const std::vector< uint64_t > &amounts, bool unlocked, uint64_t recent_cutoff, uint64_t min_count) const =0
	return a histogram of outputs on the blockchain More...

virtual bool	get_output_distribution (uint64_t amount, uint64_t from_height, uint64_t to_height, std::vector< uint64_t > &distribution, uint64_t &base) const =0

virtual bool	is_read_only () const =0
	is BlockchainDB in read-only mode? More...

virtual uint64_t	get_database_size () const =0
	get disk space requirements More...

virtual void	fixup ()
	fix up anything that may be wrong due to past bugs More...

void	set_auto_remove_logs (bool auto_remove)
	set whether or not to automatically remove logs More...

Static Public Member Functions
static void	init_options (boost::program_options::options_description &desc)
	init command line options More...

Public Attributes
bool	m_open
	Whether or not the BlockchainDB is open/ready for use. More...

epee::critical_section	m_synchronization_lock
	A lock, currently for when BlockchainLMDB needs to resize the backing db file. More...

Protected Member Functions
void	add_transaction (const crypto::hash &blk_hash, const std::pair< transaction, blobdata > &tx, const crypto::hash tx_hash_ptr=NULL, const crypto::hash tx_prunable_hash_ptr=NULL)
	helper function for add_transactions, to add each individual transaction More...

Protected Attributes
uint64_t	time_tx_exists = 0
	a performance metric More...

uint64_t	time_commit1 = 0
	a performance metric More...

bool	m_auto_remove_logs = true
	whether or not to automatically remove old logs More...

HardFork *	m_hardfork

Private Member Functions
virtual void	add_block (const block &blk, size_t block_weight, uint64_t long_term_block_weight, const difficulty_type &cumulative_difficulty, const uint64_t &coins_generated, uint64_t num_rct_outs, const crypto::hash &blk_hash)=0
	add the block and metadata to the db More...

virtual void	remove_block ()=0
	remove data about the top block More...

virtual uint64_t	add_transaction_data (const crypto::hash &blk_hash, const std::pair< transaction, blobdata > &tx, const crypto::hash &tx_hash, const crypto::hash &tx_prunable_hash)=0
	store the transaction and its metadata More...

virtual void	remove_transaction_data (const crypto::hash &tx_hash, const transaction &tx)=0
	remove data about a transaction More...

virtual uint64_t	add_output (const crypto::hash &tx_hash, const tx_out &tx_output, const uint64_t &local_index, const uint64_t unlock_time, const rct::key *commitment)=0
	store an output More...

virtual void	add_tx_amount_output_indices (const uint64_t tx_id, const std::vector< uint64_t > &amount_output_indices)=0
	store amount output indices for a tx's outputs More...

virtual void	add_spent_key (const crypto::key_image &k_image)=0
	store a spent key More...

virtual void	remove_spent_key (const crypto::key_image &k_image)=0
	remove a spent key More...

void	pop_block ()
	private version of pop_block, for undoing if an add_block fails More...

void	remove_transaction (const crypto::hash &tx_hash)
	helper function to remove transaction from the blockchain More...

Private Attributes
uint64_t	num_calls = 0
	a performance metric More...

uint64_t	time_blk_hash = 0
	a performance metric More...

uint64_t	time_add_block1 = 0
	a performance metric More...

uint64_t	time_add_transaction = 0
	a performance metric More...

Detailed Description

The BlockchainDB backing store interface declaration/contract.

This class provides a uniform interface for using BlockchainDB to store a blockchain. Any implementation of this class will also implement all functions exposed here, so one can use this class without knowing what implementation is being used. Refer to each pure virtual function's documentation here when implementing a BlockchainDB subclass.

A subclass which encounters an issue should report that issue by throwing a DB_EXCEPTION which adequately conveys the issue.

Constructor & Destructor Documentation

◆ BlockchainDB()

cryptonote::BlockchainDB::BlockchainDB ( )

inline

An empty constructor.

◆ ~BlockchainDB()

virtual cryptonote::BlockchainDB::~BlockchainDB ( )

inlinevirtual

An empty destructor.

Member Function Documentation

◆ add_block() [1/2]

virtual void cryptonote::BlockchainDB::add_block	(	const block &	blk,
		size_t	block_weight,
		uint64_t	long_term_block_weight,
		const difficulty_type &	cumulative_difficulty,
		const uint64_t &	coins_generated,
		uint64_t	num_rct_outs,
		const crypto::hash &	blk_hash
	)

privatepure virtual

add the block and metadata to the db

The subclass implementing this will add the specified block and block metadata to its backing store. This does not include its transactions, those are added in a separate step.

If any of this cannot be done, the subclass should throw the corresponding subclass of DB_EXCEPTION

Parameters

blk	the block to be added
block_weight	the weight of the block (transactions and all)
long_term_block_weight	the long term block weight of the block (transactions and all)
cumulative_difficulty	the accumulated difficulty after this block
coins_generated	the number of coins generated total after this block
blk_hash	the hash of the block

Implemented in cryptonote::BaseTestDB, and cryptonote::BlockchainLMDB.

◆ add_block() [2/2]

uint64_t cryptonote::BlockchainDB::add_block	(	const std::pair< block, blobdata > &	blk,
		size_t	block_weight,
		uint64_t	long_term_block_weight,
		const difficulty_type &	cumulative_difficulty,
		const uint64_t &	coins_generated,
		const std::vector< std::pair< transaction, blobdata >> &	txs
	)

virtual

handles the addition of a new block to BlockchainDB

This function organizes block addition and calls various functions as necessary.

NOTE: subclass implementations of this (or the functions it calls) need to handle undoing any partially-added blocks in the event of a failure.

If any of this cannot be done, the subclass should throw the corresponding subclass of DB_EXCEPTION

Parameters

blk	the block to be added
block_weight	the size of the block (transactions and all)
long_term_block_weight	the long term weight of the block (transactions and all)
cumulative_difficulty	the accumulated difficulty after this block
coins_generated	the number of coins generated total after this block
txs	the transactions in the block

Returns: the height of the chain post-addition

Reimplemented in cryptonote::BlockchainLMDB.

◆ add_max_block_size()

virtual void cryptonote::BlockchainDB::add_max_block_size ( uint64_t sz )

pure virtual

add a new max block size

The max block size will be the maximum of sz and the current block size

Parameters

sz the block size

Implemented in cryptonote::BaseTestDB, and cryptonote::BlockchainLMDB.

◆ add_output()

virtual uint64_t cryptonote::BlockchainDB::add_output	(	const crypto::hash &	tx_hash,
		const tx_out &	tx_output,
		const uint64_t &	local_index,
		const uint64_t	unlock_time,
		const rct::key *	commitment
	)

privatepure virtual

store an output

The subclass implementing this will add the output data passed to its backing store in a suitable manner. In addition, the subclass is responsible for keeping track of the global output count in some manner, so that outputs may be indexed by the order in which they were created. In the future, this tracking (of the number, at least) should be moved to this class, as it is necessary and the same among all BlockchainDB.

It returns an amount output index, which is the index of the output for its specified amount.

This data should be stored in such a manner that the only thing needed to reverse the process is the tx_out.

If any of this cannot be done, the subclass should throw the corresponding subclass of DB_EXCEPTION

Parameters

tx_hash	hash of the transaction the output was created by
tx_output	the output
local_index	index of the output in its transaction
unlock_time	unlock time/height of the output
commitment	the rct commitment to the output amount

Returns: amount output index

Implemented in cryptonote::BlockchainLMDB, cryptonote::BlockchainBDB, and cryptonote::BaseTestDB.

◆ add_spent_key()

virtual void cryptonote::BlockchainDB::add_spent_key ( const crypto::key_image & k_image )

privatepure virtual

store a spent key

The subclass implementing this will store the spent key image.

If any of this cannot be done, the subclass should throw the corresponding subclass of DB_EXCEPTION

Parameters

k_image the spent key image to store

Implemented in cryptonote::BaseTestDB, cryptonote::BlockchainLMDB, and cryptonote::BlockchainBDB.

◆ add_transaction()

void cryptonote::BlockchainDB::add_transaction	(	const crypto::hash &	blk_hash,
		const std::pair< transaction, blobdata > &	tx,
		const crypto::hash *	tx_hash_ptr = `NULL`,
		const crypto::hash *	tx_prunable_hash_ptr = `NULL`
	)

protected

helper function for add_transactions, to add each individual transaction

This function is called by add_transactions() for each transaction to be added.

Parameters

blk_hash	hash of the block which has the transaction
tx	the transaction to add
tx_hash_ptr	the hash of the transaction, if already calculated
tx_prunable_hash_ptr	the hash of the prunable part of the transaction, if already calculated

◆ add_transaction_data()

virtual uint64_t cryptonote::BlockchainDB::add_transaction_data	(	const crypto::hash &	blk_hash,
		const std::pair< transaction, blobdata > &	tx,
		const crypto::hash &	tx_hash,
		const crypto::hash &	tx_prunable_hash
	)

privatepure virtual

store the transaction and its metadata

The subclass implementing this will add the specified transaction data to its backing store. This includes only the transaction blob itself and the other data passed here, not the separate outputs of the transaction.

It returns a tx ID, which is a mapping from the tx_hash. The tx ID is used in add_tx_amount_output_indices().

If any of this cannot be done, the subclass should throw the corresponding subclass of DB_EXCEPTION

Parameters

blk_hash	the hash of the block containing the transaction
tx	the transaction to be added
tx_hash	the hash of the transaction
tx_prunable_hash	the hash of the prunable part of the transaction

Returns: the transaction ID

Implemented in cryptonote::BlockchainLMDB.

◆ add_tx_amount_output_indices()

virtual void cryptonote::BlockchainDB::add_tx_amount_output_indices	(	const uint64_t	tx_id,
		const std::vector< uint64_t > &	amount_output_indices
	)

privatepure virtual

store amount output indices for a tx's outputs

The subclass implementing this will add the amount output indices to its backing store in a suitable manner. The tx_id will be the same one that was returned from add_output().

If any of this cannot be done, the subclass should throw the corresponding subclass of DB_EXCEPTION

Parameters

tx_id	ID of the transaction containing these outputs
amount_output_indices	the amount output indices of the transaction

Implemented in cryptonote::BaseTestDB, and cryptonote::BlockchainLMDB.

◆ add_txpool_tx()

virtual void cryptonote::BlockchainDB::add_txpool_tx	(	const crypto::hash &	txid,
		const cryptonote::blobdata &	blob,
		const txpool_tx_meta_t &	details
	)

pure virtual

add a txpool transaction

Parameters

details the details of the transaction to add

Implemented in cryptonote::BlockchainLMDB, and cryptonote::BaseTestDB.

◆ batch_abort()

virtual void cryptonote::BlockchainDB::batch_abort ( )

pure virtual

aborts a batch transaction

If the subclass implements batching, this function should abort the batch it is currently on.

If no batch is in-progress, this function should throw a DB_ERROR. This exception may change in the future if it is deemed necessary to have a more granular exception type for this scenario.

If any of this cannot be done, the subclass should throw the corresponding subclass of DB_EXCEPTION

Implemented in cryptonote::BaseTestDB, cryptonote::BlockchainLMDB, and cryptonote::BlockchainBDB.

◆ batch_start()

virtual bool cryptonote::BlockchainDB::batch_start	(	uint64_t	batch_num_blocks = `0`,
		uint64_t	batch_bytes = `0`
	)

pure virtual

tells the BlockchainDB to start a new "batch" of blocks

If the subclass implements a batching method of caching blocks in RAM to be added to a backing store in groups, it should start a batch which will end either when <batch_num_blocks> has been added or batch_stop() has been called. In either case, it should end the batch and write to its backing store.

If a batch is already in-progress, this function must return false. If a batch was started by this call, it must return true.

If any of this cannot be done, the subclass should throw the corresponding subclass of DB_EXCEPTION

Parameters

batch_num_blocks number of blocks to batch together

Returns: true if we started the batch, false if already started

Implemented in cryptonote::BaseTestDB, and cryptonote::BlockchainLMDB.

◆ batch_stop()

virtual void cryptonote::BlockchainDB::batch_stop ( )

pure virtual

ends a batch transaction

If the subclass implements batching, this function should store the batch it is currently on and mark it finished.

If no batch is in-progress, this function should throw a DB_ERROR. This exception may change in the future if it is deemed necessary to have a more granular exception type for this scenario.

If any of this cannot be done, the subclass should throw the corresponding subclass of DB_EXCEPTION

Implemented in cryptonote::BaseTestDB, cryptonote::BlockchainLMDB, and cryptonote::BlockchainBDB.

◆ block_exists()

virtual bool cryptonote::BlockchainDB::block_exists	(	const crypto::hash &	h,
		uint64_t *	height = `NULL`
	)		const

pure virtual

checks if a block exists

Parameters

h	the hash of the requested block
height	if non NULL, returns the block's height if found

Returns: true of the block exists, otherwise false

Implemented in cryptonote::BlockchainLMDB, cryptonote::BlockchainBDB, and cryptonote::BaseTestDB.

◆ block_rtxn_abort()

virtual void cryptonote::BlockchainDB::block_rtxn_abort ( ) const

pure virtual

Implemented in cryptonote::BaseTestDB, and cryptonote::BlockchainLMDB.

◆ block_rtxn_start()

virtual bool cryptonote::BlockchainDB::block_rtxn_start ( ) const

pure virtual

Implemented in cryptonote::BaseTestDB, and cryptonote::BlockchainLMDB.

◆ block_rtxn_stop()

virtual void cryptonote::BlockchainDB::block_rtxn_stop ( ) const

pure virtual

Implemented in cryptonote::BaseTestDB, and cryptonote::BlockchainLMDB.

◆ block_wtxn_abort()

virtual void cryptonote::BlockchainDB::block_wtxn_abort ( )

pure virtual

Implemented in cryptonote::BaseTestDB, and cryptonote::BlockchainLMDB.

◆ block_wtxn_start()

virtual void cryptonote::BlockchainDB::block_wtxn_start ( )

pure virtual

Implemented in cryptonote::BaseTestDB, and cryptonote::BlockchainLMDB.

◆ block_wtxn_stop()

virtual void cryptonote::BlockchainDB::block_wtxn_stop ( )

pure virtual

Implemented in cryptonote::BaseTestDB, and cryptonote::BlockchainLMDB.

◆ can_thread_bulk_indices()

virtual bool cryptonote::BlockchainDB::can_thread_bulk_indices ( ) const

pure virtual

Implemented in cryptonote::BaseTestDB, cryptonote::BlockchainLMDB, and cryptonote::BlockchainBDB.

◆ check_hard_fork_info()

virtual void cryptonote::BlockchainDB::check_hard_fork_info ( )

pure virtual

verify hard fork info in database

Implemented in cryptonote::BaseTestDB, cryptonote::BlockchainLMDB, and cryptonote::BlockchainBDB.

◆ check_pruning()

virtual bool cryptonote::BlockchainDB::check_pruning ( )

pure virtual

checks pruning was done correctly, iff enabled

Returns: success iff true

Implemented in cryptonote::BaseTestDB, and cryptonote::BlockchainLMDB.

◆ close()

virtual void cryptonote::BlockchainDB::close ( )

pure virtual

close the BlockchainDB

At minimum, this call ensures that further use of the BlockchainDB instance will not have effect. In any case where it is necessary to do so, a subclass implementing this will sync with disk.

If any of this cannot be done, the subclass should throw the corresponding subclass of DB_EXCEPTION

Implemented in cryptonote::BaseTestDB, cryptonote::BlockchainLMDB, and cryptonote::BlockchainBDB.

◆ drop_hard_fork_info()

virtual void cryptonote::BlockchainDB::drop_hard_fork_info ( )

pure virtual

delete hard fork info from database

Implemented in cryptonote::BaseTestDB, cryptonote::BlockchainLMDB, and cryptonote::BlockchainBDB.

◆ fixup()

void cryptonote::BlockchainDB::fixup ( )

virtual

fix up anything that may be wrong due to past bugs

Reimplemented in cryptonote::BlockchainLMDB.

◆ for_all_key_images()

virtual bool cryptonote::BlockchainDB::for_all_key_images ( std::function< bool(const crypto::key_image &)> ) const

pure virtual

runs a function over all key images stored

The subclass should run the passed function for each key image it has stored, passing the key image as its parameter.

If any call to the function returns false, the subclass should return false. Otherwise, the subclass returns true.

Parameters

std::function fn the function to run

Returns: false if the function returns false for any key image, otherwise true

Implemented in cryptonote::BaseTestDB, cryptonote::BlockchainLMDB, and cryptonote::BlockchainBDB.

◆ for_all_outputs() [1/2]

virtual bool cryptonote::BlockchainDB::for_all_outputs ( std::function< bool(uint64_t amount, const crypto::hash &tx_hash, uint64_t height, size_t tx_idx)> f ) const

pure virtual

runs a function over all outputs stored

The subclass should run the passed function for each output it has stored, passing (amount, transaction_hash, tx_local_output_index) as its parameters.

If any call to the function returns false, the subclass should return false. Otherwise, the subclass returns true.

The subclass should throw DB_ERROR if any of the expected values are not found. Current implementations simply return false.

Parameters

std::function f the function to run

Returns: false if the function returns false for any output, otherwise true

Implemented in cryptonote::BaseTestDB, and cryptonote::BlockchainLMDB.

◆ for_all_outputs() [2/2]

virtual bool cryptonote::BlockchainDB::for_all_outputs	(	uint64_t	amount,
		const std::function< bool(uint64_t height)> &	f
	)		const

pure virtual

Implemented in cryptonote::BaseTestDB, and cryptonote::BlockchainLMDB.

◆ for_all_transactions()

virtual bool cryptonote::BlockchainDB::for_all_transactions	(	std::function< bool(const crypto::hash &, const cryptonote::transaction &)>	,
		bool	pruned
	)		const

pure virtual

runs a function over all transactions stored

The subclass should run the passed function for each transaction it has stored, passing (transaction_hash, transaction) as its parameters.

If any call to the function returns false, the subclass should return false. Otherwise, the subclass returns true.

The subclass should throw DB_ERROR if any of the expected values are not found. Current implementations simply return false.

Parameters

std::function	fn the function to run
bool	pruned whether to only get pruned tx data, or the whole

Returns: false if the function returns false for any transaction, otherwise true

Implemented in cryptonote::BaseTestDB, cryptonote::BlockchainLMDB, and cryptonote::BlockchainBDB.

◆ for_all_txpool_txes()

virtual bool cryptonote::BlockchainDB::for_all_txpool_txes	(	std::function< bool(const crypto::hash &, const txpool_tx_meta_t &, const cryptonote::blobdata *)>	,
		bool	include_blob = `false`,
		bool	include_unrelayed_txes = `true`
	)		const

pure virtual

runs a function over all txpool transactions

The subclass should run the passed function for each txpool tx it has stored, passing the tx id and metadata as its parameters.

If any call to the function returns false, the subclass should return false. Otherwise, the subclass returns true.

Parameters

std::function fn the function to run

Returns: false if the function returns false for any transaction, otherwise true

Implemented in cryptonote::BlockchainLMDB.

◆ for_blocks_range()

virtual bool cryptonote::BlockchainDB::for_blocks_range	(	const uint64_t &	h1,
		const uint64_t &	h2,
		std::function< bool(uint64_t, const crypto::hash &, const cryptonote::block &)>
	)		const

pure virtual

runs a function over a range of blocks

The subclass should run the passed function for each block in the specified range, passing (block_height, block_hash, block) as its parameters.

If any call to the function returns false, the subclass should return false. Otherwise, the subclass returns true.

The subclass should throw DB_ERROR if any of the expected values are not found. Current implementations simply return false.

Parameters

h1	the start height
h2	the end height
std::function	fn the function to run

Returns: false if the function returns false for any block, otherwise true

Implemented in cryptonote::BlockchainLMDB, and cryptonote::BaseTestDB.

◆ get_block()

block cryptonote::BlockchainDB::get_block ( const crypto::hash & h ) const

virtual

fetches the block with the given hash

Returns the requested block.

If the block does not exist, the subclass should throw BLOCK_DNE

Parameters

h	the hash to look for

Returns: the block requested

Reimplemented in cryptonote::BlockchainBDB.

◆ get_block_already_generated_coins()

virtual uint64_t cryptonote::BlockchainDB::get_block_already_generated_coins ( const uint64_t & height ) const

pure virtual

fetch a block's already generated coins

The subclass should return the total coins generated as of the block with the given height.

If the block does not exist, the subclass should throw BLOCK_DNE

Parameters

height the height requested

Returns: the already generated coins

Implemented in cryptonote::BaseTestDB, cryptonote::BlockchainLMDB, and cryptonote::BlockchainBDB.

◆ get_block_blob()

virtual cryptonote::blobdata cryptonote::BlockchainDB::get_block_blob ( const crypto::hash & h ) const

pure virtual

fetches the block with the given hash

The subclass should return the requested block.

If the block does not exist, the subclass should throw BLOCK_DNE

Parameters

h	the hash to look for

Returns: the block requested

Implemented in cryptonote::BaseTestDB, and cryptonote::BlockchainLMDB.

◆ get_block_blob_from_height()

virtual cryptonote::blobdata cryptonote::BlockchainDB::get_block_blob_from_height ( const uint64_t & height ) const

pure virtual

fetch a block blob by height

The subclass should return the block at the given height.

If the block does not exist, that is to say if the blockchain is not that high, then the subclass should throw BLOCK_DNE

Parameters

height the height to look for

Returns: the block blob

Implemented in cryptonote::BaseTestDB, and cryptonote::BlockchainLMDB.

◆ get_block_cumulative_difficulty()

virtual difficulty_type cryptonote::BlockchainDB::get_block_cumulative_difficulty ( const uint64_t & height ) const

pure virtual

fetch a block's cumulative difficulty

The subclass should return the cumulative difficulty of the block with the given height.

If the block does not exist, the subclass should throw BLOCK_DNE

Parameters

height the height requested

Returns: the cumulative difficulty

Implemented in cryptonote::BaseTestDB, cryptonote::BlockchainLMDB, and cryptonote::BlockchainBDB.

◆ get_block_cumulative_rct_outputs()

virtual std::vector<uint64_t> cryptonote::BlockchainDB::get_block_cumulative_rct_outputs ( const std::vector< uint64_t > & heights ) const

pure virtual

fetch a block's cumulative number of rct outputs

The subclass should return the numer of rct outputs in the blockchain up to the block with the given height (inclusive).

If the block does not exist, the subclass should throw BLOCK_DNE

Parameters

height the height requested

Returns: the cumulative number of rct outputs

Implemented in cryptonote::BaseTestDB, and cryptonote::BlockchainLMDB.

◆ get_block_difficulty()

virtual difficulty_type cryptonote::BlockchainDB::get_block_difficulty ( const uint64_t & height ) const

pure virtual

fetch a block's difficulty

The subclass should return the difficulty of the block with the given height.

If the block does not exist, the subclass should throw BLOCK_DNE

Parameters

height the height requested

Returns: the difficulty

Implemented in cryptonote::BaseTestDB, cryptonote::BlockchainLMDB, and cryptonote::BlockchainBDB.

◆ get_block_from_height()

block cryptonote::BlockchainDB::get_block_from_height ( const uint64_t & height ) const

virtual

fetch a block by height

If the block does not exist, that is to say if the blockchain is not that high, then the subclass should throw BLOCK_DNE

Parameters

height the height to look for

Returns: the block

Reimplemented in cryptonote::BaseTestDB, and cryptonote::BlockchainBDB.

◆ get_block_hash_from_height()

virtual crypto::hash cryptonote::BlockchainDB::get_block_hash_from_height ( const uint64_t & height ) const

pure virtual

fetch a block's hash

The subclass should return hash of the block with the given height.

If the block does not exist, the subclass should throw BLOCK_DNE

Parameters

height the height requested

Returns: the hash

Implemented in cryptonote::BaseTestDB, cryptonote::BlockchainLMDB, and cryptonote::BlockchainBDB.

◆ get_block_header()

virtual block_header cryptonote::BlockchainDB::get_block_header ( const crypto::hash & h ) const

pure virtual

fetch a block header

The subclass should return the block header from the block with the given hash.

If the block does not exist, the subclass should throw BLOCK_DNE

Parameters

h	the hash to look for

Returns: the block header

Implemented in cryptonote::BaseTestDB, cryptonote::BlockchainLMDB, and cryptonote::BlockchainBDB.

◆ get_block_height()

virtual uint64_t cryptonote::BlockchainDB::get_block_height ( const crypto::hash & h ) const

pure virtual

gets the height of the block with a given hash

The subclass should return the requested height.

If the block does not exist, the subclass should throw BLOCK_DNE

Parameters

h	the hash to look for

Returns: the height

Implemented in cryptonote::BaseTestDB, cryptonote::BlockchainLMDB, and cryptonote::BlockchainBDB.

◆ get_block_long_term_weight()

virtual uint64_t cryptonote::BlockchainDB::get_block_long_term_weight ( const uint64_t & height ) const

pure virtual

fetch a block's long term weight

If the block does not exist, the subclass should throw BLOCK_DNE

Parameters

height the height requested

Returns: the long term weight

Implemented in cryptonote::BaseTestDB, and cryptonote::BlockchainLMDB.

◆ get_block_timestamp()

virtual uint64_t cryptonote::BlockchainDB::get_block_timestamp ( const uint64_t & height ) const

pure virtual

fetch a block's timestamp

The subclass should return the timestamp of the block with the given height.

If the block does not exist, the subclass should throw BLOCK_DNE

Parameters

height the height requested

Returns: the timestamp

Implemented in cryptonote::BaseTestDB, cryptonote::BlockchainLMDB, and cryptonote::BlockchainBDB.

◆ get_block_weight()

virtual size_t cryptonote::BlockchainDB::get_block_weight ( const uint64_t & height ) const

pure virtual

fetch a block's weight

The subclass should return the weight of the block with the given height.

If the block does not exist, the subclass should throw BLOCK_DNE

Parameters

height the height requested

Returns: the weight

Implemented in cryptonote::BaseTestDB, cryptonote::BlockchainLMDB, and cryptonote::BlockchainBDB.

◆ get_block_weights()

virtual std::vector<uint64_t> cryptonote::BlockchainDB::get_block_weights	(	uint64_t	start_height,
		size_t	count
	)		const

pure virtual

fetch the last N blocks' weights

If there are fewer than N blocks, the returned array will be smaller than N

Parameters

count the number of blocks requested

Returns: the weights

Implemented in cryptonote::BaseTestDB, and cryptonote::BlockchainLMDB.

◆ get_blockchain_pruning_seed()

virtual uint32_t cryptonote::BlockchainDB::get_blockchain_pruning_seed ( ) const

pure virtual

get the blockchain pruning seed

Returns: the blockchain pruning seed

Implemented in cryptonote::BaseTestDB, and cryptonote::BlockchainLMDB.

◆ get_blocks_range()

virtual std::vector<block> cryptonote::BlockchainDB::get_blocks_range	(	const uint64_t &	h1,
		const uint64_t &	h2
	)		const

pure virtual

fetch a list of blocks

The subclass should return a vector of blocks with heights starting at h1 and ending at h2, inclusively.

If the height range requested goes past the end of the blockchain, the subclass should throw BLOCK_DNE. (current implementations simply don't catch this exception as thrown by methods called within)

Parameters

h1	the start height
h2	the end height

Returns: a vector of blocks

Implemented in cryptonote::BaseTestDB, cryptonote::BlockchainLMDB, and cryptonote::BlockchainBDB.

◆ get_database_size()

virtual uint64_t cryptonote::BlockchainDB::get_database_size ( ) const

pure virtual

get disk space requirements

Returns: the size required

Implemented in cryptonote::BaseTestDB, and cryptonote::BlockchainLMDB.

◆ get_db_name()

virtual std::string cryptonote::BlockchainDB::get_db_name ( ) const

pure virtual

gets the name of the folder the BlockchainDB's file(s) should be in

The subclass implementation should return the name of the folder in which it stores files, or an empty string if there is none.

Returns: the name of the folder with the BlockchainDB's files, if any.

Implemented in cryptonote::BaseTestDB, cryptonote::BlockchainLMDB, and cryptonote::BlockchainBDB.

◆ get_filenames()

virtual std::vector<std::string> cryptonote::BlockchainDB::get_filenames ( ) const

pure virtual

get all files used by the BlockchainDB (if any)

This function is largely for ease of automation, namely for unit tests.

The subclass implementation should return all filenames it uses.

Returns: a list of filenames

Implemented in cryptonote::BaseTestDB, cryptonote::BlockchainLMDB, and cryptonote::BlockchainBDB.

◆ get_hard_fork_version()

virtual uint8_t cryptonote::BlockchainDB::get_hard_fork_version ( uint64_t height ) const

pure virtual

checks which hardfork version a height is on

Parameters

height the height

Returns: the version

Implemented in cryptonote::BaseTestDB, cryptonote::BlockchainLMDB, and cryptonote::BlockchainBDB.

◆ get_hashes_range()

virtual std::vector<crypto::hash> cryptonote::BlockchainDB::get_hashes_range	(	const uint64_t &	h1,
		const uint64_t &	h2
	)		const

pure virtual

fetch a list of block hashes

The subclass should return a vector of block hashes from blocks with heights starting at h1 and ending at h2, inclusively.

If the height range requested goes past the end of the blockchain, the subclass should throw BLOCK_DNE. (current implementations simply don't catch this exception as thrown by methods called within)

Parameters

h1	the start height
h2	the end height

Returns: a vector of block hashes

Implemented in cryptonote::BaseTestDB, cryptonote::BlockchainLMDB, and cryptonote::BlockchainBDB.

◆ get_indexing_base()

virtual uint64_t cryptonote::BlockchainDB::get_indexing_base ( ) const

inlinevirtual

return index of the first element (should be hidden, but isn't)

Returns: the index

Reimplemented in cryptonote::BaseTestDB, and cryptonote::BlockchainBDB.

◆ get_long_term_block_weights()

virtual std::vector<uint64_t> cryptonote::BlockchainDB::get_long_term_block_weights	(	uint64_t	start_height,
		size_t	count
	)		const

pure virtual

fetch the last N blocks' long term weights

If there are fewer than N blocks, the returned array will be smaller than N

Parameters

count the number of blocks requested

Returns: the weights

Implemented in cryptonote::BaseTestDB, and cryptonote::BlockchainLMDB.

◆ get_max_block_size()

virtual uint64_t cryptonote::BlockchainDB::get_max_block_size ( )

pure virtual

get the max block size

Implemented in cryptonote::BaseTestDB, and cryptonote::BlockchainLMDB.

◆ get_num_outputs()

virtual uint64_t cryptonote::BlockchainDB::get_num_outputs ( const uint64_t & amount ) const

pure virtual

fetches the number of outputs of a given amount

The subclass should return a count of outputs of the given amount, or zero if there are none.

Parameters

amount the output amount being looked up

Returns: the number of outputs of the given amount

Implemented in cryptonote::BaseTestDB, cryptonote::BlockchainLMDB, and cryptonote::BlockchainBDB.

◆ get_output_distribution()

virtual bool cryptonote::BlockchainDB::get_output_distribution	(	uint64_t	amount,
		uint64_t	from_height,
		uint64_t	to_height,
		std::vector< uint64_t > &	distribution,
		uint64_t &	base
	)		const

pure virtual

Implemented in cryptonote::BaseTestDB, and cryptonote::BlockchainLMDB.

◆ get_output_histogram()

virtual std::map<uint64_t, std::tuple<uint64_t, uint64_t, uint64_t> > cryptonote::BlockchainDB::get_output_histogram	(	const std::vector< uint64_t > &	amounts,
		bool	unlocked,
		uint64_t	recent_cutoff,
		uint64_t	min_count
	)		const

pure virtual

return a histogram of outputs on the blockchain

Parameters

amounts	optional set of amounts to lookup
unlocked	whether to restrict count to unlocked outputs
recent_cutoff	timestamp to determine whether an output is recent
min_count	return only amounts with at least that many instances

Returns: a set of amount/instances

Implemented in cryptonote::BaseTestDB, and cryptonote::BlockchainLMDB.

◆ get_output_key() [1/2]

virtual void cryptonote::BlockchainDB::get_output_key	(	const epee::span< const uint64_t > &	amounts,
		const std::vector< uint64_t > &	offsets,
		std::vector< output_data_t > &	outputs,
		bool	allow_partial = `false`
	)		const

pure virtual

gets outputs' data

This function is a mirror of get_output_data(const uint64_t& amount, const uint64_t& index) but for a list of outputs rather than just one.

Parameters

amounts	an output amount, or as many as offsets
offsets	a list of amount-specific output indices
outputs	return-by-reference a list of outputs' metadata

Implemented in cryptonote::BlockchainLMDB.

◆ get_output_key() [2/2]

virtual output_data_t cryptonote::BlockchainDB::get_output_key	(	const uint64_t &	amount,
		const uint64_t &	index,
		bool	include_commitmemt = `true`
	)		const

pure virtual

get some of an output's data

The subclass should return the public key, unlock time, and block height for the output with the given amount and index, collected in a struct.

If the output cannot be found, the subclass should throw OUTPUT_DNE.

If any of these parts cannot be found, but some are, the subclass should throw DB_ERROR with a message stating as much.

Parameters

amount	the output amount
index	the output's index (indexed by amount)

Returns: the requested output data

Implemented in cryptonote::BaseTestDB, and cryptonote::BlockchainLMDB.

◆ get_output_tx_and_index() [1/2]

virtual void cryptonote::BlockchainDB::get_output_tx_and_index	(	const uint64_t &	amount,
		const std::vector< uint64_t > &	offsets,
		std::vector< tx_out_index > &	indices
	)		const

pure virtual

gets some outputs' tx hashes and indices

This function is a mirror of get_output_tx_and_index(const uint64_t& amount, const uint64_t& index), but for a list of outputs rather than just one.

Parameters

amount	an output amount
offsets	a list of amount-specific output indices
indices	return-by-reference a list of tx hashes and output indices (as pairs)

Implemented in cryptonote::BlockchainLMDB.

◆ get_output_tx_and_index() [2/2]

virtual tx_out_index cryptonote::BlockchainDB::get_output_tx_and_index	(	const uint64_t &	amount,
		const uint64_t &	index
	)		const

pure virtual

gets an output's tx hash and index

The subclass should return the hash of the transaction which created the output with the amount and index given, as well as its index in that transaction.

Parameters

amount	an output amount
index	an output's amount-specific index

Returns: the tx hash and output index

Implemented in cryptonote::BaseTestDB, and cryptonote::BlockchainLMDB.

◆ get_output_tx_and_index_from_global()

virtual tx_out_index cryptonote::BlockchainDB::get_output_tx_and_index_from_global ( const uint64_t & index ) const

pure virtual

gets an output's tx hash and index

The subclass should return the hash of the transaction which created the output with the global index given, as well as its index in that transaction.

Parameters

index an output's global index

Returns: the tx hash and output index

Implemented in cryptonote::BaseTestDB, cryptonote::BlockchainLMDB, and cryptonote::BlockchainBDB.

◆ get_prunable_tx_blob()

virtual bool cryptonote::BlockchainDB::get_prunable_tx_blob	(	const crypto::hash &	h,
		cryptonote::blobdata &	tx
	)		const

pure virtual

fetches the prunable transaction blob with the given hash

The subclass should return the prunable transaction stored which has the given hash.

If the transaction does not exist, or if we do not have that prunable data, the subclass should return false.

Parameters

h	the hash to look for

Returns: true iff the transaction was found and we have its prunable data

Implemented in cryptonote::BaseTestDB, and cryptonote::BlockchainLMDB.

◆ get_prunable_tx_hash()

virtual bool cryptonote::BlockchainDB::get_prunable_tx_hash	(	const crypto::hash &	tx_hash,
		crypto::hash &	prunable_hash
	)		const

pure virtual

fetches the prunable transaction hash

The subclass should return the hash of the prunable transaction data.

If the transaction hash does not exist, the subclass should return false.

Parameters

h	the tx hash to look for

Returns: true iff the transaction was found

Implemented in cryptonote::BaseTestDB, and cryptonote::BlockchainLMDB.

◆ get_pruned_tx() [1/2]

transaction cryptonote::BlockchainDB::get_pruned_tx ( const crypto::hash & h ) const

virtual

fetches the transaction base with the given hash

If the transaction does not exist, the subclass should throw TX_DNE.

Parameters

h	the hash to look for

Returns: the transaction with the given hash

◆ get_pruned_tx() [2/2]

bool cryptonote::BlockchainDB::get_pruned_tx	(	const crypto::hash &	h,
		cryptonote::transaction &	tx
	)		const

virtual

fetches the transaction base with the given hash

If the transaction does not exist, the subclass should return false.

Parameters

h	the hash to look for

Returns: true iff the transaction was found

◆ get_pruned_tx_blob()

virtual bool cryptonote::BlockchainDB::get_pruned_tx_blob	(	const crypto::hash &	h,
		cryptonote::blobdata &	tx
	)		const

pure virtual

fetches the pruned transaction blob with the given hash

The subclass should return the pruned transaction stored which has the given hash.

If the transaction does not exist, the subclass should return false.

Parameters

h	the hash to look for

Returns: true iff the transaction was found

Implemented in cryptonote::BaseTestDB, and cryptonote::BlockchainLMDB.

◆ get_top_block()

virtual block cryptonote::BlockchainDB::get_top_block ( ) const

pure virtual

fetch the top block

The subclass should return most recent block

Returns: the top block

Implemented in cryptonote::BaseTestDB, cryptonote::BlockchainLMDB, and cryptonote::BlockchainBDB.

◆ get_top_block_timestamp()

virtual uint64_t cryptonote::BlockchainDB::get_top_block_timestamp ( ) const

pure virtual

fetch the top block's timestamp

The subclass should return the timestamp of the most recent block.

Returns: the top block's timestamp

Implemented in cryptonote::BaseTestDB, cryptonote::BlockchainLMDB, and cryptonote::BlockchainBDB.

◆ get_tx() [1/2]

transaction cryptonote::BlockchainDB::get_tx ( const crypto::hash & h ) const

virtual

fetches the transaction with the given hash

If the transaction does not exist, the subclass should throw TX_DNE.

Parameters

h	the hash to look for

Returns: the transaction with the given hash

Reimplemented in cryptonote::BaseTestDB, and cryptonote::BlockchainBDB.

◆ get_tx() [2/2]

bool cryptonote::BlockchainDB::get_tx	(	const crypto::hash &	h,
		cryptonote::transaction &	tx
	)		const

virtual

fetches the transaction with the given hash

If the transaction does not exist, the subclass should return false.

Parameters

h	the hash to look for

Returns: true iff the transaction was found

Reimplemented in cryptonote::BaseTestDB.

◆ get_tx_amount_output_indices()

virtual std::vector<std::vector<uint64_t> > cryptonote::BlockchainDB::get_tx_amount_output_indices	(	const uint64_t	tx_id,
		size_t	n_txes = `1`
	)		const

pure virtual

gets output indices (amount-specific) for a transaction's outputs

The subclass should fetch the amount-specific output indices for each output in the transaction with the given ID.

If the transaction does not exist, the subclass should throw TX_DNE.

If an output cannot be found, the subclass should throw OUTPUT_DNE.

Parameters

tx_id	a transaction ID
n_txes	how many txes to get data for, starting with tx_id

Returns: a list of amount-specific output indices

Implemented in cryptonote::BaseTestDB, and cryptonote::BlockchainLMDB.

◆ get_tx_blob()

virtual bool cryptonote::BlockchainDB::get_tx_blob	(	const crypto::hash &	h,
		cryptonote::blobdata &	tx
	)		const

pure virtual

fetches the transaction blob with the given hash

The subclass should return the transaction stored which has the given hash.

If the transaction does not exist, the subclass should return false.

Parameters

h	the hash to look for

Returns: true iff the transaction was found

Implemented in cryptonote::BaseTestDB, and cryptonote::BlockchainLMDB.

◆ get_tx_block_height()

virtual uint64_t cryptonote::BlockchainDB::get_tx_block_height ( const crypto::hash & h ) const

pure virtual

fetches the height of a transaction's block

The subclass should attempt to return the height of the block containing the transaction with the given hash.

If the transaction cannot be found, the subclass should throw TX_DNE.

Parameters

h	the hash of the transaction

Returns: the height of the transaction's block

Implemented in cryptonote::BaseTestDB, cryptonote::BlockchainLMDB, and cryptonote::BlockchainBDB.

◆ get_tx_count()

virtual uint64_t cryptonote::BlockchainDB::get_tx_count ( ) const

pure virtual

fetches the total number of transactions ever

The subclass should return a count of all the transactions from all blocks.

Returns: the number of transactions in the blockchain

Implemented in cryptonote::BaseTestDB, cryptonote::BlockchainLMDB, and cryptonote::BlockchainBDB.

◆ get_tx_list()

virtual std::vector<transaction> cryptonote::BlockchainDB::get_tx_list ( const std::vector< crypto::hash > & hlist ) const

pure virtual

fetches a list of transactions based on their hashes

The subclass should attempt to fetch each transaction referred to by the hashes passed.

Currently, if any of the transactions is not in BlockchainDB, the call to get_tx in the implementation will throw TX_DNE.

Parameters

hlist a list of hashes

Returns: the list of transactions

Implemented in cryptonote::BaseTestDB, cryptonote::BlockchainLMDB, and cryptonote::BlockchainBDB.

◆ get_tx_unlock_time()

virtual uint64_t cryptonote::BlockchainDB::get_tx_unlock_time ( const crypto::hash & h ) const

pure virtual

fetch a transaction's unlock time/height

The subclass should return the stored unlock time for the transaction with the given hash.

If no such transaction exists, the subclass should throw TX_DNE.

Parameters

h	the hash of the requested transaction

Returns: the unlock time/height

Implemented in cryptonote::BaseTestDB, cryptonote::BlockchainLMDB, and cryptonote::BlockchainBDB.

◆ get_txpool_tx_blob() [1/2]

virtual cryptonote::blobdata cryptonote::BlockchainDB::get_txpool_tx_blob ( const crypto::hash & txid ) const

pure virtual

get a txpool transaction's blob

Parameters

txid	the transaction id of the transation to lookup

Returns: the blob for that transaction

Implemented in cryptonote::BaseTestDB, and cryptonote::BlockchainLMDB.

◆ get_txpool_tx_blob() [2/2]

virtual bool cryptonote::BlockchainDB::get_txpool_tx_blob	(	const crypto::hash &	txid,
		cryptonote::blobdata &	bd
	)		const

pure virtual

get a txpool transaction's blob

Parameters

txid	the transaction id of the transation to lookup
bd	the blob to return

Returns: true if the txid was in the txpool, false otherwise

Implemented in cryptonote::BaseTestDB, and cryptonote::BlockchainLMDB.

◆ get_txpool_tx_count()

virtual uint64_t cryptonote::BlockchainDB::get_txpool_tx_count ( bool include_unrelayed_txes = true ) const

pure virtual

get the number of transactions in the txpool

Implemented in cryptonote::BaseTestDB, and cryptonote::BlockchainLMDB.

◆ get_txpool_tx_meta()

virtual bool cryptonote::BlockchainDB::get_txpool_tx_meta	(	const crypto::hash &	txid,
		txpool_tx_meta_t &	meta
	)		const

pure virtual

get a txpool transaction's metadata

Parameters

txid	the transaction id of the transation to lookup
meta	the metadata to return

Returns: true if the tx meta was found, false otherwise

Implemented in cryptonote::BlockchainLMDB, and cryptonote::BaseTestDB.

◆ get_validator_list()

virtual std::string cryptonote::BlockchainDB::get_validator_list ( ) const

pure virtual

Implemented in cryptonote::BaseTestDB, and cryptonote::BlockchainLMDB.

◆ has_key_image()

virtual bool cryptonote::BlockchainDB::has_key_image ( const crypto::key_image & img ) const

pure virtual

check if a key image is stored as spent

Parameters

img	the key image to check for

Returns: true if the image is present, otherwise false

Implemented in cryptonote::BaseTestDB, cryptonote::BlockchainLMDB, and cryptonote::BlockchainBDB.

◆ height()

virtual uint64_t cryptonote::BlockchainDB::height ( ) const

pure virtual

fetch the current blockchain height

The subclass should return the current blockchain height

Returns: the current blockchain height

Implemented in cryptonote::BaseTestDB, cryptonote::BlockchainLMDB, and cryptonote::BlockchainBDB.

◆ init_options()

void cryptonote::BlockchainDB::init_options ( boost::program_options::options_description & desc )

static

init command line options

◆ is_open()

bool cryptonote::BlockchainDB::is_open ( ) const

Gets the current open/ready state of the BlockchainDB.

Returns: true if open/ready, otherwise false

◆ is_read_only()

virtual bool cryptonote::BlockchainDB::is_read_only ( ) const

pure virtual

is BlockchainDB in read-only mode?

Returns: true if in read-only mode, otherwise false

Implemented in cryptonote::BaseTestDB, cryptonote::BlockchainLMDB, and cryptonote::BlockchainBDB.

◆ lock()

virtual bool cryptonote::BlockchainDB::lock ( )

pure virtual

acquires the BlockchainDB lock

This function is a stub until such a time as locking is implemented at this level.

The subclass implementation should return true unless implementing a locking scheme of some sort, in which case it should return true upon acquisition of the lock and block until then.

If any of this cannot be done, the subclass should throw the corresponding subclass of DB_EXCEPTION

Returns: true, unless at a future time false makes sense (timeout, etc)

Implemented in cryptonote::BaseTestDB, cryptonote::BlockchainLMDB, and cryptonote::BlockchainBDB.

◆ open()

virtual void cryptonote::BlockchainDB::open	(	const std::string &	filename,
		const int	db_flags = `0`
	)

pure virtual

open a db, or create it if necessary.

This function opens an existing database or creates it if it does not exist.

The subclass implementing this will handle all file opening/creation, and is responsible for maintaining its state.

The parameter <filename> may not refer to a file name, necessarily, but could be an IP:PORT for a database which needs it, and so on. Calling it <filename> is convenient and should be descriptive enough, however.

For now, db_flags are specific to the subclass being instantiated. This is subject to change, and the db_flags parameter may be deprecated.

If any of this cannot be done, the subclass should throw the corresponding subclass of DB_EXCEPTION

Parameters

filename	a string referring to the BlockchainDB to open
db_flags	flags relevant to how to open/use the BlockchainDB

Implemented in cryptonote::BlockchainLMDB, cryptonote::BaseTestDB, and cryptonote::BlockchainBDB.

◆ pop_block() [1/2]

void cryptonote::BlockchainDB::pop_block ( )

private

private version of pop_block, for undoing if an add_block fails

This function simply calls pop_block(block& blk, std::vector<transaction>& txs) with dummy parameters, as the returns-by-reference can be discarded.

◆ pop_block() [2/2]

void cryptonote::BlockchainDB::pop_block	(	block &	blk,
		std::vector< transaction > &	txs
	)

virtual

pops the top block off the blockchain

The subclass should remove the most recent block from the blockchain, along with all transactions, outputs, and other metadata created as a result of its addition to the blockchain. Most of this is handled by the concrete members of the base class provided the subclass correctly implements remove_* functions.

The subclass should return by reference the popped block and its associated transactions

Parameters

blk	return-by-reference the block which was popped
txs	return-by-reference the transactions from the popped block

Reimplemented in cryptonote::BlockchainLMDB, and cryptonote::BlockchainBDB.

◆ prune_blockchain()

virtual bool cryptonote::BlockchainDB::prune_blockchain ( uint32_t pruning_seed = 0 )

pure virtual

prunes the blockchain

Parameters

pruning_seed the seed to use, 0 for default (highly recommended)

Returns: success iff true

Implemented in cryptonote::BaseTestDB, and cryptonote::BlockchainLMDB.

◆ prune_outputs()

virtual void cryptonote::BlockchainDB::prune_outputs ( uint64_t amount )

pure virtual

prune output data for the given amount

Parameters

amount the amount for which to prune data

Implemented in cryptonote::BaseTestDB, and cryptonote::BlockchainLMDB.

◆ remove_block()

virtual void cryptonote::BlockchainDB::remove_block ( )

privatepure virtual

remove data about the top block

The subclass implementing this will remove the block data from the top block in the chain. The data to be removed is that which was added in BlockchainDB::add_block(const block& blk, size_t block_weight, uint64_t long_term_block_weight, const difficulty_type& cumulative_difficulty, const uint64_t& coins_generated, const crypto::hash& blk_hash)

If any of this cannot be done, the subclass should throw the corresponding subclass of DB_EXCEPTION

Implemented in cryptonote::BaseTestDB, cryptonote::BlockchainLMDB, and cryptonote::BlockchainBDB.

◆ remove_data_file()

virtual bool cryptonote::BlockchainDB::remove_data_file ( const std::string & folder ) const

pure virtual

remove file(s) storing the database

This function is for resetting the database (for core tests, functional tests, etc). The function reset() is not usable because it needs to open the database file first which can fail if the existing database file is in an incompatible format. As such, this function needs to be called before calling open().

Parameters

folder The path of the folder containing the database file(s) which must not end with slash '/'.

Returns: true if the operation is succesfull

Implemented in cryptonote::BaseTestDB, and cryptonote::BlockchainLMDB.

◆ remove_spent_key()

virtual void cryptonote::BlockchainDB::remove_spent_key ( const crypto::key_image & k_image )

privatepure virtual

remove a spent key

The subclass implementing this will remove the key image.

If any of this cannot be done, the subclass should throw the corresponding subclass of DB_EXCEPTION

Parameters

k_image the spent key image to remove

Implemented in cryptonote::BaseTestDB, cryptonote::BlockchainLMDB, and cryptonote::BlockchainBDB.

◆ remove_transaction()

void cryptonote::BlockchainDB::remove_transaction ( const crypto::hash & tx_hash )

private

helper function to remove transaction from the blockchain

This function encapsulates aspects of removing a transaction.

Parameters

tx_hash the hash of the transaction to be removed

◆ remove_transaction_data()

virtual void cryptonote::BlockchainDB::remove_transaction_data	(	const crypto::hash &	tx_hash,
		const transaction &	tx
	)

privatepure virtual

remove data about a transaction

The subclass implementing this will remove the transaction data for the passed transaction. The data to be removed was added in add_transaction_data(). Additionally, current subclasses have behavior which requires the transaction itself as a parameter here. Future implementations should note that this parameter is subject to be removed at a later time.

If any of this cannot be done, the subclass should throw the corresponding subclass of DB_EXCEPTION

Parameters

tx_hash	the hash of the transaction to be removed
tx	the transaction

Implemented in cryptonote::BlockchainLMDB, cryptonote::BlockchainBDB, and cryptonote::BaseTestDB.

◆ remove_txpool_tx()

virtual void cryptonote::BlockchainDB::remove_txpool_tx ( const crypto::hash & txid )

pure virtual

remove a txpool transaction

Parameters

txid	the transaction id of the transation to remove

Implemented in cryptonote::BaseTestDB, and cryptonote::BlockchainLMDB.

◆ reset()

virtual void cryptonote::BlockchainDB::reset ( )

pure virtual

Remove everything from the BlockchainDB.

This function should completely remove all data from a BlockchainDB.

Use with caution!

If any of this cannot be done, the subclass should throw the corresponding subclass of DB_EXCEPTION

Implemented in cryptonote::BaseTestDB, cryptonote::BlockchainLMDB, and cryptonote::BlockchainBDB.

◆ reset_stats()

void cryptonote::BlockchainDB::reset_stats ( )

reset profiling stats

◆ safesyncmode()

virtual void cryptonote::BlockchainDB::safesyncmode ( const bool onoff )

pure virtual

toggle safe syncs for the DB

Used to switch DBF_SAFE on or off after starting up with DBF_FAST.

Implemented in cryptonote::BaseTestDB, and cryptonote::BlockchainLMDB.

◆ set_auto_remove_logs()

void cryptonote::BlockchainDB::set_auto_remove_logs ( bool auto_remove )

inline

set whether or not to automatically remove logs

This function is only relevant for one implementation (BlockchainBDB), but is here to keep BlockchainDB users implementation-agnostic.

Parameters

auto_remove whether or not to auto-remove logs

◆ set_batch_transactions()

virtual void cryptonote::BlockchainDB::set_batch_transactions ( bool )

pure virtual

sets whether or not to batch transactions

If the subclass implements batching, this function tells it to begin batching automatically.

If the subclass implements batching and has a batch in-progress, a parameter of false should disable batching and call batch_stop() to store the current batch.

If any of this cannot be done, the subclass should throw the corresponding subclass of DB_EXCEPTION

Parameters

bool	batch whether or not to use batch transactions.

Implemented in cryptonote::BaseTestDB, cryptonote::BlockchainLMDB, and cryptonote::BlockchainBDB.

◆ set_block_cumulative_difficulty()

virtual void cryptonote::BlockchainDB::set_block_cumulative_difficulty	(	uint64_t	height,
		difficulty_type	diff
	)

pure virtual

sets a block's cumulative difficulty

The subclass should return true if the cumulative difficulty is set successfully

If the block does not exist, the subclass should throw BLOCK_DNE

Parameters

height	the height requested
diff	the cumulative difficulty value to be set

Returns: true | false

Implemented in cryptonote::BaseTestDB, cryptonote::BlockchainLMDB, and cryptonote::BlockchainBDB.

◆ set_hard_fork()

void cryptonote::BlockchainDB::set_hard_fork ( HardFork * hf )

virtual

◆ set_hard_fork_version()

virtual void cryptonote::BlockchainDB::set_hard_fork_version	(	uint64_t	height,
		uint8_t	version
	)

pure virtual

sets which hardfork version a height is on

Parameters

height	the height
version	the version

Implemented in cryptonote::BaseTestDB, cryptonote::BlockchainLMDB, and cryptonote::BlockchainBDB.

◆ set_validator_list()

virtual void cryptonote::BlockchainDB::set_validator_list	(	std::string	,
		uint32_t	expiration_date
	)

pure virtual

Implemented in cryptonote::BaseTestDB, and cryptonote::BlockchainLMDB.

◆ show_stats()

void cryptonote::BlockchainDB::show_stats ( )

show profiling stats

This function prints current performance/profiling data to whichever log file(s) are set up (possibly including stdout or stderr)

◆ sync()

virtual void cryptonote::BlockchainDB::sync ( )

pure virtual

sync the BlockchainDB with disk

This function should write any changes to whatever permanent backing store the subclass uses. Example: a BlockchainDB instance which keeps the whole blockchain in RAM won't need to regularly access a disk, but should write out its state when this is called.

If any of this cannot be done, the subclass should throw the corresponding subclass of DB_EXCEPTION

Implemented in cryptonote::BaseTestDB, cryptonote::BlockchainLMDB, and cryptonote::BlockchainBDB.

◆ top_block_hash()

virtual crypto::hash cryptonote::BlockchainDB::top_block_hash ( uint64_t * block_height = NULL ) const

pure virtual

fetch the top block's hash

The subclass should return the hash of the most recent block

Parameters

block_height if non NULL, returns the height of that block (ie, the blockchain height minus 1)

Returns: the top block's hash

Implemented in cryptonote::BaseTestDB, and cryptonote::BlockchainLMDB.

◆ tx_exists() [1/2]

virtual bool cryptonote::BlockchainDB::tx_exists ( const crypto::hash & h ) const

pure virtual

check if a transaction with a given hash exists

The subclass should check if a transaction is stored which has the given hash and return true if so, false otherwise.

Parameters

h	the hash to check against
tx_id	(optional) returns the tx_id for the tx hash

Returns: true if the transaction exists, otherwise false

Implemented in cryptonote::BaseTestDB, cryptonote::BlockchainLMDB, and cryptonote::BlockchainBDB.

◆ tx_exists() [2/2]

virtual bool cryptonote::BlockchainDB::tx_exists	(	const crypto::hash &	h,
		uint64_t &	tx_id
	)		const

pure virtual

Implemented in cryptonote::BaseTestDB, and cryptonote::BlockchainLMDB.

◆ txpool_has_tx()

virtual bool cryptonote::BlockchainDB::txpool_has_tx ( const crypto::hash & txid ) const

pure virtual

check whether a txid is in the txpool

Implemented in cryptonote::BaseTestDB, and cryptonote::BlockchainLMDB.

◆ unlock()

virtual void cryptonote::BlockchainDB::unlock ( )

pure virtual

This function releases the BlockchainDB lock.

The subclass, should it have implemented lock(), will release any lock held by the calling thread. In the case of recursive locking, it should release one instance of a lock.

If any of this cannot be done, the subclass should throw the corresponding subclass of DB_EXCEPTION

Implemented in cryptonote::BaseTestDB, cryptonote::BlockchainLMDB, and cryptonote::BlockchainBDB.

◆ update_pruning()

virtual bool cryptonote::BlockchainDB::update_pruning ( )

pure virtual

prunes recent blockchain changes as needed, iff pruning is enabled

Returns: success iff true

Implemented in cryptonote::BaseTestDB, and cryptonote::BlockchainLMDB.

◆ update_txpool_tx()

virtual void cryptonote::BlockchainDB::update_txpool_tx	(	const crypto::hash &	txid,
		const txpool_tx_meta_t &	details
	)

pure virtual

update a txpool transaction's metadata

Parameters

txid	the txid of the transaction to update
details	the details of the transaction to update

Implemented in cryptonote::BlockchainLMDB, and cryptonote::BaseTestDB.

Member Data Documentation

◆ m_auto_remove_logs

bool cryptonote::BlockchainDB::m_auto_remove_logs = true

protected

whether or not to automatically remove old logs

◆ m_hardfork

HardFork* cryptonote::BlockchainDB::m_hardfork

protected

◆ m_open

bool cryptonote::BlockchainDB::m_open

Whether or not the BlockchainDB is open/ready for use.

◆ m_synchronization_lock

epee::critical_section cryptonote::BlockchainDB::m_synchronization_lock

mutable

A lock, currently for when BlockchainLMDB needs to resize the backing db file.

◆ num_calls

uint64_t cryptonote::BlockchainDB::num_calls = 0

private

a performance metric

◆ time_add_block1

uint64_t cryptonote::BlockchainDB::time_add_block1 = 0

private

a performance metric

◆ time_add_transaction

uint64_t cryptonote::BlockchainDB::time_add_transaction = 0

private

a performance metric

◆ time_blk_hash

uint64_t cryptonote::BlockchainDB::time_blk_hash = 0

private

a performance metric

◆ time_commit1

uint64_t cryptonote::BlockchainDB::time_commit1 = 0

protected

a performance metric

◆ time_tx_exists

uint64_t cryptonote::BlockchainDB::time_tx_exists = 0

mutableprotected

a performance metric

The documentation for this class was generated from the following files:

src/blockchain_db/blockchain_db.h
src/blockchain_db/blockchain_db.cpp

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ BlockchainDB()

◆ ~BlockchainDB()

Member Function Documentation

◆ add_block() [1/2]

◆ add_block() [2/2]

◆ add_max_block_size()

◆ add_output()

◆ add_spent_key()

◆ add_transaction()

◆ add_transaction_data()

◆ add_tx_amount_output_indices()

◆ add_txpool_tx()

◆ batch_abort()

◆ batch_start()

◆ batch_stop()

◆ block_exists()

◆ block_rtxn_abort()

◆ block_rtxn_start()

◆ block_rtxn_stop()

◆ block_wtxn_abort()

◆ block_wtxn_start()

◆ block_wtxn_stop()

◆ can_thread_bulk_indices()

◆ check_hard_fork_info()

◆ check_pruning()

◆ close()

◆ drop_hard_fork_info()

◆ fixup()

◆ for_all_key_images()

◆ for_all_outputs() [1/2]

◆ for_all_outputs() [2/2]

◆ for_all_transactions()

◆ for_all_txpool_txes()

◆ for_blocks_range()

◆ get_block()

◆ get_block_already_generated_coins()

◆ get_block_blob()

◆ get_block_blob_from_height()

◆ get_block_cumulative_difficulty()

◆ get_block_cumulative_rct_outputs()

◆ get_block_difficulty()

◆ get_block_from_height()

◆ get_block_hash_from_height()

◆ get_block_header()

◆ get_block_height()

◆ get_block_long_term_weight()

◆ get_block_timestamp()

◆ get_block_weight()

◆ get_block_weights()

◆ get_blockchain_pruning_seed()

◆ get_blocks_range()

◆ get_database_size()

◆ get_db_name()

◆ get_filenames()

◆ get_hard_fork_version()

◆ get_hashes_range()

◆ get_indexing_base()

◆ get_long_term_block_weights()

◆ get_max_block_size()

◆ get_num_outputs()

◆ get_output_distribution()

◆ get_output_histogram()

◆ get_output_key() [1/2]

◆ get_output_key() [2/2]

◆ get_output_tx_and_index() [1/2]

◆ get_output_tx_and_index() [2/2]

◆ get_output_tx_and_index_from_global()

◆ get_prunable_tx_blob()

◆ get_prunable_tx_hash()

◆ get_pruned_tx() [1/2]

◆ get_pruned_tx() [2/2]