More templates

Author: xxuejie

c-wrapper-crate/Cargo.toml

@@ -0,0 +1,9 @@
+[package]
+name = "{{project-name}}"
+version = "0.1.0"
+edition = "2021"
+
+[dependencies]
+
+[build-dependencies]
+cc = "1.0"

c-wrapper-crate/build.rs

@@ -0,0 +1,36 @@
+fn main() {
+    println!("cargo:rerun-if-changed=c.c");
+
+    let top = match std::env::var("TOP") {
+        Ok(top) => top,
+        Err(_) => "../..".to_string(),
+    };
+
+    let target_arch = std::env::var("CARGO_CFG_TARGET_ARCH").unwrap();
+    if target_arch == "riscv64" {
+        let mut build = cc::Build::new();
+        assert!(
+            build.get_compiler().is_like_clang(),
+            "Clang must be used as the compiler!"
+        );
+        build
+            .file("c.c")
+            .static_flag(true)
+            .include(format!("{}/deps/ckb-c-stdlib", top))
+            .include(format!("{}/deps/ckb-c-stdlib/libc", top))
+            .no_default_flags(true)
+            .flag("--target=riscv64")
+            .flag("-march=rv64imc_zba_zbb_zbc_zbs")
+            .flag("-O3")
+            .flag("-nostdinc")
+            .flag("-nostdlib")
+            .flag("-fvisibility=hidden")
+            .flag("-fdata-sections")
+            .flag("-ffunction-sections")
+            .flag("-Wall")
+            .flag("-Werror")
+            .flag("-Wno-unused-parameter")
+            .define("CKB_DECLARATION_ONLY", None)
+            .compile("c-impl");
+    }
+}

c-wrapper-crate/c.c

@@ -0,0 +1,3 @@
+int bar() {
+  return 42;
+}

c-wrapper-crate/src/lib.rs

@@ -0,0 +1,11 @@
+#![cfg_attr(not(test), no_std)]
+
+#[cfg(target_arch = "riscv64")]
+#[link(name = "c-impl", kind = "static")]
+extern "C" {
+    fn bar() -> core::ffi::c_int;
+}
+
+pub fn value() -> u32 {
+    (unsafe { bar() }) as u32
+}

cargo-generate.toml

@@ -2,5 +2,7 @@
 sub_templates = [
   "contract",
   "standalone-contract",
+  "c-wrapper-crate",
+  "x64-simulator-crate",
   "workspace",
 ]

x64-simulator-crate/Cargo.toml

@@ -0,0 +1,19 @@
+[package]
+name = "{{project-name}}"
+version = "0.1.0"
+edition = "2021"
+
+[dependencies]
+ckb-std = "0.15.0"
+
+# Supporting native tests powered by ckb-x64-simulator
+[target.'cfg(all(target_arch = "x86_64", unix))'.dependencies.ckb-std]
+version = "0.15.0"
+features = ["simulator"]
+
+[target.'cfg(all(target_arch = "x86_64", unix))'.dev-dependencies]
+ckb-testtool = "0.10.1"
+rusty-fork = "0.3.0"
+rand = "0.8.5"
+serde_json = "1.0"
+tempfile = "3.9.0"

x64-simulator-crate/src/lib.rs

@@ -0,0 +1,70 @@
+#![cfg_attr(not(test), no_std)]
+
+pub fn foo() -> usize {
+    ckb_std::high_level::load_witness(0, ckb_std::ckb_constants::Source::Input)
+        .expect("load_witness")
+        .len()
+}
+
+// Here we provide a native runnable test sample. The test uses ckb-x64-simulator
+// to mock CKB syscalls.
+#[cfg(all(test, target_arch = "x86_64", unix))]
+mod tests {
+    use super::*;
+    use ckb_testtool::ckb_types::{core::TransactionBuilder, prelude::*};
+    use ckb_testtool::context::Context;
+    use rand::{rngs::StdRng, Rng, SeedableRng};
+    use rusty_fork::rusty_fork_test;
+    use std::io::Write;
+
+    // TODO: Right now ckb-x64-simulator has no way of resetting the
+    // test transaction after initial setup. Hence we have to use this
+    // circumvent way of testing. Later we would want to fix ckb-x64-simulator
+    // so test data can be properly mutated, after that, we can switch
+    // to proptest for testing here.
+    rusty_fork_test! {
+        #[test]
+        fn test_any_data() {
+            let seed: u64 = match std::env::var("SEED") {
+                Ok(val) => str::parse(&val).expect("parsing number"),
+                Err(_) => std::time::SystemTime::now()
+                    .duration_since(std::time::SystemTime::UNIX_EPOCH)
+                    .unwrap()
+                    .as_nanos() as u64,
+            };
+            println!("Seed: {}", seed);
+
+            let mut rng = StdRng::seed_from_u64(seed);
+            let length = rng.gen_range(0..614400usize);
+            let data = {
+                let mut data = vec![0u8; length];
+                rng.fill(&mut data[..]);
+                data
+            };
+            let data_length = data.len();
+
+            let file = {
+                // Build a tx using data as a cell
+                let context = Context::default();
+                let tx = TransactionBuilder::default()
+                    .witness(data.pack())
+                    .build();
+
+                let mock_tx = context.dump_tx(&tx).expect("dump tx");
+
+                // Keep the tx in a temporary file, then set the environment
+                // variable for ckb-x64-simulator
+                let json = serde_json::to_string_pretty(&mock_tx).expect("json");
+                let mut file = tempfile::NamedTempFile::new().expect("tempfile");
+                file.write_all(json.as_ref()).expect("write");
+                file.flush().expect("flush");
+                std::env::set_var("CKB_TX_FILE", file.path());
+                file
+            };
+
+            assert_eq!(foo(), data_length);
+
+            drop(file);
+        }
+    }
+}