A group of custom validation functions. More...

#include <Validators.hpp>

Collaboration diagram for rpc::validation::CustomValidators:

Static Public Attributes
static CustomValidator	ledgerIndexValidator
	Provides a commonly used validator for ledger index.
static CustomValidator	ledgerTypeValidator
	Provides a validator for ledger type.
static CustomValidator	accountValidator
	Provides a commonly used validator for accounts.
static CustomValidator	accountBase58Validator
	Provides a commonly used validator for accounts.
static CustomValidator	accountMarkerValidator
	Provides a commonly used validator for markers.
static CustomValidator	accountTypeValidator
	Provides a validator for account type.
static CustomValidator	uint160HexStringValidator
	Provides a commonly used validator for uint160(AccountID) hex string.
static CustomValidator	uint192HexStringValidator
	Provides a commonly used validator for uint192 hex string.
static CustomValidator	uint256HexStringValidator
	Provides a commonly used validator for uint256 hex string.
static CustomValidator	currencyValidator
	Provides a commonly used validator for currency, including standard currency code and token code.
static CustomValidator	issuerValidator
	Provides a commonly used validator for issuer type.
static CustomValidator	subscribeStreamValidator
	Provides a validator for validating streams used in subscribe/unsubscribe.
static CustomValidator	subscribeAccountsValidator
	Provides a validator for validating accounts used in subscribe/unsubscribe.
static CustomValidator	currencyIssueValidator
	Validates an asset (ripple::Issue).
static CustomValidator	authorizeCredentialValidator
	Provides a validator for validating authorized_credentials json array.
static CustomValidator	credentialTypeValidator
	Provides a validator for validating credential_type.

Detailed Description

A group of custom validation functions.

Member Data Documentation

◆ accountBase58Validator

CustomValidator rpc::validation::CustomValidators::accountBase58Validator

static

Initial value:

=
    CustomValidator{[](boost::json::value const& value, std::string_view key) -> MaybeError {
        if (!value.is_string())
            return Error{Status{RippledError::rpcINVALID_PARAMS, std::string(key) + "NotString"}};
 
        auto const account = util::parseBase58Wrapper<ripple::AccountID>(boost::json::value_to<std::string>(value));
        if (!account || account->isZero())
            return Error{Status{ClioError::RpcMalformedAddress}};
 
        return MaybeError{};
    }}

Provides a commonly used validator for accounts.

Account must be a string and can convert to base58.

◆ accountMarkerValidator

CustomValidator rpc::validation::CustomValidators::accountMarkerValidator

static

Initial value:

=
    CustomValidator{[](boost::json::value const& value, std::string_view key) -> MaybeError {
        if (!value.is_string())
            return Error{Status{RippledError::rpcINVALID_PARAMS, std::string(key) + "NotString"}};
 
        
        
        if (!parseAccountCursor(boost::json::value_to<std::string>(value))) {
            
            return Error{Status{RippledError::rpcINVALID_PARAMS, "Malformed cursor."}};
        }
 
        return MaybeError{};
    }}

Provides a commonly used validator for markers.

A marker is composed of a comma-separated index and a start hint. The former will be read as hex, and the latter can be cast to uint64.

◆ accountTypeValidator

CustomValidator rpc::validation::CustomValidators::accountTypeValidator

static

Initial value:

=
    CustomValidator{[](boost::json::value const& value, std::string_view key) -> MaybeError {
        if (!value.is_string())
            return Error{Status{RippledError::rpcINVALID_PARAMS, fmt::format("Invalid field '{}', not string.", key)}};
 
        auto const type =
            util::LedgerTypes::getAccountOwnedLedgerTypeFromStr(boost::json::value_to<std::string>(value));
        if (type == ripple::ltANY)
            return Error{Status{RippledError::rpcINVALID_PARAMS, fmt::format("Invalid field '{}'.", key)}};
 
        return MaybeError{};
    }}

Provides a validator for account type.

A type accepts canonical names of owned ledger entry types (case insensitive) or short names. Used by account_objects.

◆ accountValidator

CustomValidator rpc::validation::CustomValidators::accountValidator

static

Initial value:

=
    CustomValidator{[](boost::json::value const& value, std::string_view key) -> MaybeError {
        if (!value.is_string())
            return Error{Status{RippledError::rpcINVALID_PARAMS, std::string(key) + "NotString"}};
 
        
        
        if (!accountFromStringStrict(boost::json::value_to<std::string>(value)))
            return Error{Status{RippledError::rpcACT_MALFORMED, std::string(key) + "Malformed"}};
 
        return MaybeError{};
    }}

Provides a commonly used validator for accounts.

Account must be a string and the converted public key is valid.

◆ authorizeCredentialValidator

CustomValidator rpc::validation::CustomValidators::authorizeCredentialValidator

