def test_non_standard_script_in_p2wsh() -> None:
network = "mainnet"
fed_pub_keys: List[Command] = ["00" * 33, "11" * 33, "22" * 33]
rec_pub_keys: List[Command] = ["77" * 33, "88" * 33, "99" * 33]
# fmt: off
redeem_script_cmds: List[Command] = [
"OP_IF",
"OP_2",
*fed_pub_keys,
"OP_3",
"OP_CHECKMULTISIG", # noqa E131
"OP_ELSE",
500,
"OP_CHECKLOCKTIMEVERIFY",
"OP_DROP", # noqa E131
"OP_2",
*rec_pub_keys,
"OP_3",
"OP_CHECKMULTISIG", # noqa E131
"OP_ENDIF",
]
# fmt: on
redeem_script = serialize(redeem_script_cmds)
assert redeem_script_cmds == parse(redeem_script)
payload = sha256(redeem_script)
script_pub_key = (
"00207b5310339c6001f75614daa5083839fa54d46165f6c56025cc54d397a85a5708")
assert script_pub_key == ScriptPubKey.p2wsh(redeem_script).script.hex()
addr = "bc1q0df3qvuuvqqlw4s5m2jsswpelf2dgct97mzkqfwv2nfe02z62uyq7n4zjj"
assert addr == address(script_pub_key, network)
assert addr == b32.address_from_witness(0, payload, network)
def test_p2ms_2() -> None:
m = 1
# all uncompressed
pub_key0 = "04 cc71eb30d653c0c3163990c47b976f3fb3f37cccdcbedb169a1dfef58bbfbfaf f7d8a473e7e2e6d317b87bafe8bde97e3cf8f065dec022b51d11fcdd0d348ac4"
pub_key1 = "04 61cbdcc5409fb4b4d42b51d33381354d80e550078cb532a34bfa2fcfdeb7d765 19aecc62770f5b0e4ef8551946d8a540911abe3e7854a26f39f58b25c15342af"
pub_key2 = "04 79BE667EF9DCBBAC55A06295CE870B07029BFCDB2DCE28D959F2815B16F81798 483ADA7726A3C4655DA4FBFC0E1108A8FD17B448A68554199C47D08FFB10D4B8"
uncompressed_pub_keys: List[Key] = [pub_key0, pub_key1, pub_key2]
# mixed compressed / uncompressed public keys
pub_key0 = "04 cc71eb30d653c0c3163990c47b976f3fb3f37cccdcbedb169a1dfef58bbfbfaf f7d8a473e7e2e6d317b87bafe8bde97e3cf8f065dec022b51d11fcdd0d348ac4"
pub_key1 = "03 61cbdcc5409fb4b4d42b51d33381354d80e550078cb532a34bfa2fcfdeb7d765"
pub_key2 = "02 79BE667EF9DCBBAC55A06295CE870B07029BFCDB2DCE28D959F2815B16F81798"
mixed_pub_keys: List[Key] = [pub_key0, pub_key1, pub_key2]
for pub_keys in (uncompressed_pub_keys, mixed_pub_keys):
for lexi_sort in (True, False):
script_pub_key = ScriptPubKey.p2ms(m,
pub_keys,
lexi_sort=lexi_sort).script
assert is_p2ms(script_pub_key)
assert address(script_pub_key) == ""
script_type, payload = type_and_payload(script_pub_key)
assert script_type == "p2ms"
assert payload == script_pub_key[:-1]
def test_p2wsh() -> None:
# self-consistency
pub_key = "02 cc71eb30d653c0c3163990c47b976f3fb3f37cccdcbedb169a1dfef58bbfbfaf"
redeem_script = ScriptPubKey.p2pkh(pub_key).script
payload = sha256(redeem_script)
script_pub_key = serialize(["OP_0", payload])
assert_p2wsh(script_pub_key)
assert script_pub_key == ScriptPubKey.p2wsh(redeem_script).script
assert ("p2wsh", payload) == type_and_payload(script_pub_key)
# bech32 address
network = "mainnet"
addr = b32.p2wsh(redeem_script, network)
assert addr == address(script_pub_key, network)
assert addr == b32.address_from_witness(0, payload, network)
# back from the address to the script_pub_key
assert script_pub_key == ScriptPubKey.from_address(addr).script
assert network == ScriptPubKey.from_address(addr).network
# p2sh-wrapped base58 address
addr = b58.p2wsh_p2sh(redeem_script, network)
assert addr == "39GUePMSQ4mADpihVLd8cFQ2tih9Fy4qkz"
err_msg = "invalid witness version: "
with pytest.raises(BTClibValueError, match=err_msg):
assert_p2wsh(b"\x33" + script_pub_key[1:])
err_msg = "invalid redeem script hash length marker: "
with pytest.raises(BTClibValueError, match=err_msg):
assert_p2wsh(script_pub_key[:1] + b"\x00" + script_pub_key[2:])
def test_p2wpkh() -> None:
# self-consistency
pub_key = "02 cc71eb30d653c0c3163990c47b976f3fb3f37cccdcbedb169a1dfef58bbfbfaf"
payload = hash160(pub_key)
script_pub_key = serialize(["OP_0", payload])
assert_p2wpkh(script_pub_key)
assert script_pub_key == ScriptPubKey.p2wpkh(pub_key).script
assert ("p2wpkh", payload) == type_and_payload(script_pub_key)
# bech32 address
network = "mainnet"
addr = b32.p2wpkh(pub_key, network)
assert addr == address(script_pub_key, network)
assert addr == b32.address_from_witness(0, payload, network)
# back from the address to the script_pub_key
assert script_pub_key == ScriptPubKey.from_address(addr).script
assert network == ScriptPubKey.from_address(addr).network
# p2sh-wrapped base58 address
addr = b58.p2wpkh_p2sh(pub_key, network)
assert addr == "3BJxz2r8zY7LxJfdGjUpjjHNh6YEiitvf2"
err_msg = "invalid witness version: "
with pytest.raises(BTClibValueError, match=err_msg):
assert_p2wpkh(b"\x33" + script_pub_key[1:])
err_msg = "invalid pub_key hash length marker: "
with pytest.raises(BTClibValueError, match=err_msg):
assert_p2wpkh(script_pub_key[:1] + b"\x00" + script_pub_key[2:])
def test_p2pkh() -> None:
# self-consistency
pub_key = (
"04 "
"cc71eb30d653c0c3163990c47b976f3fb3f37cccdcbedb169a1dfef58bbfbfaf"
"f7d8a473e7e2e6d317b87bafe8bde97e3cf8f065dec022b51d11fcdd0d348ac4")
payload = hash160(pub_key)
script_pub_key = serialize(
["OP_DUP", "OP_HASH160", payload, "OP_EQUALVERIFY", "OP_CHECKSIG"])
assert_p2pkh(script_pub_key)
assert script_pub_key == ScriptPubKey.p2pkh(pub_key).script
assert ("p2pkh", payload) == type_and_payload(script_pub_key)
# base58 address
network = "mainnet"
addr = b58.p2pkh(pub_key, network)
assert addr == address(script_pub_key, network)
assert addr == b58.address_from_h160("p2pkh", payload, network)
# back from the address to the script_pub_key
assert script_pub_key == ScriptPubKey.from_address(addr).script
assert network == ScriptPubKey.from_address(addr).network
# documented test case: https://learnmeabitcoin.com/guide/p2pkh
payload = bytes.fromhex("12ab8dc588ca9d5787dde7eb29569da63c3a238c")
script_pub_key = bytes.fromhex("76a914") + payload + bytes.fromhex("88ac")
assert_p2pkh(script_pub_key)
addr = "12higDjoCCNXSA95xZMWUdPvXNmkAduhWv"
assert addr == address(script_pub_key, network)
assert script_pub_key == ScriptPubKey.from_address(addr).script
assert network == ScriptPubKey.from_address(addr).network
err_msg = "missing final OP_EQUALVERIFY, OP_CHECKSIG"
with pytest.raises(BTClibValueError, match=err_msg):
assert_p2pkh(script_pub_key[:-2] + b"\x40\x40")
err_msg = "missing leading OP_DUP, OP_HASH160"
with pytest.raises(BTClibValueError, match=err_msg):
assert_p2pkh(b"\x40\x40" + script_pub_key[2:])
err_msg = "invalid pub_key hash length marker: "
with pytest.raises(BTClibValueError, match=err_msg):
assert_p2pkh(script_pub_key[:2] + b"\x40" + script_pub_key[3:])
def test_p2sh() -> None:
# self-consistency
pub_key = "02 cc71eb30d653c0c3163990c47b976f3fb3f37cccdcbedb169a1dfef58bbfbfaf"
redeem_script = ScriptPubKey.p2pkh(pub_key).script
payload = hash160(redeem_script)
script_pub_key = serialize(["OP_HASH160", payload, "OP_EQUAL"])
assert_p2sh(script_pub_key)
assert script_pub_key == ScriptPubKey.p2sh(redeem_script).script
assert ("p2sh", payload) == type_and_payload(script_pub_key)
# base58 address
network = "mainnet"
addr = b58.p2sh(redeem_script, network)
assert addr == address(script_pub_key, network)
assert addr == b58.address_from_h160("p2sh", payload, network)
# back from the address to the script_pub_key
assert script_pub_key == ScriptPubKey.from_address(addr).script
assert network == ScriptPubKey.from_address(addr).network
# documented test case: https://learnmeabitcoin.com/guide/p2sh
payload = bytes.fromhex("748284390f9e263a4b766a75d0633c50426eb875")
script_pub_key = bytes.fromhex("a914") + payload + bytes.fromhex("87")
assert_p2sh(script_pub_key)
addr = "3CK4fEwbMP7heJarmU4eqA3sMbVJyEnU3V"
assert addr == address(script_pub_key, network)
assert script_pub_key == ScriptPubKey.from_address(addr).script
assert network == ScriptPubKey.from_address(addr).network
err_msg = "missing final OP_EQUAL"
with pytest.raises(BTClibValueError, match=err_msg):
assert_p2sh(script_pub_key[:-1] + b"\x40")
err_msg = "missing leading OP_HASH160"
with pytest.raises(BTClibValueError, match=err_msg):
assert_p2sh(b"\x40" + script_pub_key[1:])
err_msg = "invalid redeem script hash length marker: "
with pytest.raises(BTClibValueError, match=err_msg):
assert_p2sh(script_pub_key[:1] + b"\x40" + script_pub_key[2:])
def test_nulldata() -> None:
OP_RETURN = b"\x6a" # pylint: disable=invalid-name
# self-consistency
string = "time-stamped data"
payload = string.encode()
script_pub_key = serialize(["OP_RETURN", payload])
assert script_pub_key == ScriptPubKey.nulldata(string).script
# back from the script_pub_key to the payload
assert ("nulldata", payload) == type_and_payload(script_pub_key)
# data -> payload in this case is invertible (no hash functions)
assert payload.decode("ascii") == string
assert address(script_pub_key) == ""
# documented test cases: https://learnmeabitcoin.com/guide/nulldata
string = "hello world"
payload = string.encode()
assert payload.hex() == "68656c6c6f20776f726c64" # pylint: disable=no-member
script_pub_key = OP_RETURN + var_bytes.serialize(payload)
assert script_pub_key == ScriptPubKey.nulldata(string).script
assert ("nulldata", payload) == type_and_payload(script_pub_key)
# documented test cases: https://learnmeabitcoin.com/guide/nulldata
string = "charley loves heidi"
payload = string.encode()
assert (payload.hex() # pylint: disable=no-member
== "636861726c6579206c6f766573206865696469")
script_pub_key = OP_RETURN + var_bytes.serialize(payload)
assert script_pub_key == ScriptPubKey.nulldata(string).script
assert ("nulldata", payload) == type_and_payload(script_pub_key)
# documented test cases: https://learnmeabitcoin.com/guide/nulldata
string = "家族も友達もみんなが笑顔の毎日がほしい"
payload = string.encode()
assert (
payload.hex() # pylint: disable=no-member
==
"e5aeb6e6978fe38282e58f8be98194e38282e381bfe38293e381aae3818ce7ac91e9a194e381aee6af8ee697a5e3818ce381bbe38197e38184"
)
script_pub_key = OP_RETURN + var_bytes.serialize(payload)
assert script_pub_key == ScriptPubKey.nulldata(string).script
assert ("nulldata", payload) == type_and_payload(script_pub_key)
def test_p2tr() -> None:
pub_key = "cc71eb30d653c0c3163990c47b976f3fb3f37cccdcbedb169a1dfef58bbfbfaf"
payload = output_pubkey(pub_key)[0]
script_pub_key = serialize(["OP_1", payload])
assert_p2tr(script_pub_key)
assert ("p2tr", payload) == type_and_payload(script_pub_key)
network = "mainnet"
addr = b32.p2tr(pub_key, network=network)
assert addr == address(script_pub_key, network)
assert script_pub_key == ScriptPubKey.from_address(addr).script
assert script_pub_key == ScriptPubKey.p2tr(pub_key).script
err_msg = "invalid redeem script hash length marker: "
with pytest.raises(BTClibValueError, match=err_msg):
assert_p2tr(script_pub_key[:1] + b"\x00" + script_pub_key[2:])
def test_bip67() -> None:
"BIP67 test vectors https://en.bitcoin.it/wiki/BIP_0067"
data_folder = path.join(path.dirname(__file__), "_data")
filename = path.join(data_folder, "bip67_test_vectors.json")
with open(filename, "r") as file_:
# json.dump(test_vectors, f, indent=4)
test_vectors = json.load(file_)
m = 2
for i in test_vectors:
keys, addr = test_vectors[i]
script_pub_key = ScriptPubKey.p2ms(m, keys, lexi_sort=True).script
assert is_p2ms(script_pub_key)
assert address(script_pub_key) == ""
script_type, payload = type_and_payload(script_pub_key)
assert script_type == "p2ms"
assert payload == script_pub_key[:-1]
errmsg = f"Test vector #{i}"
assert addr == b58.p2sh(script_pub_key), errmsg
def test_p2pk() -> None:
# self-consistency
pub_key = "02 cc71eb30d653c0c3163990c47b976f3fb3f37cccdcbedb169a1dfef58bbfbfaf"
script_pub_key = serialize([pub_key, "OP_CHECKSIG"])
assert_p2pk(script_pub_key)
assert script_pub_key == ScriptPubKey.p2pk(pub_key).script
assert ("p2pk", bytes.fromhex(pub_key)) == type_and_payload(script_pub_key)
assert address(script_pub_key) == ""
err_msg = "invalid pub_key length marker: "
with pytest.raises(BTClibValueError, match=err_msg):
assert_p2pk(b"\x31" + script_pub_key[1:])
# documented test case: https://learnmeabitcoin.com/guide/p2pk
pub_key = (
"04"
"ae1a62fe09c5f51b13905f07f06b99a2f7159b2225f374cd378d71302fa28414"
"e7aab37397f554a7df5f142c21c1b7303b8a0626f1baded5c72a704f7e6cd84c")
script_pub_key = bytes.fromhex("41" + pub_key + "ac")
assert_p2pk(script_pub_key)
assert script_pub_key == ScriptPubKey.p2pk(pub_key).script
err_msg = "missing final OP_CHECKSIG"
with pytest.raises(BTClibValueError, match=err_msg):
assert_p2pk(script_pub_key[:-1] + b"\x00")
err_msg = "invalid pub_key length marker: "
with pytest.raises(BTClibValueError, match=err_msg):
assert_p2pk(b"\x31" + script_pub_key[1:])
# invalid size: 34 bytes instead of (33, 65)
pub_key = "03 ae1a62fe09c5f51b13905f07f06b99a2f7159b2225f374cd378d71302fa28414 14"
err_msg = "not a private or public key: "
with pytest.raises(BTClibValueError, match=err_msg):
ScriptPubKey.p2pk(pub_key)
def test_p2ms_1() -> None:
# self-consistency
pub_key0 = "04 cc71eb30d653c0c3163990c47b976f3fb3f37cccdcbedb169a1dfef58bbfbfaf f7d8a473e7e2e6d317b87bafe8bde97e3cf8f065dec022b51d11fcdd0d348ac4"
pub_key1 = "04 61cbdcc5409fb4b4d42b51d33381354d80e550078cb532a34bfa2fcfdeb7d765 19aecc62770f5b0e4ef8551946d8a540911abe3e7854a26f39f58b25c15342af"
# documented test case: https://learnmeabitcoin.com/guide/p2ms
script_pub_key = bytes.fromhex( # fmt: off
"51" # OP_1
"41" # canonical 65-bytes push
+ pub_key0 + "41" # noqa E148 # canonical 65-bytes push
+ pub_key1 + "52" # noqa E148 # OP_2
"ae" # OP_CHECKMULTISIG
) # fmt: on
assert is_p2ms(script_pub_key)
assert address(script_pub_key) == ""
script_type, payload = type_and_payload(script_pub_key)
assert script_type == "p2ms"
assert payload == script_pub_key[:-1]
pub_keys: List[Key] = [pub_key0, pub_key1]
assert script_pub_key == ScriptPubKey.p2ms(1, pub_keys,
lexi_sort=False).script
err_msg = "invalid m in m-of-n: "
with pytest.raises(BTClibValueError, match=err_msg):
ScriptPubKey.p2ms(4, pub_keys)
err_msg = "invalid n in m-of-n: "
with pytest.raises(BTClibValueError, match=err_msg):
# pylance cannot grok the following line
ScriptPubKey.p2ms(4, [pub_key0] * 17) # type: ignore
err_msg = "invalid m in m-of-n: "
with pytest.raises(BTClibValueError, match=err_msg):
ScriptPubKey.p2ms(0, pub_keys)
err_msg = "invalid m in m-of-n: "
with pytest.raises(BTClibValueError, match=err_msg):
ScriptPubKey.p2ms(17, pub_keys)
err_msg = "not a private or public key: "
with pytest.raises(BTClibValueError, match=err_msg):
ScriptPubKey.p2ms(1, [pub_key0 + "00", pub_key1])
script_: List[Command] = [
"OP_1",
pub_key0 + "00",
pub_key1,
"OP_2",
"OP_CHECKMULTISIG",
]
script_pub_key = serialize(script_)
assert not is_p2ms(script_pub_key)
err_msg = "invalid key in p2ms"
script_pub_key = serialize(
["OP_1", pub_key0, "00", "OP_2", "OP_CHECKMULTISIG"])
assert not is_p2ms(script_pub_key)
script_pub_key = serialize(
["OP_1", pub_key0, pub_key1, "OP_2", "OP_CHECKMULTISIG"])
assert is_p2ms(script_pub_key)
script_pub_key = serialize(
["OP_2", pub_key0, pub_key1, "OP_2", "OP_CHECKMULTISIG"])
assert is_p2ms(script_pub_key)
script_pub_key = serialize(
["OP_0", pub_key0, pub_key1, "OP_2", "OP_CHECKMULTISIG"])
assert not is_p2ms(script_pub_key)
script_pub_key = serialize(
["OP_3", pub_key0, pub_key1, "OP_2", "OP_CHECKMULTISIG"])
assert not is_p2ms(script_pub_key)
script_pub_key = serialize(["OP_1", "OP_2", "OP_CHECKMULTISIG"])
assert not is_p2ms(script_pub_key)
script_pub_key = serialize(["OP_1", pub_key0, "OP_2", "OP_CHECKMULTISIG"])
assert not is_p2ms(script_pub_key)
script_pub_key = serialize(
["OP_1", pub_key0, pub_key1, "OP_3", "OP_CHECKMULTISIG"])
assert not is_p2ms(script_pub_key)
pub_key2 = "04 79BE667EF9DCBBAC55A06295CE870B07029BFCDB2DCE28D959F2815B16F81798 483ADA7726A3C4655DA4FBFC0E1108A8FD17B448A68554199C47D08FFB10D4B8"
script_pub_key = serialize(
["OP_1", pub_key0, pub_key1, pub_key2, "OP_3", "OP_CHECKMULTISIG"])
assert_p2ms(script_pub_key)
err_msg = "invalid p2ms script_pub_key size"
with pytest.raises(BTClibValueError, match=err_msg):
assert_p2ms(script_pub_key[:133] + b"\x40" + script_pub_key[134:])
with pytest.raises(BTClibValueError, match=err_msg):
assert_p2ms(script_pub_key[:-2] + b"\x00" + script_pub_key[-2:])
def test_unknown() -> None:
script_pub_key = serialize(["OP_16", 20 * b"\x00"])
assert address(script_pub_key) == ""
assert type_and_payload(script_pub_key) == ("unknown", script_pub_key)