#include <rest.h>
#include <blockfilter.h>
#include <chain.h>
#include <coins.h>
#include <consensus/params.h>
#include <core_io.h>
#include <crypto/hex_base.h>
#include <flatfile.h>
#include <httpserver.h>
#include <index/blockfilterindex.h>
#include <index/txindex.h>
#include <node/blockstorage.h>
#include <node/context.h>
#include <node/transaction.h>
#include <primitives/block.h>
#include <primitives/transaction.h>
#include <rpc/blockchain.h>
#include <rpc/mempool.h>
#include <rpc/protocol.h>
#include <rpc/request.h>
#include <rpc/server.h>
#include <rpc/util.h>
#include <serialize.h>
#include <streams.h>
#include <sync.h>
#include <tinyformat.h>
#include <txmempool.h>
#include <uint256.h>
#include <undo.h>
#include <univalue.h>
#include <util/any.h>
#include <util/check.h>
#include <util/overflow.h>
#include <util/strencodings.h>
#include <util/string.h>
#include <validation.h>
#include <any>
#include <cstdint>
#include <cstring>
#include <ios>
#include <memory>
#include <optional>
#include <span>
#include <stdexcept>
#include <string_view>
#include <utility>
#include <vector>

Include dependency graph for rest.cpp:

Classes
struct	CCoin

Functions
static bool	RESTERR (HTTPRequest *req, enum HTTPStatusCode status, std::string message)

static NodeContext *	GetNodeContext (const std::any &context, HTTPRequest *req)
	Get the node context.

static CTxMemPool *	GetMemPool (const std::any &context, HTTPRequest *req)
	Get the node context mempool.

static ChainstateManager *	GetChainman (const std::any &context, HTTPRequest *req)
	Get the node context chainstatemanager.

RESTResponseFormat	ParseDataFormat (std::string &param, const std::string &strReq)
	Parse a URI to get the data format and URI without data format and query string.

static std::string	AvailableDataFormatsString ()

static bool	CheckWarmup (HTTPRequest *req)

static bool	rest_headers (const std::any &context, HTTPRequest *req, const std::string &uri_part)

static void	SerializeBlockUndo (DataStream &stream, const CBlockUndo &block_undo)
	Serialize spent outputs as a list of per-transaction CTxOut lists using binary format.

static void	BlockUndoToJSON (const CBlockUndo &block_undo, UniValue &result)
	Serialize spent outputs as a list of per-transaction CTxOut lists using JSON format.

static bool	rest_spent_txouts (const std::any &context, HTTPRequest *req, const std::string &uri_part)

static bool	rest_block (const std::any &context, HTTPRequest *req, const std::string &uri_part, std::optional< TxVerbosity > tx_verbosity, std::optional< std::pair< size_t, size_t > > block_part=std::nullopt)
	This handler is used by multiple HTTP endpoints:

static bool	rest_block_extended (const std::any &context, HTTPRequest *req, const std::string &uri_part)

static bool	rest_block_notxdetails (const std::any &context, HTTPRequest *req, const std::string &uri_part)

static bool	rest_block_part (const std::any &context, HTTPRequest *req, const std::string &uri_part)

static bool	rest_filter_header (const std::any &context, HTTPRequest *req, const std::string &uri_part)

static bool	rest_block_filter (const std::any &context, HTTPRequest *req, const std::string &uri_part)

RPCMethod	getblockchaininfo ()

static bool	rest_chaininfo (const std::any &context, HTTPRequest *req, const std::string &uri_part)

RPCMethod	getdeploymentinfo ()

static bool	rest_deploymentinfo (const std::any &context, HTTPRequest *req, const std::string &str_uri_part)

static bool	rest_mempool (const std::any &context, HTTPRequest *req, const std::string &str_uri_part)

static bool	rest_tx (const std::any &context, HTTPRequest *req, const std::string &uri_part)

