|
|
|
// Copyright (c) 2010 Satoshi Nakamoto
|
|
|
|
// Copyright (c) 2009-2017 The Bitcoin Core developers
|
|
|
|
// Distributed under the MIT software license, see the accompanying
|
|
|
|
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
|
|
|
|
|
|
|
|
#ifndef BITCOIN_RPCPROTOCOL_H
|
|
|
|
#define BITCOIN_RPCPROTOCOL_H
|
|
|
|
|
|
|
|
#include <fs.h>
|
|
|
|
|
|
|
|
#include <list>
|
|
|
|
#include <map>
|
|
|
|
#include <stdint.h>
|
|
|
|
#include <string>
|
|
|
|
|
|
|
|
#include <univalue.h>
|
|
|
|
|
|
|
|
//! HTTP status codes
|
|
|
|
enum HTTPStatusCode
|
|
|
|
{
|
|
|
|
HTTP_OK = 200,
|
|
|
|
HTTP_BAD_REQUEST = 400,
|
|
|
|
HTTP_UNAUTHORIZED = 401,
|
|
|
|
HTTP_FORBIDDEN = 403,
|
|
|
|
HTTP_NOT_FOUND = 404,
|
evhttpd implementation
- *Replace usage of boost::asio with [libevent2](http://libevent.org/)*.
boost::asio is not part of C++11, so unlike other boost there is no
forwards-compatibility reason to stick with it. Together with #4738 (convert
json_spirit to UniValue), this rids Bitcoin Core of the worst offenders with
regard to compile-time slowness.
- *Replace spit-and-duct-tape http server with evhttp*. Front-end http handling
is handled by libevent, a work queue (with configurable depth and parallelism)
is used to handle application requests.
- *Wrap HTTP request in C++ class*; this makes the application code mostly
HTTP-server-neutral
- *Refactor RPC to move all http-specific code to a separate file*.
Theoreticaly this can allow building without HTTP server but with another RPC
backend, e.g. Qt's debug console (currently not implemented) or future RPC
mechanisms people may want to use.
- *HTTP dispatch mechanism*; services (e.g., RPC, REST) register which URL
paths they want to handle.
By using a proven, high-performance asynchronous networking library (also used
by Tor) and HTTP server, problems such as #5674, #5655, #344 should be avoided.
What works? bitcoind, bitcoin-cli, bitcoin-qt. Unit tests and RPC/REST tests
pass. The aim for now is everything but SSL support.
Configuration options:
- `-rpcthreads`: repurposed as "number of work handler threads". Still
defaults to 4.
- `-rpcworkqueue`: maximum depth of work queue. When this is reached, new
requests will return a 500 Internal Error.
- `-rpctimeout`: inactivity time, in seconds, after which to disconnect a
client.
- `-debug=http`: low-level http activity logging
10 years ago
|
|
|
HTTP_BAD_METHOD = 405,
|
|
|
|
HTTP_INTERNAL_SERVER_ERROR = 500,
|
|
|
|
HTTP_SERVICE_UNAVAILABLE = 503,
|
|
|
|
};
|
|
|
|
|
|
|
|
//! Bitcoin RPC error codes
|
|
|
|
enum RPCErrorCode
|
|
|
|
{
|
|
|
|
//! Standard JSON-RPC 2.0 errors
|
|
|
|
// RPC_INVALID_REQUEST is internally mapped to HTTP_BAD_REQUEST (400).
|
|
|
|
// It should not be used for application-layer errors.
|
|
|
|
RPC_INVALID_REQUEST = -32600,
|
|
|
|
// RPC_METHOD_NOT_FOUND is internally mapped to HTTP_NOT_FOUND (404).
|
|
|
|
// It should not be used for application-layer errors.
|
|
|
|
RPC_METHOD_NOT_FOUND = -32601,
|
|
|
|
RPC_INVALID_PARAMS = -32602,
|
|
|
|
// RPC_INTERNAL_ERROR should only be used for genuine errors in bitcoind
|
|
|
|
// (for example datadir corruption).
|
|
|
|
RPC_INTERNAL_ERROR = -32603,
|
|
|
|
RPC_PARSE_ERROR = -32700,
|
|
|
|
|
|
|
|
//! General application defined errors
|
|
|
|
RPC_MISC_ERROR = -1, //!< std::exception thrown in command handling
|
|
|
|
RPC_FORBIDDEN_BY_SAFE_MODE = -2, //!< Server is in safe mode, and command is not allowed in safe mode
|
|
|
|
RPC_TYPE_ERROR = -3, //!< Unexpected type was passed as parameter
|
|
|
|
RPC_INVALID_ADDRESS_OR_KEY = -5, //!< Invalid address or key
|
|
|
|
RPC_OUT_OF_MEMORY = -7, //!< Ran out of memory during operation
|
|
|
|
RPC_INVALID_PARAMETER = -8, //!< Invalid, missing or duplicate parameter
|
|
|
|
RPC_DATABASE_ERROR = -20, //!< Database error
|
|
|
|
RPC_DESERIALIZATION_ERROR = -22, //!< Error parsing or validating structure in raw format
|
|
|
|
RPC_VERIFY_ERROR = -25, //!< General error during transaction or block submission
|
|
|
|
RPC_VERIFY_REJECTED = -26, //!< Transaction or block was rejected by network rules
|
|
|
|
RPC_VERIFY_ALREADY_IN_CHAIN = -27, //!< Transaction already in chain
|
|
|
|
RPC_IN_WARMUP = -28, //!< Client still warming up
|
|
|
|
RPC_METHOD_DEPRECATED = -32, //!< RPC method is deprecated
|
|
|
|
|
|
|
|
//! Aliases for backward compatibility
|
|
|
|
RPC_TRANSACTION_ERROR = RPC_VERIFY_ERROR,
|
|
|
|
RPC_TRANSACTION_REJECTED = RPC_VERIFY_REJECTED,
|
|
|
|
RPC_TRANSACTION_ALREADY_IN_CHAIN= RPC_VERIFY_ALREADY_IN_CHAIN,
|
|
|
|
|
|
|
|
//! P2P client errors
|
|
|
|
RPC_CLIENT_NOT_CONNECTED = -9, //!< Bitcoin is not connected
|
|
|
|
RPC_CLIENT_IN_INITIAL_DOWNLOAD = -10, //!< Still downloading initial blocks
|
|
|
|
RPC_CLIENT_NODE_ALREADY_ADDED = -23, //!< Node is already added
|
|
|
|
RPC_CLIENT_NODE_NOT_ADDED = -24, //!< Node has not been added before
|
|
|
|
RPC_CLIENT_NODE_NOT_CONNECTED = -29, //!< Node to disconnect not found in connected nodes
|
|
|
|
RPC_CLIENT_INVALID_IP_OR_SUBNET = -30, //!< Invalid IP/Subnet
|
|
|
|
RPC_CLIENT_P2P_DISABLED = -31, //!< No valid connection manager instance found
|
|
|
|
|
|
|
|
//! Wallet errors
|
|
|
|
RPC_WALLET_ERROR = -4, //!< Unspecified problem with wallet (key not found etc.)
|
|
|
|
RPC_WALLET_INSUFFICIENT_FUNDS = -6, //!< Not enough funds in wallet or account
|
|
|
|
RPC_WALLET_INVALID_ACCOUNT_NAME = -11, //!< Invalid account name
|
|
|
|
RPC_WALLET_KEYPOOL_RAN_OUT = -12, //!< Keypool ran out, call keypoolrefill first
|
|
|
|
RPC_WALLET_UNLOCK_NEEDED = -13, //!< Enter the wallet passphrase with walletpassphrase first
|
|
|
|
RPC_WALLET_PASSPHRASE_INCORRECT = -14, //!< The wallet passphrase entered was incorrect
|
|
|
|
RPC_WALLET_WRONG_ENC_STATE = -15, //!< Command given in wrong wallet encryption state (encrypting an encrypted wallet etc.)
|
|
|
|
RPC_WALLET_ENCRYPTION_FAILED = -16, //!< Failed to encrypt the wallet
|
|
|
|
RPC_WALLET_ALREADY_UNLOCKED = -17, //!< Wallet is already unlocked
|
|
|
|
RPC_WALLET_NOT_FOUND = -18, //!< Invalid wallet specified
|
|
|
|
RPC_WALLET_NOT_SPECIFIED = -19, //!< No wallet specified (error when there are multiple wallets loaded)
|
|
|
|
};
|
|
|
|
|
|
|
|
UniValue JSONRPCRequestObj(const std::string& strMethod, const UniValue& params, const UniValue& id);
|
|
|
|
UniValue JSONRPCReplyObj(const UniValue& result, const UniValue& error, const UniValue& id);
|
|
|
|
std::string JSONRPCReply(const UniValue& result, const UniValue& error, const UniValue& id);
|
|
|
|
UniValue JSONRPCError(int code, const std::string& message);
|
|
|
|
|
|
|
|
/** Generate a new RPC authentication cookie and write it to disk */
|
|
|
|
bool GenerateAuthCookie(std::string *cookie_out);
|
|
|
|
/** Read the RPC authentication cookie from disk */
|
|
|
|
bool GetAuthCookie(std::string *cookie_out);
|
|
|
|
/** Delete RPC authentication cookie from disk */
|
|
|
|
void DeleteAuthCookie();
|
|
|
|
/** Parse JSON-RPC batch reply into a vector */
|
|
|
|
std::vector<UniValue> JSONRPCProcessBatchReply(const UniValue &in, size_t num);
|
|
|
|
|
|
|
|
#endif // BITCOIN_RPCPROTOCOL_H
|