183 lines
7.6 KiB
Python
183 lines
7.6 KiB
Python
from os import remove
|
|
from pathlib import Path
|
|
from tempfile import NamedTemporaryFile
|
|
from unittest import TestCase
|
|
|
|
from clvm_tools.clvmc import compile_clvm
|
|
|
|
from chia.types.blockchain_format.program import Program, SerializedProgram
|
|
|
|
wallet_program_files = set(
|
|
[
|
|
"chia/wallet/puzzles/calculate_synthetic_public_key.clvm",
|
|
"chia/wallet/puzzles/cat_v2.clvm",
|
|
"chia/wallet/puzzles/chialisp_deserialisation.clvm",
|
|
"chia/wallet/puzzles/rom_bootstrap_generator.clvm",
|
|
"chia/wallet/puzzles/generator_for_single_coin.clvm",
|
|
"chia/wallet/puzzles/lock.inner.puzzle.clvm",
|
|
"chia/wallet/puzzles/p2_conditions.clvm",
|
|
"chia/wallet/puzzles/p2_delegated_conditions.clvm",
|
|
"chia/wallet/puzzles/p2_delegated_puzzle.clvm",
|
|
"chia/wallet/puzzles/p2_delegated_puzzle_or_hidden_puzzle.clvm",
|
|
"chia/wallet/puzzles/p2_m_of_n_delegate_direct.clvm",
|
|
"chia/wallet/puzzles/p2_puzzle_hash.clvm",
|
|
"chia/wallet/puzzles/rl_aggregation.clvm",
|
|
"chia/wallet/puzzles/rl.clvm",
|
|
"chia/wallet/puzzles/sha256tree_module.clvm",
|
|
"chia/wallet/puzzles/singleton_top_layer.clvm",
|
|
"chia/wallet/puzzles/did_innerpuz.clvm",
|
|
"chia/wallet/puzzles/decompress_puzzle.clvm",
|
|
"chia/wallet/puzzles/decompress_coin_spend_entry_with_prefix.clvm",
|
|
"chia/wallet/puzzles/decompress_coin_spend_entry.clvm",
|
|
"chia/wallet/puzzles/block_program_zero.clvm",
|
|
"chia/wallet/puzzles/test_generator_deserialize.clvm",
|
|
"chia/wallet/puzzles/test_multiple_generator_input_arguments.clvm",
|
|
"chia/wallet/puzzles/p2_singleton.clvm",
|
|
"chia/wallet/puzzles/pool_waitingroom_innerpuz.clvm",
|
|
"chia/wallet/puzzles/pool_member_innerpuz.clvm",
|
|
"chia/wallet/puzzles/singleton_launcher.clvm",
|
|
"chia/wallet/puzzles/p2_singleton_or_delayed_puzhash.clvm",
|
|
"chia/wallet/puzzles/genesis_by_puzzle_hash.clvm",
|
|
"chia/wallet/puzzles/everything_with_signature.clvm",
|
|
"chia/wallet/puzzles/delegated_tail.clvm",
|
|
"chia/wallet/puzzles/settlement_payments.clvm",
|
|
"chia/wallet/puzzles/genesis_by_coin_id.clvm",
|
|
"chia/wallet/puzzles/singleton_top_layer_v1_1.clvm",
|
|
"chia/wallet/puzzles/nft_metadata_updater_default.clvm",
|
|
"chia/wallet/puzzles/nft_metadata_updater_updateable.clvm",
|
|
"chia/wallet/puzzles/nft_state_layer.clvm",
|
|
"chia/wallet/puzzles/nft_ownership_layer.clvm",
|
|
"chia/wallet/puzzles/nft_ownership_transfer_program_one_way_claim_with_royalties.clvm",
|
|
"chia/wallet/puzzles/decompress_block_spends.clvm",
|
|
]
|
|
)
|
|
|
|
clvm_include_files = set(
|
|
["chia/wallet/puzzles/create-lock-puzzlehash.clvm", "chia/wallet/puzzles/condition_codes.clvm"]
|
|
)
|
|
|
|
CLVM_PROGRAM_ROOT = "chia/wallet/puzzles"
|
|
|
|
|
|
def list_files(dir, glob):
|
|
dir = Path(dir)
|
|
entries = dir.glob(glob)
|
|
files = [f for f in entries if f.is_file()]
|
|
return files
|
|
|
|
|
|
def read_file(path):
|
|
with open(path) as f:
|
|
return f.read()
|
|
|
|
|
|
def path_with_ext(path, ext):
|
|
return Path(str(path) + ext)
|
|
|
|
|
|
class TestClvmCompilation(TestCase):
|
|
"""
|
|
These are tests, and not just build scripts to regenerate the bytecode, because
|
|
the developer must be aware if the compiled output changes, for any reason.
|
|
"""
|
|
|
|
def test_all_programs_listed(self):
|
|
"""
|
|
Checks to see if a new .clvm file was added to chia/wallet/puzzles, but not added to `wallet_program_files`
|
|
"""
|
|
existing_files = list_files(CLVM_PROGRAM_ROOT, "*.clvm")
|
|
existing_file_paths = set([Path(x).relative_to(CLVM_PROGRAM_ROOT) for x in existing_files])
|
|
|
|
expected_files = set(clvm_include_files).union(set(wallet_program_files))
|
|
expected_file_paths = set([Path(x).relative_to(CLVM_PROGRAM_ROOT) for x in expected_files])
|
|
|
|
self.assertEqual(
|
|
expected_file_paths,
|
|
existing_file_paths,
|
|
msg="Please add your new program to `wallet_program_files` or `clvm_include_files.values`",
|
|
)
|
|
|
|
def test_include_and_source_files_separate(self):
|
|
self.assertEqual(clvm_include_files.intersection(wallet_program_files), set())
|
|
|
|
# TODO: Test recompilation with all available compiler configurations & implementations
|
|
def test_all_programs_are_compiled(self):
|
|
"""Checks to see if a new .clvm file was added without its .hex file"""
|
|
all_compiled = True
|
|
msg = "Please compile your program with:\n"
|
|
|
|
# Note that we cannot test all existing .clvm files - some are not
|
|
# meant to be run as a "module" with load_clvm; some are include files
|
|
# We test for inclusion in `test_all_programs_listed`
|
|
for prog_path in wallet_program_files:
|
|
try:
|
|
output_path = path_with_ext(prog_path, ".hex")
|
|
hex = output_path.read_text()
|
|
self.assertTrue(len(hex) > 0)
|
|
except Exception as ex:
|
|
all_compiled = False
|
|
msg += f" run -i {prog_path.parent} -d {prog_path} > {prog_path}.hex\n"
|
|
print(ex)
|
|
msg += "and check it in"
|
|
self.assertTrue(all_compiled, msg=msg)
|
|
|
|
def test_recompilation_matches(self):
|
|
self.maxDiff = None
|
|
for f in wallet_program_files:
|
|
f = Path(f)
|
|
compile_clvm(f, path_with_ext(f, ".recompiled"), search_paths=[f.parent])
|
|
orig_hex = path_with_ext(f, ".hex").read_text().strip()
|
|
new_hex = path_with_ext(f, ".recompiled").read_text().strip()
|
|
self.assertEqual(orig_hex, new_hex, msg=f"Compilation of {f} does not match {f}.hex")
|
|
pass
|
|
|
|
def test_all_compiled_programs_are_hashed(self):
|
|
"""Checks to see if a .hex file is missing its .sha256tree file"""
|
|
all_hashed = True
|
|
msg = "Please hash your program with:\n"
|
|
for prog_path in wallet_program_files:
|
|
try:
|
|
hex = path_with_ext(prog_path, ".hex.sha256tree").read_text()
|
|
self.assertTrue(len(hex) > 0)
|
|
except Exception as ex:
|
|
print(ex)
|
|
all_hashed = False
|
|
msg += f" opd -H {prog_path}.hex | head -1 > {prog_path}.hex.sha256tree\n"
|
|
msg += "and check it in"
|
|
self.assertTrue(all_hashed, msg)
|
|
|
|
# TODO: Test all available shatree implementations on all progams
|
|
def test_shatrees_match(self):
|
|
"""Checks to see that all .sha256tree files match their .hex files"""
|
|
for prog_path in wallet_program_files:
|
|
# load the .hex file as a program
|
|
hex_filename = path_with_ext(prog_path, ".hex")
|
|
clvm_hex = hex_filename.read_text() # .decode("utf8")
|
|
clvm_blob = bytes.fromhex(clvm_hex)
|
|
s = SerializedProgram.from_bytes(clvm_blob)
|
|
p = Program.from_bytes(clvm_blob)
|
|
|
|
# load the checked-in shatree
|
|
existing_sha = path_with_ext(prog_path, ".hex.sha256tree").read_text().strip()
|
|
|
|
self.assertEqual(
|
|
s.get_tree_hash().hex(),
|
|
existing_sha,
|
|
msg=f"Checked-in shatree hash file does not match hash of loaded SerializedProgram: {prog_path}",
|
|
)
|
|
self.assertEqual(
|
|
p.get_tree_hash().hex(),
|
|
existing_sha,
|
|
msg=f"Checked-in shatree hash file does not match shatree hash of loaded Program: {prog_path}",
|
|
)
|
|
|
|
def test_017_encoding_bug_fixed(self):
|
|
with NamedTemporaryFile(delete=False) as tf:
|
|
tf.write(b"10000000")
|
|
hexname = tf.name + ".hex"
|
|
compile_clvm(tf.name, hexname, [])
|
|
with open(hexname) as f:
|
|
self.assertEqual(f.read().strip(), "8400989680")
|
|
remove(tf.name)
|
|
remove(hexname)
|