static bool	rest_getutxos (const std::any &context, HTTPRequest *req, const std::string &uri_part)

static bool	rest_blockhash_by_height (const std::any &context, HTTPRequest *req, const std::string &str_uri_part)

void	StartREST (const std::any &context)
	Start HTTP REST subsystem.

void	InterruptREST ()
	Interrupt RPC REST subsystem.

void	StopREST ()
	Stop HTTP REST subsystem.

Variables
static const size_t	MAX_GETUTXOS_OUTPOINTS = 15

static constexpr unsigned int	MAX_REST_HEADERS_RESULTS = 2000

static constexpr const char *	REST_CACHE_IMMUTABLE = "public, immutable, max-age=86400"
	Response bytes never change.

static constexpr const char *	REST_CACHE_NO_STORE = "no-store"
	Mutable, node-local, or error response; must not be cached.

struct {

RESTResponseFormat rf

const char * name

}	rf_names []

struct {

const char * prefix

bool(* handler )(const std::any &context, HTTPRequest *req, const std::string &strReq)

}	uri_prefixes []

Function Documentation

◆ AvailableDataFormatsString()

static std::string AvailableDataFormatsString ( )

static

Definition at line 177 of file rest.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ BlockUndoToJSON()

static void BlockUndoToJSON	(	const CBlockUndo &	block_undo,
		UniValue &	result
	)

static

Serialize spent outputs as a list of per-transaction CTxOut lists using JSON format.

Definition at line 321 of file rest.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CheckWarmup()

static bool CheckWarmup ( HTTPRequest * req )

static

Definition at line 194 of file rest.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getblockchaininfo()

RPCMethod getblockchaininfo ( )

Definition at line 1398 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetChainman()

static ChainstateManager * GetChainman	(	const std::any &	context,
		HTTPRequest *	req
	)

static

Get the node context chainstatemanager.

Parameters

[in] req The HTTP request, whose status code will be set if node context chainstatemanager is not found.

Returns: Pointer to the chainstatemanager or nullptr if none found.

Definition at line 142 of file rest.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getdeploymentinfo()

RPCMethod getdeploymentinfo ( )

Definition at line 1544 of file blockchain.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetMemPool()

static CTxMemPool * GetMemPool	(	const std::any &	context,
		HTTPRequest *	req
	)

static

Get the node context mempool.

Parameters

[in] req The HTTP request, whose status code will be set if node context mempool is not found.

Returns: Pointer to the mempool or nullptr if no mempool found.

Definition at line 125 of file rest.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetNodeContext()

static NodeContext * GetNodeContext	(	const std::any &	context,
		HTTPRequest *	req
	)

static

Get the node context.

Parameters

[in] req The HTTP request, whose status code will be set if node context is not found.

Returns: Pointer to the node context or nullptr if not found.

Definition at line 108 of file rest.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ InterruptREST()

void InterruptREST ( )

Interrupt RPC REST subsystem.

Definition at line 1224 of file rest.cpp.

Here is the caller graph for this function:

◆ ParseDataFormat()

RESTResponseFormat ParseDataFormat	(	std::string &	param,
		const std::string &	strReq
	)

Parse a URI to get the data format and URI without data format and query string.

Parameters

[out]	param	The strReq without the data format string and without the query string (if any).
[in]	strReq	The URI to be parsed.

Returns: RESTResponseFormat that was parsed from the URI.

Definition at line 152 of file rest.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rest_block()

static bool rest_block	(	const std::any &	context,
		HTTPRequest *	req,
		const std::string &	uri_part,
		std::optional< TxVerbosity >	tx_verbosity,
		std::optional< std::pair< size_t, size_t > >	block_part = `std::nullopt`
	)

static

This handler is used by multiple HTTP endpoints:

