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

Jump to bottom

chore: update readme #39

Merged
merged 2 commits into from
Aug 14, 2024
Merged

chore: update readme #39

merged 2 commits into from
Aug 14, 2024

Conversation

r0ohafza
Copy link
Collaborator

No description provided.

@r0ohafza r0ohafza requested a review from wminshew August 13, 2024 23:34
wminshew
wminshew reviewed Aug 14, 2024
View reviewed changes
packages/smart-vaults/README.md Outdated

![architecture](./docs/smart%20account%20architecture.png)

Currently, these smart accounts are compatible with entry point [v7.0](https://github.com/eth-infinitism/account-abstraction/tree/releases/v0.7).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

v0.7

packages/smart-vaults/README.md Outdated
* **Token Support**: Accepts **ERC721** and **ERC1155**(single and batch) tokens.
* **Fallback Manager**: Allows users to extend their smart accounts to handle future callback-based interactions, such as those involving **ERC721** tokens, ensuring future-proofing.
* **Module Manager**: Provides users the ability to add trusted modules that can interact on behalf of the smart account.
* **Contract Deployment**: Enables the deployment of new contracts using `create` from within the smart account during a User OP.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

UserOp

packages/smart-vaults/README.md Outdated
* **Module Manager**: Provides users the ability to add trusted modules that can interact on behalf of the smart account.
* **Contract Deployment**: Enables the deployment of new contracts using `create` from within the smart account during a User OP.
* **[Merkelized User Operations](#merkelized-user-operations)**: Supports signing once for multiple user operations across different networks and accounts using Merkle trees.
* **[Light User Operation](#light-user-operation)**.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When multiple signatures are required, allows the last signer to set gas according to current market conditions

packages/smart-vaults/README.md

### Merkelized User Operations

Merkelized User Operations utilize **Merkle trees** to generate a root of all intended user operations. The user signs the Merkle root once, and when submitting a user operation, the signature includes the Merkle proof for verification. There is no strict limit on the number of operations or which parameters should remain constant, allowing operations across multiple networks and smart accounts with a single signature.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hadn't thought about signing across multiple accounts but i suppose that's true lol

packages/smart-vaults/README.md Outdated

### Light User Operation

When the **threshold** (the number of unique and valid signatures required for a valid user operation) is greater than **1**, the first **threshold - 1** signatures are verified against a reduced set of properties from the user operation. This process allows flexibility, particularly in situations where gas prices fluctuate. It avoids the need for re-signing the operation due to price changes. In the case of Merkelized User Operations, the initial signatures are verified against a **light** Merkle root, constructed using these reduced light user operations.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

When the **threshold** (the number of unique and valid signatures required for a valid user operation) is greater than **1**, the first **threshold - 1** signers sign over a reduced set of properties from the user operation. This gives the final signer flexibility to e.g. price gas for the user operation inline with current market conditions. In the case of Merkelized User Operations, the initial signatures are verified against a **light** Merkle root, constructed using these reduced light user operations.

@r0ohafza r0ohafza merged commit 5456c3b into smart-vaults Aug 14, 2024
@r0ohafza r0ohafza deleted the readme-update branch August 14, 2024 16:56
r0ohafza added a commit that referenced this pull request Sep 4, 2024
@r0ohafza @frangio
feat: Splits smart vaults (#51)
1c7fdc4 
* feat: create smart vaults package

* feat: add simple account and factory from eth-infitism/aa

* feat: restructure smart vault

* feat: restructure smart vault factory

* feat: multisig support with passkey and eoa signers

* feat: add root owner tests

* feat: add multi signer tests

* fix: signer cap

* feat: add factory tests

* feat: validateUserOp tests

* feat: execute tests

* feat: create functionality

* feat: avoid signing over gas userop until last signature

* chore: update docs

* Light state sync and multi user op (#28)

* feat: light state sync first pass

* feat: 1271 light state sync support

* fix: tests

* chore: light state sync tests

* chore: erc1271 tests

* feat: multiChain user op

* lil refactoring

* minor changes

* feat: light multi user op

* fix: rename to getX()

* fix: set nonce if and only if nonce is greater than storage

* fix: revert when trying to remove empty signer

* fix: minor fixes

* fix: capitalize immutables

* feat: rootOwner -> solay/Ownable

* fix: _nonce to _salt

* feat: add styling guide

* chore: gas report

* feat: don't return early in signature verification flows

* feat: add missing event in initialize flow

* fix: pass light hash directly

* feat: optimize isValidSignature flow

* fix: use constants

* fix: add constants to multiSignerLib

* chore: add more docs

* chore: add more initialization tests

* chore: add more user op signature tests

* chore: add more erc1271 signature tests

* feat: strip down light sync (#30)

* feat: strip down light sync

* fix: clean up assembly blocks

* fix: docs

* fix: address comments

* fix: address comment

* feat: remove onlySelfOrOwner

* docs: update signature scheme

* feat: add fallback module (#31)

* feat: add fallback module

* feat: add custom receive fn

* fix: remove code check when validating signer

* chore: rename bundle to merkelized

* fix: remove redundant brackets

* chore: remove via-ir for default profile

* feat: redo signature for user op and erc1271 (#33)

* feat: redo signature for user op and erc1271

* minor changes

* minor changes

* Refactor SmartVault (#34)

* fix compiler warning

* create AccountSigner and PasskeySigner

* move nonce logic to LightSync module

* use standard capitalization

* fix enum variant

* redesign signature of _validate functions

* deduplicate merkle logic

* remove redundant code

* deduplicate multisig logic

* reuse validation function

* merge multisig logic with and without in-memory updates

* feat: rip light sync

---------

Co-authored-by: Francisco <[email protected]>

* feat: operator manager (#32)

* feat: operator manager first pass

* feat: operator manager

* docs: minor update

* fix: address comments

* chore: operator -> module

* fix: tests

* fix: name

* chore: merge multiSignerSignatureLib to multiSignerLib

* fix: add comments in user op validation

* fix: minor doc updates

* chore: minor doc updates

* feat: update storage layout of signer (#36)

* feat: update storage layout of signer

* fix: minor fixes

* fix: minor fixes

* fix: address comments

* fix: address comments

* fix: using  MultiSignerLib

* fix: use global and remove unneeded private functions

* fix: use $.isValidSignature

* fix: update isPasskey logic

* fix: address will's comments

* docs: add security contact

* fix: add storage location fallback and module manager

* fix: change updateFallbackHandler modifier public -> external

* chore: add slither and remove dead code

* feat: multi signer auth (#38)

* feat: multi signer auth

* fix: docs:
:

* fix: add suggested doc change

* chore: update readme (#39)

* chore: update readme

* fix: address comments

* chore: add dummy passkey signature test

* fix: clean up multi signer auth (#40)

* fix: clean up multi signer auth

* feat: mapping to array

* fix: address comment

* feat: update _checkOwner() (#41)

* feat: add fallback handler called event (#42)

* chore: doc updates

* chore: doc updates

* test: add missing fallback test

* feat: add upper limit to gas price in light user op hash (#43)

* feat: add upper limit to gas price in light user op hash

* fix: update comment

* feat: add preVerification and callGas limits

* feat: add verification gas limit

* fix: docs

* feat: add paymaster limits

* fix: use paymasterVerificationGasLimit

* fix: ordering of params

* fix: prevent empty signers validating signature (#45)

* fix: revert when duplicate signer is used (#46)

* fix: revert when duplicate signer is used

* fix: move check one level out

* fix: verify light merkle root when threshold is > 1 (#47)

* fix: verify light merkle root when threshold is > 1

* fix: update doc

* feat: deployment script (#44)

* feat: custom webauthn (#50)

* chore: add audit report

* fix: lint

---------

Co-authored-by: Francisco <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@wminshew wminshew wminshew left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@r0ohafza @wminshew