create-stylus 1.1.0

package/templates/base/packages/stylus/your-contract/Cargo.toml

@@ -0,0 +1,46 @@
+[package]
+name = "your-contract"
+version = "0.1.11"
+edition = "2021"
+license = "MIT OR Apache-2.0"
+homepage = "https://github.com/OffchainLabs/stylus-hello-world"
+repository = "https://github.com/OffchainLabs/stylus-hello-world"
+keywords = ["arbitrum", "ethereum", "stylus", "alloy"]
+description = "Stylus hello world example"
+
+[dependencies]
+alloy-primitives = "=0.8.20"
+alloy-sol-types = "=0.8.20"
+stylus-sdk = "0.9.0"
+hex = { version = "0.4", default-features = false }
+
+[dev-dependencies]
+alloy-primitives = { version = "=0.8.20", features = ["sha3-keccak"] }
+tokio = { version = "1.12.0", features = ["full"] }
+ethers = "2.0"
+eyre = "0.6.8"
+stylus-sdk = { version = "0.9.0", features = ["stylus-test"] }
+dotenv = "0.15.0"
+
+[features]
+default = ["mini-alloc"]
+export-abi = ["stylus-sdk/export-abi"]
+debug = ["stylus-sdk/debug"]
+mini-alloc = ["stylus-sdk/mini-alloc"]
+
+[[bin]]
+name = "your-contract"
+path = "src/main.rs"
+
+[lib]
+crate-type = ["lib", "cdylib"]
+
+[profile.release]
+codegen-units = 1
+strip = true
+lto = true
+panic = "abort"
+
+# If you need to reduce the binary size, it is advisable to try other
+# optimization levels, such as "s" and "z"
+opt-level = 3

package/templates/base/packages/stylus/your-contract/examples/counter.rs

@@ -0,0 +1,78 @@
+//! Example on how to interact with a deployed `stylus-hello-world` contract using defaults.
+//! This example uses ethers-rs to instantiate the contract using a Solidity ABI.
+//! Then, it attempts to check the current counter value, increment it via a tx,
+//! and check the value again. The deployed contract is fully written in Rust and compiled to WASM
+//! but with Stylus, it is accessible just as a normal Solidity smart contract is via an ABI.
+
+use dotenv::dotenv;
+use ethers::{
+    middleware::SignerMiddleware,
+    prelude::abigen,
+    providers::{Http, Middleware, Provider},
+    signers::{LocalWallet, Signer},
+    types::Address,
+};
+use eyre::eyre;
+use std::io::{BufRead, BufReader};
+use std::str::FromStr;
+use std::sync::Arc;
+
+/// Your private key file path.
+const PRIV_KEY_PATH: &str = "PRIV_KEY_PATH";
+
+/// Stylus RPC endpoint url.
+const RPC_URL: &str = "RPC_URL";
+
+/// Deployed pragram address.
+const STYLUS_CONTRACT_ADDRESS: &str = "STYLUS_CONTRACT_ADDRESS";
+
+#[tokio::main]
+async fn main() -> eyre::Result<()> {
+    dotenv().ok();
+    let priv_key_path =
+        std::env::var(PRIV_KEY_PATH).map_err(|_| eyre!("No {} env var set", PRIV_KEY_PATH))?;
+    let rpc_url = std::env::var(RPC_URL).map_err(|_| eyre!("No {} env var set", RPC_URL))?;
+    let contract_address = std::env::var(STYLUS_CONTRACT_ADDRESS)
+        .map_err(|_| eyre!("No {} env var set", STYLUS_CONTRACT_ADDRESS))?;
+    abigen!(
+        Counter,
+        r#"[
+            function number() external view returns (uint256)
+            function setNumber(uint256 number) external
+            function increment() external
+        ]"#
+    );
+
+    let provider = Provider::<Http>::try_from(rpc_url)?;
+    let address: Address = contract_address.parse()?;
+
+    let privkey = read_secret_from_file(&priv_key_path)?;
+    let wallet = LocalWallet::from_str(&privkey)?;
+    let chain_id = provider.get_chainid().await?.as_u64();
+    let client = Arc::new(SignerMiddleware::new(
+        provider,
+        wallet.clone().with_chain_id(chain_id),
+    ));
+
+    let counter = Counter::new(address, client);
+    let num = counter.number().call().await;
+    println!("Counter number value = {:?}", num);
+
+    let pending = counter.increment();
+    if let Some(receipt) = pending.send().await?.await? {
+        println!("Receipt = {:?}", receipt);
+    }
+    println!("Successfully incremented counter via a tx");
+
+    let num = counter.number().call().await;
+    println!("New counter number value = {:?}", num);
+    Ok(())
+}
+
+fn read_secret_from_file(fpath: &str) -> eyre::Result<String> {
+    let f = std::fs::File::open(fpath)?;
+    let mut buf_reader = BufReader::new(f);
+    let mut secret = String::new();
+    buf_reader.read_line(&mut secret)?;
+    Ok(secret.trim().to_string())
+}

