clvm_tools_rs 0.4.0

#[cfg(test)]
use rand::prelude::*;
#[cfg(test)]
use rand_chacha::ChaChaRng;

use num_bigint::ToBigInt;

use std::borrow::Borrow;
use std::fs;
use std::rc::Rc;

use clvm_rs::allocator::Allocator;

use crate::classic::clvm::__type_compatibility__::{bi_one, bi_zero, Bytes, BytesFromType};
use crate::classic::clvm::casts::{bigint_to_bytes_clvm, bigint_to_bytes_unsigned};
use crate::classic::clvm_tools::stages::stage_0::DefaultProgramRunner;

use crate::compiler::clvm::{convert_to_clvm_rs, parse_and_run, sha256tree, NewStyleIntConversion};
use crate::compiler::runtypes::RunFailure;
use crate::compiler::sexp::{parse_sexp, SExp};
use crate::compiler::srcloc::Srcloc;
use crate::tests::classic::run::RandomClvmNumber;

use crate::util::Number;

pub const TEST_TIMEOUT: usize = 1000000;

fn test_compiler_clvm(to_run: &String, args: &String) -> Result<Rc<SExp>, RunFailure> {
    let mut allocator = Allocator::new();
    let runner = Rc::new(DefaultProgramRunner::new());
    parse_and_run(
        &mut allocator,
        runner,
        &"*test*".to_string(),
        &to_run,
        &args,
        Some(TEST_TIMEOUT),
    )
}

#[test]
fn test_sexp_parse_1() {
    let loc = Srcloc::start(&"*test*".to_string());
    let res = parse_sexp(loc, "()".bytes()).map(|x| x[0].to_string());
    assert_eq!(res, Ok("()".to_string()));
}

#[test]
fn test_sexp_parse_2() {
    let loc = Srcloc::start(&"*test*".to_string());
    let res = parse_sexp(loc, "55".bytes()).and_then(|x| x[0].get_number());
    assert_eq!(res, Ok(55_i32.to_bigint().unwrap()));
}

#[test]
fn test_sexp_parse_3() {
    let loc = Srcloc::start(&"*test*".to_string());
    let res = parse_sexp(loc, "hello".bytes()).and_then(|x| x[0].get_number());
    assert_eq!(res, Ok(448378203247_i64.to_bigint().unwrap()));
}

#[test]
fn test_sexp_parse_4() {
    let loc = Srcloc::start(&"*test*".to_string());
    let res = parse_sexp(loc, "\"hello\"".bytes()).and_then(|x| x[0].get_number());
    assert_eq!(res, Ok(448378203247_i64.to_bigint().unwrap()));
}

#[test]
fn test_sexp_parse_5() {
    let loc = Srcloc::start(&"*test*".to_string());
    let res = parse_sexp(loc, "(3 . 4)".bytes()).map(|x| x[0].to_string());
    assert_eq!(res, Ok("(3 . 4)".to_string()));
}

#[test]
fn test_sexp_parse_6() {
    let loc = Srcloc::start(&"*test*".to_string());
    let res = parse_sexp(loc, "(\" \" . 3)".bytes()).map(|x| x[0].to_string());
    assert_eq!(res, Ok("(\" \" . 3)".to_string()));
}

#[test]
fn test_sexp_parse_7() {
    let loc = Srcloc::start(&"*test*".to_string());
    let res = parse_sexp(loc, "(3 . \" \")".bytes()).map(|x| x[0].to_string());
    assert_eq!(res, Ok("(3 . \" \")".to_string()));
}

#[test]
fn test_sexp_parse_8() {
    let loc = Srcloc::start(&"*test*".to_string());
    let res = parse_sexp(
        loc,
        "(a (q 2 4 (c 2 (c 6 ()))) (c (q 13 26729 \"there\" \"fool\") 1))".bytes(),
    )
    .map(|x| x[0].to_string());
    assert_eq!(
        res,
        Ok("(a (q 2 4 (c 2 (c 6 ()))) (c (q 13 26729 \"there\" \"fool\") 1))".to_string())
    );
}

