mcpField
S
setup-stylus-contracts

setup-stylus-contracts

github.com/openzeppelinDevelopment219213 installsUpdated 2d ago
Repository

About setup-stylus-contracts

A setup guide for Rust developers building Arbitrum Stylus contracts, covering the toolchain, OpenZeppelin dependencies, contract conventions, and build and deployment steps.

Key features

  1. 01Install Rust, WASM target, and cargo-stylus
  2. 02Configure OpenZeppelin Stylus dependencies
  3. 03Follow contract import and interface patterns
  4. 04Check contracts, export ABI, and deploy

Use cases

  1. 01Start a new Stylus contract project
  2. 02Add OpenZeppelin components to a contract
  3. 03Check WASM compilation and export an ABI
  4. 04Deploy a contract to Arbitrum Stylus

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/openzeppelin/openzeppelin-skills --skill setup-stylus-contracts

After installing, type/setup-stylus-contractsin Claude Code to confirm it loaded.

Details

From the project README

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 --force cargo-stylus

Create a new Stylus project:

cargo stylus new my_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:

[dependencies]
openzeppelin-stylus = "=<VERSION>"

Enable the export-abi feature flag for ABI generation:

[features]
export-abi = ["openzeppelin-stylus/export-abi"]

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

[lib]
crate-type = ["lib", "cdylib"]

Import Conventions

Imports use openzeppelin_stylus (underscores) as the crate root:

use openzeppelin_stylus::token::erc20::{Erc20, IErc20};
use openzeppelin_stylus::access::ownable::{Ownable, IOwnable};
use openzeppelin_stylus::utils::pausable::{Pausable, IPausable};
use openzeppelin_stylus::utils::introspection::erc165::IErc165;

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

#[entrypoint]
#[storage]
struct MyToken {
    erc20: Erc20,
    ownable: Ownable,
}

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

#[public]
#[implements(IErc20<Error = erc20::Error>, IOwnable<Error = ownable::Error>)]
impl MyToken {}

#[public]
impl IErc20 for MyToken {
    type Error = erc20::Error;
    // delegate to self.erc20 ...
}

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

Build & Deploy Basics

Validate the contract compiles to valid Stylus WASM:

cargo stylus check

Export the Solidity ABI:

cargo stylus export-abi

Deploy to an Arbitrum Stylus endpoint:

cargo stylus deploy --endpoint="<RPC_URL>" --private-key-path="<KEY_FILE>"

Comments

Markdown supported