1
mirror of https://github.com/bitcoin/bitcoin synced 2024-10-02 08:00:31 +02:00

compressor: Make the domain of CompressAmount(...) explicit

This commit is contained in:
practicalswift 2020-01-13 15:09:36 +00:00
parent 4a7fd7a712
commit 7e9c7113af

View File

@ -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.