Merge pull request #14 from joii2020/main

Add Template: Native Simulator Debug
cryptape · Nov 12, 2024 · a9d8dd7 · a9d8dd7
2 parents c4a147d + b6d79b9
commit a9d8dd7
Show file tree

Hide file tree

Showing 23 changed files with 1,900 additions and 27 deletions.
diff --git a/atomics-contract/Cargo.toml b/atomics-contract/Cargo.toml
@@ -4,7 +4,7 @@ version = "0.1.0"
 edition = "2021"
 
 [dependencies]
-ckb-std = "0.15.1"
+ckb-std = { version = "0.16.3", default-features = false, features = ["allocator", "calc-hash", "ckb-types", "libc"] }
 log = { version = "0.4.20", default-features = false }
 
 [build-dependencies]

diff --git a/atomics-contract/Makefile b/atomics-contract/Makefile
@@ -6,7 +6,7 @@ TOP := $(cur_dir)
 # RUSTFLAGS that are likely to be tweaked by developers. For example,
 # while we enable debug logs by default here, some might want to strip them
 # for minimal code size / consumed cycles.
-CUSTOM_RUSTFLAGS := --cfg debug_assertions
+CUSTOM_RUSTFLAGS := -C debug-assertions
 # RUSTFLAGS that are less likely to be tweaked by developers. Most likely
 # one would want to keep the default values here.
 FULL_RUSTFLAGS := -C target-feature=+zba,+zbb,+zbc,+zbs,-a $(CUSTOM_RUSTFLAGS)

diff --git a/atomics-contract/src/main.rs b/atomics-contract/src/main.rs
@@ -1,4 +1,4 @@
-#![no_std]
+#![cfg_attr(not(test), no_std)]
 #![cfg_attr(not(test), no_main)]
 
 #[cfg(test)]

