feat: add plugin manager decorator for MSCA #274

moldy530 · 2023-11-22T20:39:21Z

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 improving the plugin management system in the codebase.

Detailed summary:

Added support for the generate script in nx.json.
Added a new generate script in package.json which runs the generate command.
Updated the build script in package.json to include a lint:write command after the build process.
Added new types and imports related to plugin management.
Updated the useAlchemyProvider hook in aa-simple-dapp to use the createMultiOwnerMSCA function instead of LightSmartContractAccount.
Added new files and changes related to plugin management in the accounts package.
Added new files and changes related to plugin management in the core package.
Updated the provider package to include new types and imports related to plugin management.
Updated the SmartAccountProvider class in the provider package to include support for provider decorators.
Updated the disconnect method in the SmartAccountProvider class to include support for provider decorators.
Added new files and changes related to plugin management in the msca package.
Added new exports and types related to plugin management in the accounts package.

The following files were skipped due to too many changes: packages/core/src/account/types.ts, packages/accounts/src/msca/plugins/multi-owner.ts, packages/accounts/scripts/plugingen.ts, packages/accounts/src/msca/abis/IPluginManager.ts, packages/accounts/src/msca/builder.ts

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

avasisht23

some questions on setup, thanks for porting this over from 6900

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

avasisht23 · 2023-11-27T01:10:48Z

packages/accounts/src/msca/plugins/manager/decorator.ts

nit: should the plugin-manager be under "plugins"? especially since it's a separate interface than pluginExecutors?

i'd have put it in a different folder under msca, but curious what you think.

Oh I was gonna keep all plugin stuff in plugins the plugins/manager was meant to denote that it is separate from executors. What are you suggesting as a alt? I'm open to moving it

I was suggesting /accounts/src/msca/plugin-manager as the folder for the manager, as opposed to the /accounts/src/msca/plugins for the plugin

ah yea I'm fine with that change too

avasisht23 · 2023-11-27T01:19:59Z

packages/accounts/src/msca/plugins/manager/decorator.ts

+  type UninstallPluginParams,
+} from "./uninstallPlugin.js";
+
+export const pluginManagerDecorator = <


nit[learn] is there a reason you're using the keyword "Decorator", isnce it's mainly used for functions that wrap some context (a class/method), not an object as you have here? As I understand it from typescript, do you plan to use it like:

class ExampleClass { @pluginManagerDecorator() method() {} }

I can see this being very useful for the plugins themselves on something like execute, but as for the manager feels more like an extend function, like ".withPluginManager()"?

yea a decorator is the @ thing usually, but this is also meant to be used with the Decorator Pattern defined on provider and account: https://refactoring.guru/design-patterns/decorator

@moldy530 how should we integrate with the provider in aa-sdk?
should we have the clients of aa-sdk to directly use this decorator on the SmartAccountProvider (AlchemyProvider or other) on the client side?

yea the idea is that any ISmartAccountProvider can call .extend(pluginManagerDecorator) as a result we don't really need to provide much more than this. I think we can take all of the decorators that we build for MSCA in one big mscaDecorators or something to make this easier

@denniswon see: #287

does this need any re-factoring re: fitting into #287's new Plugin interface?

Nope, I think it's fine for this to be standalone as it is here. the MSCA builder will just leverage this as is

packages/accounts/src/msca/plugins/manager/installPlugin.ts

packages/accounts/src/msca/plugins/manager/uninstallPlugin.ts

packages/accounts/src/msca/plugins/manager/installPlugin.ts

denniswon · 2023-11-27T19:11:34Z

packages/accounts/src/msca/plugins/manager/decorator.ts

+  type UninstallPluginParams,
+} from "./uninstallPlugin.js";
+
+export const pluginManagerDecorator = <


@moldy530 how should we integrate with the provider in aa-sdk?
should we have the clients of aa-sdk to directly use this decorator on the SmartAccountProvider (AlchemyProvider or other) on the client side?

avasisht23

last few recs, then lgtm

avasisht23 · 2023-11-29T22:36:26Z

packages/accounts/src/msca/plugins/manager/decorator.ts

I was suggesting /accounts/src/msca/plugin-manager as the folder for the manager, as opposed to the /accounts/src/msca/plugins for the plugin

avasisht23 · 2023-11-29T22:58:40Z

packages/accounts/src/msca/plugins/manager/decorator.ts

+  type UninstallPluginParams,
+} from "./uninstallPlugin.js";
+
+export const pluginManagerDecorator = <


does this need any re-factoring re: fitting into #287's new Plugin interface?

avasisht23

lgtm!

denniswon · 2023-12-01T00:45:25Z

packages/accounts/src/msca/plugin-manager/installPlugin.ts

+  manifestHash?: Hash;
+  pluginInitData?: Hash;
+  dependencies?: Address[];
+  injectedHooks?: InjectedHook[];


why do we have these here? are there cases where plugin manifest contract cannot be read through rpc?

this is on the interface: https://eips.ethereum.org/EIPS/eip-6900#ipluginmanagersol

* feat: add some plugin generation logic * chore: add generate commands * style: apply PR suggestion Co-authored-by: Dennis Won <[email protected]> * 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 <[email protected]>

* 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

* 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 <[email protected]> * 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 <[email protected]> * 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 <[email protected]> Co-authored-by: avasisht23 <[email protected]>

