https://github.com/SoulWallet/soul-wallet-contract

core contract of eip 4337 implementation
https://github.com/SoulWallet/soul-wallet-contract

Last synced: about 2 months ago
JSON representation

core contract of eip 4337 implementation

• Host: GitHub
• URL: https://github.com/SoulWallet/soul-wallet-contract
• Owner: SoulWallet
• Created: 2022-08-09T06:38:52.000Z (almost 2 years ago)
• Default Branch: develop
• Last Pushed: 2024-02-05T15:03:29.000Z (5 months ago)
• Last Synced: 2024-02-06T08:08:16.597Z (5 months ago)
• Language: Solidity
• Size: 10.3 MB
• Stars: 245
• Watchers: 17
• Forks: 90
• Open Issues: 10
• Metadata Files:
  • Readme: README.md

Lists

• awesome-account-abstraction - Soul Wallet
• awesome-modular-accounts - Soul Wallet

README

        


  
SoulWallet Contracts [draft version]
  









## Features

- Support [ERC-4337: Account Abstraction](https://eips.ethereum.org/EIPS/eip-4337)

- [Modular design ](https://hackmd.io/3gbndH7tSl2J1EbNePJ3Yg)

- Upgradability: The smart contract for this wallet can be upgraded in a secure way to add new features or fix vulnerabilities in the future.

- Stablecoin pay gas: Users can pay transaction gas fees with stablecoins such as USDC, USDT, DAI, etc.

## Architecutre

The smart contract comprises three main logic components:

1. SoulWallet Core:

- This is the primary wallet logic.

- Supports the ERC4337 interface.

- Manages modules and hooks.

2. Modules:

- Modules provide extended functionality.

- A module is a whitelisted contract capable of executing transactions on behalf of the smart contract wallet.

- Modules enhance the functionality of the contracts by adding extra access logic for transaction execution.

3. Hooks:

- A hook is essentially a function or a set of functions that are called at specific points within a contract's execution flow.

- Hooks can be set up to perform additional checks on transactions before they're executed.

## Repository Structure

All contracts are held within the `soul-wallet-contract/contracts` folder.

```

contracts

├── abstract

├── automation

├── dev

│   └── tokens

├── factory

├── hooks

│   └── 2fa

├── interfaces

├── libraries

├── modules

│   ├── interfaces

│   ├── socialRecovery

│   │   ├── base

│   │   └── interfaces

│   └── upgrade

├── paymaster

│   └── interfaces

└── validator

    └── libraries

```

## Test

```shell

npm run test

```

## Integration

Third parties can build new modules/plugins on top of SoulWallet to add additional functionality.

### Module

To add a new module, the contract should inherit from BaseModule. BaseModule is an abstract base contract that provides a foundation for other modules. It ensures the initialization, de-initialization, and proper authorization of modules.

```solidity

import "./BaseModule.sol";

contract NewModule is BaseModule {

    function requiredFunctions() external pure override returns (bytes4[] memory)

    {

        // return wallet functions that modules need access to

    }

     function inited(address wallet) internal view virtual override returns (bool) {

        // Implement your checking logic

    }

    function _init(bytes calldata data) internal virtual override {

        // Implement initialization logic

    }

    function _deInit() internal virtual override {

        // Implement de-initialization logic

    }

}

```

### Hook

To integrate a new hook, your contract should inherit `IHook` interface. This interface will define the standard structure and functionalities for your hooks.

```solidity

import {IHook} from "@soulwallet-core/contracts/interface/IHook.sol";

contract NewHook is IHook {

     function preIsValidSignatureHook(bytes32 hash, bytes calldata hookSignature) external view {

        // Implement hook logic

     }

    function preUserOpValidationHook(

        UserOperation calldata userOp,

        bytes32 userOpHash,

        uint256 missingAccountFunds,

        bytes calldata hookSignature

    ) external {

        // Implement your hook-specific logic here

    }

}

```

## Disclaimer

This project is provided "as is" with no warranties or guarantees of any kind, express or implied. The developers make no claims about the suitability, reliability, availability, timeliness, security or accuracy of the software or its related documentation. The use of this software is at your own risk.

The developers will not be liable for any damages or losses, whether direct, indirect, incidental or consequential, arising from the use of or inability to use this software or its related documentation, even if advised of the possibility of such damages.

## Acknowledgments

- ERC-4337: Account Abstraction Using Alt Mempool

- Infinitism account abstraction contract

- Gnosis Safe Contracts