mining.h File Reference

#include <cstddef>
#include <memory>
#include <string>
#include <vector>

Include dependency graph for mining.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
namespace	node

Functions
std::vector< std::shared_ptr< CBlock > >	CreateBlockChain (size_t total_height, const CChainParams &params)
	Create a blockchain, starting from genesis.
bool	BuildChain (const node::NodeContext &node, const CBlockIndex *pindex, const CScript &coinbase_script_pub_key, size_t length, std::vector< std::shared_ptr< CBlock > > &chain)
	Build a chain of length coinbase-only blocks on top of pindex (which need not be the active tip, allowing forks to be created) and submit their headers.
COutPoint	MineBlock (const node::NodeContext &, const node::BlockCreateOptions &assembler_options)
	Returns the generated coin.
COutPoint	MineBlock (const node::NodeContext &, std::shared_ptr< CBlock > &block)
	Returns the generated coin (or Null if the block was invalid).
COutPoint	ProcessBlock (const node::NodeContext &, const std::shared_ptr< CBlock > &block)
	Returns the generated coin (or Null if the block was invalid).
std::shared_ptr< CBlock >	PrepareBlock (const node::NodeContext &node, const node::BlockCreateOptions &assembler_options)
	Prepare a block to be mined.
COutPoint	generatetoaddress (const node::NodeContext &, const std::string &address)
	RPC-like helper function, returns the generated coin.

Function Documentation

BuildChain()

bool BuildChain	(	const node::NodeContext &	node,
		const CBlockIndex *	pindex,
		const CScript &	coinbase_script_pub_key,
		size_t	length,
		std::vector< std::shared_ptr< CBlock > > &	chain )

Build a chain of length coinbase-only blocks on top of pindex (which need not be the active tip, allowing forks to be created) and submit their headers.

The blocks themselves are returned in chain for the caller to process.

Definition at line 78 of file mining.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

CreateBlockChain()

std::vector< std::shared_ptr< CBlock > > CreateBlockChain	(	size_t	total_height,
		const CChainParams &	params )

Create a blockchain, starting from genesis.

Definition at line 43 of file mining.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

generatetoaddress()

COutPoint generatetoaddress	(	const node::NodeContext &	node,
		const std::string &	address )

RPC-like helper function, returns the generated coin.

Definition at line 34 of file mining.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

MineBlock() [1/2]

COutPoint MineBlock	(	const node::NodeContext &	node,
		const node::BlockCreateOptions &	assembler_options )

Returns the generated coin.

Definition at line 119 of file mining.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

MineBlock() [2/2]

COutPoint MineBlock	(	const node::NodeContext &	node,
		std::shared_ptr< CBlock > &	block )

Returns the generated coin (or Null if the block was invalid).

It is recommended to call RegenerateCommitments before mining the block to avoid merkle tree mismatches.

Definition at line 143 of file mining.cpp.

Here is the call graph for this function:

PrepareBlock()

std::shared_ptr< CBlock > PrepareBlock	(	const node::NodeContext &	node,
		const node::BlockCreateOptions &	assembler_options )

Prepare a block to be mined.

Definition at line 172 of file mining.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

ProcessBlock()

COutPoint ProcessBlock	(	const node::NodeContext &	node,
		const std::shared_ptr< CBlock > &	block )

Returns the generated coin (or Null if the block was invalid).

Definition at line 153 of file mining.cpp.

Here is the call graph for this function:

Here is the caller graph for this function: