🦀 rustmate

Blazing fast, modern, and optimized Rust building blocks for smart contract development using Stylus.

This is experimental software and is provided on an "as is" and "as available" basis. We do not give any warranties and will not be liable for any losses incurred through any use of this code base.

📜 Contracts

auth
├─ Owned — "Simple single owner authorization"
├─ Auth — "Flexible and updatable auth pattern"
mixins
├─ ERC4626 — "Minimal ERC4626 tokenized Vault implementation"
tokens
├─ WETH — "Minimalist and modern Wrapped Ether implementation"
├─ ERC20 — "Modern and gas efficient ERC20 + EIP-2612 implementation"
├─ ERC721 — "Modern, minimalist, and gas efficient ERC721 implementation"
├─ ERC1155 — "Minimalist and gas efficient standard ERC1155 implementation"
├─ ERC6909 — "Minimalist and gas efficient standard ERC6909 implementation"
utils
├─ CREATE3 — "Deploy to deterministic addresses without an initcode factor"
├─ Bytes32Address — "Library for converting between addresses and bytes32 values"

🔧 How to use

First, install the Stylus SDK for Rust and create a new project:

cargo stylus new my-project --minimal

Then, install rustmate:

cargo install rustmate

Import the contracts you want to use:

use rustmate::tokens::erc20::{ERC20, ERC20Params};

✅ Gas benchmarks

🧪 Results

👷 How to replicate

Install Python and Rust, and then install the Stylus CLI tool with Cargo:

RUSTFLAGS="-C link-args=-rdynamic" cargo install --force cargo-stylus

Add the wasm32-unknown-unknown build target to your Rust compiler:

rustup target add wasm32-unknown-unknown

Then, clone the repository:

git clone https://github.com/cairoeth/rustmate && cd rustmate

Clone Arbitrum Nitro node that supports Stylus:

git clone -b stylus --recurse-submodules https://github.com/OffchainLabs/nitro-testnode.git && cd nitro-testnode

Run the node and wait for it to start up:

./test-node.bash --init --detach

Open another terminal window and fund the deployer address:

./test-node.bash script send-l2 --to address_0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266 --ethamount 100

Navigate back to rustmate and select a benchmark to run. For example, ERC20:

cd ../benchmark/erc20_benchmark && python snapshot.py

Check the results in the terminal or in the .gas-snapshot file.

🙏🏼 Acknowledgements

This repository is inspired by or directly modified from many sources, primarily:

• solmate
• OpenZeppelin Contracts
• snekmate
• stylus-sdk-rs

🫡 Contributing

Check out the Contribution Guidelines!