Bitcoin ABC  0.24.11
P2P Digital Currency
Classes | Enumerations | Functions | Variables
rest.cpp File Reference
#include <blockdb.h>
#include <chain.h>
#include <chainparams.h>
#include <config.h>
#include <core_io.h>
#include <httpserver.h>
#include <index/txindex.h>
#include <node/context.h>
#include <primitives/block.h>
#include <primitives/transaction.h>
#include <rpc/blockchain.h>
#include <rpc/protocol.h>
#include <rpc/server.h>
#include <streams.h>
#include <sync.h>
#include <txmempool.h>
#include <util/ref.h>
#include <util/strencodings.h>
#include <validation.h>
#include <version.h>
#include <boost/algorithm/string.hpp>
#include <univalue.h>
Include dependency graph for rest.cpp:

Go to the source code of this file.

Classes

struct  CCoin
 

Enumerations

enum  RetFormat { RetFormat::UNDEF, RetFormat::BINARY, RetFormat::HEX, RetFormat::JSON }
 

Functions

static bool RESTERR (HTTPRequest *req, enum HTTPStatusCode status, std::string message)
 
static NodeContextGetNodeContext (const util::Ref &context, HTTPRequest *req)
 Get the node context. More...
 
static CTxMemPoolGetMemPool (const util::Ref &context, HTTPRequest *req)
 Get the node context mempool. More...
 
static RetFormat ParseDataFormat (std::string &param, const std::string &strReq)
 
static std::string AvailableDataFormatsString ()
 
static bool CheckWarmup (HTTPRequest *req)
 
static bool rest_headers (Config &config, const util::Ref &context, HTTPRequest *req, const std::string &strURIPart)
 
static bool rest_block (const Config &config, HTTPRequest *req, const std::string &strURIPart, bool showTxDetails)
 
static bool rest_block_extended (Config &config, const util::Ref &context, HTTPRequest *req, const std::string &strURIPart)
 
static bool rest_block_notxdetails (Config &config, const util::Ref &context, HTTPRequest *req, const std::string &strURIPart)
 
static bool rest_chaininfo (Config &config, const util::Ref &context, HTTPRequest *req, const std::string &strURIPart)
 
static bool rest_mempool_info (Config &config, const util::Ref &context, HTTPRequest *req, const std::string &strURIPart)
 
static bool rest_mempool_contents (Config &config, const util::Ref &context, HTTPRequest *req, const std::string &strURIPart)
 
static bool rest_tx (Config &config, const util::Ref &context, HTTPRequest *req, const std::string &strURIPart)
 
static bool rest_getutxos (Config &config, const util::Ref &context, HTTPRequest *req, const std::string &strURIPart)
 
static bool rest_blockhash_by_height (Config &config, const util::Ref &context, HTTPRequest *req, const std::string &str_uri_part)
 
void StartREST (const util::Ref &context)
 Start HTTP REST subsystem. More...
 
void InterruptREST ()
 Interrupt RPC REST subsystem. More...
 
void StopREST ()
 Stop HTTP REST subsystem. More...
 

Variables

static const size_t MAX_GETUTXOS_OUTPOINTS = 15
 
struct {
   RetFormat   rf
 
   const char *   name
 
rf_names []
 
struct {
   const char *   prefix
 
