From 2a97913185e396d050f249c7bfb536229f5c0676 Mon Sep 17 00:00:00 2001 From: Abit Date: Tue, 23 Oct 2018 14:13:54 +0200 Subject: [PATCH] Update get_trade_history API docs and coding style --- .../app/include/graphene/app/database_api.hpp | 32 +++++++++++-------- 1 file changed, 19 insertions(+), 13 deletions(-) diff --git a/libraries/app/include/graphene/app/database_api.hpp b/libraries/app/include/graphene/app/database_api.hpp index 7102ffe62c..e43f5dfc3d 100644 --- a/libraries/app/include/graphene/app/database_api.hpp +++ b/libraries/app/include/graphene/app/database_api.hpp @@ -501,28 +501,34 @@ class database_api vector get_top_markets(uint32_t limit)const; /** - * @brief Returns recent trades for the market assetA:assetB, ordered by time, most recent first. The range is [stop, start) - * Note: Currently, timezone offsets are not supported. The time must be UTC. - * @param a String name of the first asset - * @param b String name of the second asset - * @param stop Stop time as a UNIX timestamp, the earliest trade to retrieve - * @param limit Number of trasactions to retrieve, capped at 100 + * @brief Returns recent trades for the market base:quote, ordered by time, most recent first. + * Note: Currently, timezone offsets are not supported. The time must be UTC. The range is [stop, start). + * In case when there are more than 100 trades occurred in the same second, this API only returns + * the first 100 records, can use another API `get_trade_history_by_sequence` to query for the rest. + * @param base symbol or ID of the base asset + * @param quote symbol or ID of the quote asset * @param start Start time as a UNIX timestamp, the latest trade to retrieve + * @param stop Stop time as a UNIX timestamp, the earliest trade to retrieve + * @param limit Number of trasactions to retrieve, capped at 100. * @return Recent transactions in the market */ - vector get_trade_history( const string& base, const string& quote, fc::time_point_sec start, fc::time_point_sec stop, unsigned limit = 100 )const; + vector get_trade_history( const string& base, const string& quote, + fc::time_point_sec start, fc::time_point_sec stop, + unsigned limit = 100 )const; /** - * @brief Returns trades for the market assetA:assetB, ordered by time, most recent first. The range is [stop, start) - * Note: Currently, timezone offsets are not supported. The time must be UTC. - * @param a String name of the first asset - * @param b String name of the second asset + * @brief Returns trades for the market base:quote, ordered by time, most recent first. + * Note: Currently, timezone offsets are not supported. The time must be UTC. The range is [stop, start). + * @param base symbol or ID of the base asset + * @param quote symbol or ID of the quote asset + * @param start Start sequence as an Integer, the latest trade to retrieve * @param stop Stop time as a UNIX timestamp, the earliest trade to retrieve * @param limit Number of trasactions to retrieve, capped at 100 - * @param start Start sequence as an Integer, the latest trade to retrieve * @return Transactions in the market */ - vector get_trade_history_by_sequence( const string& base, const string& quote, int64_t start, fc::time_point_sec stop, unsigned limit = 100 )const; + vector get_trade_history_by_sequence( const string& base, const string& quote, + int64_t start, fc::time_point_sec stop, + unsigned limit = 100 )const;