diff --git a/src/rpc/handlers/AccountChannels.h b/src/rpc/handlers/AccountChannels.h index 32c817afe..4461bb17c 100644 --- a/src/rpc/handlers/AccountChannels.h +++ b/src/rpc/handlers/AccountChannels.h @@ -27,6 +27,14 @@ #include namespace RPC { + +/** + * @brief The account_channels method returns information about an account's Payment Channels. This includes only + * channels where the specified account is the channel's source, not the destination. + * All information retrieved is relative to a particular version of the ledger. + * + * For more details see: https://xrpl.org/account_channels.html + */ class AccountChannelsHandler { // dependencies diff --git a/src/rpc/handlers/AccountCurrencies.h b/src/rpc/handlers/AccountCurrencies.h index 9dd0089be..89218999f 100644 --- a/src/rpc/handlers/AccountCurrencies.h +++ b/src/rpc/handlers/AccountCurrencies.h @@ -27,6 +27,13 @@ #include namespace RPC { + +/** + * @brief The account_currencies command retrieves a list of currencies that an account can send or receive, + * based on its trust lines. + * + * For more details see: https://xrpl.org/account_currencies.html + */ class AccountCurrenciesHandler { // dependencies diff --git a/src/rpc/handlers/AccountInfo.h b/src/rpc/handlers/AccountInfo.h index ec0e02d42..12c174b18 100644 --- a/src/rpc/handlers/AccountInfo.h +++ b/src/rpc/handlers/AccountInfo.h @@ -25,6 +25,12 @@ #include namespace RPC { + +/** + * @brief The account_info command retrieves information about an account, its activity, and its XRP balance. + * + * For more details see: https://xrpl.org/account_info.html + */ class AccountInfoHandler { std::shared_ptr sharedPtrBackend_; diff --git a/src/rpc/handlers/AccountLines.h b/src/rpc/handlers/AccountLines.h index 936d3204b..65e57358f 100644 --- a/src/rpc/handlers/AccountLines.h +++ b/src/rpc/handlers/AccountLines.h @@ -28,6 +28,12 @@ namespace RPC { +/** + * @brief The account_lines method returns information about an account's trust lines, which contain balances in all + * non-XRP currencies and assets. + * + * For more details see: https://xrpl.org/account_lines.html + */ class AccountLinesHandler { // dependencies diff --git a/src/rpc/handlers/AccountNFTs.h b/src/rpc/handlers/AccountNFTs.h index 1198ccff8..dc5275ba9 100644 --- a/src/rpc/handlers/AccountNFTs.h +++ b/src/rpc/handlers/AccountNFTs.h @@ -25,6 +25,12 @@ #include namespace RPC { + +/** + * @brief The account_nfts method returns a list of NFToken objects for the specified account. + * + * For more details see: https://xrpl.org/account_nfts.html + */ class AccountNFTsHandler { std::shared_ptr sharedPtrBackend_; diff --git a/src/rpc/handlers/AccountObjects.h b/src/rpc/handlers/AccountObjects.h index 9b2e66ce2..c5ae64b3d 100644 --- a/src/rpc/handlers/AccountObjects.h +++ b/src/rpc/handlers/AccountObjects.h @@ -27,6 +27,15 @@ #include namespace RPC { + +/** + * @brief The account_objects command returns the raw ledger format for all objects owned by an account. + * The results can be filtered by the type. + * The valid types are: check, deposit_preauth, escrow, nft_offer, offer, payment_channel, signer_list, state (trust + * line), and ticket. + * + * For more details see: https://xrpl.org/account_objects.html + */ class AccountObjectsHandler { // dependencies diff --git a/src/rpc/handlers/AccountOffers.h b/src/rpc/handlers/AccountOffers.h index eb5a9500e..6d1332fee 100644 --- a/src/rpc/handlers/AccountOffers.h +++ b/src/rpc/handlers/AccountOffers.h @@ -25,6 +25,12 @@ #include namespace RPC { + +/** + * @brief The account_offers method retrieves a list of offers made by a given account. + * + * For more details see: https://xrpl.org/account_offers.html + */ class AccountOffersHandler { std::shared_ptr sharedPtrBackend_; diff --git a/src/rpc/handlers/AccountTx.h b/src/rpc/handlers/AccountTx.h index f89797f58..0ba13ff5d 100644 --- a/src/rpc/handlers/AccountTx.h +++ b/src/rpc/handlers/AccountTx.h @@ -26,6 +26,12 @@ #include namespace RPC { + +/** + * @brief The account_tx method retrieves a list of transactions that involved the specified account. + * + * For more details see: https://xrpl.org/account_tx.html + */ class AccountTxHandler { clio::Logger log_{"RPC"}; diff --git a/src/rpc/handlers/BookChanges.h b/src/rpc/handlers/BookChanges.h index 4940886cf..e84efe67e 100644 --- a/src/rpc/handlers/BookChanges.h +++ b/src/rpc/handlers/BookChanges.h @@ -27,6 +27,11 @@ namespace RPC { +/** + * @brief BookChangesHandler returns the order book changes for a given ledger. + * + * This API is not documented in the rippled API documentation. + */ class BookChangesHandler { std::shared_ptr sharedPtrBackend_; diff --git a/src/rpc/handlers/BookOffers.h b/src/rpc/handlers/BookOffers.h index 1bce6cf97..13f1efac6 100644 --- a/src/rpc/handlers/BookOffers.h +++ b/src/rpc/handlers/BookOffers.h @@ -24,6 +24,12 @@ #include namespace RPC { + +/** + * @brief The book_offers method retrieves a list of Offers between two currencies, also known as an order book. + * + * For more details see: https://xrpl.org/book_offers.html + */ class BookOffersHandler { std::shared_ptr sharedPtrBackend_; diff --git a/src/rpc/handlers/GatewayBalances.h b/src/rpc/handlers/GatewayBalances.h index 91e1412ae..31fb0b574 100644 --- a/src/rpc/handlers/GatewayBalances.h +++ b/src/rpc/handlers/GatewayBalances.h @@ -25,6 +25,13 @@ #include namespace RPC { + +/** + * The gateway_balances command calculates the total balances issued by a given account, optionally excluding amounts + * held by operational addresses. + * + * For more details see: https://xrpl.org/gateway_balances.html#gateway_balances + */ class GatewayBalancesHandler { std::shared_ptr sharedPtrBackend_; diff --git a/src/rpc/handlers/Ledger.h b/src/rpc/handlers/Ledger.h index 622fa420c..0936eda0b 100644 --- a/src/rpc/handlers/Ledger.h +++ b/src/rpc/handlers/Ledger.h @@ -25,6 +25,12 @@ #include namespace RPC { + +/** + * @brief Retrieve information about the public ledger. + * + * For more details see: https://xrpl.org/ledger.html + */ class LedgerHandler { std::shared_ptr sharedPtrBackend_; diff --git a/src/rpc/handlers/LedgerData.h b/src/rpc/handlers/LedgerData.h index d082489ae..88949848a 100644 --- a/src/rpc/handlers/LedgerData.h +++ b/src/rpc/handlers/LedgerData.h @@ -25,6 +25,13 @@ #include namespace RPC { + +/** + * @brief The ledger_data method retrieves contents of the specified ledger. You can iterate through several calls to + * retrieve the entire contents of a single ledger version. + * + * For more details see: https://xrpl.org/ledger_data.html + */ class LedgerDataHandler { // dependencies diff --git a/src/rpc/handlers/LedgerEntry.h b/src/rpc/handlers/LedgerEntry.h index a6fa9f7de..787a784fb 100644 --- a/src/rpc/handlers/LedgerEntry.h +++ b/src/rpc/handlers/LedgerEntry.h @@ -26,6 +26,12 @@ namespace RPC { +/** + * @brief The ledger_entry method returns a single ledger object from the XRP Ledger in its raw format. + * The clio has not supported: nft_page + * + * For more details see: https://xrpl.org/ledger_entry.html + */ class LedgerEntryHandler { std::shared_ptr sharedPtrBackend_; diff --git a/src/rpc/handlers/LedgerRange.h b/src/rpc/handlers/LedgerRange.h index 00a67ba2e..2fc10bc2a 100644 --- a/src/rpc/handlers/LedgerRange.h +++ b/src/rpc/handlers/LedgerRange.h @@ -28,6 +28,11 @@ namespace RPC { +/** + * @brief The ledger_range command returns the index number of the earliest and latest ledgers that the server has. + * + * Not documented in the official rippled API docs. + */ class LedgerRangeHandler { std::shared_ptr sharedPtrBackend_; diff --git a/src/rpc/handlers/NFTBuyOffers.h b/src/rpc/handlers/NFTBuyOffers.h index 3fc096314..a2a7beb57 100644 --- a/src/rpc/handlers/NFTBuyOffers.h +++ b/src/rpc/handlers/NFTBuyOffers.h @@ -23,6 +23,12 @@ #include namespace RPC { + +/** + * @brief The nft_buy_offers method returns a list of buy offers for a given NFToken object. + * + * For more details see: https://xrpl.org/nft_buy_offers.html + */ class NFTBuyOffersHandler : public NFTOffersHandlerBase { public: diff --git a/src/rpc/handlers/NFTHistory.h b/src/rpc/handlers/NFTHistory.h index 2f82f75ce..40bbb2998 100644 --- a/src/rpc/handlers/NFTHistory.h +++ b/src/rpc/handlers/NFTHistory.h @@ -26,6 +26,12 @@ #include namespace RPC { + +/** + * @brief The nft_history command asks the Clio server for past transaction metadata for the NFT being queried. + * + * For more details see: https://xrpl.org/nft_history.html#nft_history + */ class NFTHistoryHandler { clio::Logger log_{"RPC"}; diff --git a/src/rpc/handlers/NFTInfo.h b/src/rpc/handlers/NFTInfo.h index 4adea98f9..c1c51262d 100644 --- a/src/rpc/handlers/NFTInfo.h +++ b/src/rpc/handlers/NFTInfo.h @@ -25,6 +25,12 @@ #include namespace RPC { + +/** + * @brief The nft_info command asks the Clio server for information about the NFT being queried. + * + * For more details see: https://xrpl.org/nft_info.html + */ class NFTInfoHandler { std::shared_ptr sharedPtrBackend_; diff --git a/src/rpc/handlers/NFTSellOffers.h b/src/rpc/handlers/NFTSellOffers.h index f0aa976ca..60dd634c5 100644 --- a/src/rpc/handlers/NFTSellOffers.h +++ b/src/rpc/handlers/NFTSellOffers.h @@ -24,6 +24,11 @@ namespace RPC { +/** + * @brief The nft_sell_offers method returns a list of sell offers for a given NFToken object. + * + * For more details see: https://xrpl.org/nft_sell_offers.html + */ class NFTSellOffersHandler : public NFTOffersHandlerBase { public: diff --git a/src/rpc/handlers/NoRippleCheck.h b/src/rpc/handlers/NoRippleCheck.h index 4d12cfb8d..77cdf32ef 100644 --- a/src/rpc/handlers/NoRippleCheck.h +++ b/src/rpc/handlers/NoRippleCheck.h @@ -27,6 +27,13 @@ #include namespace RPC { + +/** + * @brief The noripple_check command provides a quick way to check the status of the Default Ripple field for an account + * and the No Ripple flag of its trust lines, compared with the recommended settings. + * + * For more details see: https://xrpl.org/noripple_check.html + */ class NoRippleCheckHandler { std::shared_ptr sharedPtrBackend_; diff --git a/src/rpc/handlers/Ping.h b/src/rpc/handlers/Ping.h index 2dec27aff..87ce94998 100644 --- a/src/rpc/handlers/Ping.h +++ b/src/rpc/handlers/Ping.h @@ -23,6 +23,11 @@ namespace RPC { +/** + * @brief The ping command returns an acknowledgement, so that clients can test the connection status and latency. + * + * For more details see https://xrpl.org/ping.html + */ class PingHandler { public: diff --git a/src/rpc/handlers/Random.h b/src/rpc/handlers/Random.h index 40a1fa204..4a40ea6fe 100644 --- a/src/rpc/handlers/Random.h +++ b/src/rpc/handlers/Random.h @@ -27,6 +27,12 @@ namespace RPC { +/** + * @brief The random command provides a random number to be used as a source of entropy for random number generation by + * clients. + * + * For more details see: https://xrpl.org/random.html + */ class RandomHandler { public: diff --git a/src/rpc/handlers/ServerInfo.h b/src/rpc/handlers/ServerInfo.h index ba55f502b..755ce7bec 100644 --- a/src/rpc/handlers/ServerInfo.h +++ b/src/rpc/handlers/ServerInfo.h @@ -239,6 +239,12 @@ private: } }; +/** + * @brief The server_info command asks the Clio server for a human-readable version of various information about the + * Clio server being queried. + * + * For more details see: https://xrpl.org/server_info-clio.html + */ using ServerInfoHandler = BaseServerInfoHandler; } // namespace RPC diff --git a/src/rpc/handlers/Subscribe.h b/src/rpc/handlers/Subscribe.h index a5453c1b2..c62f75dea 100644 --- a/src/rpc/handlers/Subscribe.h +++ b/src/rpc/handlers/Subscribe.h @@ -295,6 +295,11 @@ private: } }; +/** + * @brief The subscribe method requests periodic notifications from the server when certain events happen. + * + * For more details see: https://xrpl.org/subscribe.html + */ using SubscribeHandler = BaseSubscribeHandler; } // namespace RPC diff --git a/src/rpc/handlers/TransactionEntry.h b/src/rpc/handlers/TransactionEntry.h index 661bbe3db..d91146a1b 100644 --- a/src/rpc/handlers/TransactionEntry.h +++ b/src/rpc/handlers/TransactionEntry.h @@ -25,6 +25,12 @@ #include namespace RPC { + +/** + * @brief The transaction_entry method retrieves information on a single transaction from a specific ledger version. + * + * For more details see: https://xrpl.org/transaction_entry.html + */ class TransactionEntryHandler { std::shared_ptr sharedPtrBackend_; diff --git a/src/rpc/handlers/Tx.h b/src/rpc/handlers/Tx.h index 526fa1761..e61855d72 100644 --- a/src/rpc/handlers/Tx.h +++ b/src/rpc/handlers/Tx.h @@ -25,6 +25,12 @@ #include namespace RPC { + +/** + * @brief The tx method retrieves information on a single transaction, by its identifying hash. + * + * For more details see: https://xrpl.org/tx.html + */ class TxHandler { std::shared_ptr sharedPtrBackend_; diff --git a/src/rpc/handlers/Unsubscribe.h b/src/rpc/handlers/Unsubscribe.h index 60a6257d5..6a9bb0b37 100644 --- a/src/rpc/handlers/Unsubscribe.h +++ b/src/rpc/handlers/Unsubscribe.h @@ -210,6 +210,12 @@ private: } }; +/** + * @brief The unsubscribe command tells the server to stop sending messages for a particular subscription or set of + * subscriptions. + * + * For more details see: https://xrpl.org/unsubscribe.html + */ using UnsubscribeHandler = BaseUnsubscribeHandler; } // namespace RPC