Template for workspace project (#309)

* Added template for workspace project.
To avoid name collisions of bins in workspace, bins had to be prepended
with project name.
Rewritten modules to fit changes to core.

* Fixed contract template

examples2/Cargo.toml

@@ -7,12 +7,12 @@ edition = "2021"
 odra = { path = "../odra" }
 
 [[bin]]
-name = "build_contract"
+name = "examples2_build_contract"
 path = "bin/build_contract.rs"
 test = false
 
 [[bin]]
-name = "build_schema"
+name = "examples2_build_schema"
 path = "bin/build_schema.rs"
 test = false
 

modules/Cargo.toml

@@ -15,12 +15,12 @@ casper-event-standard = "0.4.1"
 hex = { version = "0.4.3", default-features = false }
 
 [[bin]]
-name = "build_contract"
+name = "odra_modules_build_contract"
 path = "bin/build_contract.rs"
 test = false
 
 [[bin]]
-name = "build_schema"
+name = "odra_modules_build_schema"
 path = "bin/build_schema.rs"
 test = false
 

modules/src/access/ownable.rs

@@ -171,8 +171,8 @@ mod test {
             new_owner: Some(deployer)
         };
 
-        env.emitted_event(&ownable.address, &event);
-        env.emitted_event(&ownable_2step.address, &event);
+        env.emitted_event(&ownable.address(), &event);
+        env.emitted_event(&ownable_2step.address(), &event);
     }
 
     #[test]
