@biconomy-devx/erc7579-msa
v0.0.4
Published
ERC7579 Modular Smart Account
Downloads
26
Readme
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.
📚 Table of Contents
- ERC-7579 Modular Smart Account Base 🚀
Getting Started
To kickstart, follow these steps:
Prerequisites
- Node.js (v18.x or later)
- Yarn (or npm)
- Foundry (Refer to Foundry installation instructions)
Installation
- Clone the repository:
git clone https://github.com/bcnmy/erc7579-modular-smart-account.git
cd erc7579-modular-smart-account
- Install dependencies:
yarn install
- 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 deploy
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 | | --------- | ---------- | ----------------------- | | Firm Name | DD-MM-YYYY | View Report | | Firm Name | DD-MM-YYYY | 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:
- 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.