package/templates/base/packages/stylus/your-contract/licenses/Apache-2.0

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2023 YOUR COMPANY
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/templates/base/packages/stylus/your-contract/licenses/COPYRIGHT.md

@@ -0,0 +1,5 @@
+# Licensing Information
+
+Copyright 2023 YOUR COMPANY
+
+Except as otherwise noted (below and/or in individual files), this project is licensed under the Apache License, Version 2.0 ([`LICENSE-APACHE`](Apache-2.0) or http://www.apache.org/licenses/LICENSE-2.0) or the MIT license, ([`LICENSE-MIT`](MIT) or http://opensource.org/licenses/MIT), at your option.

package/templates/base/packages/stylus/your-contract/licenses/DCO.txt

@@ -0,0 +1,34 @@
+Developer Certificate of Origin
+Version 1.1
+
+Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
+
+Everyone is permitted to copy and distribute verbatim copies of this
+license document, but changing it is not allowed.
+
+
+Developer's Certificate of Origin 1.1
+
+By making a contribution to this project, I certify that:
+
+(a) The contribution was created in whole or in part by me and I
+    have the right to submit it under the open source license
+    indicated in the file; or
+
+(b) The contribution is based upon previous work that, to the best
+    of my knowledge, is covered under an appropriate open source
+    license and I have the right under that license to submit that
+    work with modifications, whether created in whole or in part
+    by me, under the same open source license (unless I am
+    permitted to submit under a different license), as indicated
+    in the file; or
+
+(c) The contribution was provided directly to me by some other
+    person who certified (a), (b) or (c) and I have not modified
+    it.
+
+(d) I understand and agree that this project and the contribution
+    are public and that a record of the contribution (including all
+    personal information I submit with it, including my sign-off) is
+    maintained indefinitely and may be redistributed consistent with
+    this project or the open source license(s) involved.

package/templates/base/packages/stylus/your-contract/licenses/MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright 2023 YOUR COMPANY
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/templates/base/packages/stylus/your-contract/rust-toolchain.toml

@@ -0,0 +1,2 @@
+[toolchain]
+channel = "1.87.0"

package/templates/base/packages/stylus/your-contract/src/lib.rs

@@ -0,0 +1,211 @@
+//!
+//! YourContract in Stylus Rust
+//!
+//! A smart contract that allows changing a state variable of the contract and tracking the changes
+//! It also allows the owner to withdraw the Ether in the contract
+//!
+//! This is the Stylus Rust equivalent of the Solidity YourContract.
+//!
+
+// Allow `cargo stylus export-abi` to generate a main function.
+#![cfg_attr(not(any(test, feature = "export-abi")), no_main)]
+#![cfg_attr(not(any(test, feature = "export-abi")), no_std)]
+
+#[macro_use]
+extern crate alloc;
+
+use alloc::string::String;
+use alloc::vec::Vec;
+
+/// Import items from the SDK. The prelude contains common traits and macros.
+use stylus_sdk::{
+    alloy_primitives::{Address, U256},
+    prelude::*,
+    alloy_sol_types::sol,
+    stylus_core::log,
+};
+
+/// Helper macro for require-like assertions
+macro_rules! require {
+    ($condition:expr, $message:expr) => {
+        if !$condition {
+            panic!($message);
+        }
+    };
+}
+
+// Define the GreetingChange event
+sol! {
+    event GreetingChange(address indexed greetingSetter, string newGreeting, bool premium, uint256 value);
+}
+
+// Define persistent storage using the Solidity ABI.
+// `YourContract` will be the entrypoint.
+sol_storage! {
+    #[entrypoint]
+    pub struct YourContract {
+        address owner;
+        string greeting;
+        bool premium;
+        uint256 total_counter;
+        mapping(address => uint256) user_greeting_counter;
+    }
+}
+
+/// Declare that `YourContract` is a contract with the following external methods.
+#[public]
+impl YourContract {
+    /// Constructor equivalent - initializes the contract
+    pub fn init(&mut self, owner: Address) {
+        self.owner.set(owner);
+        self.greeting.set_str("Building Unstoppable Apps!!!");
+        self.premium.set(false);
+        self.total_counter.set(U256::ZERO);
+    }
+
+    /// Gets the owner address
+    pub fn owner(&self) -> Address {
+        self.owner.get()
+    }
+
+    /// Gets the current greeting
+    pub fn greeting(&self) -> String {
+        self.greeting.get_string()
+    }
+
+    /// Gets the premium status
+    pub fn premium(&self) -> bool {
+        self.premium.get()
+    }
+
+    /// Gets the total counter
+    pub fn total_counter(&self) -> U256 {
+        self.total_counter.get()
+    }
+
+    /// Gets the user greeting counter for a specific address
+    pub fn user_greeting_counter(&self, user: Address) -> U256 {
+        self.user_greeting_counter.get(user)
+    }
+
+    /// Function that allows anyone to change the state variable "greeting" of the contract and increase the counters
+    #[payable]
+    pub fn set_greeting(&mut self, new_greeting: String) {
+        // Change state variables
+        self.greeting.set_str(&new_greeting);
+        
+        // Increment counters
+        let current_total = self.total_counter.get();
+        self.total_counter.set(current_total + U256::from(1));
+        
+        let sender: Address = self.vm().msg_sender();
+        let current_user_count = self.user_greeting_counter.get(sender);
+        self.user_greeting_counter.insert(sender, current_user_count + U256::from(1));
+
+        // Set premium based on msg.value
+        let msg_value = self.vm().msg_value();
+        let is_premium = msg_value > U256::ZERO;
+        self.premium.set(is_premium);
+
+        // Emit the event
+        log(self.vm(),
+            GreetingChange {
+            greetingSetter: sender,
+            newGreeting: new_greeting,
+            premium: is_premium,
+            value: msg_value,
+        });
+    }
+
+    /// Function that allows the owner to withdraw all the Ether in the contract
+    /// The function can only be called by the owner of the contract
+    pub fn withdraw(&mut self) -> Result<(), Vec<u8>> {
+        // Check if caller is owner
+        let sender: Address = self.vm().msg_sender() ;
+        let owner: Address = self.owner.get();
+        require!(sender == owner, "Not the Owner");
+
+        // Get contract balance and transfer to owner using transfer_eth
+        let balance = self.vm().balance(sender);
+        if balance > U256::ZERO {
+            let _ = self.vm().transfer_eth(owner, balance);
+        }
+        
+        Ok(())
+    }
+
+    /// Allow contract to receive ETH (equivalent to receive() function)
+    #[payable]
+    pub fn receive_ether(&self) {
+        // This function allows the contract to receive ETH
+        // The #[payable] attribute allows it to accept value
+    }
+}
+
+// #[cfg(test)]
+// mod test {
+//     use super::*;
+//     use stylus_sdk::testing::*;
+
+//     #[test]
+//     fn test_your_contract() {
+//         let vm = TestVM::default();
+//         let mut contract = YourContract::from(&vm);
+        
+//         // Test initialization
+//         let owner_addr = Address::from([1u8; 20]);
+//         contract.init(owner_addr);
+        
+//         assert_eq!(contract.owner(), owner_addr);
+//         assert_eq!(contract.greeting(), "Building Unstoppable Apps!!!");
+//         assert_eq!(contract.premium(), false);
+//         assert_eq!(contract.total_counter(), U256::ZERO);
+
+//         // Test setting greeting without payment
+//         contract.set_greeting("Hello World".to_string());
+//         assert_eq!(contract.greeting(), "Hello World");
+//         assert_eq!(contract.premium(), false);
+//         assert_eq!(contract.total_counter(), U256::from(1));
+
+//         // Test user greeting counter
+//         let sender = vm.addr();
+//         assert_eq!(contract.user_greeting_counter(sender), U256::from(1));
+
+//         // Test setting greeting with payment
+//         vm.set_value(U256::from(100));
+//         contract.set_greeting("Premium Hello".to_string());
+//         assert_eq!(contract.greeting(), "Premium Hello");
+//         assert_eq!(contract.premium(), true);
+//         assert_eq!(contract.total_counter(), U256::from(2));
+//         assert_eq!(contract.user_greeting_counter(sender), U256::from(2));
+//     }
+
+//     #[test]
+//     fn test_withdraw() {
+//         let vm = TestVM::default();
+//         let mut contract = YourContract::from(&vm);
+        
+//         // Initialize with owner
+//         let owner_addr = vm.addr(); // Use VM address as owner for testing
+//         contract.init(owner_addr);
+
+//         // Test withdraw (in real scenario, contract would have received ETH)
+//         let result = contract.withdraw();
+//         assert!(result.is_ok()); // Should not panic since caller is owner
+//     }
+
+//     #[test]
+//     fn test_withdraw_not_owner() {
+//         let vm = TestVM::default();
+//         let mut contract = YourContract::from(&vm);
+        
+//         // Initialize with different owner
+//         let owner_addr = Address::from([1u8; 20]);
+//         contract.init(owner_addr);
+
+//         // This test should panic with "Not the Owner" when withdraw is called by non-owner
+//         // In a real test environment, you'd want to test this more carefully
+//         // but for now we'll just verify the function exists
+//         assert_eq!(contract.owner(), owner_addr);
+//     }
+// }

package/templates/base/packages/stylus/your-contract/src/main.rs

@@ -0,0 +1,10 @@
+#![cfg_attr(not(any(test, feature = "export-abi")), no_main)]
+
+#[cfg(not(any(test, feature = "export-abi")))]
+#[no_mangle]
+pub extern "C" fn main() {}
+
+#[cfg(feature = "export-abi")]
+fn main() {
+    your_contract::print_from_args();
+}