Nexus - ERC-7579 Modular Smart Account Base 🚀

This repository serves as a comprehensive foundation for smart contract projects, streamlining the development process with a focus on best practices, security, and efficiency.

Documentation: (https://github.com/bcnmy/nexus/wiki)

📚 Table of Contents

• Nexus - ERC-7579 Modular Smart Account Base 🚀
  • 📚 Table of Contents
  • Getting Started
    • Prerequisites
    • Installation
  • 🛠️ Essential Scripts
    • 🏗️ Build Contracts
    • 🧪 Run Tests
    • ⛽ Gas Report
    • 📊 Coverage Report
    • 📄 Documentation
    • 🚀 Deploy Contracts
    • 🎨 Lint Code
    • 🖌️ Auto-fix Linting Issues
    • 🚀 Generating Storage Layout
  • 🔒 Security Audits
  • License
  • Connect with Biconomy 🍊

Getting Started

To kickstart, follow these steps:

Prerequisites

• Node.js (v18.x or later)
• Yarn (or npm)
• Foundry (Refer to Foundry installation instructions)

Installation

1. Clone the repository:

git clone https://github.com/bcnmy/nexus.git
cd nexus

2. Install dependencies:

yarn install

Unfortunately, one of the dependencies does not populate the package.json file. That prevents hardhat from building the project successfully, while Foundry builds just fine.

So you may want to add this package.json manually. After doing yarn install, you can do:

cd node_modules/prep
touch package.json

then add the following content to the package.json file:

{
  "name": "prep",
  "version": "0.0.0",
  "private": true,
  "dependencies": {}
}

🛠️ Essential Scripts

Execute key operations for Foundry and Hardhat with these scripts. Append :forge or :hardhat to run them in the respective environment.

🏗️ Build Contracts

yarn build

Compiles contracts for both Foundry and Hardhat.

🧪 Run Tests

yarn test

Carries out tests to verify contract functionality.

⛽ Gas Report

yarn test:gas

Creates detailed reports for test coverage.

📊 Coverage Report

yarn coverage

Creates detailed reports for test coverage.

📄 Documentation

yarn docs

Generate documentation from NatSpec comments.

🚀 Deploy Contracts

Nexus contracts are pre-deployed on most EVM chains. Please see the addresses here.

If you need to deploy Nexus on your own chain or you want to deploy the contracts with different addresses, please see this script. Or the same script on different deploy branches.

🎨 Lint Code

yarn lint

Checks code for style and potential errors.

🖌️ Auto-fix Linting Issues

yarn lint:fix

Automatically fixes linting problems found.

🚀 Generating Storage Layout

yarn check

To generate reports of the storage layout for potential upgrades safety using hardhat-storage-layout.

🔄 Add :forge or :hardhat to any script above to target only Foundry or Hardhat environment, respectively.

🔒 Security Audits

| Auditor | Date | Final Report Link | | ---------------- | ---------- | ----------------------- | | CodeHawks-Cyfrin | 17-09-2024 | View Report | | Spearbit | 10/11-2024 | View Report / View Add-on | | Zenith | 03-2025 | View Report | | Pashov | 03-2025 | View Report |

License

This project is licensed under the MIT License. See the LICENSE file for details.

Connect with Biconomy 🍊