static

Provides a validator for validating authorized_credentials json array.

Used by deposit_preauth.

◆ credentialTypeValidator

CustomValidator rpc::validation::CustomValidators::credentialTypeValidator

static

Initial value:

=
    CustomValidator{[](boost::json::value const& value, std::string_view key) -> MaybeError {
        if (not value.is_string())
            return Error{Status{ClioError::RpcMalformedAuthorizedCredentials, std::string(key) + " NotString"}};
 
        auto const& credTypeHex = ripple::strViewUnHex(value.as_string());
        if (!credTypeHex.has_value())
            return Error{Status{ClioError::RpcMalformedAuthorizedCredentials, std::string(key) + " NotHexString"}};
 
        if (credTypeHex->empty())
            return Error{Status{ClioError::RpcMalformedAuthorizedCredentials, std::string(key) + " is empty"}};
 
        if (credTypeHex->size() > ripple::maxCredentialTypeLength) {
            return Error{
                Status{ClioError::RpcMalformedAuthorizedCredentials, std::string(key) + " greater than max length"}
            };
        }
 
        return MaybeError{};
    }}

Provides a validator for validating credential_type.

Used by AuthorizeCredentialValidator in deposit_preauth.

◆ currencyIssueValidator

CustomValidator rpc::validation::CustomValidators::currencyIssueValidator

static

Initial value:

=
    CustomValidator{[](boost::json::value const& value, std::string_view key) -> MaybeError {
        if (not value.is_object())
            return Error{Status{RippledError::rpcINVALID_PARAMS, std::string(key) + "NotObject"}};
 
        try {
            parseIssue(value.as_object());
        } catch (std::runtime_error const&) {
            return Error{Status{ClioError::RpcMalformedRequest}};
        }
 
        return MaybeError{};
    }}

Validates an asset (ripple::Issue).

Used by amm_info.

◆ currencyValidator

CustomValidator rpc::validation::CustomValidators::currencyValidator

static

Initial value:

=
    CustomValidator{[](boost::json::value const& value, std::string_view key) -> MaybeError {
        if (!value.is_string())
            return Error{Status{RippledError::rpcINVALID_PARAMS, std::string(key) + "NotString"}};
 
        auto const currencyStr = boost::json::value_to<std::string>(value);
        if (currencyStr.empty())
            return Error{Status{RippledError::rpcINVALID_PARAMS, std::string(key) + "IsEmpty"}};
 
        ripple::Currency currency;
        if (!ripple::to_currency(currency, currencyStr))
            return Error{Status{ClioError::RpcMalformedCurrency, "malformedCurrency"}};
 
        return MaybeError{};
    }}

Provides a commonly used validator for currency, including standard currency code and token code.

◆ issuerValidator

CustomValidator rpc::validation::CustomValidators::issuerValidator

static

Initial value:

=
    CustomValidator{[](boost::json::value const& value, std::string_view key) -> MaybeError {
        if (!value.is_string())
            return Error{Status{RippledError::rpcINVALID_PARAMS, std::string(key) + "NotString"}};
 
        ripple::AccountID issuer;
 
        
        if (!ripple::to_issuer(issuer, boost::json::value_to<std::string>(value)))
            return Error{Status{RippledError::rpcINVALID_PARAMS, fmt::format("Invalid field '{}', bad issuer.", key)}};
 
        if (issuer == ripple::noAccount()) {
            return Error{
                Status{RippledError::rpcINVALID_PARAMS, fmt::format("Invalid field '{}', bad issuer account one.", key)}
            };
        }
 
        return MaybeError{};
    }}

Provides a commonly used validator for issuer type.

It must be a hex string or base58 string.

◆ ledgerIndexValidator

CustomValidator rpc::validation::CustomValidators::ledgerIndexValidator

static

Initial value:

=
    CustomValidator{[](boost::json::value const& value, std::string_view ) -> MaybeError {
        auto err = Error{Status{RippledError::rpcINVALID_PARAMS, "ledgerIndexMalformed"}};
 
        if (!value.is_string() && !(value.is_uint64() || value.is_int64()))
            return err;
 
        if (value.is_string() && value.as_string() != "validated" &&
            !checkIsU32Numeric(boost::json::value_to<std::string>(value)))
            return err;
 
        return MaybeError{};
    }}

Provides a commonly used validator for ledger index.

LedgerIndex must be a string or an int. If the specified LedgerIndex is a string, its value must be either "validated" or a valid integer value represented as a string.

◆ ledgerTypeValidator

CustomValidator rpc::validation::CustomValidators::ledgerTypeValidator

static

Initial value:

