1// Copyright (c) 2010 Satoshi Nakamoto
2// Copyright (c) 2009-present The Bitcoin Core developers
3// Distributed under the MIT software license, see the accompanying
4// file COPYING or http://www.opensource.org/licenses/mit-license.php.
5
6#ifndef BITCOIN_RPC_PROTOCOL_H
7#define BITCOIN_RPC_PROTOCOL_H
8
9#include <string_view>
10
11//! HTTP status codes
12enum HTTPStatusCode : int
13{
14    HTTP_OK                    = 200,
15    HTTP_NO_CONTENT            = 204,
16    HTTP_BAD_REQUEST           = 400,
17    HTTP_UNAUTHORIZED          = 401,
18    HTTP_FORBIDDEN             = 403,
19    HTTP_NOT_FOUND             = 404,
20    HTTP_BAD_METHOD            = 405,
21    HTTP_CONTENT_TOO_LARGE     = 413,
22    HTTP_INTERNAL_SERVER_ERROR = 500,
23    HTTP_SERVICE_UNAVAILABLE   = 503,
24};
25
26//! Mapping of HTTP status codes to short string explanation.
27//! Copied from libevent http.c success_phrases[] and client_error_phrases[]
28inline std::string_view HTTPStatusReasonString(HTTPStatusCode code)
29{
30    switch (code) {
31    case HTTP_OK: return "OK";
32    case HTTP_NO_CONTENT: return "No Content";
33    case HTTP_BAD_REQUEST: return "Bad Request";
34    case HTTP_UNAUTHORIZED: return "Unauthorized";
35    case HTTP_FORBIDDEN: return "Forbidden";
36    case HTTP_NOT_FOUND: return "Not Found";
37    case HTTP_BAD_METHOD: return "Method Not Allowed";
38    case HTTP_CONTENT_TOO_LARGE: return "Content too large";
39    case HTTP_INTERNAL_SERVER_ERROR: return "Internal Server Error";
40    case HTTP_SERVICE_UNAVAILABLE: return "Service Unavailable";
41    }
42
43    // Reason phrases are optional and may be replaced by local variants.
44    // https://httpwg.org/specs/rfc9110.html#rfc.section.15.1
45    return "";
46}
47
48//! Bitcoin RPC error codes
49enum RPCErrorCode
50{
51    //! Standard JSON-RPC 2.0 errors
52    // RPC_INVALID_REQUEST is internally mapped to HTTP_BAD_REQUEST (400).
53    // It should not be used for application-layer errors.
54    RPC_INVALID_REQUEST  = -32600,
55    // RPC_METHOD_NOT_FOUND is internally mapped to HTTP_NOT_FOUND (404).
56    // It should not be used for application-layer errors.
57    RPC_METHOD_NOT_FOUND = -32601,
58    RPC_INVALID_PARAMS   = -32602,
59    // RPC_INTERNAL_ERROR should only be used for genuine errors in bitcoind
60    // (for example datadir corruption).
61    RPC_INTERNAL_ERROR   = -32603,
62    RPC_PARSE_ERROR      = -32700,
63
64    //! General application defined errors
65    RPC_MISC_ERROR                  = -1,  //!< std::exception thrown in command handling
66    RPC_TYPE_ERROR                  = -3,  //!< Unexpected type was passed as parameter
67    RPC_INVALID_ADDRESS_OR_KEY      = -5,  //!< Invalid address or key
68    RPC_OUT_OF_MEMORY               = -7,  //!< Ran out of memory during operation
69    RPC_INVALID_PARAMETER           = -8,  //!< Invalid, missing or duplicate parameter
70    RPC_DATABASE_ERROR              = -20, //!< Database error
71    RPC_DESERIALIZATION_ERROR       = -22, //!< Error parsing or validating structure in raw format
72    RPC_VERIFY_ERROR                = -25, //!< General error during transaction or block submission
73    RPC_VERIFY_REJECTED             = -26, //!< Transaction or block was rejected by network rules
74    RPC_VERIFY_ALREADY_IN_UTXO_SET  = -27, //!< Transaction already in utxo set
75    RPC_IN_WARMUP                   = -28, //!< Client still warming up
76    RPC_METHOD_DEPRECATED           = -32, //!< RPC method is deprecated
77    RPC_LIMIT_EXCEEDED              = -37, //!< A bounded resource is currently at capacity
78
79    //! Aliases for backward compatibility
80    RPC_TRANSACTION_ERROR           = RPC_VERIFY_ERROR,
81    RPC_TRANSACTION_REJECTED        = RPC_VERIFY_REJECTED,
82
83    //! P2P client errors
84    RPC_CLIENT_NOT_CONNECTED        = -9,  //!< Bitcoin is not connected
85    RPC_CLIENT_IN_INITIAL_DOWNLOAD  = -10, //!< Still downloading initial blocks
86    RPC_CLIENT_NODE_ALREADY_ADDED   = -23, //!< Node is already added
87    RPC_CLIENT_NODE_NOT_ADDED       = -24, //!< Node has not been added before
88    RPC_CLIENT_NODE_NOT_CONNECTED   = -29, //!< Node to disconnect not found in connected nodes
89    RPC_CLIENT_INVALID_IP_OR_SUBNET = -30, //!< Invalid IP/Subnet
90    RPC_CLIENT_P2P_DISABLED         = -31, //!< No valid connection manager instance found
91    RPC_CLIENT_NODE_CAPACITY_REACHED= -34, //!< Max number of outbound or block-relay connections already open
92
93    //! Chain errors
94    RPC_CLIENT_MEMPOOL_DISABLED     = -33, //!< No mempool instance found
95
96    //! Wallet errors
97    RPC_WALLET_ERROR                = -4,  //!< Unspecified problem with wallet (key not found etc.)
98    RPC_WALLET_INSUFFICIENT_FUNDS   = -6,  //!< Not enough funds in wallet or account
99    RPC_WALLET_INVALID_LABEL_NAME   = -11, //!< Invalid label name
100    RPC_WALLET_KEYPOOL_RAN_OUT      = -12, //!< Keypool ran out, call keypoolrefill first
101    RPC_WALLET_UNLOCK_NEEDED        = -13, //!< Enter the wallet passphrase with walletpassphrase first
102    RPC_WALLET_PASSPHRASE_INCORRECT = -14, //!< The wallet passphrase entered was incorrect
103    RPC_WALLET_WRONG_ENC_STATE      = -15, //!< Command given in wrong wallet encryption state (encrypting an encrypted wallet etc.)
104    RPC_WALLET_ENCRYPTION_FAILED    = -16, //!< Failed to encrypt the wallet
105    RPC_WALLET_ALREADY_UNLOCKED     = -17, //!< Wallet is already unlocked
106    RPC_WALLET_NOT_FOUND            = -18, //!< Invalid wallet specified
107    RPC_WALLET_NOT_SPECIFIED        = -19, //!< No wallet specified (error when there are multiple wallets loaded)
108    RPC_WALLET_ALREADY_LOADED       = -35, //!< This same wallet is already loaded
109    RPC_WALLET_ALREADY_EXISTS       = -36, //!< There is already a wallet with the same name
110
111    //! Backwards compatible aliases
112    RPC_WALLET_INVALID_ACCOUNT_NAME = RPC_WALLET_INVALID_LABEL_NAME,
113
114    //! Unused reserved codes, kept around for backwards compatibility. Do not reuse.
115    RPC_FORBIDDEN_BY_SAFE_MODE      = -2,  //!< Server is in safe mode, and command is not allowed in safe mode
116};
117
118#endif // BITCOIN_RPC_PROTOCOL_H
119