Bitcoin Core 31.99.0
P2P Digital Currency
Public Attributes | List of all members
TxDocOptions Struct Reference

#include <rawtransaction_util.h>

Public Attributes

std::string txid_field_doc {"The transaction id"}
 The description of the txid field. More...
 
bool wallet {false}
 Include wallet-related fields (e.g. ischange on outputs) More...
 
ElisionMode elision_mode {ElisionMode::None}
 Controls top-level field elision in the help. More...
 
std::optional< std::string > elision_summary {}
 Summary text shown as "..." required for elision_mode == WithSummary. More...
 
bool prevout {false}
 Include prevout field. More...
 
bool prevout_optional {false}
 Mark prevout field as optional (omitted when undo data unavailable) More...
 
bool fee {false}
 Include fee field. More...
 
bool hex {false}
 Include hex field. More...
 
std::optional< std::string > vin_item_doc {}
 Customize the vin item object's description (only meaningful when vin_inner_elision is set) More...
 
std::optional< std::string > prevout_doc {}
 Customize the prevout field's description (only meaningful when prevout is true) More...
 
std::optional< std::string > fee_doc {}
 Customize the fee field's description (only meaningful when fee is true) More...
 
std::optional< std::string > vin_inner_elision {}
 Elide vin inner fields but keep vin array with prevout expanded. More...
 

Detailed Description

Definition at line 65 of file rawtransaction_util.h.

Member Data Documentation

◆ elision_mode

ElisionMode TxDocOptions::elision_mode {ElisionMode::None}

Controls top-level field elision in the help.

Definition at line 71 of file rawtransaction_util.h.

◆ elision_summary

std::optional<std::string> TxDocOptions::elision_summary {}

Summary text shown as "..." required for elision_mode == WithSummary.

Definition at line 73 of file rawtransaction_util.h.

◆ fee

bool TxDocOptions::fee {false}

Include fee field.

Definition at line 79 of file rawtransaction_util.h.

◆ fee_doc

std::optional<std::string> TxDocOptions::fee_doc {}

Customize the fee field's description (only meaningful when fee is true)

Definition at line 87 of file rawtransaction_util.h.

◆ hex

bool TxDocOptions::hex {false}

Include hex field.

Definition at line 81 of file rawtransaction_util.h.

◆ prevout

bool TxDocOptions::prevout {false}

Include prevout field.

Definition at line 75 of file rawtransaction_util.h.

◆ prevout_doc

std::optional<std::string> TxDocOptions::prevout_doc {}

Customize the prevout field's description (only meaningful when prevout is true)

Definition at line 85 of file rawtransaction_util.h.

◆ prevout_optional

bool TxDocOptions::prevout_optional {false}

Mark prevout field as optional (omitted when undo data unavailable)

Definition at line 77 of file rawtransaction_util.h.

◆ txid_field_doc

std::string TxDocOptions::txid_field_doc {"The transaction id"}

The description of the txid field.

Definition at line 67 of file rawtransaction_util.h.

◆ vin_inner_elision

std::optional<std::string> TxDocOptions::vin_inner_elision {}

Elide vin inner fields but keep vin array with prevout expanded.

Definition at line 89 of file rawtransaction_util.h.

◆ vin_item_doc

std::optional<std::string> TxDocOptions::vin_item_doc {}

Customize the vin item object's description (only meaningful when vin_inner_elision is set)

Definition at line 83 of file rawtransaction_util.h.

◆ wallet

bool TxDocOptions::wallet {false}

Include wallet-related fields (e.g. ischange on outputs)

Definition at line 69 of file rawtransaction_util.h.


The documentation for this struct was generated from the following file: