From b34fdb5ade0b48384636f8c7c9673554bf82cedf Mon Sep 17 00:00:00 2001
From: Sebastian Falbesoner <sebastian.falbesoner@gmail.com>
Date: Tue, 4 Mar 2025 09:57:49 -0500
Subject: [PATCH] test: introduce output amount (de)compression routines

---
 .../feature_framework_unit_tests.py           |  1 +
 test/functional/test_framework/compressor.py  | 58 +++++++++++++++++++
 2 files changed, 59 insertions(+)
 create mode 100644 test/functional/test_framework/compressor.py

diff --git a/test/functional/feature_framework_unit_tests.py b/test/functional/feature_framework_unit_tests.py
index 14d83f8a707..4ee2143ad6c 100755
--- a/test/functional/feature_framework_unit_tests.py
+++ b/test/functional/feature_framework_unit_tests.py
@@ -18,6 +18,7 @@ TEST_FRAMEWORK_MODULES = [
     "address",
     "crypto.bip324_cipher",
     "blocktools",
+    "compressor",
     "crypto.chacha20",
     "crypto.ellswift",
     "key",
diff --git a/test/functional/test_framework/compressor.py b/test/functional/test_framework/compressor.py
new file mode 100644
index 00000000000..1c30d749df5
--- /dev/null
+++ b/test/functional/test_framework/compressor.py
@@ -0,0 +1,58 @@
+#!/usr/bin/env python3
+# Copyright (c) 2025-present The Bitcoin Core developers
+# Distributed under the MIT software license, see the accompanying
+# file COPYING or http://www.opensource.org/licenses/mit-license.php.
+"""Routines for compressing transaction output amounts and scripts."""
+import unittest
+
+from .messages import COIN
+
+
+def compress_amount(n):
+    if n == 0:
+        return 0
+    e = 0
+    while ((n % 10) == 0) and (e < 9):
+        n //= 10
+        e += 1
+    if e < 9:
+        d = n % 10
+        assert (d >= 1 and d <= 9)
+        n //= 10
+        return 1 + (n*9 + d - 1)*10 + e
+    else:
+        return 1 + (n - 1)*10 + 9
+
+
+def decompress_amount(x):
+    if x == 0:
+        return 0
+    x -= 1
+    e = x % 10
+    x //= 10
+    n = 0
+    if e < 9:
+        d = (x % 9) + 1
+        x //= 9
+        n = x * 10 + d
+    else:
+        n = x + 1
+    while e > 0:
+        n *= 10
+        e -= 1
+    return n
+
+
+class TestFrameworkCompressor(unittest.TestCase):
+    def test_amount_compress_decompress(self):
+        def check_amount(amount, expected_compressed):
+            self.assertEqual(compress_amount(amount), expected_compressed)
+            self.assertEqual(decompress_amount(expected_compressed), amount)
+
+        # test cases from compress_tests.cpp:compress_amounts
+        check_amount(0, 0x0)
+        check_amount(1, 0x1)
+        check_amount(1000000, 0x7)
+        check_amount(COIN, 0x9)
+        check_amount(50*COIN, 0x32)
+        check_amount(21000000*COIN, 0x1406f40)