|
| 1 | +# Copyright (c) 2017 Pieter Wuille |
| 2 | +# |
| 3 | +# Permission is hereby granted, free of charge, to any person obtaining a copy |
| 4 | +# of this software and associated documentation files (the "Software"), to deal |
| 5 | +# in the Software without restriction, including without limitation the rights |
| 6 | +# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| 7 | +# copies of the Software, and to permit persons to whom the Software is |
| 8 | +# furnished to do so, subject to the following conditions: |
| 9 | +# |
| 10 | +# The above copyright notice and this permission notice shall be included in |
| 11 | +# all copies or substantial portions of the Software. |
| 12 | +# |
| 13 | +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 14 | +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 15 | +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| 16 | +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 17 | +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 18 | +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
| 19 | +# THE SOFTWARE. |
| 20 | + |
| 21 | +"""Reference implementation for Bech32 and segwit addresses.""" |
| 22 | + |
| 23 | +import sys |
| 24 | +_bchr = chr |
| 25 | +_bord = lambda x: ord(x) if isinstance(x, str) else x |
| 26 | +if sys.version > '3': |
| 27 | + long = int |
| 28 | + _bchr = lambda x: bytes([x]) |
| 29 | + _bord = lambda x: x |
| 30 | + |
| 31 | +CHARSET = "qpzry9x8gf2tvdw0s3jn54khce6mua7l" |
| 32 | + |
| 33 | + |
| 34 | +def bech32_polymod(values): |
| 35 | + """Internal function that computes the Bech32 checksum.""" |
| 36 | + generator = [0x3b6a57b2, 0x26508e6d, 0x1ea119fa, 0x3d4233dd, 0x2a1462b3] |
| 37 | + chk = 1 |
| 38 | + for value in values: |
| 39 | + top = chk >> 25 |
| 40 | + chk = (chk & 0x1ffffff) << 5 ^ value |
| 41 | + for i in range(5): |
| 42 | + chk ^= generator[i] if ((top >> i) & 1) else 0 |
| 43 | + return chk |
| 44 | + |
| 45 | + |
| 46 | +def bech32_hrp_expand(hrp): |
| 47 | + """Expand the HRP into values for checksum computation.""" |
| 48 | + return [ord(x) >> 5 for x in hrp] + [0] + [ord(x) & 31 for x in hrp] |
| 49 | + |
| 50 | + |
| 51 | +def bech32_verify_checksum(hrp, data): |
| 52 | + """Verify a checksum given HRP and converted data characters.""" |
| 53 | + return bech32_polymod(bech32_hrp_expand(hrp) + data) == 1 |
| 54 | + |
| 55 | + |
| 56 | +def bech32_create_checksum(hrp, data): |
| 57 | + """Compute the checksum values given HRP and data.""" |
| 58 | + values = bech32_hrp_expand(hrp) + data |
| 59 | + polymod = bech32_polymod(values + [0, 0, 0, 0, 0, 0]) ^ 1 |
| 60 | + return [(polymod >> 5 * (5 - i)) & 31 for i in range(6)] |
| 61 | + |
| 62 | + |
| 63 | +def bech32_encode(hrp, data): |
| 64 | + """Compute a Bech32 string given HRP and data values.""" |
| 65 | + combined = data + bech32_create_checksum(hrp, data) |
| 66 | + return hrp + '1' + ''.join([CHARSET[d] for d in combined]) |
| 67 | + |
| 68 | + |
| 69 | +def bech32_decode(bech): |
| 70 | + """Validate a Bech32 string, and determine HRP and data.""" |
| 71 | + if ((any(ord(x) < 33 or ord(x) > 126 for x in bech)) or |
| 72 | + (bech.lower() != bech and bech.upper() != bech)): |
| 73 | + return (None, None) |
| 74 | + bech = bech.lower() |
| 75 | + pos = bech.rfind('1') |
| 76 | + if pos < 1 or pos + 7 > len(bech) or len(bech) > 90: |
| 77 | + return (None, None) |
| 78 | + if not all(x in CHARSET for x in bech[pos+1:]): |
| 79 | + return (None, None) |
| 80 | + hrp = bech[:pos] |
| 81 | + data = [CHARSET.find(x) for x in bech[pos+1:]] |
| 82 | + if not bech32_verify_checksum(hrp, data): |
| 83 | + return (None, None) |
| 84 | + return (hrp, data[:-6]) |
| 85 | + |
| 86 | + |
| 87 | +def convertbits(data, frombits, tobits, pad=True): |
| 88 | + """General power-of-2 base conversion.""" |
| 89 | + acc = 0 |
| 90 | + bits = 0 |
| 91 | + ret = [] |
| 92 | + maxv = (1 << tobits) - 1 |
| 93 | + max_acc = (1 << (frombits + tobits - 1)) - 1 |
| 94 | + for value in data: |
| 95 | + value = _bord(value) |
| 96 | + if value < 0 or (value >> frombits): |
| 97 | + return None |
| 98 | + acc = ((acc << frombits) | value) & max_acc |
| 99 | + bits += frombits |
| 100 | + while bits >= tobits: |
| 101 | + bits -= tobits |
| 102 | + ret.append((acc >> bits) & maxv) |
| 103 | + if pad: |
| 104 | + if bits: |
| 105 | + ret.append((acc << (tobits - bits)) & maxv) |
| 106 | + elif bits >= frombits or ((acc << (tobits - bits)) & maxv): |
| 107 | + return None |
| 108 | + return ret |
| 109 | + |
| 110 | + |
| 111 | +def decode(hrp, addr): |
| 112 | + """Decode a segwit address.""" |
| 113 | + hrpgot, data = bech32_decode(addr) |
| 114 | + if hrpgot != hrp: |
| 115 | + return (None, None) |
| 116 | + decoded = convertbits(data[1:], 5, 8, False) |
| 117 | + if decoded is None or len(decoded) < 2 or len(decoded) > 40: |
| 118 | + return (None, None) |
| 119 | + if data[0] > 16: |
| 120 | + return (None, None) |
| 121 | + if data[0] == 0 and len(decoded) != 20 and len(decoded) != 32: |
| 122 | + return (None, None) |
| 123 | + return (data[0], decoded) |
| 124 | + |
| 125 | + |
| 126 | +def encode(hrp, witver, witprog): |
| 127 | + """Encode a segwit address.""" |
| 128 | + ret = bech32_encode(hrp, [witver] + convertbits(witprog, 8, 5)) |
| 129 | + if decode(hrp, ret) == (None, None): |
| 130 | + return None |
| 131 | + return ret |
0 commit comments