From 6b2a248bb58c58bd824e60232954cc8bb903e207 Mon Sep 17 00:00:00 2001
From: Kristaps Kaupe <kristaps@blogiem.lv>
Date: Thu, 20 Jul 2023 00:36:40 +0300
Subject: [PATCH] Add typehints to BIP21 code

---
 jmbitcoin/jmbitcoin/bip21.py | 19 +++++++++++--------
 1 file changed, 11 insertions(+), 8 deletions(-)

diff --git a/jmbitcoin/jmbitcoin/bip21.py b/jmbitcoin/jmbitcoin/bip21.py
index c618254..5aea31b 100644
--- a/jmbitcoin/jmbitcoin/bip21.py
+++ b/jmbitcoin/jmbitcoin/bip21.py
@@ -4,25 +4,26 @@
 # this are expected to do address validation independently anyway.
 
 from jmbitcoin import amount_to_sat
+from typing import Dict, List, Tuple, Union
 from urllib.parse import parse_qs, quote, unquote_plus, urlencode, urlparse
 import re
 
 
-def is_bip21_uri(uri):
+def is_bip21_uri(uri: str) -> bool:
     parsed = urlparse(uri)
     return parsed.scheme.lower() == 'bitcoin' and parsed.path != ''
 
 
-def is_bip21_amount_str(amount):
+def _is_bip21_amount_str(amount: str) -> bool:
     return re.compile(r"^[0-9]{1,8}(\.[0-9]{1,8})?$").match(str(amount)) != None
 
 
-def validate_bip21_amount(amount):
-    if not is_bip21_amount_str(amount):
+def _validate_bip21_amount(amount: str) -> None:
+    if not _is_bip21_amount_str(amount):
         raise ValueError("Invalid BTC amount " + str(amount))
 
 
-def decode_bip21_uri(uri):
+def decode_bip21_uri(uri: str) -> Dict[str, Union[str, int]]:
     if not is_bip21_uri(uri):
         raise ValueError("Not a valid BIP21 URI: " + uri)
     result = {}
@@ -35,7 +36,7 @@ def decode_bip21_uri(uri):
                 " in BIP21 URI.")
         if key == 'amount':
             amount_str = params['amount'][0]
-            validate_bip21_amount(amount_str)
+            _validate_bip21_amount(amount_str)
             # Convert amount to sats, as used internally by JM
             result['amount'] = amount_to_sat(amount_str + "btc")
         else:
@@ -43,10 +44,12 @@ def decode_bip21_uri(uri):
     return result
 
 
-def encode_bip21_uri(address, params, safe=""):
+def encode_bip21_uri(address: str,
+                     params: Union[dict, List[Tuple[str, Union[float, int, str]]]],
+                     safe: str = "") -> str:
     uri = 'bitcoin:' + address
     if len(params) > 0:
         if 'amount' in params:
-            validate_bip21_amount(params['amount'])
+            _validate_bip21_amount(params['amount'])
         uri += '?' + urlencode(params, safe=safe, quote_via=quote)
     return uri