tests: add tests for all supported payment identifier types.

resolve and finalize phases still TODO

electrum/tests/test_payment_identifier.py

@@ -1,10 +1,20 @@
-from electrum import payment_identifier
+from electrum import SimpleConfig
-from electrum.payment_identifier import maybe_extract_lightning_payment_identifier
+from electrum.payment_identifier import (maybe_extract_lightning_payment_identifier, PaymentIdentifier,
+                                         PaymentIdentifierType)
 
 from . import ElectrumTestCase
 
 
+class WalletMock:
+    def __init__(self, electrum_path):
+        self.config = SimpleConfig({'electrum_path': electrum_path})
+        self.contacts = None
+
+
 class TestPaymentIdentifier(ElectrumTestCase):
+    def setUp(self):
+        super().setUp()
+        self.wallet = WalletMock(self.electrum_path)
 
     def test_maybe_extract_lightning_payment_identifier(self):
         bolt11 = "lnbc1ps9zprzpp5qqqsyqcyq5rqwzqfqqqsyqcyq5rqwzqfqqqsyqcyq5rqwzqfqypqsp5zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zygsdqq9qypqszpyrpe4tym8d3q87d43cgdhhlsrt78epu7u99mkzttmt2wtsx0304rrw50addkryfrd3vn3zy467vxwlmf4uz7yvntuwjr2hqjl9lw5cqwtp2dy"
@@ -18,3 +28,189 @@ class TestPaymentIdentifier(ElectrumTestCase):
         self.assertEqual(None, maybe_extract_lightning_payment_identifier(f"bitcoin:{bolt11}"))
         self.assertEqual(None, maybe_extract_lightning_payment_identifier(f":{bolt11}"))
         self.assertEqual(None, maybe_extract_lightning_payment_identifier(f"garbage text"))
