setup-stylus-contracts

Stylus Setup

Rust & Cargo Stylus Setup

Install the Rust toolchain and WASM target:

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
rustup target add wasm32-unknown-unknown

Install the Cargo Stylus CLI:

cargo install

Create a new Stylus project:

A Rust nightly toolchain is required. The project should include a rust-toolchain.toml specifying the nightly channel, rust-src component, and wasm32-unknown-unknown target. Check the rust-contracts-stylus repo for the current recommended nightly date.

Adding OpenZeppelin Dependencies

Look up the current version from crates.io/crates/openzeppelin-stylus before adding. Add to Cargo.toml:

Enable the export-abi feature flag for ABI generation:

The crate must be compiled as both a library and a cdylib:

Import Conventions

Imports use openzeppelin_stylus (underscores) as the crate root:

Contracts use #[storage] and #[entrypoint] on the main struct, embedding OpenZeppelin components as fields:

Public methods are exposed with #[public] and #[implements(...)]. The canonical pattern uses an empty impl block for dispatch registration, plus separate trait impl blocks:

Top-level modules: access, finance, proxy, token, utils.

Build & Deploy Basics

Validate the contract compiles to valid Stylus WASM:

Export the Solidity ABI:

Deploy to an Arbitrum Stylus endpoint: