Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update alpha version #134

Merged
merged 10 commits into from
Feb 1, 2024
Merged

update alpha version #134

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
bb10369
style: Rename LICENSE files (#125)
adam-alchemy Jan 29, 2024
4dc1f45
style: fix typo (#122)
howydev Jan 29, 2024
9355395
feat: move token receiver functions into account (#124)
jaypaik Jan 29, 2024
8fc26e0
test: token receiver hook tests (#126)
jaypaik Jan 29, 2024
b88441f
feat: overridable token receivers (#127)
jaypaik Jan 30, 2024
ef912fc
style: rename msca -> ma, remove token receiver plugin usage (#129)
howydev Jan 31, 2024
9c9c6c3
refactor: rename ContractAccessControlType.NONE to ALLOW_ALL_ACCESS (…
adam-alchemy Jan 31, 2024
645de7b
feat: add audit reports (#131)
jaypaik Feb 1, 2024
3c82501
chore: update deploy script (#132)
howydev Feb 1, 2024
078f7c3
chore: deploy to sepolia, base sepolia, polygon (#133)
howydev Feb 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 12 additions & 5 deletions .env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,19 @@ REQUIRED_STAKE_AMOUNT=1
UNSTAKE_DELAY_SEC=86400

ENTRYPOINT=
# MSCA_IMPL=
# OWNER_FACTORY=
# OWNER_TOKEN_RECEIVER_FACTORY=

# MA_IMPL=
# FACTORY=
# OWNER_PLUGIN=
# TOKEN_RECEIVER_PLUGIN=
# SESSION_KEY_PLUGIN=

# MA_IMPL_SALT=
# FACTORY_SALT=
# MULTI_OWNER_PLUGIN_SALT=
# SESSION_KEY_PLUGIN_SALT=

# EXPECTED_MA_IMPL=
# EXPECTED_FACTORY=
# EXPECTED_OWNER_PLUGIN=
# EXPECTED_SESSION_KEY_PLUGIN=

RPC_URL=
1,359 changes: 907 additions & 452 deletions .gasestimates.md
View file
Open in desktop

Large diffs are not rendered by default.

4 changes: 4 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,7 @@ lcov.info

# secret
.env

# deployments
broadcast/**/run-latest.json
broadcast/**/dry-run/**/*
51 changes: 21 additions & 30 deletions .storagelayout.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,47 +15,43 @@ Generated via `bash utils/inspect.sh`.
| Name | Type | Slot | Offset | Bytes | Contract |
|------|------|------|--------|-------|----------|

`forge inspect --pretty src/account/PluginManagerInternals.sol:PluginManagerInternals storage-layout`
`forge inspect --pretty src/account/AccountStorageV1.sol:AccountStorageV1 storage-layout`
| Name | Type | Slot | Offset | Bytes | Contract |
|------|------|------|--------|-------|----------|

`forge inspect --pretty src/account/UpgradeableModularAccount.sol:UpgradeableModularAccount storage-layout`
`forge inspect --pretty src/account/PluginManagerInternals.sol:PluginManagerInternals storage-layout`
| Name | Type | Slot | Offset | Bytes | Contract |
|------|------|------|--------|-------|----------|

`forge inspect --pretty src/factory/MultiOwnerMSCAFactory.sol:MultiOwnerMSCAFactory storage-layout`
| Name | Type | Slot | Offset | Bytes | Contract |
|--------|---------|------|--------|-------|-------------------------------------------------------------|
| _owner | address | 0 | 0 | 20 | src/factory/MultiOwnerMSCAFactory.sol:MultiOwnerMSCAFactory |

`forge inspect --pretty src/factory/MultiOwnerTokenReceiverMSCAFactory.sol:MultiOwnerTokenReceiverMSCAFactory storage-layout`
| Name | Type | Slot | Offset | Bytes | Contract |
|--------|---------|------|--------|-------|---------------------------------------------------------------------------------------|
| _owner | address | 0 | 0 | 20 | src/factory/MultiOwnerTokenReceiverMSCAFactory.sol:MultiOwnerTokenReceiverMSCAFactory |

`forge inspect --pretty src/libraries/AccountStorageV1.sol:AccountStorageV1 storage-layout`
`forge inspect --pretty src/account/UpgradeableModularAccount.sol:UpgradeableModularAccount storage-layout`
| Name | Type | Slot | Offset | Bytes | Contract |
|------|------|------|--------|-------|----------|

`forge inspect --pretty src/plugins/BasePlugin.sol:BasePlugin storage-layout`
| Name | Type | Slot | Offset | Bytes | Contract |
|------|------|------|--------|-------|----------|
`forge inspect --pretty src/factory/MultiOwnerModularAccountFactory.sol:MultiOwnerModularAccountFactory storage-layout`
| Name | Type | Slot | Offset | Bytes | Contract |
|---------------|---------|------|--------|-------|---------------------------------------------------------------------------------|
| _owner | address | 0 | 0 | 20 | src/factory/MultiOwnerModularAccountFactory.sol:MultiOwnerModularAccountFactory |
| _pendingOwner | address | 1 | 0 | 20 | src/factory/MultiOwnerModularAccountFactory.sol:MultiOwnerModularAccountFactory |

`forge inspect --pretty src/plugins/TokenReceiverPlugin.sol:TokenReceiverPlugin storage-layout`
`forge inspect --pretty src/plugins/BasePlugin.sol:BasePlugin storage-layout`
| Name | Type | Slot | Offset | Bytes | Contract |
|------|------|------|--------|-------|----------|

`forge inspect --pretty src/plugins/owner/MultiOwnerPlugin.sol:MultiOwnerPlugin storage-layout`
| Name | Type | Slot | Offset | Bytes | Contract |
|------------------|--------------------------------|------|--------|-------|---------------------------------------------------------|
| _nameFallback | string | 0 | 0 | 32 | src/plugins/owner/MultiOwnerPlugin.sol:MultiOwnerPlugin |
| _versionFallback | string | 1 | 0 | 32 | src/plugins/owner/MultiOwnerPlugin.sol:MultiOwnerPlugin |
| _owners | struct AssociatedLinkedListSet | 2 | 0 | 32 | src/plugins/owner/MultiOwnerPlugin.sol:MultiOwnerPlugin |
| Name | Type | Slot | Offset | Bytes | Contract |
|---------|--------------------------------|------|--------|-------|---------------------------------------------------------|
| _owners | struct AssociatedLinkedListSet | 0 | 0 | 32 | src/plugins/owner/MultiOwnerPlugin.sol:MultiOwnerPlugin |

`forge inspect --pretty src/plugins/session/SessionKeyPlugin.sol:SessionKeyPlugin storage-layout`
| Name | Type | Slot | Offset | Bytes | Contract |
|--------------|--------------------------------|------|--------|-------|-----------------------------------------------------------|
| _sessionKeys | struct AssociatedLinkedListSet | 0 | 0 | 32 | src/plugins/session/SessionKeyPlugin.sol:SessionKeyPlugin |
| Name | Type | Slot | Offset | Bytes | Contract |
|---------------|--------------------------------|------|--------|-------|-----------------------------------------------------------|
| _keyIdCounter | mapping(address => uint256) | 0 | 0 | 32 | src/plugins/session/SessionKeyPlugin.sol:SessionKeyPlugin |
| _sessionKeys | struct AssociatedLinkedListSet | 1 | 0 | 32 | src/plugins/session/SessionKeyPlugin.sol:SessionKeyPlugin |

`forge inspect --pretty src/plugins/session/permissions/SessionKeyPermissions.sol:SessionKeyPermissions storage-layout`
| Name | Type | Slot | Offset | Bytes | Contract |
|---------------|-----------------------------|------|--------|-------|---------------------------------------------------------------------------------|
| _keyIdCounter | mapping(address => uint256) | 0 | 0 | 32 | src/plugins/session/permissions/SessionKeyPermissions.sol:SessionKeyPermissions |

`forge inspect --pretty src/plugins/session/permissions/SessionKeyPermissionsBase.sol:SessionKeyPermissionsBase storage-layout`
| Name | Type | Slot | Offset | Bytes | Contract |
Expand All @@ -67,8 +63,3 @@ Generated via `bash utils/inspect.sh`.
|---------------|-----------------------------|------|--------|-------|-------------------------------------------------------------------------------------------|
| _keyIdCounter | mapping(address => uint256) | 0 | 0 | 32 | src/plugins/session/permissions/SessionKeyPermissionsLoupe.sol:SessionKeyPermissionsLoupe |

`forge inspect --pretty src/plugins/session/permissions/SessionKeyPermissionsPlugin.sol:SessionKeyPermissionsPlugin storage-layout`
| Name | Type | Slot | Offset | Bytes | Contract |
|---------------|-----------------------------|------|--------|-------|---------------------------------------------------------------------------------------------|
| _keyIdCounter | mapping(address => uint256) | 0 | 0 | 32 | src/plugins/session/permissions/SessionKeyPermissionsPlugin.sol:SessionKeyPermissionsPlugin |

0 COPYING → LICENSE-GPL
View file
Open in desktop
File renamed without changes.
0 LICENSE → LICENSE-MIT
View file
Open in desktop
File renamed without changes.
26 changes: 14 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,17 @@ Alchemy's Modular Account is a maximally modular, upgradeable Smart Contract Acc
## Overview

This repository contains:
* [Modular Account implementation](src/account)
* [Modular Account factories](src/factory)
* 3 ERC-6900 compatible plugins:
* [MultiOwnerPlugin](src/plugins/owner) is a plugin supporting 1+ ECDSA owners.
* [TokenReceiverPlugin](src/plugins/TokenReceiverPlugin.sol) contains ERC721/ERC777/ERC1155 token receivers.
* [SessionKeyPlugin](src/plugins/session) enables session keys with optional permissions such as time ranges, token spend limits, and gas spend limits.

- [Modular Account implementation](src/account)
- [Modular Account factory](src/factory)
- 2 ERC-6900 compatible plugins:
- [MultiOwnerPlugin](src/plugins/owner) is a plugin supporting 1+ ECDSA owners.
- [SessionKeyPlugin](src/plugins/session) enables session keys with optional permissions such as time ranges, token spend limits, and gas spend limits.

The account and plugins conform to these ERC versions:
* ERC-4337: 0.6.0
* ERC-6900: 0.7.0

- ERC-4337: 0.6.0
- ERC-6900: 0.7.0

## Development

Expand Down Expand Up @@ -43,20 +44,21 @@ FOUNDRY_PROFILE=lite forge test -vvv
### Deployment

A deployment script can be found in the `scripts/` folder

```bash
forge script script/Deploy.s.sol --rpc-url $RPC_URL --broadcast
```

## Security and Audits

We have done 2 audits from Spearbit and Quantstamp and will upload the reports shortly.
We have done 2 audits from Spearbit and Quantstamp and will upload the reports shortly. Note that these audit reports may contain references to "MSCA". This was the name we used for Modular Account previously.

## License

The Modular Account libraries (all code inside the [src/libraries](src/libraries) directory) are licensed under the MIT License, also included in our repository in [LICENSE](LICENSE).
The Modular Account libraries (all code inside the [src/libraries](src/libraries) directory) are licensed under the MIT License, also included in our repository in [LICENSE-MIT](LICENSE-MIT).

The Modular Account and ERC-6900 interfaces (all code inside the [src/interfaces](src/interfaces) directory) are licensed under the CC0 1.0 Universal License.
The Modular Account interfaces and ERC-6900 interfaces (all code inside the [src/interfaces](src/interfaces) directory) are licensed under the CC0 1.0 Universal License.

All other code for Modular Account is licensed under the GNU General Public License v3.0, also included in our repository in [COPYING](COPYING).
All other code for Modular Account is licensed under the GNU General Public License v3.0, also included in our repository in [LICENSE-GPL](LICENSE-GPL).

Alchemy Insights, Inc., 548 Market St., PMB 49099, San Francisco, CA 94104; [email protected]
Binary file added audits/2024-01-31_quantstamp_0e3fd1e.pdf
View file
Open in desktop
Binary file not shown.
Binary file added audits/2024-01-31_spearbit_0e3fd1e.pdf
View file
Open in desktop
Binary file not shown.
125 changes: 125 additions & 0 deletions broadcast/Deploy.s.sol/11155111/run-1706829580.json
View file
Open in desktop

Large diffs are not rendered by default.

409 changes: 0 additions & 409 deletions broadcast/Deploy.s.sol/11155111/run-latest.json
View file
Open in desktop

This file was deleted.

365 changes: 365 additions & 0 deletions broadcast/Deploy.s.sol/137/run-1706829813.json
View file
Open in desktop

Large diffs are not rendered by default.

250 changes: 250 additions & 0 deletions broadcast/Deploy.s.sol/84532/run-1706829406.json
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion foundry.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ out = 'out'
test = 'test'
libs = ['lib']
optimizer = true
optimizer_runs = 1600
optimizer_runs = 900
ignored_error_codes = []

[fuzz]
Expand Down
Loading
Loading