From 0742c7840f03505597fd2de87db97f12597ef667 Mon Sep 17 00:00:00 2001
From: Jon Atack <jon@atack.com>
Date: Tue, 27 Apr 2021 10:54:44 +0200
Subject: rpc: enable passing decimals to AmountFromValue, add doxygen

---
 src/rpc/util.h | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

(limited to 'src/rpc/util.h')

diff --git a/src/rpc/util.h b/src/rpc/util.h
index 8ec18b2f35..41cbcc6032 100644
--- a/src/rpc/util.h
+++ b/src/rpc/util.h
@@ -77,7 +77,14 @@ extern uint256 ParseHashO(const UniValue& o, std::string strKey);
 extern std::vector<unsigned char> ParseHexV(const UniValue& v, std::string strName);
 extern std::vector<unsigned char> ParseHexO(const UniValue& o, std::string strKey);
 
-extern CAmount AmountFromValue(const UniValue& value);
+/**
+ * Validate and return a CAmount from a UniValue number or string.
+ *
+ * @param[in] value     UniValue number or string to parse.
+ * @param[in] decimals  Number of significant digits (default: 8).
+ * @returns a CAmount if the various checks pass.
+ */
+extern CAmount AmountFromValue(const UniValue& value, int decimals = 8);
 
 using RPCArgList = std::vector<std::pair<std::string, UniValue>>;
 extern std::string HelpExampleCli(const std::string& methodname, const std::string& args);
-- 
cgit v1.2.3