Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/openfort-xyz/openfort-contracts
Official Contracts of the Openfort Project
https://github.com/openfort-xyz/openfort-contracts
aa erc-4337 ethreum evm-blockchain solidity web3
Last synced: about 2 months ago
JSON representation
Official Contracts of the Openfort Project
- Host: GitHub
- URL: https://github.com/openfort-xyz/openfort-contracts
- Owner: openfort-xyz
- License: gpl-3.0
- Created: 2023-04-28T15:10:56.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-24T11:43:31.000Z (8 months ago)
- Last Synced: 2024-08-03T16:09:31.723Z (5 months ago)
- Topics: aa, erc-4337, ethreum, evm-blockchain, solidity, web3
- Language: Solidity
- Homepage: https://www.openfort.xyz/
- Size: 1.43 MB
- Stars: 20
- Watchers: 2
- Forks: 9
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-account-abstraction - Openfort
README
![Openfort Protocol][banner-image]
[banner-image]: .github/img/OpenfortRed.png
# Openfort Contracts
Official Contracts of the Openfort Project.
The following standards are supported:
- ERC-20, ERC-721, ERC-777 and ERC-1155 for different token handling.
- ERC-173 for ownership standard.
- EIP-712 and EIP-5267 for typed structured data hashing and signing.
- ERC-1271 for standard signature validation.
- ERC-1967 and ERC-1822 for proxies (upgradeable Openfort accounts).
- EIP-1014 for generating counterfactual addresses using Openfort factories.
- ERC-4337 for leveraging Account Abstraction using alternative mempools.
- ERC-6551 for leveraging Token Bound Accounts
## Development
### Install [Foundry](https://github.com/foundry-rs/foundry#installation)
```
curl -L https://foundry.paradigm.xyz | bash
foundryup
```
### Build and test
```
git clone https://github.com/openfort-xyz/openfort-contracts.git && cd openfort-contracts
yarn
forge install
forge build
forge test
```
### Unit Test Coverage
You can use `Foundry` to get the unit test coverage.
Use the `lcov` report format and `genhtml` to view the coverage data in a nice web interface.
```
forge coverage --report lcov
genhtml -o report --branch-coverage lcov.info
```
## Use different built-in scripts
> Before executing any of the scripts below, make sure you've properly configured your `.env` file.
### Generate a gas report
```
./script/gasProfile.sh
```
### Deploy Upgradeable and Managed factories to all chains
```
./script/deployAllChains.sh
```
### Check paymaster's deposit and Patron's balance on different chains
```
forge script CheckDeposits --force
```
### Deploy one upgradeable factory and one account
Simulation:
```
forge script --force script/deployManagedAccounts.s.sol -vvvvv --optimizer-runs 1000000 --slow --fork-url $
```
Actual deployment:
```
forge script --force script/deployManagedAccounts.s.sol -vvvvv --optimizer-runs 1000000 --slow --fork-url $ --broadcast --verify --etherscan-api-key $
```
### Compare gas costs
You can compare gas costs by running the following command against different gas reports:
```
forge snapshot --silent --diff gas_reports/2023-05-24_11:52.snap.out
```
## Static Analyzers
### Static analysis using Slither
If you want to perform a static analysis of the smart contracts using Slither, you can run the following commands:
```
pip3 install slither-analyzer
pip3 install solc-select
solc-select install 0.8.19
solc-select use 0.8.19
slither .
```
### Static analysis using Mythril
If you want to perform a static analysis of the smart contracts using Mythril, you can run the following commands:
```
rustup default nightly
pip3 install mythril
myth analyze contracts/core/static/StaticOpenfortAccount.sol --solc-json mythril.config.json
```
If you run into the error `ImportError: cannot import name 'getargspec' from 'inspect'` from Python3 running the commands above, please see the temporary fix [on this comment](https://github.com/ethereum/web3.py/issues/2704#issuecomment-1333163491).
## Gas Stats
As of June 2023, the current average gas cost for deploying or using the different smart contracts of this project is:
### Upgradeable Accounts
| Smart Contract | Description | # of deployments per game/ecosystem | Avg gas cost |
| :----------------- | :---------------------------------- | :---------------------------------- | :------------------------ |
| UpgradeableOpenfortFactory | Deploy factory (containing UpgradeableOpenfortAccount's implementation) | 1 | ~3,250,000 |
| UpgradeableOpenfortAccount | Create a new upgradeable account using the `createAccountWithNonce()` of the factory | indefinite | ~200,000 |
| UpgradeableOpenfortAccount | Updating to a new implementation using `upgradeTo()` | indefinite | ~3,500 |
### Paymaster
| Smart Contract | Description | # of deployments per game/ecosystem | Avg gas cost |
| :----------------- | :---------------------------------- | :---------------------------------- | :------------------------ |
| OpenfortPaymaster | Deploy Paymaster to pay gas in ERC20s | 1 | ~1,250,000 |
## Gas Stats in USD
The gas price range is reported as the daily average gas price for the first 90 days of 2023 ± one standard deviation.
| Blockchain | Gas Price Range | Token Price | Create an Upgradeable account |
| :------------- | :-------------------- | :---------------- | :------ |
| Ethereum | 30.5 ± 10.5 gwei | ~$1800 | $7.5-15 |
| Polygon | 220 ± 108 gwei | ~$0.67 | $0.015-$0.045 |
| Avalanche | 36 ± 4.5 nAVAX | ~$12.8 | $0.08-$0.11 |
| BSC | 7 ± 0.55 gwei | ~$240 | $0.32-$0.36 |