* 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 <[email protected]> * 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 <[email protected]> * chore: lint * feat: add plugin manager decorator for MSCA (#274) * 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 <[email protected]> * 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 <[email protected]> * 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 <[email protected]> Co-authored-by: avasisht23 <[email protected]> * fix: missed some plugingen fixes * refactor: change the names of the plugin decorators and add example usages (#308) * feat: extend msca account with account loupe decorators (#309) * 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 <[email protected]> * Update packages/core/src/account/types.ts Co-authored-by: Michael Moldoveanu <[email protected]> * Update packages/core/src/account/types.ts Co-authored-by: Michael Moldoveanu <[email protected]> * Update packages/accounts/src/msca/account-loupe/decorator.ts Co-authored-by: Michael Moldoveanu <[email protected]> * fix: fix lint and build --------- Co-authored-by: Michael Moldoveanu <[email protected]> * fix: update the logic for signing 1271 messages * feat: msca plugingen to accept multichain address format (#314) * feat: msca plugingen to accept multichain address format * Update packages/accounts/scripts/plugingen.ts Co-authored-by: Michael Moldoveanu <[email protected]> * Update packages/accounts/wagmi.config.ts Co-authored-by: Michael Moldoveanu <[email protected]> * feat: changed address field in plugingenconfig to addresses --------- Co-authored-by: Michael Moldoveanu <[email protected]> * feat: msca token receiver plugin with opt out option to exclude default 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: add session key plugin abi and plugingen (#284) * 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 * feat: msca plugin provider decorator to support user op overrides (#342) * feat: msca plugingen to generate subfolders for each plugin (#350) --------- Co-authored-by: Dennis Won <[email protected]> Co-authored-by: avasisht23 <[email protected]>

* 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 <[email protected]> * 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 <[email protected]> * 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 <[email protected]> Co-authored-by: avasisht23 <[email protected]>

moldy530 force-pushed the moldy/plugin-manager branch from 012fa4e to 0453694 Compare November 22, 2023 20:40

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

denniswon force-pushed the moldy/plugin-manager branch from 0453694 to b3cbe07 Compare November 24, 2023 03:07

avasisht23 reviewed Nov 27, 2023

View reviewed changes

denniswon reviewed Nov 27, 2023

View reviewed changes

moldy530 force-pushed the moldy/plugin-manager branch from b3cbe07 to 56d6277 Compare November 27, 2023 21:26

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

moldy530 force-pushed the moldy/plugin-manager branch 2 times, most recently from 4c1b14b to 9052c2e Compare November 28, 2023 16:14

avasisht23 force-pushed the msca-base branch 2 times, most recently from e453d12 to 26460de Compare November 29, 2023 18:23

moldy530 force-pushed the moldy/plugin-manager branch 2 times, most recently from 6a2cce7 to 7a7328f Compare November 29, 2023 21:56

avasisht23 reviewed Nov 29, 2023

View reviewed changes

moldy530 force-pushed the moldy/plugin-manager branch from 7a7328f to 9e24f7b Compare November 30, 2023 16:33

moldy530 marked this pull request as ready for review November 30, 2023 20:03

moldy530 requested review from rthomare, dancoombs and mokok123 as code owners November 30, 2023 20:03

denniswon approved these changes Nov 30, 2023

View reviewed changes

avasisht23 approved these changes Dec 1, 2023

View reviewed changes

denniswon reviewed Dec 1, 2023

View reviewed changes

avasisht23 force-pushed the msca-base branch from 26460de to ba7f7c4 Compare December 1, 2023 01:23

denniswon force-pushed the moldy/plugin-manager branch from 9e24f7b to ef0f578 Compare December 1, 2023 01:31

avasisht23 force-pushed the msca-base branch from ba7f7c4 to e45e903 Compare December 1, 2023 08:54

moldy530 and others added 5 commits December 1, 2023 11:24

feat: add initial skeleton for 6900 account support

d5bfdf5

chore: update plugin gen

5f4c849

feat: add plugin manager decorator for MSCA

39690c8

feat: add a mechanism for adding provider decorators to accounts (#287)

eb454b6

* 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

moldy530 force-pushed the moldy/plugin-manager branch from 8c812a8 to eb454b6 Compare December 1, 2023 16:25

moldy530 merged commit 0f62d68 into msca-base Dec 1, 2023
2 of 3 checks passed

moldy530 deleted the moldy/plugin-manager branch December 1, 2023 16:25

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add plugin manager decorator for MSCA #274

feat: add plugin manager decorator for MSCA #274

moldy530 commented Nov 22, 2023 •

edited by pr-codex bot

Loading

avasisht23 left a comment

avasisht23 Nov 27, 2023

moldy530 Nov 27, 2023

avasisht23 Nov 29, 2023

moldy530 Nov 30, 2023

avasisht23 Nov 27, 2023

moldy530 Nov 27, 2023

denniswon Nov 27, 2023

moldy530 Nov 27, 2023

moldy530 Nov 28, 2023

avasisht23 Nov 29, 2023

moldy530 Nov 30, 2023

denniswon Nov 27, 2023

avasisht23 left a comment

avasisht23 Nov 29, 2023

avasisht23 Nov 29, 2023

avasisht23 left a comment

denniswon Dec 1, 2023

avasisht23 Dec 1, 2023

feat: add plugin manager decorator for MSCA #274

feat: add plugin manager decorator for MSCA #274

Conversation

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

Pull Request Checklist

PR-Codex overview

Detailed summary:

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

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

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

moldy530 commented Nov 22, 2023 •

edited by pr-codex bot

Loading