create-stylus 0.1.0 → 0.1.1

package/templates/base/packages/stylus/counter/Cargo.toml

@@ -0,0 +1,46 @@
+[package]
+name = "stylus-hello-world"
+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 = "stylus-hello-world"
+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/counter/rust-toolchain.toml

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

package/templates/base/packages/stylus/counter/src/lib.rs

@@ -0,0 +1,121 @@
+//!
+//! Stylus Hello World
+//!
+//! The following contract implements the Counter example from Foundry.
+//!
+//! ```solidity
+//! contract Counter {
+//!     uint256 public number;
+//!     function setNumber(uint256 newNumber) public {
+//!         number = newNumber;
+//!     }
+//!     function increment() public {
+//!         number++;
+//!     }
+//! }
+//! ```
+//!
+//! The program is ABI-equivalent with Solidity, which means you can call it from both Solidity and Rust.
+//! To do this, run `cargo stylus export-abi`.
+//!
+//! Note: this code is a template-only and has not been audited.
+//!
+// 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::vec::Vec;
+
+/// Import items from the SDK. The prelude contains common traits and macros.
+use stylus_sdk::{alloy_primitives::U256, prelude::*};
+
+// Define some persistent storage using the Solidity ABI.
+// `Counter` will be the entrypoint.
+sol_storage! {
+    #[entrypoint]
+    pub struct Counter {
+        uint256 number;
+        bool is_initialized;
+    }
+}
+
+/// Declare that `Counter` is a contract with the following external methods.
+#[public]
+impl Counter {
+    pub fn initialize(&mut self, initial_number: U256) {
+        if !self.is_initialized.get() {
+            self.number.set(initial_number);
+            self.is_initialized.set(true);
+        } else {
+            panic!("Counter already initialized");
+        }
+    }
+
+    /// Gets the number from storage.
+    pub fn number(&self) -> U256 {
+        self.number.get()
+    }
+
+    /// Sets a number in storage to a user-specified value.
+    pub fn set_number(&mut self, new_number: U256) {
+        self.number.set(new_number);
+    }
+
+    /// Sets a number in storage to a user-specified value.
+    pub fn mul_number(&mut self, new_number: U256) {
+        self.number.set(new_number * self.number.get());
+    }
+
+    /// Sets a number in storage to a user-specified value.
+    pub fn add_number(&mut self, new_number: U256) {
+        self.number.set(new_number + self.number.get());
+    }
+
+    /// Increments `number` and updates its value in storage.
+    pub fn increment(&mut self) {
+        let number = self.number.get();
+        self.set_number(number + U256::from(1));
+    }
+
+    /// Adds the wei value from msg_value to the number in storage.
+    #[payable]
+    pub fn add_from_msg_value(&mut self) {
+        let number = self.number.get();
+        self.set_number(number + self.vm().msg_value());
+    }
+}
+
+#[cfg(test)]
+mod test {
+    use super::*;
+
+    #[test]
+    fn test_counter() {
+        use stylus_sdk::testing::*;
+        let vm = TestVM::default();
+        let mut contract = Counter::from(&vm);
+
+        assert_eq!(U256::ZERO, contract.number());
+
+        contract.increment();
+        assert_eq!(U256::from(1), contract.number());
+
+        contract.add_number(U256::from(3));
+        assert_eq!(U256::from(4), contract.number());
+
+        contract.mul_number(U256::from(2));
+        assert_eq!(U256::from(8), contract.number());
+
+        contract.set_number(U256::from(100));
+        assert_eq!(U256::from(100), contract.number());
+
+        // Override the msg value for future contract method invocations.
+        vm.set_value(U256::from(2));
+
+        contract.add_from_msg_value();
+        assert_eq!(U256::from(102), contract.number());
+    }
+}

package/templates/base/packages/stylus/counter/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() {
+    stylus_hello_world::print_from_args();
+}

package/templates/base/packages/stylus/scripts/deploy.ts

@@ -32,7 +32,15 @@ export default async function deployScript(deployOptions: DeployOptions) {
     ...deployOptions,
   });
 
