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
  • 🏆 Biconomy Champions League 🏆
    • Champions Roster
    • Entering the League
  • Documentation and Resources
  • 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

3. Setup environment variables:

Copy .env.example to .env and fill in your details.

🛠️ 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 differnet 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

Entering the League

Your journey to becoming a champion can start in any domain:

• Code Wizards: Dive into our Gas Optimization efforts.
• Security Guardians: Enhance our safety following the Security Guidelines.
• Documentation Scribes: Elevate our knowledge base with your contributions.

The Champions League is not just a recognition, it's a testament to the impactful work done by our community. Whether you're optimizing gas usage or securing our contracts, your contributions help shape the future of Biconomy.

To Join: Leave a lasting impact in your chosen area. Our Hall of Fame is regularly updated to honor our most dedicated contributors.

Let's build a legacy together, championing innovation and excellence in the blockchain space.

Documentation and Resources

For a comprehensive understanding of our project and to contribute effectively, please refer to the following resources:

• Contributing Guidelines: Learn how to contribute to our project, from code contributions to documentation improvements.
• Code of Conduct: Our commitment to fostering an open and welcoming environment.
• Security Policy: Guidelines for reporting security vulnerabilities.
• Gas Optimization Program: Contribute towards optimizing gas efficiency of our smart contracts.
• Changelog: Stay updated with the changes and versions.

License

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

Connect with Biconomy 🍊