Bitcoin Core 30.99.0
P2P Digital Currency
core_io.h
Go to the documentation of this file.
1// Copyright (c) 2009-2022 The Bitcoin Core developers
2// Distributed under the MIT software license, see the accompanying
3// file COPYING or http://www.opensource.org/licenses/mit-license.php.
4
5#ifndef BITCOIN_CORE_IO_H
6#define BITCOIN_CORE_IO_H
7
8#include <consensus/amount.h>
9#include <util/result.h>
10
11#include <string>
12#include <vector>
13#include <optional>
14
15class CBlock;
16class CBlockHeader;
17class CScript;
18class CTransaction;
20class SigningProvider;
21class uint256;
22class UniValue;
23class CTxUndo;
24class CTxOut;
25
29enum class TxVerbosity {
30 SHOW_TXID,
33};
34
35// core_read.cpp
36CScript ParseScript(const std::string& s);
37std::string ScriptToAsmStr(const CScript& script, const bool fAttemptSighashDecode = false);
38[[nodiscard]] bool DecodeHexTx(CMutableTransaction& tx, const std::string& hex_tx, bool try_no_witness = false, bool try_witness = true);
39[[nodiscard]] bool DecodeHexBlk(CBlock&, const std::string& strHexBlk);
40bool DecodeHexBlockHeader(CBlockHeader&, const std::string& hex_header);
41
42[[nodiscard]] util::Result<int> SighashFromStr(const std::string& sighash);
43
44// core_write.cpp
45UniValue ValueFromAmount(const CAmount amount);
46std::string FormatScript(const CScript& script);
47std::string EncodeHexTx(const CTransaction& tx);
48std::string SighashToStr(unsigned char sighash_type);
49void ScriptToUniv(const CScript& script, UniValue& out, bool include_hex = true, bool include_address = false, const SigningProvider* provider = nullptr);
50void TxToUniv(const CTransaction& tx, const uint256& block_hash, UniValue& entry, bool include_hex = true, const CTxUndo* txundo = nullptr, TxVerbosity verbosity = TxVerbosity::SHOW_DETAILS, std::function<bool(const CTxOut&)> is_change_func = {});
51
52#endif // BITCOIN_CORE_IO_H
int64_t CAmount
Amount in satoshis (Can be negative)
Definition: amount.h:12
Nodes collect new transactions into a block, hash them into a hash tree, and scan through nonce value...
Definition: block.h:22
Definition: block.h:69
Serialized script, used inside transaction inputs and outputs.
Definition: script.h:413
The basic transaction that is broadcasted on the network and contained in blocks.
Definition: transaction.h:296
An output of a transaction.
Definition: transaction.h:150
Undo information for a CTransaction.
Definition: undo.h:53
An interface to be implemented by keystores that support signing.
256-bit opaque blob.
Definition: uint256.h:196
std::string EncodeHexTx(const CTransaction &tx)
Definition: core_write.cpp:143
std::string SighashToStr(unsigned char sighash_type)
Definition: core_write.cpp:84
CScript ParseScript(const std::string &s)
Definition: core_read.cpp:63
void TxToUniv(const CTransaction &tx, const uint256 &block_hash, UniValue &entry, bool include_hex=true, const CTxUndo *txundo=nullptr, TxVerbosity verbosity=TxVerbosity::SHOW_DETAILS, std::function< bool(const CTxOut &)> is_change_func={})
Definition: core_write.cpp:171
std::string FormatScript(const CScript &script)
Definition: core_write.cpp:39
util::Result< int > SighashFromStr(const std::string &sighash)
Definition: core_read.cpp:237
bool DecodeHexBlk(CBlock &, const std::string &strHexBlk)
Definition: core_read.cpp:220
bool DecodeHexBlockHeader(CBlockHeader &, const std::string &hex_header)
Definition: core_read.cpp:206
TxVerbosity
Verbose level for block's transaction.
Definition: core_io.h:29
@ SHOW_DETAILS_AND_PREVOUT
The same as previous option with information about prevouts if available.
@ SHOW_TXID
Only TXID for each block's transaction.
@ SHOW_DETAILS
Include TXID, inputs, outputs, and other common block's transaction information.
std::string ScriptToAsmStr(const CScript &script, const bool fAttemptSighashDecode=false)
Create the assembly string representation of a CScript object.
Definition: core_write.cpp:98
void ScriptToUniv(const CScript &script, UniValue &out, bool include_hex=true, bool include_address=false, const SigningProvider *provider=nullptr)
Definition: core_write.cpp:150
UniValue ValueFromAmount(const CAmount amount)
Definition: core_write.cpp:26
bool DecodeHexTx(CMutableTransaction &tx, const std::string &hex_tx, bool try_no_witness=false, bool try_witness=true)
Definition: core_read.cpp:196
A mutable version of CTransaction.
Definition: transaction.h:378