Skip to content

Commit

Permalink
Merge pull request #52 from bcnmy/feat/phase-2-cleanup
Browse files Browse the repository at this point in the history
Feat/phase 2 cleanup
  • Loading branch information
livingrockrises authored Apr 28, 2024
2 parents c78f761 + 11e685a commit 2d7a72a
Show file tree
Hide file tree
Showing 89 changed files with 3,048 additions and 1,863 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/foundry-gas-diff.yml
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ jobs:
- name: Compare gas reports
uses: Rubilmax/foundry-gas-diff@v3.16
with:
summaryQuantile: 0.9 # only display the 10% most significant gas diffs in the summary (defaults to 20%)
summaryQuantile: 0.95 # only display the 5% most significant gas diffs in the summary (defaults to 20%)
sortCriteria: avg,max # sort diff rows by criteria
sortOrders: desc,asc # and directions
ignore: test-foundry/**/* # filter out gas reports from specific paths (test/ is included by default)
Expand Down
2 changes: 1 addition & 1 deletion .prettierrc
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
{
"files": "*.sol",
"options": {
"printWidth": 120,
"printWidth": 150,
"tabWidth": 4,
"proseWrap": "always",
"useTabs": false,
Expand Down
15 changes: 8 additions & 7 deletions .solhint.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"extends": "solhint:recommended",
"rules": {
"compiler-version": ["error", "^0.8.24"],
"func-visibility": ["warn", { "ignoreConstructors": true }],
"func-visibility": ["error", { "ignoreConstructors": true }],
"reentrancy": "error",
"state-visibility": "error",
"quotes": ["error", "double"],
Expand All @@ -12,25 +12,26 @@
"func-name-mixedcase": "error",
"func-param-name-mixedcase": "error",
"modifier-name-mixedcase": "error",
"private-vars-leading-underscore": ["warn", { "strict": true }],
"private-vars-leading-underscore": ["error", { "strict": true }],
"use-forbidden-name": "error",
"var-name-mixedcase": "error",
"imports-on-top": "error",
"ordering": "error",
"visibility-modifier-order": "error",
"code-complexity": ["error", 8],
"function-max-lines": ["error", 80],
"max-line-length": ["warn", 120],
"no-empty-blocks": "error",
"max-line-length": ["error", 150],
"no-empty-blocks": "off",
"no-unused-vars": "error",
"payable-fallback": "off",
"constructor-syntax": "error",
"explicit-types": "error",
"no-unused-import": "error",
"one-contract-per-file": "warn",
"one-contract-per-file": "error",
"reason-string": "error",
"custom-errors": "off",
"no-inline-assembly": "off"
"avoid-low-level-calls": "off",
"no-inline-assembly": "off",
"no-complex-fallback": "off"
},
"plugins": ["prettier"]
}
3 changes: 1 addition & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# Changelog

All notable changes to the `erc7579-modular-smart-account` project will be documented in this file.
All notable changes to the `erc7579-modular-smart-account` project will be documented in this file.
All notable changes to the `nexus` project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

Expand Down
20 changes: 10 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Contributing to erc7579-modular-smart-account
# Contributing to nexus

First off, thanks for taking the time to contribute to the `erc7579-modular-smart-account`! ❤️ Your efforts help build a strong, collaborative environment for developing robust smart contracts.
First off, thanks for taking the time to contribute to the `nexus`! ❤️ Your efforts help build a strong, collaborative environment for developing robust smart contracts.

## Table of Contents

- [Contributing to erc7579-modular-smart-account](#contributing-to-erc7579-modular-smart-account)
- [Contributing to nexus](#contributing-to-nexus)
- [Table of Contents](#table-of-contents)
- [I Have a Question](#i-have-a-question)
- [I Want To Contribute](#i-want-to-contribute)
Expand All @@ -25,7 +25,7 @@ If you have a question, please make sure to go through our [Documentation](https

For questions that remain unanswered, feel free to ask by:

- Opening an [Issue](https://github.com/bcnmy/erc7579-modular-smart-account/issues/new) with a detailed description of your query.
- Opening an [Issue](https://github.com/bcnmy/nexus/issues/new) with a detailed description of your query.
- Joining our community discussions on [Discord](https://discord.gg/biconomy) or [Telegram](https://t.me/biconomy).

## I Want To Contribute
Expand All @@ -36,23 +36,23 @@ When contributing to this project, you agree that you have authored 100% of the

### Reporting Bugs

A detailed bug report plays a crucial role in improving the `erc7579-modular-smart-account`. Before submitting a bug report:
A detailed bug report plays a crucial role in improving the `nexus`. Before submitting a bug report:

- Ensure you're using the latest version.
- Verify if it's a real bug and not an error on your side by consulting the [documentation](https://docs.biconomy.io/).
- Search both open and closed [issues](https://github.com/bcnmy/erc7579-modular-smart-account/issues?q=label%3Abug) to avoid duplicates.
- Search both open and closed [issues](https://github.com/bcnmy/nexus/issues?q=label%3Abug) to avoid duplicates.

To submit a bug report, open an [issue](https://github.com/bcnmy/erc7579-modular-smart-account/issues/new) and include as much relevant information as possible.
To submit a bug report, open an [issue](https://github.com/bcnmy/nexus/issues/new) and include as much relevant information as possible.

### Suggesting Enhancements

We welcome suggestions for enhancements, including new features or improvements to existing ones. Before submitting:

- Ensure you're using the latest version.
- Check the [documentation](https://docs.biconomy.io/) to see if the enhancement is already implemented.
- Search existing [issues](https://github.com/bcnmy/erc7579-modular-smart-account/issues) to avoid duplicates.
- Search existing [issues](https://github.com/bcnmy/nexus/issues) to avoid duplicates.

To suggest an enhancement, open an [issue](https://github.com/bcnmy/erc7579-modular-smart-account/issues/new) with a clear title and detailed description.
To suggest an enhancement, open an [issue](https://github.com/bcnmy/nexus/issues/new) with a clear title and detailed description.

### Your First Code Contribution

Expand Down Expand Up @@ -81,7 +81,7 @@ Use clear, concise commit messages that describe the changes you've made. Follow

## Join The Project Team

Interested in becoming a more integral part of the `erc7579-modular-smart-account` team? Great! Start by consistently contributing to the project, and don't hesitate to reach out to us on [Discord](https://discord.gg/biconomy) or [Telegram](https://t.me/biconomy) to express your interest.
Interested in becoming a more integral part of the `nexus` team? Great! Start by consistently contributing to the project, and don't hesitate to reach out to us on [Discord](https://discord.gg/biconomy) or [Telegram](https://t.me/biconomy) to express your interest.

## **Recognition and Rewards**

Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
[![Biconomy](https://img.shields.io/badge/Made_with_%F0%9F%8D%8A_by-Biconomy-ff4e17?style=flat)](https://biconomy.io) [![License MIT](https://img.shields.io/badge/License-MIT-blue?&style=flat)](./LICENSE) [![Hardhat](https://img.shields.io/badge/Built%20with-Hardhat-FFDB1C.svg)](https://hardhat.org/) [![Foundry](https://img.shields.io/badge/Built%20with-Foundry-FFBD10.svg)](https://getfoundry.sh/)

![Codecov Hardhat Coverage](https://img.shields.io/codecov/c/github/bcnmy/erc7579-modular-smart-account?token=oyX38XKbO9&flag=hardhat&label=Hardhat%20Coverage&logo=codecov) ![Codecov Foundry Coverage](https://img.shields.io/codecov/c/github/bcnmy/erc7579-modular-smart-account?token=oyX38XKbO9&flag=foundry&label=Foundry%20Coverage&logo=codecov)
![Codecov Hardhat Coverage](https://img.shields.io/codecov/c/github/bcnmy/nexus?token=oyX38XKbO9&flag=hardhat&label=Hardhat%20Coverage&logo=codecov) ![Codecov Foundry Coverage](https://img.shields.io/codecov/c/github/bcnmy/nexus?token=oyX38XKbO9&flag=foundry&label=Foundry%20Coverage&logo=codecov)

# ERC-7579 Modular Smart Account Base 🚀

[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/bcnmy/erc7579-modular-smart-account)
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/bcnmy/nexus)

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

Expand Down Expand Up @@ -48,8 +48,8 @@ To kickstart, follow these steps:
1. **Clone the repository:**

```bash
git clone https://github.com/bcnmy/erc7579-modular-smart-account.git
cd erc7579-modular-smart-account
git clone https://github.com/bcnmy/nexus.git
cd nexus
```

2. **Install dependencies:**
Expand Down
2 changes: 1 addition & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ We'll work with you to assess and understand the scope of the issue.

For vulnerabilities that are less critical and do not immediately affect our users:

1. Open an issue in our GitHub repository (`https://github.com/bcnmy/erc7579-modular-smart-account/issues`).
1. Open an issue in our GitHub repository (`https://github.com/bcnmy/nexus/issues`).

2. Provide detailed information about the issue and steps to reproduce.

Expand Down
Loading

0 comments on commit 2d7a72a

Please sign in to comment.