/block/ via rest_block_extended()
/block/notxdetails/ via rest_block_notxdetails()
/blockpart/ via rest_block_part() (doesn't support JSON response, so tx_verbosity is unset)

Definition at line 421 of file rest.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rest_block_extended()

static bool rest_block_extended	(	const std::any &	context,
		HTTPRequest *	req,
		const std::string &	uri_part
	)

static

Definition at line 506 of file rest.cpp.

Here is the call graph for this function:

◆ rest_block_filter()

static bool rest_block_filter	(	const std::any &	context,
		HTTPRequest *	req,
		const std::string &	uri_part
	)

static

Definition at line 661 of file rest.cpp.

Here is the call graph for this function:

◆ rest_block_notxdetails()

static bool rest_block_notxdetails	(	const std::any &	context,
		HTTPRequest *	req,
		const std::string &	uri_part
	)

static

Definition at line 511 of file rest.cpp.

Here is the call graph for this function:

◆ rest_block_part()

static bool rest_block_part	(	const std::any &	context,
		HTTPRequest *	req,
		const std::string &	uri_part
	)

static

Definition at line 516 of file rest.cpp.

Here is the call graph for this function:

◆ rest_blockhash_by_height()

static bool rest_blockhash_by_height	(	const std::any &	context,
		HTTPRequest *	req,
		const std::string &	str_uri_part
	)

static

Definition at line 1142 of file rest.cpp.

Here is the call graph for this function:

◆ rest_chaininfo()

static bool rest_chaininfo	(	const std::any &	context,
		HTTPRequest *	req,
		const std::string &	uri_part
	)

static

Definition at line 758 of file rest.cpp.

Here is the call graph for this function:

◆ rest_deploymentinfo()

static bool rest_deploymentinfo	(	const std::any &	context,
		HTTPRequest *	req,
		const std::string &	str_uri_part
	)

static

Definition at line 786 of file rest.cpp.

Here is the call graph for this function:

◆ rest_filter_header()

static bool rest_filter_header	(	const std::any &	context,
		HTTPRequest *	req,
		const std::string &	uri_part
	)

static

Definition at line 535 of file rest.cpp.

Here is the call graph for this function:

◆ rest_getutxos()

static bool rest_getutxos	(	const std::any &	context,
		HTTPRequest *	req,
		const std::string &	uri_part
	)

static

Definition at line 945 of file rest.cpp.

Here is the call graph for this function:

◆ rest_headers()

static bool rest_headers	(	const std::any &	context,
		HTTPRequest *	req,
		const std::string &	uri_part
	)

static

Definition at line 202 of file rest.cpp.

Here is the call graph for this function:

◆ rest_mempool()

static bool rest_mempool	(	const std::any &	context,
		HTTPRequest *	req,
		const std::string &	str_uri_part
	)

static

Definition at line 827 of file rest.cpp.

Here is the call graph for this function:

◆ rest_spent_txouts()

static bool rest_spent_txouts	(	const std::any &	context,
		HTTPRequest *	req,
		const std::string &	uri_part
	)

static

Definition at line 342 of file rest.cpp.

Here is the call graph for this function:

◆ rest_tx()

static bool rest_tx	(	const std::any &	context,
		HTTPRequest *	req,
		const std::string &	uri_part
	)

static

Definition at line 884 of file rest.cpp.

Here is the call graph for this function:

◆ RESTERR()

static bool RESTERR	(	HTTPRequest *	req,
		enum HTTPStatusCode	status,
		std::string	message
	)

static

Definition at line 93 of file rest.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SerializeBlockUndo()

static void SerializeBlockUndo	(	DataStream &	stream,
		const CBlockUndo &	block_undo
	)

static

Serialize spent outputs as a list of per-transaction CTxOut lists using binary format.

Definition at line 306 of file rest.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ StartREST()

void StartREST ( const std::any & context )

Start HTTP REST subsystem.

Precondition; HTTP and RPC has been started.

Definition at line 1216 of file rest.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ StopREST()

void StopREST ( )

Stop HTTP REST subsystem.

Precondition; HTTP and RPC has been stopped.

Definition at line 1228 of file rest.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

◆ handler

bool(* handler) (const std::any &context, HTTPRequest *req, const std::string &strReq)	(	const std::any &	context,
		HTTPRequest *	req,
		const std::string &	strReq
	)

Definition at line 1198 of file rest.cpp.

◆ MAX_GETUTXOS_OUTPOINTS

const size_t MAX_GETUTXOS_OUTPOINTS = 15

static

Definition at line 60 of file rest.cpp.

◆ MAX_REST_HEADERS_RESULTS

constexpr unsigned int MAX_REST_HEADERS_RESULTS = 2000

staticconstexpr

Definition at line 61 of file rest.cpp.

◆ name

const char* name

Definition at line 71 of file rest.cpp.

◆ prefix

const char* prefix

Definition at line 1197 of file rest.cpp.

◆ REST_CACHE_IMMUTABLE

constexpr const char* REST_CACHE_IMMUTABLE = "public, immutable, max-age=86400"

staticconstexpr

Response bytes never change.

One-day TTL limits staleness across software upgrades.

Definition at line 65 of file rest.cpp.

◆ REST_CACHE_NO_STORE

constexpr const char* REST_CACHE_NO_STORE = "no-store"

staticconstexpr

Mutable, node-local, or error response; must not be cached.

Definition at line 67 of file rest.cpp.

◆ rf

RESTResponseFormat rf

Definition at line 70 of file rest.cpp.

◆ [struct]

const struct { ... } rf_names[]

Initial value:

= {
      {RESTResponseFormat::UNDEF, ""},
      {RESTResponseFormat::BINARY, "bin"},
      {RESTResponseFormat::HEX, "hex"},
      {RESTResponseFormat::JSON, "json"},
}

◆ [struct]

const struct { ... } uri_prefixes[]

Initial value:

= {
    {"/rest/tx/", rest_tx},
    {"/rest/block/notxdetails/", rest_block_notxdetails},
    {"/rest/block/", rest_block_extended},
    {"/rest/blockpart/", rest_block_part},
    {"/rest/blockfilter/", rest_block_filter},
    {"/rest/blockfilterheaders/", rest_filter_header},
    {"/rest/chaininfo", rest_chaininfo},
    {"/rest/mempool/", rest_mempool},
    {"/rest/headers/", rest_headers},
    {"/rest/getutxos", rest_getutxos},
    {"/rest/deploymentinfo/", rest_deploymentinfo},
    {"/rest/deploymentinfo", rest_deploymentinfo},
    {"/rest/blockhashbyheight/", rest_blockhash_by_height},
    {"/rest/spenttxouts/", rest_spent_txouts},
}

Classes

Functions

Variables

Function Documentation

◆ AvailableDataFormatsString()

◆ BlockUndoToJSON()

◆ CheckWarmup()

◆ getblockchaininfo()

◆ GetChainman()

◆ getdeploymentinfo()

◆ GetMemPool()

◆ GetNodeContext()

◆ InterruptREST()

◆ ParseDataFormat()

◆ rest_block()

◆ rest_block_extended()

◆ rest_block_filter()

◆ rest_block_notxdetails()

◆ rest_block_part()

◆ rest_blockhash_by_height()

◆ rest_chaininfo()

◆ rest_deploymentinfo()

◆ rest_filter_header()

◆ rest_getutxos()

◆ rest_headers()

◆ rest_mempool()

◆ rest_spent_txouts()

◆ rest_tx()

◆ RESTERR()

◆ SerializeBlockUndo()

◆ StartREST()

◆ StopREST()

Variable Documentation

◆ handler

◆ MAX_GETUTXOS_OUTPOINTS

◆ MAX_REST_HEADERS_RESULTS

◆ name

◆ prefix

◆ REST_CACHE_IMMUTABLE

◆ REST_CACHE_NO_STORE

◆ rf

◆ [struct]

◆ [struct]