feat: add initial skeleton for 6900 account support #248

moldy530 · 2023-11-14T00:08:51Z

Pull Request Checklist

Did you add new tests and confirm existing tests pass? (yarn test)
Did you update relevant docs? (docs are found in the site folder, see guidleines below)
Do your commits follow the Conventional Commits standard?
Does your PR title also follow the Conventional Commits standard?
If you have a breaking change, is it [correctly reflected in your commit message](https://www.conventionalcommits.org/en/v1.0.0/#examples? (e.g. feat!: breaking change)
Did you run lint (yarn lint:check) and fix any issues? (yarn lint:fix)
Is the base branch you're merging into development and not main?

PR-Codex overview

This PR focuses on adding plugin configuration and management functionality to the smart contract account system.

Detailed summary

Added plugin configuration files for multi-owner, session key, and token receiver plugins.
Added plugin generation configurations for multi-owner, session key, and token receiver plugins.
Updated the provider schema to include connection configuration options.
Updated the account base class to include an extend method for extending the account functionality.
Added types for plugin hooks and injected hooks information.
Updated the wagmi.config.ts file to generate plugin files based on the plugin configurations.
Updated the Alchemy schema to include the connection configuration schema.
Updated the provider interface to include a generic type parameter for provider decorators.
Updated the uninstallPlugin function to include a generic type parameter for the smart account provider.
Added the IStandardExecutorAbi to the account base class.

The following files were skipped due to too many changes: packages/accounts/src/msca/plugin-manager/uninstallPlugin.ts, packages/accounts/src/msca/utils.ts, packages/core/src/provider/base.ts, packages/accounts/src/msca/account-loupe/decorator.ts, packages/accounts/src/msca/plugins/types.ts, packages/accounts/src/msca/plugin-manager/installPlugin.ts, packages/accounts/src/index.ts, examples/aa-simple-dapp/src/hooks/useAlchemyProvider.ts, packages/accounts/src/msca/abis/IAccountLoupe.ts, packages/accounts/src/msca/account-loupe/types.ts, packages/core/src/account/types.ts, packages/accounts/src/msca/abis/MultiOwnerMSCAFactory.ts, packages/accounts/src/msca/abis/IPluginManager.ts, packages/accounts/src/msca/abis/MultiOwnerTokenReceiverMSCAFactory.ts, packages/accounts/src/msca/multi-owner-account.ts, packages/accounts/src/msca/plugins/session-key/plugin.ts, packages/accounts/scripts/plugingen.ts, packages/accounts/src/msca/plugins/multi-owner/plugin.ts, packages/accounts/src/msca/builder.ts, packages/accounts/src/msca/plugins/token-receiver/plugin.ts, packages/accounts/src/msca/abis/IPlugin.ts, packages/accounts/plugindefs/token-receiver/abi.ts, packages/accounts/plugindefs/session-key/abi.ts, packages/accounts/plugindefs/multi-owner/abi.ts, yarn.lock

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

packages/accounts/src/msca/plugins/multi-owner/signer.ts

packages/accounts/src/msca/account.ts

packages/accounts/src/msca/plugins/multi-owner/plugin.ts

packages/accounts/src/msca/plugins/multi-owner/signer.ts

packages/accounts/src/msca/base.ts

moldy530 · 2023-11-21T22:38:36Z

packages/accounts/src/msca/plugins/types.ts

+
+export interface Plugin<D> {
+  meta: { name: string; version: string };
+  accountDecorators: (a: BaseSmartContractAccount) => D;


we should expose a method or the rpcProvider property on ISmartContractAccount so we can use that here instead of BaseSmartContractAccount

by having made it readonly you can now, right?

I did but not on the ISmartContractAccount, I can update the ISmartContractAccount interface here if we're cool with that change

moldy530 · 2023-11-21T22:40:10Z

packages/accounts/plugindefs/index.ts

@@ -0,0 +1 @@
+export { MultiOwnerPluginGenConfig } from "./multi-owner/config.js";


we can probably do better here by just reading all the config.js files found within this folder and exporting their contents. we might need to do default exports for the configs though

hmm but will take break the vscode module navigation ? or you mean reading all config.ts files and export their contents by writing into a new file for exports in out or something

yea the way I was thinking would break module navigation good call... we could make the plugin gen script overwrite this file though that's a good idea

denniswon · 2023-11-26T08:24:25Z

packages/accounts/src/msca/multi-owner-account.ts

+      const signWith1271Wrapper = async (msg: Hash): Promise<`0x${string}`> => {
+        const multiOwnerAugmented =
+          acct.extendWithPluginMethods(MultiOwnerPlugin);
+
+        const [, name, version, chainId, verifyingContract, salt] =
+          await multiOwnerAugmented.readEip712Domain();
+
+        return params.owner.signTypedData({
+          domain: {
+            chainId: Number(chainId),
+            name,
+            salt,
+            verifyingContract,
+            version,
+          },
+          types: {
+            ERC6900Message: [{ name: "message", type: "bytes" }],
+          },
+          message: {
+            ERC6900Message: {
+              message: toBytes(msg),
+            },
+          },
+          primaryType: "ERC6900Message",
+        });
+      };


this is signing with 1271?
can you point to the reference where the contract implements function isValidSignature? Wondering how you came up with the primaryType ERC6900Message. Is that degined in the eip712Domain function of MultiOwnerPlugin?

https://github.com/OMGWINNING/account-contracts/blob/master/src/plugins/owner/MultiOwnerPlugin.sol#L136

All signatures for 1271 validation in the MSCA (and LightAccount) require this wrapping

denniswon · 2023-11-26T08:27:53Z

packages/accounts/src/msca/multi-owner-account.ts

+    .withFactory(async (acct) => {
+      const ownerAddress = await params.owner.getAddress();
+      return concatHex([
+        acct.getFactoryAddress(),
+        encodeFunctionData({
+          abi: MultiOwnerMSCAFactoryAbi,
+          functionName: "createAccount",
+          // TODO: this needs to support creating accounts with multiple owners
+          args: [params.index, [ownerAddress]],
+        }),
+      ]);
+    })


so MultiOwnerMSCAFactory is always the factory that create MSCAs? There isn't a separate MSCAFactory right?

There can be any number of factories for an MSCA which is why I added this withFactory concept. The other factory that exists already is the MultiOwnerWithTokenReceiver factory

denniswon · 2023-11-26T08:28:28Z

packages/accounts/src/msca/multi-owner-account.ts

+>() =>
+  createBaseSmartAccountParamsSchema<TTransport>().extend({
+    owner: SignerSchema,
+    index: z.bigint().optional().default(0n),


what does this index specify?

index is used as a salt, if you want to create many accounts with the same set of initial owners but have them be at other addresses use can use the salt to differentiate them

denniswon · 2023-11-26T08:34:32Z

packages/accounts/src/msca/builder.ts

+  | "signMessage"
+  | "signTypedData"
+  | "signUserOperationHash"
+  | "getDummySignature"


these are abstraction functions except the execute functions from SmartContractAccount correct?

Then why also signUserOperationHash? Don't we just use signMessage for signing uos?

for 1271 validation, we sign messages differently that we do for UO hashes. The MSCA (and LightAccount) expects the UO to be personal sign of the hash. 1271 expects a sign typed data following the envelope defined above

denniswon · 2023-11-26T08:35:28Z

packages/accounts/plugindefs/types.ts

+  // TODO: need to make this configurable to run in CI without requiring this
+  rpcUrl?: string;


what do you mean configurable here?

I think I forgot to remove the TODO because it is optional now

the idea is that we shouldn't have to hardcode an RPC URL here. This is useful for testing locally if you want to hit a local anvil instance

is there a better way to write this type so it's dependent on environment to see if rpcUrl is defined?

we can probs just do that in the plugin gen code

.vscode/settings.json

avasisht23

would like to review the builder + multi-owner-account files live as a team, but left comments elsewhere

avasisht23 · 2023-11-27T02:11:58Z

packages/accounts/package.json

@@ -29,6 +29,8 @@
    "./package.json": "./package.json"
  },
  "scripts": {
+    "generate": "npx wagmi generate",


learn: have you worked with the wagmi cli? if not / maybe if you remember when you first did, did you just look up a way to generate abis and some stackoverflow pointed you to it?

otherwise, curious how you arrived at this solution.

I used it before, but then looked at their codebase for how they define plugins so I could write my own

avasisht23 · 2023-11-27T02:15:32Z

packages/accounts/src/msca/plugins/types.ts

+
+export interface Plugin<D> {
+  meta: { name: string; version: string };
+  accountDecorators: (a: BaseSmartContractAccount) => D;


by having made it readonly you can now, right?

avasisht23 · 2023-11-27T02:16:22Z

packages/accounts/scripts/plugingen.ts

should the file be "plugin-gen.ts" to be kebab case?

avasisht23 · 2023-11-27T02:18:10Z

packages/accounts/plugindefs/types.ts

+  // TODO: need to make this configurable to run in CI without requiring this
+  rpcUrl?: string;


is there a better way to write this type so it's dependent on environment to see if rpcUrl is defined?

avasisht23 · 2023-11-27T02:19:09Z

packages/accounts/wagmi.config.ts

+const pluginRegEx: RegExp = /[pP]lugin/g;
+
+export default defineConfig(
+  pluginConfigs.map((config) => ({


nit: is there a way to check if there's no diff to the generated file? this re-writes every plugin auto-gen file each time the yarn script is run, right?

yea it does and we probs can, but we can probs leverage nx and lerna to do that by adding an nx config for generate

packages/accounts/scripts/plugingen.ts

avasisht23 · 2023-11-27T02:34:50Z

packages/accounts/src/msca/abis/IPlugin.ts

nit: want to include a link to the repo + etherscan / some way to validate the abi?

replied elsewhere too, but let's keep those out of here for now since none of these things are in production yet

packages/accounts/src/msca/abis/IStandardExecutor.ts

packages/accounts/src/msca/abis/MultiOwnerMSCAFactory.ts

avasisht23 · 2023-11-27T02:41:18Z

packages/accounts/plugindefs/index.ts

nit: should this folder be plugin-defs?

yea I think that's a fair change

avasisht23 · 2023-11-27T22:29:42Z

main
- feat: add initial skeleton for 6900 account support #248 👈
  - feat: add upgrade functionality for light account to msca #298
  - feat: add upgrade functionality for light account to msca #285

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @moldy530 and the rest of your teammates on Graphite

packages/accounts/src/msca/base.ts

* feat: add some plugin generation logic * chore: add generate commands * style: apply PR suggestion Co-authored-by: Dennis Won <denniswon@users.noreply.github.com> * refactor: create plugin config concept * feat: add multi-owner-msca impl that leverages the plugin gen (#263) * feat: add multi-owner-msca impl that leverages the plugin gen * feat: proposal for msca builder pattern (#264) * feat: proposal for msca builder pattern * refactor: rework plugin gen to create read methods for the account --------- Co-authored-by: Dennis Won <denniswon@users.noreply.github.com>

* feat: add initial skeleton for 6900 account support * feat: add some plugin generation logic (#262) * feat: add some plugin generation logic * chore: add generate commands * style: apply PR suggestion Co-authored-by: Dennis Won <denniswon@users.noreply.github.com> * refactor: create plugin config concept * feat: add multi-owner-msca impl that leverages the plugin gen (#263) * feat: add multi-owner-msca impl that leverages the plugin gen * feat: proposal for msca builder pattern (#264) * feat: proposal for msca builder pattern * refactor: rework plugin gen to create read methods for the account --------- Co-authored-by: Dennis Won <denniswon@users.noreply.github.com> * chore: update plugin gen * feat: add plugin manager decorator for MSCA * feat: add a mechanism for adding provider decorators to accounts (#287) * feat: add a mechanism for adding provider decorators to accounts * chore: update lerna and package json to lint generated files * refactor: rename MSCA to IMSCA --------- Co-authored-by: Dennis Won <denniswon@users.noreply.github.com> Co-authored-by: avasisht23 <ajay@alchemy.com>

…sages (#308)

* refactor: move required by types to aa-core utils types folder * feat: extend msca account with account loupe decorators * feat: move extend method on account from msca to base account * Update packages/core/src/account/types.ts Co-authored-by: Michael Moldoveanu <michael.moldoveanu@alchemy.com> * Update packages/core/src/account/types.ts Co-authored-by: Michael Moldoveanu <michael.moldoveanu@alchemy.com> * Update packages/core/src/account/types.ts Co-authored-by: Michael Moldoveanu <michael.moldoveanu@alchemy.com> * Update packages/accounts/src/msca/account-loupe/decorator.ts Co-authored-by: Michael Moldoveanu <michael.moldoveanu@alchemy.com> * fix: fix lint and build --------- Co-authored-by: Michael Moldoveanu <michael.moldoveanu@alchemy.com>

* feat: msca plugingen to accept multichain address format * Update packages/accounts/scripts/plugingen.ts Co-authored-by: Michael Moldoveanu <michael.moldoveanu@alchemy.com> * Update packages/accounts/wagmi.config.ts Co-authored-by: Michael Moldoveanu <michael.moldoveanu@alchemy.com> * feat: changed address field in plugingenconfig to addresses --------- Co-authored-by: Michael Moldoveanu <michael.moldoveanu@alchemy.com>

…lt token receiver plugin (#316) * feat: msca plugingen to accept multichain address format * feat: msca token receiver plugin with opt out option to exclude default token receiver plugin

* feat: msca plugingen to accept multichain address format * feat: msca token receiver plugin with opt out option to exclude default token receiver plugin * feat: msca token receiver plugin with opt out option to exclude default token receiver plugin * feat: add session key plugin abi and plugingen

moldy530 commented Nov 14, 2023

View reviewed changes

packages/accounts/src/msca/plugins/multi-owner/signer.ts Outdated Show resolved Hide resolved

moldy530 commented Nov 14, 2023

View reviewed changes

packages/accounts/src/msca/plugins/multi-owner/signer.ts Outdated Show resolved Hide resolved

moldy530 commented Nov 14, 2023

View reviewed changes

packages/accounts/src/msca/account.ts Outdated Show resolved Hide resolved

moldy530 force-pushed the msca-base branch 3 times, most recently from 750aad0 to 3552335 Compare November 14, 2023 19:43

avasisht23 force-pushed the development branch from 733b177 to 81406f6 Compare November 14, 2023 21:09

moldy530 force-pushed the msca-base branch from b573ea6 to 4069aec Compare November 15, 2023 23:29

moldy530 commented Nov 15, 2023

View reviewed changes

packages/accounts/src/msca/account.ts Outdated Show resolved Hide resolved

moldy530 force-pushed the msca-base branch from 4069aec to 4b117c7 Compare November 15, 2023 23:39

moldy530 commented Nov 15, 2023

View reviewed changes

packages/accounts/src/msca/plugins/multi-owner/plugin.ts Outdated Show resolved Hide resolved

moldy530 force-pushed the msca-base branch from 4b117c7 to 928a8eb Compare November 15, 2023 23:52

moldy530 commented Nov 16, 2023

View reviewed changes

packages/accounts/src/msca/plugins/multi-owner/signer.ts Outdated Show resolved Hide resolved

denniswon force-pushed the msca-base branch 2 times, most recently from 718db97 to 928a8eb Compare November 16, 2023 16:52

moldy530 force-pushed the msca-base branch 4 times, most recently from 6161184 to 55dfbdc Compare November 16, 2023 21:44

moldy530 commented Nov 16, 2023

View reviewed changes

packages/accounts/src/msca/base.ts Outdated Show resolved Hide resolved

moldy530 commented Nov 21, 2023

View reviewed changes

moldy530 force-pushed the msca-base branch 2 times, most recently from 382246c to a5d466e Compare November 22, 2023 20:11

denniswon force-pushed the msca-base branch from a5d466e to 4f99d57 Compare November 24, 2023 03:06

denniswon reviewed Nov 26, 2023

View reviewed changes

avasisht23 reviewed Nov 27, 2023

View reviewed changes

.vscode/settings.json Outdated Show resolved Hide resolved

avasisht23 reviewed Nov 27, 2023

View reviewed changes

avasisht23 force-pushed the msca-base branch from 4f99d57 to dc4c98b Compare November 27, 2023 22:29

moldy530 changed the base branch from development to main December 1, 2023 17:44

denniswon force-pushed the msca-base branch from 7b96662 to 9199774 Compare December 1, 2023 21:31

avasisht23 force-pushed the msca-base branch from 6142f07 to c69950e Compare December 3, 2023 01:36

avasisht23 mentioned this pull request Dec 3, 2023

feat: add upgrade functionality for light account to msca #298

Merged

8 tasks

avasisht23 force-pushed the msca-base branch from c69950e to 4bc3911 Compare December 3, 2023 02:04

moldy530 force-pushed the msca-base branch from 3b1a1f9 to dbdfbf1 Compare December 4, 2023 16:22

avasisht23 force-pushed the msca-base branch from dbdfbf1 to 2a267ed Compare December 4, 2023 19:42

denniswon force-pushed the msca-base branch from 1e6cf6c to f65970e Compare December 6, 2023 22:55

moldy530 commented Dec 12, 2023

View reviewed changes

packages/accounts/src/msca/base.ts Outdated Show resolved Hide resolved

moldy530 and others added 12 commits January 8, 2024 11:43

chore: lint

2fb93ca

fix: missed some plugingen fixes

ece75c1

refactor: change the names of the plugin decorators and add example u…

afdd33e

…sages (#308)

fix: update the logic for signing 1271 messages

12a19e5

feat: msca token receiver plugin with opt out option to exclude defau…

d242c3a

…lt token receiver plugin (#316) * feat: msca plugingen to accept multichain address format * feat: msca token receiver plugin with opt out option to exclude default token receiver plugin

feat: msca plugin provider decorator to support user op overrides (#342)

b254d8a

feat: msca plugingen to generate subfolders for each plugin (#350)

760a47c

moldy530 force-pushed the msca-base branch from 084f65a to 760a47c Compare January 8, 2024 16:43

moldy530 marked this pull request as ready for review January 8, 2024 18:04

moldy530 requested review from rthomare, dancoombs and mokok123 as code owners January 8, 2024 18:04

denniswon approved these changes Jan 8, 2024

View reviewed changes

moldy530 merged commit eb842bf into main Jan 8, 2024
2 checks passed

moldy530 deleted the msca-base branch January 8, 2024 18:06

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add initial skeleton for 6900 account support #248

feat: add initial skeleton for 6900 account support #248

moldy530 commented Nov 14, 2023 •

edited by pr-codex bot

Loading

moldy530 Nov 21, 2023

avasisht23 Nov 27, 2023

moldy530 Nov 27, 2023

moldy530 Nov 21, 2023

denniswon Nov 24, 2023

moldy530 Nov 27, 2023

denniswon Nov 26, 2023

moldy530 Nov 26, 2023

denniswon Nov 26, 2023

moldy530 Nov 26, 2023

denniswon Nov 26, 2023

moldy530 Nov 26, 2023

denniswon Nov 26, 2023

moldy530 Nov 26, 2023

denniswon Nov 26, 2023

moldy530 Nov 26, 2023

moldy530 Nov 26, 2023

avasisht23 Nov 27, 2023

moldy530 Nov 27, 2023

avasisht23 left a comment

avasisht23 Nov 27, 2023

moldy530 Nov 27, 2023

avasisht23 Nov 27, 2023

avasisht23 Nov 27, 2023

avasisht23 Nov 27, 2023

avasisht23 Nov 27, 2023

moldy530 Nov 27, 2023

avasisht23 Nov 27, 2023

moldy530 Nov 27, 2023

avasisht23 Nov 27, 2023

moldy530 Nov 27, 2023

avasisht23 commented Nov 27, 2023 •

edited

Loading

		@@ -0,0 +1 @@
		export { MultiOwnerPluginGenConfig } from "./multi-owner/config.js";

		// TODO: need to make this configurable to run in CI without requiring this
		rpcUrl?: string;

feat: add initial skeleton for 6900 account support #248

feat: add initial skeleton for 6900 account support #248

Conversation

moldy530 commented Nov 14, 2023 • edited by pr-codex bot Loading

Pull Request Checklist

PR-Codex overview

Detailed summary

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

avasisht23 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

avasisht23 commented Nov 27, 2023 • edited Loading

moldy530 commented Nov 14, 2023 •

edited by pr-codex bot

Loading

avasisht23 commented Nov 27, 2023 •

edited

Loading