-  /// Deploy your contract with a custom name
+  // EXAMPLE: Deploy to Orbit Chains, uncomment to try
+  // await deployStylusContract({
+  //   contract: "counter",
+  //   constructorArgs: [100],
+  //   isOrbit: true,
+  //   ...deployOptions,
+  // });
+
+  // EXAMPLE: Deploy your contract with a custom name, uncomment to try
   // await deployStylusContract({
   //   contract: "your-contract",
   //   constructorArgs: [config.deployerAddress],

package/templates/base/packages/stylus/scripts/deploy_contract.ts

@@ -4,11 +4,17 @@ import {
   executeCommand,
   extractDeploymentInfo,
   saveDeployment,
+  ORBIT_CHAINS,
   // estimateGasPrice,
 } from "./utils/";
 import { exportStylusAbi } from "./export_abi";
 import { DeployOptions } from "./utils/type";
 import { buildDeployCommand } from "./utils/command";
+import { Chain, createPublicClient, createWalletClient, http } from "viem";
+import { privateKeyToAccount } from "viem/accounts";
+
+import { arbitrumNitro } from "../../nextjs/utils/scaffold-stylus/supportedChains";
+import deployedContracts from "../../nextjs/contracts/deployedContracts";
 
 /**
  * Deploy a single contract using cargo stylus
@@ -61,6 +67,48 @@ export default async function deployStylusContract(
       config.chain?.id,
     );
 
+    // Call the initialize function if orbit deployment
+    if (
+      !!deployOptions.isOrbit &&
+      config.chain?.id !== arbitrumNitro?.id.toString()
+    ) {
+      const orbitChain = ORBIT_CHAINS.find(
+        (chain) => chain.id.toString() === config.chain?.id,
+      );
+
+      if (!orbitChain) {
+        throw new Error(
+          `Chain ${config.chain?.id} is not supported for orbit deployment`,
+        );
+      }
+
+      const publicClient = createPublicClient({
+        chain: orbitChain as unknown as Chain,
+        transport: http(),
+      });
+
+      // need wallet client to sign the transaction
+      const walletClient = createWalletClient({
+        chain: orbitChain as unknown as Chain,
+        transport: http(),
+      });
+
+      const account = privateKeyToAccount(config.privateKey as `0x${string}`);
+
+      const { request } = await publicClient.simulateContract({
+        account,
+        address: deploymentInfo.address,
+        // @ts-expect-error deployed contract is empty at the beginning
+        abi: deployedContracts[config.chain.id][config.contractName].abi,
+        functionName: "initialize",
+        args: deployOptions.constructorArgs,
+      });
+
+      const initTxHash = await walletClient.writeContract(request);
+
+      console.log("Initialize transaction hash: ", initTxHash);
+    }
+
     // Step 3: Verify the contract
     if (deployOptions.verify) {
       try {

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

@@ -22,7 +22,8 @@ export async function buildDeployCommand(
 
   if (
     deployOptions.constructorArgs &&
-    deployOptions.constructorArgs.length > 0
+    deployOptions.constructorArgs.length > 0 &&
+    !deployOptions.isOrbit
   ) {
     baseCommand += ` --constructor-args ${deployOptions.constructorArgs.map((arg) => `"${arg}"`).join(" ")} `;
   }

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

@@ -154,9 +154,7 @@ export async function generateTsAbi(
   };
 
   let deployedContractsObj: any = {};
-  const fileHeader =
-    generatedContractComment +
-    'import { GenericContractsDeclaration } from "~~/utils/scaffold-eth/contract";\n\n';
+  const fileHeader = generatedContractComment + "\n\n";
 
   if (fs.existsSync(TARGET_FILE)) {
     const fileContent = fs.readFileSync(TARGET_FILE, "utf8");
@@ -177,7 +175,7 @@ export async function generateTsAbi(
 
   const contractsString = JSON.stringify(deployedContractsObj, null, 2);
 
-  const output = `${fileHeader}const deployedContracts = ${contractsString} as const;\n\nexport default deployedContracts satisfies GenericContractsDeclaration;\n`;
+  const output = `${fileHeader}const deployedContracts = ${contractsString} as const;\n\nexport default deployedContracts;\n`;
 
   if (!fs.existsSync(TARGET_DIR)) {
     fs.mkdirSync(TARGET_DIR);

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/readme.md

@@ -194,7 +194,7 @@ 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>