@@ -181,14 +181,14 @@ mod test {
         let (mut contract, initial_owner) = setup_ownable();
 
         // when the current owner transfers ownership
-        let new_owner = contract.env.get_account(1);
+        let new_owner = contract.env().get_account(1);
         contract.transfer_ownership(new_owner);
 
         // then the new owner is set
         assert_eq!(new_owner, contract.get_owner());
         // then a OwnershipTransferred event was emitted
-        contract.env.emitted_event(
-            &contract.address,
+        contract.env().emitted_event(
+            &contract.address(),
             &OwnershipTransferred {
                 previous_owner: Some(initial_owner),
                 new_owner: Some(new_owner)
@@ -202,27 +202,27 @@ mod test {
         let (mut contract, initial_owner) = setup_ownable_2_step();
 
         // when the current owner transfers ownership
-        let new_owner = contract.env.get_account(1);
+        let new_owner = contract.env().get_account(1);
         contract.transfer_ownership(new_owner);
 
         // when the pending owner accepts the transfer
-        contract.env.set_caller(new_owner);
+        contract.env().set_caller(new_owner);
         contract.accept_ownership();
 
         // then the new owner is set
         assert_eq!(new_owner, contract.get_owner());
         // then the pending owner is unset
         assert_eq!(None, contract.get_pending_owner());
         // then OwnershipTransferStarted and OwnershipTransferred events were emitted
-        contract.env.emitted_event(
-            &contract.address,
+        contract.env().emitted_event(
+            &contract.address(),
             &OwnershipTransferStarted {
                 previous_owner: Some(initial_owner),
                 new_owner: Some(new_owner)
             }
         );
-        contract.env.emitted_event(
-            &contract.address,
+        contract.env().emitted_event(
+            &contract.address(),
             &OwnershipTransferred {
                 previous_owner: Some(initial_owner),
                 new_owner: Some(new_owner)
@@ -236,8 +236,8 @@ mod test {
         let (mut contract, _) = setup_ownable();
 
         // when a non-owner account is the caller
-        let (caller, new_owner) = (contract.env.get_account(1), contract.env.get_account(2));
-        contract.env.set_caller(caller);
+        let (caller, new_owner) = (contract.env().get_account(1), contract.env().get_account(2));
+        contract.env().set_caller(caller);
 
         // then ownership transfer fails
         let err = contract.try_transfer_ownership(new_owner).unwrap_err();
@@ -250,15 +250,15 @@ mod test {
         let (mut contract, initial_owner) = setup_ownable_2_step();
 
         // when a non-owner account is the caller
-        let (caller, new_owner) = (contract.env.get_account(1), contract.env.get_account(2));
-        contract.env.set_caller(caller);
+        let (caller, new_owner) = (contract.env().get_account(1), contract.env().get_account(2));
+        contract.env().set_caller(caller);
 
         // then ownership transfer fails
         let err = contract.try_transfer_ownership(new_owner).unwrap_err();
         assert_eq!(err, CallerNotTheOwner.into());
 
         // when the owner is the caller
-        contract.env.set_caller(initial_owner);
+        contract.env().set_caller(initial_owner);
         contract.transfer_ownership(new_owner);
 
         // then the pending owner is set
@@ -287,8 +287,8 @@ mod test {
                 contract.renounce_ownership();
 
                 // then an event is emitted
-                contract.env.emitted_event(
-                    &contract.address,
+                contract.env().emitted_event(
+                    &contract.address(),
                     &OwnershipTransferred {
                         previous_owner: Some(initial_owner),
                         new_owner: None
@@ -310,8 +310,8 @@ mod test {
 
         contracts.iter_mut().for_each(|contract| {
             // when a non-owner account is the caller
-            let caller = contract.env.get_account(1);
-            contract.env.set_caller(caller);
+            let caller = contract.env().get_account(1);
+            contract.env().set_caller(caller);
 
             // then renounce ownership fails
             let err = contract.try_renounce_ownership().unwrap_err();
@@ -344,19 +344,11 @@ mod test {
         let env = odra::test_env();
         let ownable = OwnableDeployer::init(&env);
         let ownable_2_step = Ownable2StepDeployer::init(&env);
+        let renouncable_ref = RenounceableHostRef::new(*ownable.address(), env.clone());
+        let renouncable_2_step_ref =
+            RenounceableHostRef::new(*ownable_2_step.address(), env.clone());
         (
-            vec![
-                RenounceableHostRef {
-                    address: ownable.address,
-                    env: env.clone(),
-                    attached_value: Default::default()
-                },
-                RenounceableHostRef {
-                    address: ownable_2_step.address,
-                    env: env.clone(),
-                    attached_value: Default::default()
-                },
-            ],
+            vec![renouncable_ref, renouncable_2_step_ref],
             env.get_account(0)
         )
     }

templates/blank/Cargo.toml

@@ -7,12 +7,12 @@ edition = "2021"
 #odra_dependency
 
 [[bin]]
-name = "build_contract"
+name = "{{project-name}}_build_contract"
 path = "bin/build_contract.rs"
 test = false
 
 [[bin]]
-name = "build_schema"
+name = "{{project_name}}_build_schema"
 path = "bin/build_schema.rs"
 test = false
 

templates/blank/Odra.toml

@@ -1,3 +1,3 @@
 #[[contracts]]
-#name = "mycontract"
+#name = "Mycontract"
 #fqn = "{{project-name}}::Mycontract"

templates/blank/README.md

@@ -1,7 +1,7 @@
 # {{project-name}}
 
 ## Usage
-It's recommend to install 
+It's recommended to install 
 [cargo-odra](https://github.com/odradev/cargo-odra) first.
 
 ### Build

templates/full/Cargo.toml

@@ -7,12 +7,12 @@ edition = "2021"
 #odra_dependency
 
 [[bin]]
-name = "build_contract"
+name = "{{project-name}}_build_contract"
 path = "bin/build_contract.rs"
 test = false
 
 [[bin]]
-name = "build_schema"
+name = "{{project-name}}_build_schema"
 path = "bin/build_schema.rs"
 test = false
 

templates/full/Odra.toml

@@ -1,3 +1,3 @@
 [[contracts]]
-name = "flipper"
+name = "Flipper"
 fqn = "{{project-name}}::Flipper"

templates/full/README.md

@@ -1,7 +1,7 @@
 # {{project-name}}
 
 ## Usage
-It's recommend to install 
+It's recommended to install 
 [cargo-odra](https://github.com/odradev/cargo-odra) first.
 
 ### Build

templates/full/src/flipper.rs

@@ -18,7 +18,7 @@ pub struct Flipper {
 impl Flipper {
     /// Odra constructor.
     /// 
-    /// Initializes the contract with the value of value.
+    /// Initializes the contract.
     pub fn init(&mut self) {
         self.value.set(false);
     }

templates/module.rs.template

@@ -1,18 +1,23 @@
 use odra::prelude::*;
-use odra::{Module, Variable, ContractEnv};
+use odra::Variable;
 
-/// A #module_name module storage definition.
+/// A module definition. Each module struct consists Variables and Mappings
+/// or/and another modules.
 #[odra::module]
 pub struct #module_name {
-    env: Rc<ContractEnv>,
+    /// The module itself does not store the value,
+    /// it's a proxy that writes/reads value to/from the host.
     value: Variable<bool>,
 }
 
-/// Module entrypoints implementation.
+/// Module implementation.
+///
+/// To generate entrypoints,
+/// an implementation block must be marked as #[odra::module].
 #[odra::module]
 impl #module_name {
     /// #module_name constructor.
-    /// Initializes the contract with the value of value.
+    /// Initializes the contract.
     pub fn init(&mut self) {
         self.value.set(false);
     }

templates/workspace/.gitignore

@@ -0,0 +1 @@
+/target

templates/workspace/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+Changelog for `{{project-name}}`.
+
+## [0.1.0] - {{date}}
+### Added
+- `flipper` module.
+- `flapper` module.

templates/workspace/Cargo.toml

@@ -0,0 +1,16 @@
+[workspace]
+members = [
+    "flipper",
+    "flapper",
+    ]
+resolver = "2"
+
+[workspace.dependencies]
+#odra_dependency
+
+[profile.release]
+codegen-units = 1
+lto = true
+
+[profile.dev.package."*"]
+opt-level = 3

templates/workspace/Odra.toml

@@ -0,0 +1,7 @@
+[[contracts]]
+name = "Flipper"
+fqn = "flipper::Flipper"
+
+[[contracts]]
+name = "Flapper"
+fqn = "flapper::Flapper"

templates/workspace/README.md

@@ -0,0 +1,31 @@
+# {{project-name}}
+
+## Usage
+It's recommended to install 
+[cargo-odra](https://github.com/odradev/cargo-odra) first.
+
+### Build
+
+```
+$ cargo odra build
+```
+To build a wasm file, you need to pass the -b parameter. 
+The result files will be placed in `${project-root}/wasm` directory.
+
+```
+$ cargo odra build -b casper
+```
+
+### Test
+To run test on your local machine, you can basically execute the command:
+
+```
+$ cargo odra test
+```
+
+To test actual wasm files against a backend, 
+you need to specify the backend passing -b argument to `cargo-odra`.
+
+```
+$ cargo odra test -b casper
+```

templates/workspace/flapper/.gitignore

@@ -0,0 +1,7 @@
+.idea
+.vscode
+/target
+Cargo.lock
+.backend*
+.builder*
+/wasm

templates/workspace/flapper/Cargo.toml

@@ -0,0 +1,17 @@
+[package]
+name = "flapper"
+version = "0.1.0"
+edition = "2021"
+
+[dependencies]
+odra = { workspace = true }
+
+[[bin]]
+name = "flapper_build_contract"
+path = "bin/build_contract.rs"
+test = false
+
+[[bin]]
+name = "flapper_build_schema"
+path = "bin/build_schema.rs"
+test = false

templates/workspace/flapper/bin/build_contract.rs

@@ -0,0 +1,4 @@
+#![no_std]
+#![no_main]
+#![allow(unused_imports, clippy::single_component_path_imports)]
+use flapper;

templates/workspace/flapper/bin/build_schema.rs

@@ -0,0 +1,10 @@
+use odra::contract_def::ContractBlueprint;
+
+extern "Rust" {
+    fn module_schema() -> ContractBlueprint;
+}
+
+fn main() {
+    let schema = unsafe { module_schema() };
+    println!("{:#?}", schema);
+}

templates/workspace/flapper/build.rs

@@ -0,0 +1,8 @@
+use std::env;
+
+pub fn main() {
+    println!("cargo:rerun-if-env-changed=ODRA_MODULE");
+    let module = env::var("ODRA_MODULE").unwrap_or_else(|_| "".to_string());
+    let msg = format!("cargo:rustc-cfg=odra_module=\"{}\"", module);
+    println!("{}", msg);
+}