+
+    def test_immediate_available(self):
+        bolt11 = 'lnbc1ps9zprzpp5qqqsyqcyq5rqwzqfqqqsyqcyq5rqwzqfqqqsyqcyq5rqwzqfqypqsp5zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zygsdqq9qypqszpyrpe4tym8d3q87d43cgdhhlsrt78epu7u99mkzttmt2wtsx0304rrw50addkryfrd3vn3zy467vxwlmf4uz7yvntuwjr2hqjl9lw5cqwtp2dy'
+        pi = PaymentIdentifier(None, bolt11)
+        self.assertTrue(pi.is_available())
+        self.assertTrue(pi.is_lightning())
+        self.assertFalse(pi.is_onchain())
+        self.assertIsNotNone(pi.bolt11)
+
+        bip21 = 'bitcoin:bc1qj3zx2zc4rpv3npzmznxhdxzn0wm7pzqp8p2293?message=unit_test'
+        pi = PaymentIdentifier(None, bip21)
+        self.assertTrue(pi.is_available())
+        self.assertFalse(pi.is_lightning())
+        self.assertTrue(pi.is_onchain())
+        self.assertIsNotNone(pi.bip21)
+
+        address = 'bc1qj3zx2zc4rpv3npzmznxhdxzn0wm7pzqp8p2293'
+        pi = PaymentIdentifier(None, address)
+        self.assertTrue(pi.is_available())
+        self.assertFalse(pi.is_lightning())
+        self.assertTrue(pi.is_onchain())
+        self.assertIsNotNone(pi.spk)
+
+    def test_bolt11(self):
+        # no amount, no fallback address
+        bolt11 = 'lnbc1ps9zprzpp5qqqsyqcyq5rqwzqfqqqsyqcyq5rqwzqfqqqsyqcyq5rqwzqfqypqsp5zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zyg3zygsdqq9qypqszpyrpe4tym8d3q87d43cgdhhlsrt78epu7u99mkzttmt2wtsx0304rrw50addkryfrd3vn3zy467vxwlmf4uz7yvntuwjr2hqjl9lw5cqwtp2dy'
+        for pi_str in [
+            f'{bolt11}',
+            f'  {bolt11}',
+            f'{bolt11}  ',
+            f'lightning:{bolt11}',
+            f'  lightning:{bolt11}',
+            f'lightning:{bolt11}  ',
+            f'lightning:{bolt11.upper()}',
+            f'lightning:{bolt11}'.upper(),
+        ]:
+            pi = PaymentIdentifier(None, pi_str)
+            self.assertTrue(pi.is_valid())
+            self.assertEqual(PaymentIdentifierType.BOLT11, pi.type)
+            self.assertFalse(pi.is_amount_locked())
+            self.assertFalse(pi.is_error())
+            self.assertIsNotNone(pi.bolt11)
+
+        for pi_str in [
+            f'lightning:  {bolt11}',
+            f'bitcoin:{bolt11}'
+        ]:
+            pi = PaymentIdentifier(None, pi_str)
+            self.assertFalse(pi.is_valid())
+
+        # amount, fallback address
+        bolt_11_w_fallback = 'lnbc20m1pvjluezpp5qqqsyqcyq5rqwzqfqqqsyqcyq5rqwzqfqqqsyqcyq5rqwzqfqypqhp58yjmdan79s6qqdhdzgynm4zwqd5d7xmw5fk98klysy043l2ahrqsfpp3qjmp7lwpagxun9pygexvgpjdc4jdj85fr9yq20q82gphp2nflc7jtzrcazrra7wwgzxqc8u7754cdlpfrmccae92qgzqvzq2ps8pqqqqqqpqqqqq9qqqvpeuqafqxu92d8lr6fvg0r5gv0heeeqgcrqlnm6jhphu9y00rrhy4grqszsvpcgpy9qqqqqqgqqqqq7qqzqj9n4evl6mr5aj9f58zp6fyjzup6ywn3x6sk8akg5v4tgn2q8g4fhx05wf6juaxu9760yp46454gpg5mtzgerlzezqcqvjnhjh8z3g2qqdhhwkj'
+        pi = PaymentIdentifier(None, bolt_11_w_fallback)
+        self.assertTrue(pi.is_valid())
+        self.assertEqual(PaymentIdentifierType.BOLT11, pi.type)
+        self.assertIsNotNone(pi.bolt11)
+        self.assertTrue(pi.is_lightning())
+        self.assertTrue(pi.is_onchain())
+        self.assertTrue(pi.is_amount_locked())
+
+        self.assertFalse(pi.is_error())
+        self.assertFalse(pi.need_resolve())
+        self.assertFalse(pi.need_finalize())
+        self.assertFalse(pi.is_multiline())
+
+    def test_bip21(self):
+        bip21 = 'bitcoin:bc1qj3zx2zc4rpv3npzmznxhdxzn0wm7pzqp8p2293?message=unit_test'
+        for pi_str in [
+            f'{bip21}',
+            f'  {bip21}',
+            f'{bip21}  ',
+            f'{bip21}'.upper(),
+        ]:
+            pi = PaymentIdentifier(None, pi_str)
+            self.assertTrue(pi.is_available())
+            self.assertFalse(pi.is_lightning())
+            self.assertTrue(pi.is_onchain())
+            self.assertIsNotNone(pi.bip21)
+
+        # amount, expired, message
+        bip21 = 'bitcoin:bc1qy7ps80x5csdqpfcekn97qfljxtg2lrya8826ds?amount=0.001&message=unit_test&time=1707382023&exp=3600'
+
+        pi = PaymentIdentifier(None, bip21)
+        self.assertTrue(pi.is_available())
+        self.assertFalse(pi.is_lightning())
+        self.assertTrue(pi.is_onchain())
+        self.assertIsNotNone(pi.bip21)
+
+        self.assertTrue(pi.has_expired())
+        self.assertEqual('unit_test', pi.bip21.get('message'))
+
+        # amount, expired, message, lightning w matching amount
+        bip21 = 'bitcoin:1RustyRX2oai4EYYDpQGWvEL62BBGqN9T?amount=0.02&message=unit_test&time=1707382023&exp=3600&lightning=lnbc20m1pvjluezpp5qqqsyqcyq5rqwzqfqqqsyqcyq5rqwzqfqqqsyqcyq5rqwzqfqypqhp58yjmdan79s6qqdhdzgynm4zwqd5d7xmw5fk98klysy043l2ahrqsfpp3qjmp7lwpagxun9pygexvgpjdc4jdj85fr9yq20q82gphp2nflc7jtzrcazrra7wwgzxqc8u7754cdlpfrmccae92qgzqvzq2ps8pqqqqqqpqqqqq9qqqvpeuqafqxu92d8lr6fvg0r5gv0heeeqgcrqlnm6jhphu9y00rrhy4grqszsvpcgpy9qqqqqqgqqqqq7qqzqj9n4evl6mr5aj9f58zp6fyjzup6ywn3x6sk8akg5v4tgn2q8g4fhx05wf6juaxu9760yp46454gpg5mtzgerlzezqcqvjnhjh8z3g2qqdhhwkj'
+
+        pi = PaymentIdentifier(None, bip21)
+        self.assertTrue(pi.is_available())
+        self.assertTrue(pi.is_lightning())
+        self.assertTrue(pi.is_onchain())
+        self.assertIsNotNone(pi.bip21)
+        self.assertIsNotNone(pi.bolt11)
+
+        self.assertTrue(pi.has_expired())
+        self.assertEqual('unit_test', pi.bip21.get('message'))
+
+        # amount, expired, message, lightning w non-matching amount
+        bip21 = 'bitcoin:1RustyRX2oai4EYYDpQGWvEL62BBGqN9T?amount=0.01&message=unit_test&time=1707382023&exp=3600&lightning=lnbc20m1pvjluezpp5qqqsyqcyq5rqwzqfqqqsyqcyq5rqwzqfqqqsyqcyq5rqwzqfqypqhp58yjmdan79s6qqdhdzgynm4zwqd5d7xmw5fk98klysy043l2ahrqsfpp3qjmp7lwpagxun9pygexvgpjdc4jdj85fr9yq20q82gphp2nflc7jtzrcazrra7wwgzxqc8u7754cdlpfrmccae92qgzqvzq2ps8pqqqqqqpqqqqq9qqqvpeuqafqxu92d8lr6fvg0r5gv0heeeqgcrqlnm6jhphu9y00rrhy4grqszsvpcgpy9qqqqqqgqqqqq7qqzqj9n4evl6mr5aj9f58zp6fyjzup6ywn3x6sk8akg5v4tgn2q8g4fhx05wf6juaxu9760yp46454gpg5mtzgerlzezqcqvjnhjh8z3g2qqdhhwkj'
+
+        pi = PaymentIdentifier(None, bip21)
+        self.assertFalse(pi.is_valid())
+
+    def test_lnurl(self):
+        lnurl = 'lnurl1dp68gurn8ghj7um9wfmxjcm99e5k7telwy7nxenrxvmrgdtzxsenjcm98pjnwxq96s9'
+        pi = PaymentIdentifier(None, lnurl)
+        self.assertTrue(pi.is_valid())
+        self.assertFalse(pi.is_available())
+        self.assertTrue(pi.need_resolve())
+
+        # TODO: resolve mock
+
+    def test_multiline(self):
+        pi_str = '\n'.join([
+            'bc1qj3zx2zc4rpv3npzmznxhdxzn0wm7pzqp8p2293,0.01',
+            'bc1q66ex4c3vek4cdmrfjxtssmtguvs3r30pf42jpj,0.01',
+        ])
+        pi = PaymentIdentifier(self.wallet, pi_str)
+        self.assertTrue(pi.is_valid())
+        self.assertTrue(pi.is_multiline())
+        self.assertFalse(pi.is_multiline_max())
+
+        pi_str = '\n'.join([
+            'bc1qj3zx2zc4rpv3npzmznxhdxzn0wm7pzqp8p2293,0.01',
+            'bc1q66ex4c3vek4cdmrfjxtssmtguvs3r30pf42jpj,0.01',
+            'bc1qy7ps80x5csdqpfcekn97qfljxtg2lrya8826ds,!',
+            'script(OP_RETURN deadbeef),0'
+        ])
+        pi = PaymentIdentifier(self.wallet, pi_str)
+        self.assertTrue(pi.is_valid())
+        self.assertTrue(pi.is_multiline())
+        self.assertTrue(pi.is_multiline_max())
+
+        pi_str = '\n'.join([
+            'bc1qj3zx2zc4rpv3npzmznxhdxzn0wm7pzqp8p2293,0.01',
+            'script(OP_RETURN baddc0ffee),0'
+        ])
+        pi = PaymentIdentifier(self.wallet, pi_str)
+        self.assertTrue(pi.is_valid())
+        self.assertTrue(pi.is_multiline())
+
+    def test_spk(self):
+        pi_str = 'bc1qj3zx2zc4rpv3npzmznxhdxzn0wm7pzqp8p2293'
+        pi = PaymentIdentifier(None, pi_str)
+        self.assertTrue(pi.is_valid())
+        self.assertTrue(pi.is_available())
+
+        # TODO: script should be valid?
+        # pi_str = 'script(OP_RETURN baddc0ffee),0'
+        # pi = PaymentIdentifier(None, pi_str)
+        # self.assertTrue(pi.is_valid())
+        # self.assertTrue(pi.is_available())
+
+    def test_email_and_domain(self):
+        pi_str = 'some.domain'
+        pi = PaymentIdentifier(None, pi_str)
+        self.assertTrue(pi.is_valid())
+        self.assertEqual(PaymentIdentifierType.DOMAINLIKE, pi.type)
+        self.assertFalse(pi.is_available())
+        self.assertTrue(pi.need_resolve())
+
+        pi_str = 'user@some.domain'
+        pi = PaymentIdentifier(None, pi_str)
+        self.assertTrue(pi.is_valid())
+        self.assertEqual(PaymentIdentifierType.EMAILLIKE, pi.type)
+        self.assertFalse(pi.is_available())
+        self.assertTrue(pi.need_resolve())
+
+        # TODO resolve mock
+
+    def test_bip70(self):
+        pi_str = 'bitcoin:?r=https://test.bitpay.com/i/87iLJoaYVyJwFXtdassQJv'
+        pi = PaymentIdentifier(None, pi_str)
+        self.assertTrue(pi.is_valid())
+        self.assertEqual(PaymentIdentifierType.BIP70, pi.type)
+        self.assertFalse(pi.is_available())
+        self.assertTrue(pi.need_resolve())
+
+        # TODO resolve mock