|
rippled
|
API version numbers used in later API versions. More...
Namespaces | |
| namespace | common |
| namespace | detail |
| namespace | Tuning |
| Tuned constants. | |
Classes | |
| class | AccountLines_test |
| class | codeString_test |
| struct | Context |
| The context of information needed to call an RPC. More... | |
| struct | ErrorInfo |
| Maps an rpc error code to its token, default message, and HTTP status. More... | |
| class | fillJson_test |
| struct | GRPCContext |
| struct | Handler |
| struct | JsonContext |
| class | JSONRPC_test |
| struct | key_strings |
| class | LedgerHandler |
| class | LedgerRequest_test |
| class | LegacyPathFind |
| struct | Request |
| struct | Status |
| Status represents the results of an operation that might fail. More... | |
| struct | TxnTestData |
| class | VersionHandler |
| class | WalletPropose_test |
Typedefs | |
| using | ProcessTransactionFn = std::function< void(std::shared_ptr< Transaction > &transaction, bool bUnlimited, bool bLocal, NetworkOPs::FailHard failType)> |
| using | Output = std::function< void(boost::string_ref const &)> |
Enumerations | |
| enum | Condition { NO_CONDITION = 0 , NEEDS_NETWORK_CONNECTION = 1 , NEEDS_CURRENT_LEDGER = 1 << 1 , NEEDS_CLOSED_LEDGER = 1 << 2 } |
Functions | |
| void | setVersion (Json::Value &parent, unsigned int apiVersion, bool betaEnabled) |
| unsigned int | getAPIVersionNumber (Json::Value const &jv, bool betaEnabled) |
| Retrieve the api version number from the json value. | |
| ErrorInfo const & | get_error_info (error_code_i code) |
| Returns an ErrorInfo that reflects the error code. | |
| bool | contains_error (Json::Value const &json) |
Returns true if the json contains an rpc error specification. | |
| int | error_code_http_status (error_code_i code) |
| Returns http status that corresponds to the error code. | |
| BEAST_DEFINE_TESTSUITE (AccountLines, rpc, xrpl) | |
| BEAST_DEFINE_TESTSUITE (JSONRPC, rpc, xrpl) | |
| BEAST_DEFINE_TESTSUITE (WalletPropose, rpc, xrpl) | |
| BEAST_DEFINE_TESTSUITE (LedgerRequest, rpc, xrpl) | |
| BEAST_DEFINE_TESTSUITE (codeString, rpc, RPC) | |
| BEAST_DEFINE_TESTSUITE (fillJson, rpc, RPC) | |
| template<class L > | |
| Json::Value | computeBookChanges (std::shared_ptr< L const > const &lpAccepted) |
| std::optional< std::string > | encodeCTID (uint32_t ledgerSeq, uint32_t txnIndex, uint32_t networkID) noexcept |
| Encodes ledger sequence, transaction index, and network ID into a CTID string. | |
| template<typename T > | |
| std::optional< std::tuple< uint32_t, uint16_t, uint16_t > > | decodeCTID (T const ctid) noexcept |
| Decodes a CTID string or integer into its component parts. | |
| template<class GetLedgerIndex , class GetCloseTime > | |
| std::optional< STAmount > | getDeliveredAmount (GetLedgerIndex const &getLedgerIndex, GetCloseTime const &getCloseTime, std::shared_ptr< STTx const > const &serializedTx, TxMeta const &transactionMeta) |
| bool | canHaveDeliveredAmount (std::shared_ptr< STTx const > const &serializedTx, TxMeta const &transactionMeta) |
| template<class GetLedgerIndex > | |
| static std::optional< STAmount > | getDeliveredAmount (RPC::Context const &context, std::shared_ptr< STTx const > const &serializedTx, TxMeta const &transactionMeta, GetLedgerIndex const &getLedgerIndex) |
| Handler const * | getHandler (unsigned version, bool betaEnabled, std::string const &name) |
| std::set< char const * > | getHandlerNames () |
| Return names of all methods. | |
| Handler const * | getHandler (unsigned int version, bool betaEnabled, std::string const &) |
| template<class Value > | |
| Json::Value | makeObjectValue (Value const &value, Json::StaticString const &field=jss::message) |
| Return a Json::objectValue with a single entry. | |
| template<class T > | |
| error_code_i | conditionMet (Condition condition_required, T &context) |
| Status | doCommand (RPC::JsonContext &, Json::Value &) |
| Execute an RPC command and store the results in a Json::Value. | |
| Role | roleRequired (unsigned int version, bool betaEnabled, std::string const &method) |
| std::uint64_t | getStartHint (std::shared_ptr< SLE const > const &sle, AccountID const &accountID) |
| Gets the start hint for traversing account objects. | |
| bool | isRelatedToAccount (ReadView const &ledger, std::shared_ptr< SLE const > const &sle, AccountID const &accountID) |
| Tests if a ledger entry (SLE) is owned by the specified account. | |
| hash_set< AccountID > | parseAccountIds (Json::Value const &jvArray) |
| Parses an array of account IDs from a JSON value. | |
| std::optional< Json::Value > | readLimitField (unsigned int &limit, Tuning::LimitRange const &range, JsonContext const &context) |
| Retrieves the limit value from a JsonContext or sets a default. | |
| std::optional< Seed > | parseRippleLibSeed (Json::Value const ¶ms) |
| Parses a RippleLib seed from RPC parameters. | |
| std::optional< Seed > | getSeedFromRPC (Json::Value const ¶ms, Json::Value &error) |
| Extracts a Seed from RPC parameters. | |
| std::optional< std::pair< PublicKey, SecretKey > > | keypairForSignature (Json::Value const ¶ms, Json::Value &error, unsigned int apiVersion=apiVersionIfUnspecified) |
| Generates a keypair for signature from RPC parameters. | |
| std::pair< RPC::Status, LedgerEntryType > | chooseLedgerEntryType (Json::Value const ¶ms) |
| Chooses the ledger entry type based on RPC parameters. | |
| bool | isAccountObjectsValidType (LedgerEntryType const &type) |
| Checks if the type is a valid filtering type for the account_objects method. | |
| template<class T , class R > | |
| Status | ledgerFromRequest (T &ledger, GRPCContext< R > const &context) |
| Retrieves a ledger from a gRPC request context. | |
| template Status | ledgerFromRequest (std::shared_ptr< ReadView const > &, GRPCContext< org::xrpl::rpc::v1::GetLedgerEntryRequest > const &) |
| template Status | ledgerFromRequest (std::shared_ptr< ReadView const > &, GRPCContext< org::xrpl::rpc::v1::GetLedgerDataRequest > const &) |
| template Status | ledgerFromRequest (std::shared_ptr< ReadView const > &, GRPCContext< org::xrpl::rpc::v1::GetLedgerRequest > const &) |
| template<class T > | |
| Status | ledgerFromSpecifier (T &ledger, org::xrpl::rpc::v1::LedgerSpecifier const &specifier, Context const &context) |
| Retrieves a ledger based on a LedgerSpecifier. | |
| template<class T > | |
| Status | getLedger (T &ledger, uint256 const &ledgerHash, Context const &context) |
| Retrieves a ledger by its hash. | |
| template<class T > | |
| Status | getLedger (T &ledger, uint32_t ledgerIndex, Context const &context) |
| Retrieves a ledger by its sequence index. | |
| template<class T > | |
| Status | getLedger (T &ledger, LedgerShortcut shortcut, Context const &context) |
Retrieves a ledger specified by a LedgerShortcut. | |
| template Status | getLedger (std::shared_ptr< ReadView const > &, uint32_t, Context const &) |
| template Status | getLedger (std::shared_ptr< ReadView const > &, LedgerShortcut shortcut, Context const &) |
| template Status | getLedger (std::shared_ptr< ReadView const > &, uint256 const &, Context const &) |
| Status | lookupLedger (std::shared_ptr< ReadView const > &, JsonContext const &, Json::Value &result) |
| Looks up a ledger from a request and fills a Json::Value with ledger data. | |
| Json::Value | lookupLedger (std::shared_ptr< ReadView const > &, JsonContext const &) |
| Looks up a ledger from a request and returns a Json::Value with either an error or ledger data. | |
| Expected< std::shared_ptr< Ledger const >, Json::Value > | getOrAcquireLedger (RPC::JsonContext const &context) |
| Retrieves or acquires a ledger based on the parameters provided in the given JsonContext. | |
| static XRPAmount | getTxFee (Application const &app, Config const &config, Json::Value tx) |
| Json::Value | getCurrentNetworkFee (Role const role, Config const &config, LoadFeeTrack const &feeTrack, TxQ const &txQ, Application const &app, Json::Value const &tx, int mult, int div) |
| Json::Value | checkFee (Json::Value &request, Role const role, bool doAutoFill, Config const &config, LoadFeeTrack const &feeTrack, TxQ const &txQ, Application const &app) |
| Fill in the fee on behalf of the client. | |
| Json::Value | transactionSign (Json::Value jvRequest, unsigned apiVersion, NetworkOPs::FailHard failType, Role role, std::chrono::seconds validatedLedgerAge, Application &app) |
| Returns a Json::objectValue. | |
| Json::Value | transactionSubmit (Json::Value jvRequest, unsigned apiVersion, NetworkOPs::FailHard failType, Role role, std::chrono::seconds validatedLedgerAge, Application &app, ProcessTransactionFn const &processTransaction) |
| Returns a Json::objectValue. | |
| Json::Value | transactionSignFor (Json::Value jvRequest, unsigned apiVersion, NetworkOPs::FailHard failType, Role role, std::chrono::seconds validatedLedgerAge, Application &app) |
| Returns a Json::objectValue. | |
| Json::Value | transactionSubmitMultiSigned (Json::Value jvRequest, unsigned apiVersion, NetworkOPs::FailHard failType, Role role, std::chrono::seconds validatedLedgerAge, Application &app, ProcessTransactionFn const &processTransaction) |
| Returns a Json::objectValue. | |
| ProcessTransactionFn | getProcessTxnFn (NetworkOPs &netOPs) |
| Output | stringOutput (std::string &s) |
| void | inject_error (error_code_i code, Json::Value &json) |
| Add or update the json update to reflect the error code. | |
| void | inject_error (error_code_i code, std::string const &message, Json::Value &json) |
| Json::Value | make_error (error_code_i code) |
| Returns a new json object that reflects the error code. | |
| Json::Value | make_error (error_code_i code, std::string const &message) |
| Json::Value | make_param_error (std::string const &message) |
| Returns a new json object that indicates invalid parameters. | |
| std::string | missing_field_message (std::string const &name) |
| Json::Value | missing_field_error (std::string const &name) |
| Json::Value | missing_field_error (Json::StaticString name) |
| std::string | object_field_message (std::string const &name) |
| Json::Value | object_field_error (std::string const &name) |
| Json::Value | object_field_error (Json::StaticString name) |
| std::string | invalid_field_message (std::string const &name) |
| std::string | invalid_field_message (Json::StaticString name) |
| Json::Value | invalid_field_error (std::string const &name) |
| Json::Value | invalid_field_error (Json::StaticString name) |
| std::string | expected_field_message (std::string const &name, std::string const &type) |
| std::string | expected_field_message (Json::StaticString name, std::string const &type) |
| Json::Value | expected_field_error (std::string const &name, std::string const &type) |
| Json::Value | expected_field_error (Json::StaticString name, std::string const &type) |
| Json::Value | not_validator_error () |
| void | insertNFTSyntheticInJson (Json::Value &, std::shared_ptr< STTx const > const &, TxMeta const &) |
| Adds common synthetic fields to transaction-related JSON responses. | |
| void | insertDeliverMax (Json::Value &tx_json, TxType txnType, unsigned int apiVersion) |
Copy Amount field to DeliverMax field in transaction output JSON. | |
| void | insertDeliveredAmount (Json::Value &meta, ReadView const &, std::shared_ptr< STTx const > const &serializedTx, TxMeta const &) |
Add a delivered_amount field to the meta input/output parameter. | |
| void | insertDeliveredAmount (Json::Value &meta, RPC::JsonContext const &, std::shared_ptr< Transaction > const &, TxMeta const &) |
| void | insertDeliveredAmount (Json::Value &meta, RPC::JsonContext const &, std::shared_ptr< STTx const > const &, TxMeta const &) |
| std::optional< STAmount > | getDeliveredAmount (RPC::Context const &context, std::shared_ptr< STTx const > const &serializedTx, TxMeta const &transactionMeta, LedgerIndex const &ledgerIndex) |
| bool | canHaveMPTokenIssuanceID (std::shared_ptr< STTx const > const &serializedTx, TxMeta const &transactionMeta) |
Add a mpt_issuance_id field to the meta input/output parameter. | |
| std::optional< uint192 > | getIDFromCreatedIssuance (TxMeta const &transactionMeta) |
| void | insertMPTokenIssuanceID (Json::Value &response, std::shared_ptr< STTx const > const &transaction, TxMeta const &transactionMeta) |
Variables | |
| template<unsigned int Version> | |
| static constexpr std::integral_constant< unsigned, Version > | apiVersion = {} |
| static constexpr auto | apiInvalidVersion = apiVersion<0> |
| static constexpr auto | apiMinimumSupportedVersion = apiVersion<1> |
| static constexpr auto | apiMaximumSupportedVersion = apiVersion<2> |
| static constexpr auto | apiVersionIfUnspecified = apiVersion<1> |
| static constexpr auto | apiCommandLineVersion = apiVersion<1> |
| static constexpr auto | apiBetaVersion = apiVersion<3> |
| static constexpr auto | apiMaximumValidVersion = apiBetaVersion |
| static constexpr TxnTestData | txnTestArray [] |
| static key_strings const | secp256k1_strings |
| static key_strings const | ed25519_strings |
| static key_strings const | strong_brain_strings |
API version numbers used in later API versions.
Requests with a version number in the range [apiMinimumSupportedVersion, apiMaximumSupportedVersion] are supported.
If [beta_rpc_api] is enabled in config, the version numbers in the range [apiMinimumSupportedVersion, apiBetaVersion] are supported.
Network Requests without explicit version numbers use apiVersionIfUnspecified. apiVersionIfUnspecified is 1, because all the RPC requests with a version >= 2 must explicitly specify the version in the requests. Note that apiVersionIfUnspecified will be lower than apiMinimumSupportedVersion when we stop supporting API version 1.
Command line Requests use apiCommandLineVersion.
| using xrpl::RPC::ProcessTransactionFn = typedef std::function< void(std::shared_ptr<Transaction>& transaction, bool bUnlimited, bool bLocal, NetworkOPs::FailHard failType)> |
Definition at line 68 of file TransactionSign.h.
| using xrpl::RPC::Output = typedef std::function<void(boost::string_ref const&)> |
Definition at line 8 of file src/xrpld/rpc/Output.h.
| enum xrpl::RPC::Condition |
| void xrpl::RPC::setVersion | ( | Json::Value & | parent, |
| unsigned int | apiVersion, | ||
| bool | betaEnabled | ||
| ) |
Definition at line 58 of file ApiVersion.h.
| unsigned int xrpl::RPC::getAPIVersionNumber | ( | Json::Value const & | jv, |
| bool | betaEnabled | ||
| ) |
Retrieve the api version number from the json value.
Note that APIInvalidVersion will be returned if 1) the version number field has a wrong format 2) the version number retrieved is out of the supported range 3) the version number is unspecified and APIVersionIfUnspecified is out of the supported range
| jv | a Json value that may or may not specify the api version number |
| betaEnabled | if the beta API version is enabled |
Definition at line 97 of file ApiVersion.h.
| ErrorInfo const & xrpl::RPC::get_error_info | ( | error_code_i | code | ) |
Returns an ErrorInfo that reflects the error code.
Definition at line 182 of file ErrorCodes.cpp.
| void xrpl::RPC::inject_error | ( | error_code_i | code, |
| Json::Value & | json | ||
| ) |
Add or update the json update to reflect the error code.
Definition at line 164 of file ErrorCodes.cpp.
| void xrpl::RPC::inject_error | ( | error_code_i | code, |
| std::string const & | message, | ||
| Json::Value & | json | ||
| ) |
Definition at line 173 of file ErrorCodes.cpp.
| Json::Value xrpl::RPC::make_error | ( | error_code_i | code | ) |
Returns a new json object that reflects the error code.
Definition at line 190 of file ErrorCodes.cpp.
| Json::Value xrpl::RPC::make_error | ( | error_code_i | code, |
| std::string const & | message | ||
| ) |
Definition at line 198 of file ErrorCodes.cpp.
| Json::Value xrpl::RPC::make_param_error | ( | std::string const & | message | ) |
Returns a new json object that indicates invalid parameters.
Definition at line 214 of file ErrorCodes.h.
| std::string xrpl::RPC::missing_field_message | ( | std::string const & | name | ) |
Definition at line 220 of file ErrorCodes.h.
| Json::Value xrpl::RPC::missing_field_error | ( | std::string const & | name | ) |
Definition at line 226 of file ErrorCodes.h.
| Json::Value xrpl::RPC::missing_field_error | ( | Json::StaticString | name | ) |
Definition at line 232 of file ErrorCodes.h.
| std::string xrpl::RPC::object_field_message | ( | std::string const & | name | ) |
Definition at line 238 of file ErrorCodes.h.
| Json::Value xrpl::RPC::object_field_error | ( | std::string const & | name | ) |
Definition at line 244 of file ErrorCodes.h.
| Json::Value xrpl::RPC::object_field_error | ( | Json::StaticString | name | ) |
Definition at line 250 of file ErrorCodes.h.
| std::string xrpl::RPC::invalid_field_message | ( | std::string const & | name | ) |
Definition at line 256 of file ErrorCodes.h.
| std::string xrpl::RPC::invalid_field_message | ( | Json::StaticString | name | ) |
Definition at line 262 of file ErrorCodes.h.
| Json::Value xrpl::RPC::invalid_field_error | ( | std::string const & | name | ) |
Definition at line 268 of file ErrorCodes.h.
| Json::Value xrpl::RPC::invalid_field_error | ( | Json::StaticString | name | ) |
Definition at line 274 of file ErrorCodes.h.
| std::string xrpl::RPC::expected_field_message | ( | std::string const & | name, |
| std::string const & | type | ||
| ) |
Definition at line 280 of file ErrorCodes.h.
| std::string xrpl::RPC::expected_field_message | ( | Json::StaticString | name, |
| std::string const & | type | ||
| ) |
Definition at line 286 of file ErrorCodes.h.
| Json::Value xrpl::RPC::expected_field_error | ( | std::string const & | name, |
| std::string const & | type | ||
| ) |
Definition at line 292 of file ErrorCodes.h.
| Json::Value xrpl::RPC::expected_field_error | ( | Json::StaticString | name, |
| std::string const & | type | ||
| ) |
Definition at line 298 of file ErrorCodes.h.
| Json::Value xrpl::RPC::not_validator_error | ( | ) |
Definition at line 304 of file ErrorCodes.h.
| bool xrpl::RPC::contains_error | ( | Json::Value const & | json | ) |
Returns true if the json contains an rpc error specification.
Definition at line 206 of file ErrorCodes.cpp.
| int xrpl::RPC::error_code_http_status | ( | error_code_i | code | ) |
Returns http status that corresponds to the error code.
Definition at line 214 of file ErrorCodes.cpp.
| void xrpl::RPC::insertNFTSyntheticInJson | ( | Json::Value & | response, |
| std::shared_ptr< STTx const > const & | transaction, | ||
| TxMeta const & | transactionMeta | ||
| ) |
Adds common synthetic fields to transaction-related JSON responses.
Definition at line 15 of file NFTSyntheticSerializer.cpp.
| xrpl::RPC::BEAST_DEFINE_TESTSUITE | ( | AccountLines | , |
| rpc | , | ||
| xrpl | |||
| ) |
| xrpl::RPC::BEAST_DEFINE_TESTSUITE | ( | JSONRPC | , |
| rpc | , | ||
| xrpl | |||
| ) |
| xrpl::RPC::BEAST_DEFINE_TESTSUITE | ( | WalletPropose | , |
| rpc | , | ||
| xrpl | |||
| ) |
| xrpl::RPC::BEAST_DEFINE_TESTSUITE | ( | LedgerRequest | , |
| rpc | , | ||
| xrpl | |||
| ) |
| xrpl::RPC::BEAST_DEFINE_TESTSUITE | ( | codeString | , |
| rpc | , | ||
| RPC | |||
| ) |
| xrpl::RPC::BEAST_DEFINE_TESTSUITE | ( | fillJson | , |
| rpc | , | ||
| RPC | |||
| ) |
| void xrpl::RPC::insertDeliverMax | ( | Json::Value & | tx_json, |
| TxType | txnType, | ||
| unsigned int | apiVersion | ||
| ) |
Copy Amount field to DeliverMax field in transaction output JSON.
This only applies to Payment transaction type, all others are ignored.
When apiVersion > 1 will also remove Amount field, forcing users to access this value using new DeliverMax field only.
Definition at line 9 of file DeliverMax.cpp.
| Json::Value xrpl::RPC::computeBookChanges | ( | std::shared_ptr< L const > const & | lpAccepted | ) |
Definition at line 27 of file BookChanges.h.
|
noexcept |
Encodes ledger sequence, transaction index, and network ID into a CTID string.
| ledgerSeq | Ledger sequence number (max 0x0FFF'FFFF). |
| txnIndex | Transaction index within the ledger (max 0xFFFF). |
| networkID | Network identifier (max 0xFFFF). |
|
noexcept |
Decodes a CTID string or integer into its component parts.
| T | Type of the CTID input (string, string_view, char*, integral). |
| ctid | CTID value to decode. |
| void xrpl::RPC::insertDeliveredAmount | ( | Json::Value & | meta, |
| ReadView const & | ledger, | ||
| std::shared_ptr< STTx const > const & | serializedTx, | ||
| TxMeta const & | transactionMeta | ||
| ) |
Add a delivered_amount field to the meta input/output parameter.
The field is only added to successful payment and check cash transactions. If a delivered amount field is available in the TxMeta parameter, that value is used. Otherwise, the transaction's Amount field is used. If neither is available, then the delivered amount is set to "unavailable".
Definition at line 81 of file DeliveredAmount.cpp.
| void xrpl::RPC::insertDeliveredAmount | ( | Json::Value & | meta, |
| RPC::JsonContext const & | context, | ||
| std::shared_ptr< Transaction > const & | transaction, | ||
| TxMeta const & | transactionMeta | ||
| ) |
Definition at line 138 of file DeliveredAmount.cpp.
| void xrpl::RPC::insertDeliveredAmount | ( | Json::Value & | meta, |
| RPC::JsonContext const & | context, | ||
| std::shared_ptr< STTx const > const & | transaction, | ||
| TxMeta const & | transactionMeta | ||
| ) |
Definition at line 148 of file DeliveredAmount.cpp.
| std::optional< STAmount > xrpl::RPC::getDeliveredAmount | ( | RPC::Context const & | context, |
| std::shared_ptr< STTx const > const & | serializedTx, | ||
| TxMeta const & | transactionMeta, | ||
| LedgerIndex const & | ledgerIndex | ||
| ) |
Definition at line 128 of file DeliveredAmount.cpp.
| std::optional< STAmount > xrpl::RPC::getDeliveredAmount | ( | GetLedgerIndex const & | getLedgerIndex, |
| GetCloseTime const & | getCloseTime, | ||
| std::shared_ptr< STTx const > const & | serializedTx, | ||
| TxMeta const & | transactionMeta | ||
| ) |
Definition at line 25 of file DeliveredAmount.cpp.
| bool xrpl::RPC::canHaveDeliveredAmount | ( | std::shared_ptr< STTx const > const & | serializedTx, |
| TxMeta const & | transactionMeta | ||
| ) |
Definition at line 63 of file DeliveredAmount.cpp.
|
static |
Definition at line 110 of file DeliveredAmount.cpp.
| Handler const * xrpl::RPC::getHandler | ( | unsigned | version, |
| bool | betaEnabled, | ||
| std::string const & | name | ||
| ) |
Definition at line 236 of file Handler.cpp.
| std::set< char const * > xrpl::RPC::getHandlerNames | ( | ) |
Return names of all methods.
Definition at line 242 of file Handler.cpp.
| Handler const * xrpl::RPC::getHandler | ( | unsigned int | version, |
| bool | betaEnabled, | ||
| std::string const & | |||
| ) |
| Json::Value xrpl::RPC::makeObjectValue | ( | Value const & | value, |
| Json::StaticString const & | field = jss::message |
||
| ) |
Return a Json::objectValue with a single entry.
| error_code_i xrpl::RPC::conditionMet | ( | Condition | condition_required, |
| T & | context | ||
| ) |
| bool xrpl::RPC::canHaveMPTokenIssuanceID | ( | std::shared_ptr< STTx const > const & | serializedTx, |
| TxMeta const & | transactionMeta | ||
| ) |
Add a mpt_issuance_id field to the meta input/output parameter.
The field is only added to successful MPTokenIssuanceCreate transactions. The mpt_issuance_id is parsed from the sequence and the issuer in the MPTokenIssuance object.
Definition at line 8 of file MPTokenIssuanceID.cpp.
| std::optional< uint192 > xrpl::RPC::getIDFromCreatedIssuance | ( | TxMeta const & | transactionMeta | ) |
Definition at line 25 of file MPTokenIssuanceID.cpp.
| void xrpl::RPC::insertMPTokenIssuanceID | ( | Json::Value & | response, |
| std::shared_ptr< STTx const > const & | transaction, | ||
| TxMeta const & | transactionMeta | ||
| ) |
Definition at line 40 of file MPTokenIssuanceID.cpp.
| Status xrpl::RPC::doCommand | ( | RPC::JsonContext & | context, |
| Json::Value & | result | ||
| ) |
Execute an RPC command and store the results in a Json::Value.
Definition at line 192 of file RPCHandler.cpp.
| Role xrpl::RPC::roleRequired | ( | unsigned int | version, |
| bool | betaEnabled, | ||
| std::string const & | method | ||
| ) |
Definition at line 226 of file RPCHandler.cpp.
| std::uint64_t xrpl::RPC::getStartHint | ( | std::shared_ptr< SLE const > const & | sle, |
| AccountID const & | accountID | ||
| ) |
Gets the start hint for traversing account objects.
This function retrieves a hint value from the specified ledger entry (SLE) that can be used to optimize traversal of account objects for the given account ID.
| sle | Shared pointer to the ledger entry (SLE) defined by the marker passed into the RPC. |
| accountID | The ID of the account whose objects are being traversed. |
Definition at line 22 of file RPCHelpers.cpp.
| bool xrpl::RPC::isRelatedToAccount | ( | ReadView const & | ledger, |
| std::shared_ptr< SLE const > const & | sle, | ||
| AccountID const & | accountID | ||
| ) |
Tests if a ledger entry (SLE) is owned by the specified account.
Determines whether the given SLE is related to or owned by the provided account ID within the context of the specified ledger.
| ledger | The ledger view used to search for the SLE. |
| sle | Shared pointer to the SLE to test for ownership. |
| accountID | The account being tested for SLE ownership. |
Definition at line 39 of file RPCHelpers.cpp.
| hash_set< AccountID > xrpl::RPC::parseAccountIds | ( | Json::Value const & | jvArray | ) |
Parses an array of account IDs from a JSON value.
Extracts and returns a set of AccountID objects from the provided JSON array.
| jvArray | The JSON value containing an array of account IDs. |
Definition at line 73 of file RPCHelpers.cpp.
| std::optional< Json::Value > xrpl::RPC::readLimitField | ( | unsigned int & | limit, |
| Tuning::LimitRange const & | range, | ||
| JsonContext const & | context | ||
| ) |
Retrieves the limit value from a JsonContext or sets a default.
Reads the "limit" field from the given JsonContext, applies default, minimum, and maximum constraints as appropriate, and returns an error as JSON if validation fails.
| limit | Reference to the variable where the limit value will be stored. |
| range | The allowed range for the limit value. |
| context | The JSON context from which to read the limit. |
Definition at line 89 of file RPCHelpers.cpp.
| std::optional< Seed > xrpl::RPC::parseRippleLibSeed | ( | Json::Value const & | params | ) |
Parses a RippleLib seed from RPC parameters.
Attempts to extract and return a Seed from the provided JSON parameters using RippleLib conventions.
| params | The JSON value containing RPC parameters. |
Definition at line 110 of file RPCHelpers.cpp.
| std::optional< Seed > xrpl::RPC::getSeedFromRPC | ( | Json::Value const & | params, |
| Json::Value & | error | ||
| ) |
Extracts a Seed from RPC parameters.
Attempts to parse and return a Seed from the provided JSON RPC parameters. If parsing fails, an error is set in the provided error JSON value.
| params | The JSON value containing RPC parameters. |
| error | Reference to a JSON value to be set with error information if parsing fails. |
Definition at line 128 of file RPCHelpers.cpp.
| std::optional< std::pair< PublicKey, SecretKey > > xrpl::RPC::keypairForSignature | ( | Json::Value const & | params, |
| Json::Value & | error, | ||
| unsigned int | apiVersion = apiVersionIfUnspecified |
||
| ) |
Generates a keypair for signature from RPC parameters.
Attempts to derive a public and secret key pair from the provided JSON RPC parameters. If an error occurs, it is set in the provided error JSON value.
| params | The JSON value containing RPC parameters. |
| error | Reference to a JSON value to be set with error information if keypair generation fails. |
| apiVersion | The API version to use for keypair derivation (defaults to apiVersionIfUnspecified). |
Definition at line 183 of file RPCHelpers.cpp.
| std::pair< RPC::Status, LedgerEntryType > xrpl::RPC::chooseLedgerEntryType | ( | Json::Value const & | params | ) |
Chooses the ledger entry type based on RPC parameters.
Determines the appropriate LedgerEntryType to use based on the provided JSON parameters, and returns a pair containing the RPC status and the selected type.
| params | The JSON value containing RPC parameters. |
Definition at line 308 of file RPCHelpers.cpp.
| bool xrpl::RPC::isAccountObjectsValidType | ( | LedgerEntryType const & | type | ) |
Checks if the type is a valid filtering type for the account_objects method.
Determines whether the specified LedgerEntryType is valid for filtering in the account_objects RPC method. Types such as Amendments, DirectoryNode, FeeSettings, and LedgerHashes are not considered valid as they cannot be owned by an account.
| type | The ledger entry type to check. |
Definition at line 357 of file RPCHelpers.cpp.
| Status xrpl::RPC::ledgerFromRequest | ( | T & | ledger, |
| GRPCContext< R > const & | context | ||
| ) |
Retrieves a ledger from a gRPC request context.
This function attempts to find and fill the provided ledger pointer based on the parameters in the given gRPC context. On success, the ledger pointer is filled.
| T | Type of the ledger pointer to be filled. |
| R | Type of the gRPC request. |
| ledger | Reference to the ledger pointer to be filled. |
| context | The gRPC context containing request parameters and environment. |
Definition at line 122 of file RPCLedgerHelpers.cpp.
| template Status xrpl::RPC::ledgerFromRequest | ( | std::shared_ptr< ReadView const > & | , |
| GRPCContext< org::xrpl::rpc::v1::GetLedgerEntryRequest > const & | |||
| ) |
| template Status xrpl::RPC::ledgerFromRequest | ( | std::shared_ptr< ReadView const > & | , |
| GRPCContext< org::xrpl::rpc::v1::GetLedgerDataRequest > const & | |||
| ) |
| template Status xrpl::RPC::ledgerFromRequest | ( | std::shared_ptr< ReadView const > & | , |
| GRPCContext< org::xrpl::rpc::v1::GetLedgerRequest > const & | |||
| ) |
| Status xrpl::RPC::ledgerFromSpecifier | ( | T & | ledger, |
| org::xrpl::rpc::v1::LedgerSpecifier const & | specifier, | ||
| Context const & | context | ||
| ) |
Retrieves a ledger based on a LedgerSpecifier.
This function attempts to find and fill the provided ledger pointer based on the specified LedgerSpecifier. On success, the ledger pointer is filled.
| T | Type of the ledger pointer to be filled. |
| ledger | Reference to the ledger pointer to be filled. |
| specifier | The LedgerSpecifier describing which ledger to retrieve. |
| context | The RPC context containing request parameters and environment. |
Definition at line 142 of file RPCLedgerHelpers.cpp.
| Status xrpl::RPC::getLedger | ( | T & | ledger, |
| uint256 const & | ledgerHash, | ||
| Context const & | context | ||
| ) |
Retrieves a ledger by its hash.
This function attempts to find and fill the provided ledger pointer with the ledger corresponding to the specified hash. If the operation is successful, the ledger pointer will be set; otherwise, an error status is returned.
| T | Type of the ledger pointer to be filled. |
| ledger | Reference to the ledger pointer to be filled. |
| ledgerHash | The hash of the ledger to retrieve. |
| context | The RPC context containing request parameters and environment. |
Definition at line 187 of file RPCLedgerHelpers.cpp.
| Status xrpl::RPC::getLedger | ( | T & | ledger, |
| uint32_t | ledgerIndex, | ||
| Context const & | context | ||
| ) |
Retrieves a ledger by its sequence index.
This function attempts to find and fill the provided ledger pointer with the ledger corresponding to the specified sequence index. If the operation is successful, the ledger pointer will be set; otherwise, an error status is returned.
| T | Type of the ledger pointer to be filled. |
| ledger | Reference to the ledger pointer to be filled. |
| ledgerIndex | The sequence index of the ledger to retrieve. |
| context | The RPC context containing request parameters and environment. |
Definition at line 197 of file RPCLedgerHelpers.cpp.
| Status xrpl::RPC::getLedger | ( | T & | ledger, |
| LedgerShortcut | shortcut, | ||
| Context const & | context | ||
| ) |
Retrieves a ledger specified by a LedgerShortcut.
This function attempts to find and fill the provided ledger pointer with the ledger corresponding to the specified shortcut. If the operation is successful, the ledger pointer will be set; otherwise, an error status is returned.
| T | Type of the ledger pointer to be filled. |
| ledger | Reference to the ledger pointer to be filled. |
| shortcut | The shortcut specifying which ledger to retrieve. |
| context | The RPC context containing request parameters and environment. |
Definition at line 226 of file RPCLedgerHelpers.cpp.
| template Status xrpl::RPC::getLedger | ( | std::shared_ptr< ReadView const > & | , |
| uint32_t | , | ||
| Context const & | |||
| ) |
| template Status xrpl::RPC::getLedger | ( | std::shared_ptr< ReadView const > & | , |
| LedgerShortcut | shortcut, | ||
| Context const & | |||
| ) |
| template Status xrpl::RPC::getLedger | ( | std::shared_ptr< ReadView const > & | , |
| uint256 const & | , | ||
| Context const & | |||
| ) |
| Status xrpl::RPC::lookupLedger | ( | std::shared_ptr< ReadView const > & | , |
| JsonContext const & | , | ||
| Json::Value & | result | ||
| ) |
Looks up a ledger from a request and fills a Json::Value with ledger data.
This function attempts to find a ledger based on the parameters in the given JsonContext. On success, the ledger pointer is filled and the result parameter is populated with ledger data. On failure, an error status is returned.
| ledger | Reference to a shared pointer to the ledger to be filled. |
| context | The RPC JsonContext containing request parameters and environment. |
| result | Reference to a Json::Value to be filled with ledger data. |
Definition at line 314 of file RPCLedgerHelpers.cpp.
| Json::Value xrpl::RPC::lookupLedger | ( | std::shared_ptr< ReadView const > & | , |
| JsonContext const & | |||
| ) |
Looks up a ledger from a request and returns a Json::Value with either an error or ledger data.
This function attempts to find a ledger based on the parameters in the given JsonContext. On success, the ledger pointer is filled and a Json::Value representing the ledger is returned. On failure, a Json::Value describing the error is returned.
| ledger | Reference to a shared pointer to the ledger to be filled. |
| context | The RPC JsonContext containing request parameters and environment. |
Definition at line 336 of file RPCLedgerHelpers.cpp.
| Expected< std::shared_ptr< Ledger const >, Json::Value > xrpl::RPC::getOrAcquireLedger | ( | RPC::JsonContext const & | context | ) |
Retrieves or acquires a ledger based on the parameters provided in the given JsonContext.
This function differs from the other ledger getter functions in this file in that it attempts to either retrieve an existing ledger or acquire it if it is not already available, based on the context of the RPC request. It returns an Expected containing either a shared pointer to the requested immutable Ledger object or a Json::Value describing an error. Unlike the other getLedger or lookupLedger functions, which typically fill a provided ledger pointer or result object and return a Status, this function encapsulates both the result and error in a single return value, making it easier to handle success and failure cases in a unified way.
| context | The RPC JsonContext containing request parameters and environment. |
Definition at line 346 of file RPCLedgerHelpers.cpp.
|
static |
Definition at line 716 of file TransactionSign.cpp.
| Json::Value xrpl::RPC::getCurrentNetworkFee | ( | Role const | role, |
| Config const & | config, | ||
| LoadFeeTrack const & | feeTrack, | ||
| TxQ const & | txQ, | ||
| Application const & | app, | ||
| Json::Value const & | tx, | ||
| int | mult, | ||
| int | div | ||
| ) |
Definition at line 789 of file TransactionSign.cpp.
| Json::Value xrpl::RPC::checkFee | ( | Json::Value & | request, |
| Role const | role, | ||
| bool | doAutoFill, | ||
| Config const & | config, | ||
| LoadFeeTrack const & | feeTrack, | ||
| TxQ const & | txQ, | ||
| Application const & | app | ||
| ) |
Fill in the fee on behalf of the client.
This is called when the client does not explicitly specify the fee. The client may also put a ceiling on the amount of the fee. This ceiling is expressed as a multiplier based on the current ledger's fee schedule.
JSON fields
"Fee" The fee paid by the transaction. Omitted when the client wants the fee filled in.
"fee_mult_max" A multiplier applied to the current ledger's transaction fee that caps the maximum fee the server should auto fill. If this optional field is not specified, then a default multiplier is used. "fee_div_max" A divider applied to the current ledger's transaction fee that caps the maximum fee the server should auto fill. If this optional field is not specified, then a default divider (1) is used. "fee_mult_max" and "fee_div_max" are both used such that the maximum fee will be base * fee_mult_max / fee_div_max as an integer.
| tx | The JSON corresponding to the transaction to fill in. |
| ledger | A ledger for retrieving the current fee schedule. |
| roll | Identifies if this is called by an administrative endpoint. |
Definition at line 827 of file TransactionSign.cpp.
| Json::Value xrpl::RPC::transactionSign | ( | Json::Value | jvRequest, |
| unsigned | apiVersion, | ||
| NetworkOPs::FailHard | failType, | ||
| Role | role, | ||
| std::chrono::seconds | validatedLedgerAge, | ||
| Application & | app | ||
| ) |
Returns a Json::objectValue.
Definition at line 885 of file TransactionSign.cpp.
| Json::Value xrpl::RPC::transactionSubmit | ( | Json::Value | jvRequest, |
| unsigned | apiVersion, | ||
| NetworkOPs::FailHard | failType, | ||
| Role | role, | ||
| std::chrono::seconds | validatedLedgerAge, | ||
| Application & | app, | ||
| ProcessTransactionFn const & | processTransaction | ||
| ) |
Returns a Json::objectValue.
Definition at line 919 of file TransactionSign.cpp.
| Json::Value xrpl::RPC::transactionSignFor | ( | Json::Value | jvRequest, |
| unsigned | apiVersion, | ||
| NetworkOPs::FailHard | failType, | ||
| Role | role, | ||
| std::chrono::seconds | validatedLedgerAge, | ||
| Application & | app | ||
| ) |
Returns a Json::objectValue.
Definition at line 1037 of file TransactionSign.cpp.
| Json::Value xrpl::RPC::transactionSubmitMultiSigned | ( | Json::Value | jvRequest, |
| unsigned | apiVersion, | ||
| NetworkOPs::FailHard | failType, | ||
| Role | role, | ||
| std::chrono::seconds | validatedLedgerAge, | ||
| Application & | app, | ||
| ProcessTransactionFn const & | processTransaction | ||
| ) |
Returns a Json::objectValue.
Definition at line 1145 of file TransactionSign.cpp.
| ProcessTransactionFn xrpl::RPC::getProcessTxnFn | ( | NetworkOPs & | netOPs | ) |
Definition at line 72 of file TransactionSign.h.
| Output xrpl::RPC::stringOutput | ( | std::string & | s | ) |
Definition at line 11 of file src/xrpld/rpc/Output.h.
|
staticconstexpr |
Definition at line 38 of file ApiVersion.h.
|
staticconstexpr |
Definition at line 40 of file ApiVersion.h.
|
staticconstexpr |
Definition at line 41 of file ApiVersion.h.
|
staticconstexpr |
Definition at line 42 of file ApiVersion.h.
|
staticconstexpr |
Definition at line 43 of file ApiVersion.h.
|
staticconstexpr |
Definition at line 44 of file ApiVersion.h.
|
staticconstexpr |
Definition at line 45 of file ApiVersion.h.
|
staticconstexpr |
Definition at line 46 of file ApiVersion.h.
|
staticconstexpr |
Definition at line 52 of file JSONRPC_test.cpp.
|
static |
Definition at line 35 of file KeyGeneration_test.cpp.
|
static |
Definition at line 49 of file KeyGeneration_test.cpp.
|
static |
Definition at line 63 of file KeyGeneration_test.cpp.