#[test]
fn test_clvm_1() {
    let loc = Srcloc::start(&"*test*".to_string());
    let result = test_compiler_clvm(
        &"(a (q 2 4 (c 2 (c 6 ()))) (c (q 13 26729 \"there\" \"fool\") 1))".to_string(),
        &"()".to_string(),
    )
    .unwrap();
    let want = parse_sexp(loc, "(\"there\" \"fool\")".bytes()).unwrap();

    assert!(result.equal_to(want[0].borrow()));
}

#[test]
fn test_clvm_2() {
    let loc = Srcloc::start(&"*test*".to_string());
    let result =
        test_compiler_clvm(
            &"(a (q 2 (q 2 2 (c 2 (c 3 (q)))) (c (q 2 (i 5 (q 4 (q . 4) (c 9 (c (a 2 (c 2 (c 13 (q)))) (q)))) (q 1)) 1) 1)) 1)".to_string(),
            &"(1 2)".to_string(),
        ).unwrap();
    let want = parse_sexp(loc, "(4 1 (4 2 ()))".bytes()).unwrap();

    assert!(result.equal_to(want[0].borrow()));
}

#[test]
fn test_clvm_3() {
    let loc = Srcloc::start(&"*test*".to_string());
    let result = test_compiler_clvm(
        &"(2 (3 (1) (1 16 (1 . 1) (1 . 3)) (1 16 (1 . 5) (1 . 8))) 1)".to_string(),
        &"()".to_string(),
    )
    .unwrap();
    let want = parse_sexp(loc, "13".bytes()).unwrap();

    assert!(result.equal_to(want[0].borrow()));
}

#[test]
fn test_clvm_4() {
    let loc = Srcloc::start(&"*test*".to_string());
    let result = test_compiler_clvm(
        &"(divmod (1 . 300000003392) (1 . 10000000))".to_string(),
        &"()".to_string(),
    )
    .unwrap();
    let want = parse_sexp(loc, "(30000 . 3392)".bytes()).unwrap();

    assert!(result.equal_to(want[0].borrow()));
}

#[cfg(test)]
fn does_number_need_extension_byte(n: Number) -> bool {
    let mut iv = n.clone();
    let eight_ones = 255_u32.to_bigint().unwrap();
    while iv > eight_ones {
        iv /= eight_ones.clone() + bi_one();
    }
    iv > 127_u32.to_bigint().unwrap()
}

// This seems like a reasonable way to unit test just the conversion functions
// in a broad way i suppose.
#[test]
fn test_random_int_just_the_conversion_functions_and_no_other_things_from_the_stack_1() {
    let mut rng = ChaChaRng::from_os_rng();
    for _ in 1..=200 {
        let number_spec: RandomClvmNumber = rng.random();

        let to_bytes_clvm = bigint_to_bytes_clvm(&number_spec.intended_value).raw();
        let to_bytes_unsigned = if number_spec.intended_value < bi_zero() {
            None
        } else {
            Some(bigint_to_bytes_unsigned(&number_spec.intended_value).raw())
        };

        if number_spec.intended_value == bi_zero() {
            assert!(to_bytes_clvm.is_empty());
            if let Some(usbi) = &to_bytes_unsigned {
                assert!(usbi.is_empty());
            }
            continue;
        }

        // Determine whether an extension byte would be needed.
        let need_ext_byte = does_number_need_extension_byte(number_spec.intended_value.clone());
        if need_ext_byte {
            assert_eq!(to_bytes_clvm[0], 0);
            if let Some(usbi) = &to_bytes_unsigned {
                assert_eq!(usbi[0] & 0x80, 0x80);
            }
        }

        // Check clvm repr
        let one_byte_size = 256_u32.to_bigint().unwrap();
        let mut check_value = number_spec.intended_value.clone();
        for b in to_bytes_clvm.iter().rev() {
            let isolated_byte = check_value.clone() & (one_byte_size.clone() - bi_one());
            check_value >>= 8;
            assert_eq!(isolated_byte, b.to_bigint().unwrap());
        }

        // Check unsigned repr
        check_value = number_spec.intended_value.clone();
        if let Some(usbi) = &to_bytes_unsigned {
            for b in usbi.iter().rev() {
                let isolated_byte = check_value.clone() & (one_byte_size.clone() - bi_one());
                check_value >>= 8;
                assert_eq!(isolated_byte, b.to_bigint().unwrap());
            }
        }
    }
}