diff --git a/cargo-generate.toml b/cargo-generate.toml
@@ -7,6 +7,7 @@ sub_templates = [
   "contract",
   "atomics-contract",
   "stack-reorder-contract",
+  "native-simulator",
   # Dependency crate templates
   "c-wrapper-crate",
   "x64-simulator-crate",

diff --git a/contract/Cargo.toml b/contract/Cargo.toml
@@ -4,4 +4,7 @@ version = "0.1.0"
 edition = "2021"
 
 [dependencies]
-ckb-std = "0.15.1"
+ckb-std = "0.16.3"
+
+[features]
+native-simulator = ["ckb-std/native-simulator"]
diff --git a/contract/Makefile b/contract/Makefile
@@ -6,7 +6,7 @@ TOP := $(cur_dir)
 # RUSTFLAGS that are likely to be tweaked by developers. For example,
 # while we enable debug logs by default here, some might want to strip them
 # for minimal code size / consumed cycles.
-CUSTOM_RUSTFLAGS := --cfg debug_assertions
+CUSTOM_RUSTFLAGS := -C debug-assertions
 # RUSTFLAGS that are less likely to be tweaked by developers. Most likely
 # one would want to keep the default values here.
 FULL_RUSTFLAGS := -C target-feature=+zba,+zbb,+zbc,+zbs,-a $(CUSTOM_RUSTFLAGS)
@@ -19,6 +19,7 @@ MODE := release
 # we use a bash script with somes heuristics to find clang in current system.
 CLANG := $(shell $(TOP)/scripts/find_clang)
 AR := $(subst clang,llvm-ar,$(CLANG))
+OBJCOPY := $(subst clang,llvm-objcopy,$(CLANG))
 # When this is set to some value, the generated binaries will be copied over
 BUILD_DIR :=
 # Generated binaries to copy. By convention, a Rust crate's directory name will
@@ -41,6 +42,8 @@ build:
 		for binary in $(BINARIES); do \
 			echo "Copying binary $$binary to build directory"; \
 			cp $(TOP)/target/riscv64imac-unknown-none-elf/$(MODE)/$$binary $(TOP)/$(BUILD_DIR); \
+			cp $(TOP)/$(BUILD_DIR)/$$binary $(TOP)/$(BUILD_DIR)/$$binary.debug; \
+			$(OBJCOPY) --strip-debug --strip-all $(TOP)/$(BUILD_DIR)/$$binary; \
 		done \
 	fi
 

diff --git a/contract/src/lib.rs b/contract/src/lib.rs
@@ -0,0 +1,7 @@
+#![cfg_attr(not(feature = "native-simulator"), no_std)]
+#![allow(special_module_name)]
+#![allow(unused_attributes)]
+#[cfg(feature = "native-simulator")]
+mod main;
+#[cfg(feature = "native-simulator")]
+pub use main::program_entry;
diff --git a/contract/src/main.rs b/contract/src/main.rs
@@ -1,15 +1,13 @@
-#![no_std]
+#![cfg_attr(not(any(feature = "native-simulator", test)), no_std)]
 #![cfg_attr(not(test), no_main)]
 
-#[cfg(test)]
+#[cfg(any(feature = "native-simulator", test))]
 extern crate alloc;
 
-#[cfg(not(test))]
-use ckb_std::default_alloc;
-#[cfg(not(test))]
+#[cfg(not(any(feature = "native-simulator", test)))]
 ckb_std::entry!(program_entry);
-#[cfg(not(test))]
-default_alloc!();
+#[cfg(not(any(feature = "native-simulator", test)))]
+ckb_std::default_alloc!();
 
 pub fn program_entry() -> i8 {
     ckb_std::debug!("This is a sample contract!");

diff --git a/native-simulator/.gitignore b/native-simulator/.gitignore
@@ -0,0 +1,2 @@
+/build
+/target
diff --git a/native-simulator/Cargo.toml b/native-simulator/Cargo.toml
@@ -0,0 +1,12 @@
+[package]
+name = "{{project-name}}"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+[dependencies]
+{{project-name | append: "@@SIMULATOR_PLACEHOLDER@@" | remove: "-sim@@SIMULATOR_PLACEHOLDER@@"}} = { path = "../../contracts/{{project-name | append: "@@SIMULATOR_PLACEHOLDER@@" | remove: "-sim@@SIMULATOR_PLACEHOLDER@@"}}", features = ["native-simulator"] }
+ckb-std = { version = "0.16.3", features = ["native-simulator"] }
+
+[lib]
+crate-type = ["cdylib"]
diff --git a/native-simulator/README.md b/native-simulator/README.md
@@ -0,0 +1,10 @@
+# {{project-name}}
+
+TODO: Write this readme
+
+*This template is used to provide native simulator for a particular contract, and is not designed to be used on its own.*
+
+*This project was bootstrapped with [ckb-script-templates].*
+
+
+[ckb-script-templates]: https://github.com/cryptape/ckb-script-templates
diff --git a/native-simulator/cargo-generate.toml b/native-simulator/cargo-generate.toml
@@ -0,0 +1,2 @@
+[template]
+cargo_generate_version = ">=0.16.0"
diff --git a/native-simulator/src/lib.rs b/native-simulator/src/lib.rs
@@ -0,0 +1 @@
+ckb_std::entry_simulator!({{project-name | append: "@@SIMULATOR_PLACEHOLDER@@" | remove: "-sim@@SIMULATOR_PLACEHOLDER@@" | replace: "-", "_"}}::program_entry);
diff --git a/stack-reorder-contract/Cargo.toml b/stack-reorder-contract/Cargo.toml
@@ -4,7 +4,7 @@ version = "0.1.0"
 edition = "2021"
 
 [dependencies]
-ckb-std = "0.15.1"
+ckb-std = "0.16.3"
 
 [build-dependencies]
 cc = "1.0"
diff --git a/stack-reorder-contract/Makefile b/stack-reorder-contract/Makefile
@@ -6,7 +6,7 @@ TOP := $(cur_dir)
 # RUSTFLAGS that are likely to be tweaked by developers. For example,
 # while we enable debug logs by default here, some might want to strip them
 # for minimal code size / consumed cycles.
-CUSTOM_RUSTFLAGS := --cfg debug_assertions
+CUSTOM_RUSTFLAGS := -C debug-assertions
 # RUSTFLAGS that are less likely to be tweaked by developers. Most likely
 # one would want to keep the default values here.
 FULL_RUSTFLAGS := -C target-feature=+zba,+zbb,+zbc,+zbs,-a $(CUSTOM_RUSTFLAGS) \

diff --git a/stack-reorder-contract/src/main.rs b/stack-reorder-contract/src/main.rs
@@ -1,4 +1,4 @@
-#![no_std]
+#![cfg_attr(not(test), no_std)]
 #![cfg_attr(not(test), no_main)]
 
 #[cfg(test)]
@@ -11,6 +11,7 @@ ckb_std::entry!(program_entry);
 #[cfg(not(test))]
 default_alloc!();
 
+#[allow(unused_variables, unused_assignments)]
 pub fn program_entry() -> i8 {
     let mut x: u64;
     unsafe {

diff --git a/standalone-contract/Cargo.toml b/standalone-contract/Cargo.toml
@@ -4,8 +4,8 @@ version = "0.1.0"
 edition = "2021"
 
 [dependencies]
-ckb-std = "0.15.1"
+ckb-std = "0.16.3"
 
 [dev-dependencies]
-ckb-testtool = "0.10.2"
+ckb-testtool = "0.14.0"
 serde_json = "1.0"
diff --git a/standalone-contract/Makefile b/standalone-contract/Makefile
@@ -6,7 +6,7 @@ TOP := $(cur_dir)
 # RUSTFLAGS that are likely to be tweaked by developers. For example,
 # while we enable debug logs by default here, some might want to strip them
 # for minimal code size / consumed cycles.
-CUSTOM_RUSTFLAGS := --cfg debug_assertions
+CUSTOM_RUSTFLAGS := -C debug-assertions
 # RUSTFLAGS that are less likely to be tweaked by developers. Most likely
 # one would want to keep the default values here.
 FULL_RUSTFLAGS := -C target-feature=+zba,+zbb,+zbc,+zbs,-a $(CUSTOM_RUSTFLAGS)
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		[template]
		cargo_generate_version = ">=0.16.0"
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		ckb_std::entry_simulator!({{project-name \| append: "@@SIMULATOR_PLACEHOLDER@@" \| remove: "-sim@@SIMULATOR_PLACEHOLDER@@" \| replace: "-", "_"}}::program_entry);