create-stylus 0.0.6 → 0.1.1

package/templates/base/packages/stylus/scripts/utils/network.ts

@@ -1,6 +1,12 @@
 import { arbitrum, arbitrumNova, arbitrumSepolia } from "viem/chains";
 import { Address, Chain } from "viem";
-import { arbitrumNitro } from "../../../nextjs/utils/scaffold-stylus/supportedChains";
+import {
+  arbitrumNitro,
+  superposition,
+  eduChainTestnet,
+  superpositionTestnet,
+  eduChain,
+} from "../../../nextjs/utils/scaffold-stylus/supportedChains";
 import * as path from "path";
 import * as fs from "fs";
 import { config as dotenvConfig } from "dotenv";
@@ -16,6 +22,10 @@ export const SUPPORTED_NETWORKS: Record<string, Chain> = {
   arbitrumSepolia,
   arbitrumNitro: arbitrumNitro as Chain,
   arbitrumNova: arbitrumNova as Chain,
+  eduChainTestnet: eduChainTestnet as unknown as Chain,
+  eduChain: eduChain as unknown as Chain,
+  superposition: superposition as Chain,
+  superpositionTestnet: superpositionTestnet as Chain,
 };
 
 export const ALIASES: Record<string, string> = {
@@ -23,8 +33,20 @@ export const ALIASES: Record<string, string> = {
   sepolia: "arbitrumSepolia",
   devnet: "arbitrumNitro",
   nova: "arbitrumNova",
+  educhain_testnet: "educhainTestnet",
+  educhain: "eduChain",
+  superposition: "superposition",
+  superposition_testnet: "superpositionTestnet",
 };
 
+// TODO: add more compatible Orbit Chains here
+export const ORBIT_CHAINS: Chain[] = [
+  eduChain as unknown as Chain,
+  eduChainTestnet as unknown as Chain,
+  superposition as Chain,
+  superpositionTestnet as Chain,
+];
+
 export function getChain(networkName: string): SupportedNetworkMinimal | null {
   try {
     const actualNetworkName = ALIASES[networkName.toLowerCase()] || networkName;
@@ -75,6 +97,30 @@ export function getPrivateKey(networkName: string): string {
       } else {
         throw new Error("PRIVATE_KEY_NOVA is not set");
       }
+    case "educhaintestnet":
+      if (process.env["PRIVATE_KEY_EDUCHAIN_TESTNET"]) {
+        return process.env["PRIVATE_KEY_EDUCHAIN_TESTNET"];
+      } else {
+        throw new Error("PRIVATE_KEY_EDUCHAIN_TESTNET is not set");
+      }
+    case "educhain":
+      if (process.env["PRIVATE_KEY_EDUCHAIN"]) {
+        return process.env["PRIVATE_KEY_EDUCHAIN"];
+      } else {
+        throw new Error("PRIVATE_KEY_EDUCHAIN is not set");
+      }
+    case "superposition":
+      if (process.env["PRIVATE_KEY_SUPERPOSITION"]) {
+        return process.env["PRIVATE_KEY_SUPERPOSITION"];
+      } else {
+        throw new Error("PRIVATE_KEY_SUPERPOSITION is not set");
+      }
+    case "superpositiontestnet":
+      if (process.env["PRIVATE_KEY_SUPERPOSITION_TESTNET"]) {
+        return process.env["PRIVATE_KEY_SUPERPOSITION_TESTNET"];
+      } else {
+        throw new Error("PRIVATE_KEY_SUPERPOSITION_TESTNET is not set");
+      }
     default:
       return (
         process.env["PRIVATE_KEY"] ||
@@ -92,6 +138,14 @@ export const getAccountAddress = (networkName: string): Address | undefined => {
       return process.env["ACCOUNT_ADDRESS_SEPOLIA"] as Address;
     case "arbitrumnova":
       return process.env["ACCOUNT_ADDRESS_NOVA"] as Address;
+    case "educhaintestnet":
+      return process.env["ACCOUNT_ADDRESS_EDUCHAIN_TESTNET"] as Address;
+    case "educhain":
+      return process.env["ACCOUNT_ADDRESS_EDUCHAIN"] as Address;
+    case "superposition":
+      return process.env["ACCOUNT_ADDRESS_SUPERPOSITION"] as Address;
+    case "superpositiontestnet":
+      return process.env["ACCOUNT_ADDRESS_SUPERPOSITION_TESTNET"] as Address;
     default:
       return (
         (process.env["ACCOUNT_ADDRESS"] as Address) ||
@@ -118,6 +172,26 @@ function getRpcUrlFromChain(chain: Chain): string {
         return process.env["RPC_URL_NOVA"];
       }
       break;
+    case eduChainTestnet.id:
+      if (process.env["RPC_URL_EDUCHAIN_TESTNET"]) {
+        return process.env["RPC_URL_EDUCHAIN_TESTNET"];
+      }
+      break;
+    case eduChain.id:
+      if (process.env["RPC_URL_EDUCHAIN"]) {
+        return process.env["RPC_URL_EDUCHAIN"];
+      }
+      break;
+    case superposition.id:
+      if (process.env["RPC_URL_SUPERPOSITION"]) {
+        return process.env["RPC_URL_SUPERPOSITION"];
+      }
+      break;
+    case superpositionTestnet.id:
+      if (process.env["RPC_URL_SUPERPOSITION_TESTNET"]) {
+        return process.env["RPC_URL_SUPERPOSITION_TESTNET"];
+      }
+      break;
     default:
       if (process.env["RPC_URL"]) {
         return process.env["RPC_URL"];

package/templates/base/packages/stylus/scripts/utils/type.ts

@@ -18,6 +18,7 @@ export interface DeployOptions {
   estimateGas?: boolean;
   maxFee?: string;
   verify?: boolean;
+  isOrbit?: boolean;
 }
 
 export interface DeploymentData {

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

@@ -13,7 +13,7 @@ alloy-primitives = "=0.8.20"
 alloy-sol-types = "=0.8.20"
 stylus-sdk = "0.9.0"
 hex = { version = "0.4", default-features = false }
-openzeppelin-stylus = "0.2.0"
+openzeppelin-stylus = "=0.2.0"
 
 [dev-dependencies]
 alloy-primitives = { version = "=0.8.20", features = ["sha3-keccak"] }

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

@@ -1,2 +1,8 @@
+# NOTE: this toolchain is nightly because of openzeppelin requirements
+
 [toolchain]
-channel = "1.87.0"
+# We should use stable here once nitro-testnode is updated and the contracts fit
+# the size limit (issue <https://github.com/OpenZeppelin/rust-contracts-stylus/issues/129>).
+channel = "1.89.0"
+components = ["rust-src", "rustfmt", "clippy"]
+targets = ["wasm32-unknown-unknown"]

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

@@ -170,70 +170,46 @@ impl IOwnable for YourContract {
     }
 }
 
-// #[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);
-//     }
-// }
+#[cfg(test)]
+mod test {
+    use super::*;
+    use stylus_sdk::testing::*;
+
+    #[no_mangle]
+    pub unsafe extern "C" fn emit_log(_pointer: *const u8, _len: usize, _: usize) {}
+    #[no_mangle]
+    pub unsafe extern "C" fn msg_sender(_sender: *mut u8) {}
+
+    #[test]
+    fn test_your_contract() {
+        let vm = TestVM::default();
+        let mut contract = YourContract::from(&vm);
+
+        // Test initialization
+        let owner_addr = Address::from([1u8; 20]);
+        let _ = contract.constructor(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.msg_sender();
+        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));
+    }
+}

package/templates/base/readme.md

@@ -189,12 +189,12 @@ To deploy your contracts to other networks (other than the default local Nitro d
 This template supports Arbitrum networks only. You can test which networks are available and their RPC URLs:
 
 ```bash
-yarn test:networks
+yarn info:networks
 ```
 
 This will show you all supported networks and their corresponding RPC endpoints.
 
-### Deploy to Other Network
+### Deploy to Other Network (Non-Orbit Chains)
 
 Once configured, deploy to your target network:
 
@@ -208,6 +208,14 @@ yarn deploy --network <network>
 - **Always keep your private key secure and never commit it to version control**
 - Consider using environment variable management tools for production deployments
 
+### Deploy to Orbit Chains
+
+Before deploying, you would have to ensure that your `deployStylusContract` function on your `deploy.ts` function has the `isOrbit` value set to `true` (example provided in `deploy.ts`).
+
+Your contract must have an `initialize()` function as the replacement for the constructor, since not all orbit chains support the constructor feature. Please leave it blank if you don't have any constructor.
+
+> Make sure you handle initialization properly in your contract, meaning it should only be called once and functions should not run if contract is not initialized.
+
 ## Verify your contract (Highly Experimental)
 
 <details>