From 7e9c7113afbed96cef80c327cc93e82000d6bb69 Mon Sep 17 00:00:00 2001
From: practicalswift <practicalswift@users.noreply.github.com>
Date: Mon, 13 Jan 2020 15:09:36 +0000
Subject: [PATCH] compressor: Make the domain of CompressAmount(...) explicit

---
 src/compressor.h | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/src/compressor.h b/src/compressor.h
index c1eda503c8..acb34da4a0 100644
--- a/src/compressor.h
+++ b/src/compressor.h
@@ -19,7 +19,17 @@ bool CompressScript(const CScript& script, std::vector<unsigned char> &out);
 unsigned int GetSpecialScriptSize(unsigned int nSize);
 bool DecompressScript(CScript& script, unsigned int nSize, const std::vector<unsigned char> &out);
 
+/**
+ * Compress amount.
+ *
+ * nAmount is of type uint64_t and thus cannot be negative. If you're passing in
+ * a CAmount (int64_t), make sure to properly handle the case where the amount
+ * is negative before calling CompressAmount(...).
+ *
+ * @pre Function defined only for 0 <= nAmount <= MAX_MONEY.
+ */
 uint64_t CompressAmount(uint64_t nAmount);
+
 uint64_t DecompressAmount(uint64_t nAmount);
 
 /** Compact serializer for scripts.