=
    CustomValidator{[](boost::json::value const& value, std::string_view key) -> MaybeError {
        if (!value.is_string())
            return Error{Status{RippledError::rpcINVALID_PARAMS, fmt::format("Invalid field '{}', not string.", key)}};
 
        auto const type = util::LedgerTypes::getLedgerEntryTypeFromStr(boost::json::value_to<std::string>(value));
        if (type == ripple::ltANY)
            return Error{Status{RippledError::rpcINVALID_PARAMS, fmt::format("Invalid field '{}'.", key)}};
 
        return MaybeError{};
    }}

Provides a validator for ledger type.

A type accepts canonical names of ledger entry types (case insensitive) or short names. Used by ledger_data.

◆ subscribeAccountsValidator

CustomValidator rpc::validation::CustomValidators::subscribeAccountsValidator

static

Initial value:

=
    CustomValidator{[](boost::json::value const& value, std::string_view key) -> MaybeError {
        if (!value.is_array())
            return Error{Status{RippledError::rpcINVALID_PARAMS, std::string(key) + "NotArray"}};
 
        if (value.as_array().empty())
            return Error{Status{RippledError::rpcACT_MALFORMED, std::string(key) + " malformed."}};
 
        for (auto const& v : value.as_array()) {
            auto obj = boost::json::object();
            auto const keyItem = std::string(key) + "'sItem";
 
            obj[keyItem] = v;
 
            if (auto err = accountValidator.verify(obj, keyItem); !err)
                return err;
        }
 
        return MaybeError{};
    }}

Provides a validator for validating accounts used in subscribe/unsubscribe.

◆ subscribeStreamValidator

CustomValidator rpc::validation::CustomValidators::subscribeStreamValidator

static

Initial value:

=
    CustomValidator{[](boost::json::value const& value, std::string_view key) -> MaybeError {
        if (!value.is_array())
            return Error{Status{RippledError::rpcINVALID_PARAMS, std::string(key) + "NotArray"}};
 
        static std::unordered_set<std::string> const kVALID_STREAMS = {
            "ledger", "transactions", "transactions_proposed", "book_changes", "manifests", "validations"
        };
 
        static std::unordered_set<std::string> const kNOT_SUPPORT_STREAMS = {"peer_status", "consensus", "server"};
        for (auto const& v : value.as_array()) {
            if (!v.is_string())
                return Error{Status{RippledError::rpcINVALID_PARAMS, "streamNotString"}};
 
            if (kNOT_SUPPORT_STREAMS.contains(boost::json::value_to<std::string>(v)))
                return Error{Status{RippledError::rpcNOT_SUPPORTED}};
 
            if (not kVALID_STREAMS.contains(boost::json::value_to<std::string>(v)))
                return Error{Status{RippledError::rpcSTREAM_MALFORMED}};
        }
 
        return MaybeError{};
    }}

Provides a validator for validating streams used in subscribe/unsubscribe.

◆ uint160HexStringValidator

CustomValidator rpc::validation::CustomValidators::uint160HexStringValidator

static

Initial value:

=
    CustomValidator{[](boost::json::value const& value, std::string_view key) -> MaybeError {
        return makeHexStringValidator<ripple::uint160>(value, key);
    }}

Provides a commonly used validator for uint160(AccountID) hex string.

It must be a string and also a decodable hex. AccountID uses this validator.

◆ uint192HexStringValidator

CustomValidator rpc::validation::CustomValidators::uint192HexStringValidator

static

Initial value:

=
    CustomValidator{[](boost::json::value const& value, std::string_view key) -> MaybeError {
        return makeHexStringValidator<ripple::uint192>(value, key);
    }}

Provides a commonly used validator for uint192 hex string.

It must be a string and also a decodable hex. MPTIssuanceID uses this validator.

◆ uint256HexStringValidator

CustomValidator rpc::validation::CustomValidators::uint256HexStringValidator

static

Initial value:

=
    CustomValidator{[](boost::json::value const& value, std::string_view key) -> MaybeError {
        return makeHexStringValidator<ripple::uint256>(value, key);
    }}

Provides a commonly used validator for uint256 hex string.

It must be a string and also a decodable hex. Transaction index, ledger hash all use this validator.

The documentation for this struct was generated from the following files:

/__w/clio/clio/src/rpc/common/Validators.hpp
/__w/clio/clio/src/rpc/common/Validators.cpp

Static Public Attributes

Detailed Description

Member Data Documentation

◆ accountBase58Validator

◆ accountMarkerValidator

◆ accountTypeValidator

◆ accountValidator

◆ authorizeCredentialValidator

◆ credentialTypeValidator

◆ currencyIssueValidator

◆ currencyValidator

◆ issuerValidator

◆ ledgerIndexValidator

◆ ledgerTypeValidator

◆ subscribeAccountsValidator

◆ subscribeStreamValidator

◆ uint160HexStringValidator

◆ uint192HexStringValidator

◆ uint256HexStringValidator