[#node-BlockCreateOptions]
= xref:node.adoc[node]::BlockCreateOptions
:relfileprefix: ../
:mrdocs:

Block template creation options. These override node defaults, but can't exceed node limits (e.g. block_reserved_weight can't exceed max block weight).

== Synopsis

Declared in `<node/mining_types.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
struct BlockCreateOptions;
----

== Data Members

[cols="1,4"]
|===
| Name| Description
| xref:node/BlockCreateOptions/block_max_weight.adoc[`block_max_weight`] 
| Maximum block weight, defaults to ‐maxblockweight
| xref:node/BlockCreateOptions/block_min_fee_rate.adoc[`block_min_fee_rate`] 
| Minimum fee rate for transactions to be included. Providing a value overrides the ‐blockmintxfee startup setting.
| xref:node/BlockCreateOptions/block_reserved_weight.adoc[`block_reserved_weight`] 
| The default reserved weight for the fixed‐size block header, transaction count and coinbase transaction. Minimum: 2000 weight units (MINIMUM_BLOCK_RESERVED_WEIGHT).
| xref:node/BlockCreateOptions/coinbase_output_max_additional_sigops.adoc[`coinbase_output_max_additional_sigops`] 
| The maximum additional sigops which the pool will add in coinbase transaction outputs.
| xref:node/BlockCreateOptions/coinbase_output_script.adoc[`coinbase_output_script`] 
| Script to put in the coinbase transaction. The default is an anyone‐can‐spend dummy.
| xref:node/BlockCreateOptions/print_modified_fee.adoc[`print_modified_fee`] 
| Whether to log the fee rate of each transaction when it is added to the block template. Providing a value overrides the ‐printpriority startup setting.
| xref:node/BlockCreateOptions/test_block_validity.adoc[`test_block_validity`] 
| Whether to call TestBlockValidity() at the end of CreateNewBlock(). Should only be disabled for tests / benchmarks.
| xref:node/BlockCreateOptions/use_mempool.adoc[`use_mempool`] 
| Set false to omit mempool transactions
|===


== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:node/CheckMiningOptions.adoc[`CheckMiningOptions`]
| Check option values for validity. Returns an error for invalid values.
| xref:node/FlattenMiningOptions.adoc[`FlattenMiningOptions`]
| Replace null optional values with their hardcoded defaults.
| xref:node/MergeMiningOptions.adoc[`MergeMiningOptions`]
| Merge two BlockCreateOptions structs, replacing null values in `x` with non‐null values from `y.`
| xref:node/ReadMiningArgs.adoc[`ReadMiningArgs`]
| Read the mining options set in `args.` Returns an error if one was encountered.
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#