   bool(*   handler )(Config &config, const
      util::Ref &context,
      HTTPRequest *req, const
      std::string &strReq)
 
uri_prefixes []
 

Enumeration Type Documentation

◆ RetFormat

enum RetFormat
strong
Enumerator
UNDEF 
BINARY 
HEX 
JSON 

Definition at line 34 of file rest.cpp.

Function Documentation

◆ AvailableDataFormatsString()

static std::string AvailableDataFormatsString ( )
static

Definition at line 132 of file rest.cpp.

Here is the caller graph for this function:

◆ CheckWarmup()

static bool CheckWarmup ( HTTPRequest req)
static

Definition at line 149 of file rest.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetMemPool()

static CTxMemPool* GetMemPool ( const util::Ref context,
HTTPRequest req 
)
static

Get the node context mempool.

Parameters
[in]reqThe 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 100 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 util::Ref context,
HTTPRequest req 
)
static

Get the node context.

Parameters
[in]reqThe 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 79 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 797 of file rest.cpp.

Here is the caller graph for this function:

◆ ParseDataFormat()

static RetFormat ParseDataFormat ( std::string &  param,
const std::string &  strReq 
)
static

Definition at line 110 of file rest.cpp.

Here is the caller graph for this function:

◆ rest_block()

static bool rest_block ( const Config config,
HTTPRequest req,
const std::string &  strURIPart,
bool  showTxDetails 
)
static

Definition at line 248 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 ( Config config,
const util::Ref context,
HTTPRequest req,
const std::string &  strURIPart 
)
static

Definition at line 324 of file rest.cpp.

Here is the call graph for this function:

◆ rest_block_notxdetails()

static bool rest_block_notxdetails ( Config config,
const util::Ref context,
HTTPRequest req,
const std::string &  strURIPart 
)
static

Definition at line 330 of file rest.cpp.

Here is the call graph for this function:

◆ rest_blockhash_by_height()

static bool rest_blockhash_by_height ( Config config,
const util::Ref context,
HTTPRequest req,
const std::string &  str_uri_part 
)
static

Definition at line 719 of file rest.cpp.

Here is the call graph for this function:

◆ rest_chaininfo()

static bool rest_chaininfo ( Config config,
const util::Ref context,
HTTPRequest req,
const std::string &  strURIPart 
)
static

Definition at line 336 of file rest.cpp.

Here is the call graph for this function:

◆ rest_getutxos()

static bool rest_getutxos ( Config config,
const util::Ref context,
HTTPRequest req,
const std::string &  strURIPart 
)
static

Definition at line 496 of file rest.cpp.

Here is the call graph for this function:

◆ rest_headers()

static bool rest_headers ( Config config,
const util::Ref context,
HTTPRequest req,
const std::string &  strURIPart 
)
static

Definition at line 159 of file rest.cpp.

Here is the call graph for this function:

◆ rest_mempool_contents()

static bool rest_mempool_contents ( Config config,
const util::Ref context,
HTTPRequest req,
const std::string &  strURIPart 
)
static

Definition at line 393 of file rest.cpp.

Here is the call graph for this function:

◆ rest_mempool_info()

static bool rest_mempool_info ( Config config,
const util::Ref context,
HTTPRequest req,
const std::string &  strURIPart 
)
static

Definition at line 363 of file rest.cpp.

Here is the call graph for this function:

◆ rest_tx()

static bool rest_tx ( Config config,
const util::Ref context,
HTTPRequest req,
const std::string &  strURIPart 
)
static

Definition at line 424 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 65 of file rest.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ StartREST()

void StartREST ( const util::Ref context)

Start HTTP REST subsystem.

Precondition; HTTP and RPC has been started.

Definition at line 787 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 799 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) (Config &config, const util::Ref &context, HTTPRequest *req, const std::string &strReq)

Definition at line 773 of file rest.cpp.

◆ MAX_GETUTXOS_OUTPOINTS

const size_t MAX_GETUTXOS_OUTPOINTS = 15
static

Definition at line 32 of file rest.cpp.

◆ name

const char* name

Definition at line 43 of file rest.cpp.

◆ prefix

const char* prefix

Definition at line 772 of file rest.cpp.

◆ rf

Definition at line 42 of file rest.cpp.

◆ rf_names

const { ... } rf_names[]
Initial value:
= {
{RetFormat::HEX, "hex"},
{RetFormat::JSON, "json"},
}

◆ uri_prefixes

const { ... } uri_prefixes[]
Initial value:
= {
{"/rest/tx/", rest_tx},
{"/rest/block/notxdetails/", rest_block_notxdetails},
{"/rest/block/", rest_block_extended},
{"/rest/chaininfo", rest_chaininfo},
{"/rest/mempool/info", rest_mempool_info},
{"/rest/mempool/contents", rest_mempool_contents},
{"/rest/headers/", rest_headers},
{"/rest/getutxos", rest_getutxos},
{"/rest/blockhashbyheight/", rest_blockhash_by_height},
}
rest_blockhash_by_height
static bool rest_blockhash_by_height(Config &config, const util::Ref &context, HTTPRequest *req, const std::string &str_uri_part)
Definition: rest.cpp:719
rest_block_extended
static bool rest_block_extended(Config &config, const util::Ref &context, HTTPRequest *req, const std::string &strURIPart)
Definition: rest.cpp:324
RetFormat::UNDEF
@ UNDEF
RetFormat::BINARY
@ BINARY
RetFormat::JSON
@ JSON
rest_mempool_info
static bool rest_mempool_info(Config &config, const util::Ref &context, HTTPRequest *req, const std::string &strURIPart)
Definition: rest.cpp:363
rest_getutxos
static bool rest_getutxos(Config &config, const util::Ref &context, HTTPRequest *req, const std::string &strURIPart)
Definition: rest.cpp:496
rest_headers
static bool rest_headers(Config &config, const util::Ref &context, HTTPRequest *req, const std::string &strURIPart)
Definition: rest.cpp:159
rest_tx
static bool rest_tx(Config &config, const util::Ref &context, HTTPRequest *req, const std::string &strURIPart)
Definition: rest.cpp:424
rest_chaininfo
static bool rest_chaininfo(Config &config, const util::Ref &context, HTTPRequest *req, const std::string &strURIPart)
Definition: rest.cpp:336
RetFormat::HEX
@ HEX
rest_block_notxdetails
static bool rest_block_notxdetails(Config &config, const util::Ref &context, HTTPRequest *req, const std::string &strURIPart)
Definition: rest.cpp:330
rest_mempool_contents
static bool rest_mempool_contents(Config &config, const util::Ref &context, HTTPRequest *req, const std::string &strURIPart)
Definition: rest.cpp:393