#[test]
fn test_sha256_tree_hash() {
    let filename = "resources/tests/assert.clvm.out";
    let assert_clvm_compiled = fs::read_to_string(filename).expect("should exist");
    let parsed = parse_sexp(
        Srcloc::start(filename),
        assert_clvm_compiled.as_bytes().iter().copied(),
    )
    .expect("should parse");
    let hash_result = Bytes::new(Some(BytesFromType::Raw(sha256tree(parsed[0].clone())))).hex();
    assert_eq!(
        hash_result,
        "156e86309040ed6bbfee805c9c6ca7eebc140490bd1b97d6d18fb8ebc91fd05a"
    );
}

#[test]
fn test_sha256_integer_0_hash() {
    let srcloc = Srcloc::start("*test*");
    let value = Rc::new(SExp::Integer(srcloc, bi_zero()));
    let hash_result = Bytes::new(Some(BytesFromType::Raw(sha256tree(value)))).hex();
    assert_eq!(
        hash_result,
        "4bf5122f344554c53bde2ebb8cd2b7e3d1600ad631c385a5d7cce23c7785459a"
    );
}

#[test]
fn test_sha256_integer_0_hash_pre_fix() {
    let srcloc = Srcloc::start("*test*");
    let value = Rc::new(SExp::Integer(srcloc, bi_zero()));
    let _old_style = NewStyleIntConversion::new(false);
    let hash_result = Bytes::new(Some(BytesFromType::Raw(sha256tree(value)))).hex();
    assert_eq!(
        hash_result,
        "47dc540c94ceb704a23875c11273e16bb0b8a87aed84de911f2133568115f254"
    );
}

#[test]
fn test_integer_0_to_clvm() {
    let srcloc = Srcloc::start("*test*");
    let value = Rc::new(SExp::Integer(srcloc, bi_zero()));
    let mut allocator = Allocator::new();
    let clvm_target = convert_to_clvm_rs(&mut allocator, value).expect("ok");
    let empty: [u8; 0] = [];
    let atom = allocator.atom(clvm_target);
    assert_eq!(atom.as_ref(), &empty);
}

#[test]
fn test_integer_hash_255() {
    let srcloc = Srcloc::start("*test*");
    let value = Rc::new(SExp::Integer(srcloc, 255_u32.to_bigint().unwrap()));
    let hash_result = Bytes::new(Some(BytesFromType::Raw(sha256tree(value)))).hex();
    assert_eq!(
        hash_result,
        "b7ae7729555ec6829c579c2602edc6cb94b4ed3d820ddda0a45ac54030f8a53d"
    );
}

#[test]
fn test_integer_hash_255_pre_fix() {
    let srcloc = Srcloc::start("*test*");
    let value = Rc::new(SExp::Integer(srcloc, 255_u32.to_bigint().unwrap()));
    let _old_style = NewStyleIntConversion::new(false);
    let hash_result = Bytes::new(Some(BytesFromType::Raw(sha256tree(value)))).hex();
    assert_eq!(
        hash_result,
        "b7ae7729555ec6829c579c2602edc6cb94b4ed3d820ddda0a45ac54030f8a53d"
    );
}

#[test]
fn test_integer_hash_m129() {
    let srcloc = Srcloc::start("*test*");
    let value = Rc::new(SExp::Integer(srcloc, -129_i32.to_bigint().unwrap()));
    let hash_result = Bytes::new(Some(BytesFromType::Raw(sha256tree(value)))).hex();
    assert_eq!(
        hash_result,
        "5a0c1fec64751e82c0d4861d0bc19c7580525d2f47667956bbd9d79e260aae00"
    );
}

#[test]
fn test_integer_hash_m129_pre_fix() {
    let srcloc = Srcloc::start("*test*");
    let value = Rc::new(SExp::Integer(srcloc, -129_i32.to_bigint().unwrap()));
    let _old_style = NewStyleIntConversion::new(false);
    let hash_result = Bytes::new(Some(BytesFromType::Raw(sha256tree(value)))).hex();
    assert_eq!(
        hash_result,
        "5a0c1fec64751e82c0d4861d0bc19c7580525d2f47667956bbd9d79e260aae00"
    );
}