bcnmy/scw-contracts

SCW contracts for Biconomy Smart Account

Biconomy Smart Account: Leading Implementation of Account Abstraction 🌐

Biconomy Smart Account is a smart contract wallet focused on implementing Account Abstraction. It builds on the core concepts of Gnosis and Argent safes and is compliant with ERC-4337 and ERC-6900.

📜 Smart Contracts

• BaseSmartAccount.sol: An abstract contract implementing the EIP4337 IWallet interface.
• Proxy.sol: A lightweight proxy upgradeable through the UUPS pattern.
• SmartAccountFactory.sol: This factory contract manages the deployment of Smart Account (Account Abstraction).
• SmartAccount.sol: The primary implementation contract for a Smart Account (Account Abstraction).
• EntryPoint.sol: Implements the EIP4337 Entry Point contract.
• StakeManager.sol: A stake manager for wallet and paymaster deposits/stakes.
• Executor.sol: A helper contract facilitating calls and delegate calls to dapp contracts.
• FallbackManager.sol: Manages a fallback handler for delegate calls.
• ModuleManager.sol: Adopts the Gnosis Safe module manager pattern.
• DefaultCallbackHandler.sol: Handles hooks to respond to token receipts.
• MultiSend.sol & MultiSendCallOnly.sol: Facilitates batching multiple transactions into one.
• VerifyingSingletonPaymaster.sol: A paymaster that uses an external service for transaction validation.
• PaymasterHelpers.sol: A library essential for decoding paymaster data and context.

🛠️ Prerequisites

• Node.js
• Yarn or npm
• Hardhat

🚀 How to Run the Project

Before diving in, place a mnemonic in a .secret file at the root. Remember: Never commit this file or share it publicly.

Setup

Setup: Clone the repository and install dependencies.

git clone https://github.com/bcnmy/scw-contracts.git
cd scw-contracts
npm install

Configuration: Create a .secret file at the root to store your mnemonic. Note: Never commit this file. shell echo "your mnemonic here" > .secret

🛠️ Development Commands

Below are the commands you can use for various tasks:

🧪 Testing

Run regular tests:

npx hardhat test

For Bundler Integration Tests, first install realpath:

brew install coreutils

Then, run the Bundler Integration Tests:

yarn bundler-test

📦 Compilation & Deployment

Compile contracts:

npx hardhat compile

Clean the environment:

npx hardhat clean

Start a local Ethereum node:

npx hardhat node

Deploy contracts:

npx hardhat run scripts/deploy.ts
TS_NODE_FILES=true npx ts-node scripts/deploy.ts

📈 Analysis & Reporting

Display available accounts:

npx hardhat accounts

Get help on Hardhat commands:

npx hardhat help

Test with gas report:

REPORT_GAS=true npx hardhat test

Generate code coverage report:

npx hardhat coverage

🧹 Code Quality & Formatting

Lint JavaScript and TypeScript files:

npx eslint '**/*.{js,ts}'

Automatically fix linting issues:

npx eslint '**/*.{js,ts}' --fix

Check formatting for JSON, Solidity, and Markdown files:

npx prettier '**/*.{json,sol,md}' --check

Automatically format files:

npx prettier '**/*.{json,sol,md}' --write

Lint Solidity contracts:

npx solhint 'contracts/**/*.sol'

Automatically fix issues in Solidity contracts:

npx solhint 'contracts/**/*.sol' --fix

---

This format separates the description from the command, making it clearer and more readable.

🔍 Etherscan Verification

To verify on Etherscan, deploy a contract to an Ethereum network supported by Etherscan, like Ropsten. Set up your .env file, deploy your contract, and then verify:

hardhat run --network goerli scripts/deploy.ts
npx hardhat verify --network goerli DEPLOYED_CONTRACT_ADDRESS "Hello, Hardhat!"

⚡ Performance Optimizations

Boost your tests and scripts' speed by setting the TS_NODE_TRANSPILE_ONLY environment variable to 1 in Hardhat's environment. More details are available in the documentation.

---

🤝 Contributing

Biconomy Smart Account is an open-source project. Contributions are welcome. If you're interested in contributing, please check our contribution guidelines and feel free to submit pull requests or raise issues.

📜 License

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

scw-contracts's Issues

Bug Report 2024-01-28

I'm opening this issue to report a bug, which I'm doing based on this:

If you've identified a bug that hasn't been reported, open a new Issue detailing the bug.

With this specific bug, it'd be better if the details aren't available for everyone to see, so can I send my writeup privately to the team somehow? I can do email or any other medium.

Wrong information in natspec

For MultiOwnedECDSA module in develop branch (links below) some of the information is used from ECDSA module but they seem inaccurate.

https://github.com/bcnmy/scw-contracts/blob/develop/contracts/smart-account/modules/MultiOwnedECDSAModule.sol#L15

https://github.com/bcnmy/scw-contracts/blob/develop/contracts/smart-account/modules/MultiOwnedECDSAModule.sol#L19
(should Not be one owner per smart account)

same in interfaces
https://github.com/bcnmy/scw-contracts/blob/develop/contracts/smart-account/interfaces/modules/IMultiOwnedECDSAModule.sol#L9

Module Manager: execTransactionFromModule does not emit module events

I noticed that in the module manager's execTransactionFromModule function, it directly uses the _execute function from the executor contract. However, this setup doesn't emit any of module events when a transaction succeeds or fails.

I'm wondering why we're not using the _executeFromModule function, like we do in the execBatchTransactionFromModule method, for consistency.

Wrong name

scw-contracts/contracts/smart-account/modules/MultiOwnedECDSAModule.sol

Line 32 in bb275bf

string public constant NAME = "ECDSA Ownership Registry Module";

Name should be replaced

Checking initializer.length

Why does the SmartAccountFactory include a check for initializer.length > 0 in the deployAccount and deployCounterFactualAccount functions? Given that the initializer is not passed directly and is not optional. Under what circumstances would initializer.length be zero?