Skip to content

bcnmy/nexus

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Biconomy License MIT Hardhat Foundry

Codecov Hardhat Coverage Codecov Foundry Coverage

Nexus - ERC-7579 Modular Smart Account Base πŸš€

Open in GitHub Codespaces

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

Getting Started

To kickstart, follow these steps: To kickstart, follow these steps:

Prerequisites

Installation

  1. Clone the repository:
git clone https://github.com/bcnmy/nexus.git
cd nexus
  1. Install dependencies:
yarn install
  1. 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

yarn run deploy:hardhat --network hardhat

Deploys contracts onto the blockchain network.

🎨 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
Firm Name DD-MM-YYYY View Report

πŸ† Biconomy Champions League πŸ†

Welcome to the Champions League, a place where your contributions to Biconomy are celebrated and immortalized in our Hall of Fame. This elite group showcases individuals who have significantly advanced our mission, from enhancing code efficiency to strengthening security, and enriching our documentation.

Champions Roster

🍊 Contributor πŸ›‘οΈ Domain
@user1 Code Optimization
@user2 Security
@user3 Documentation
... ...

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:

License

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

Connect with Biconomy 🍊

Website Telegram Twitter LinkedIn Discord YouTube GitHub