feat: aa-core smart account provider fee options to handle more systematic fee options for userops #276

denniswon · 2023-11-24T00:41:13Z

per https://app.asana.com/0/1205598840815267/1205909484815093/f

this task is a ground work for supporting more advanced ways to enable/manage gas estimates during the user operation creation from the sdk.

This PR specifically defines and implements the smart account provider behavior when populating the gas fields of the user operation, enabling more stress-free and less error-prone experience for developers.

Tested with e2e tests that used to be more flaky, but fixed to be rather consistent on the PR #243

PR-Codex overview

This PR focuses on updating the gas estimation and fee options in the Alchemy codebase.

Detailed summary:

Renamed estimateGas to delegateGasEstimation in withAlchemyGasManager.md
Removed FeeOpts type in type.ts
Added RequestGasAndPaymasterAndDataOverrides type in index.ts
Updated ClientWithAlchemyMethods type in client.ts
Updated log level in logger.ts
Added utility functions in index.ts
Added new types in types/index.ts
Updated AccountMiddlewareFn and related types in provider/types.ts
Updated schema in schema.ts
Added utility function in bigint.ts

The following files were skipped due to too many changes: packages/core/src/utils/bigint.ts, packages/alchemy/src/middleware/gas-fees.ts, packages/core/src/utils/index.ts, packages/core/src/provider/schema.ts, packages/accounts/src/light-account/e2e-tests/light-account.test.ts, packages/core/e2e-tests/simple-account.test.ts, packages/alchemy/src/provider.ts, packages/alchemy/src/middleware/gas-manager.ts, packages/alchemy/e2e-tests/simple-account.test.ts, packages/core/src/provider/base.ts

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

packages/core/src/provider/types.ts

packages/core/src/schema.ts

packages/alchemy/src/middleware/gas-manager.ts

packages/core/src/provider/base.ts

avasisht23

think it might be good to review provider/base.ts, provider/types.ts, and middleware/gas-manager.ts live as a team. left comments on everything else though.

site/packages/aa-alchemy/middleware/withAlchemyGasManager.md

packages/core/src/utils/schema.ts

packages/core/src/utils/index.ts

packages/core/src/provider/schema.ts

packages/core/src/utils/bigint.ts

packages/core/src/provider/base.ts

packages/alchemy/src/middleware/gas-manager.ts

packages/core/src/utils/schema.ts

packages/core/src/provider/base.ts

packages/alchemy/src/middleware/gas-manager.ts

avasisht23

some qs/nits

avasisht23 · 2023-11-28T20:14:32Z

packages/core/src/utils/bigint.ts

+ * @param args a list of bigints to get the max of
+ * @returns the min bigint in the list
+ */
+export const bigIntMin = (...args: bigint[]) => {


bump still don't see it used, you're welcome to keep it if you anticipate a use case.

packages/accounts/src/light-account/e2e-tests/light-account.test.ts

packages/alchemy/e2e-tests/simple-account.test.ts

packages/core/src/utils/index.ts

packages/alchemy/e2e-tests/simple-account.test.ts

packages/alchemy/src/middleware/gas-fees.ts

packages/alchemy/src/middleware/gas-manager.ts

…matic fee options for userops

…are functions

* feat: support updated overrides for alchemy request gas and paymaster and data * feat: rebase parent where account middle func def is updated

Co-authored-by: Ajay Vasisht <[email protected]>

avasisht23

few leftover comments to address?

packages/core/src/utils/index.ts

packages/alchemy/e2e-tests/simple-account.test.ts

avasisht23 · 2023-11-29T18:19:14Z

packages/core/src/provider/types.ts

@@ -325,7 +329,8 @@ export interface ISmartAccountProvider<
   * Overrides the feeDataGetter middleware which is used for setting the fee fields on the UserOperation
   * prior to execution.
   *
-   * @param override - a function for overriding the default feeDataGetter middleware
+   * @param override   - a function for overriding the default feeDataGetter middleware


avasisht23 · 2023-11-29T18:19:21Z

packages/core/src/provider/types.ts

@@ -325,7 +329,8 @@ export interface ISmartAccountProvider<
   * Overrides the feeDataGetter middleware which is used for setting the fee fields on the UserOperation
   * prior to execution.
   *
-   * @param override - a function for overriding the default feeDataGetter middleware
+   * @param override   - a function for overriding the default feeDataGetter middleware
+   * @param feeOptions - optional FeeDataFeeOptions to set at the global level of the provider.


packages/alchemy/src/middleware/gas-manager.ts

packages/alchemy/src/middleware/types/index.ts

packages/core/src/provider/base.ts

packages/core/src/utils/bigint.ts

packages/core/src/utils/index.ts

Co-authored-by: Ajay Vasisht <[email protected]>

Co-authored-by: Michael Moldoveanu <[email protected]>

moldy530

LGTM but there's still one unaddressed comment from @avasisht23 here

packages/core/src/provider/base.ts

avasisht23

lgtm, one last comment to address + 1 request for follow-up :) nice work!

…matic fee options for userops (#276) * feat: aa-core smart account provider fee options to handle more systematic fee options for userops * feat: remove fee options middleware and expose fee options to middleware functions * feat: aa-alchemy ergonomic support for handling gas estimation (#243) * feat: support updated overrides for alchemy request gas and paymaster and data * feat: rebase parent where account middle func def is updated * Update site/packages/aa-alchemy/middleware/withAlchemyGasManager.md Co-authored-by: Ajay Vasisht <[email protected]> * Update packages/core/src/utils/index.ts Co-authored-by: Ajay Vasisht <[email protected]> * Update packages/core/src/utils/index.ts Co-authored-by: Ajay Vasisht <[email protected]> * Update packages/core/src/provider/base.ts Co-authored-by: Michael Moldoveanu <[email protected]> * fix: alchemy gas manager 0x check for user op overrides --------- Co-authored-by: Ajay Vasisht <[email protected]> Co-authored-by: Michael Moldoveanu <[email protected]>

denniswon requested review from moldy530, rthomare, dancoombs, mokok123 and avasisht23 as code owners November 24, 2023 00:41

denniswon force-pushed the denniswon/feeoptions branch from cdd5bb8 to dc77bad Compare November 24, 2023 00:46

Base automatically changed from denniswon/loglevel to development November 24, 2023 00:55

moldy530 reviewed Nov 26, 2023

View reviewed changes

packages/core/src/provider/types.ts Outdated Show resolved Hide resolved

moldy530 reviewed Nov 26, 2023

View reviewed changes

packages/core/src/schema.ts Outdated Show resolved Hide resolved

moldy530 reviewed Nov 26, 2023

View reviewed changes

packages/alchemy/src/middleware/gas-manager.ts Outdated Show resolved Hide resolved

moldy530 reviewed Nov 26, 2023

View reviewed changes

packages/core/src/provider/base.ts Outdated Show resolved Hide resolved

avasisht23 reviewed Nov 27, 2023

View reviewed changes

denniswon force-pushed the denniswon/feeoptions branch 5 times, most recently from 8ee6b14 to 7c5dcf4 Compare November 28, 2023 17:00

denniswon changed the base branch from development to denniswon/drop-and-replace November 28, 2023 17:00

moldy530 reviewed Nov 28, 2023

View reviewed changes

packages/core/src/utils/schema.ts Show resolved Hide resolved

moldy530 reviewed Nov 28, 2023

View reviewed changes

avasisht23 reviewed Nov 28, 2023

View reviewed changes

packages/alchemy/src/middleware/gas-manager.ts Show resolved Hide resolved

denniswon force-pushed the denniswon/feeoptions branch 2 times, most recently from f15e335 to fcafec7 Compare November 29, 2023 17:25

denniswon and others added 4 commits November 29, 2023 09:27

feat: aa-core smart account provider fee options to handle more syste…

8363554

…matic fee options for userops

feat: remove fee options middleware and expose fee options to middlew…

c691d3d

…are functions

feat: aa-alchemy ergonomic support for handling gas estimation (#243)

3646c95

* feat: support updated overrides for alchemy request gas and paymaster and data * feat: rebase parent where account middle func def is updated

Update site/packages/aa-alchemy/middleware/withAlchemyGasManager.md

4106a28

Co-authored-by: Ajay Vasisht <[email protected]>

denniswon force-pushed the denniswon/feeoptions branch from fcafec7 to 9048fcb Compare November 29, 2023 17:27

denniswon changed the base branch from denniswon/drop-and-replace to development November 29, 2023 17:38

Update packages/core/src/utils/index.ts

f06f1c5

Co-authored-by: Ajay Vasisht <[email protected]>

denniswon force-pushed the denniswon/feeoptions branch from 9048fcb to f06f1c5 Compare November 29, 2023 17:40

avasisht23 reviewed Nov 29, 2023

View reviewed changes

moldy530 reviewed Nov 29, 2023

View reviewed changes

denniswon and others added 3 commits November 29, 2023 11:23

Update packages/core/src/utils/index.ts

f92c456

Co-authored-by: Ajay Vasisht <[email protected]>

Update packages/core/src/provider/base.ts

1647615

Co-authored-by: Michael Moldoveanu <[email protected]>

fix: alchemy gas manager 0x check for user op overrides

4f5d49f

denniswon force-pushed the denniswon/feeoptions branch from bb83c95 to 4f5d49f Compare November 29, 2023 19:39

moldy530 approved these changes Nov 29, 2023

View reviewed changes

avasisht23 reviewed Nov 29, 2023

View reviewed changes

packages/core/src/provider/base.ts Show resolved Hide resolved

avasisht23 approved these changes Nov 29, 2023

View reviewed changes

denniswon force-pushed the denniswon/feeoptions branch from f108d0a to 4f5d49f Compare November 30, 2023 00:51

denniswon merged commit a969bb5 into development Nov 30, 2023
6 checks passed

denniswon deleted the denniswon/feeoptions branch November 30, 2023 01:43

moldy530 mentioned this pull request Dec 1, 2023

chore: release v1.3.0 #295

Merged

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: aa-core smart account provider fee options to handle more systematic fee options for userops #276

feat: aa-core smart account provider fee options to handle more systematic fee options for userops #276

denniswon commented Nov 24, 2023 •

edited by pr-codex bot

Loading

avasisht23 left a comment

avasisht23 left a comment

avasisht23 Nov 28, 2023

avasisht23 left a comment

avasisht23 Nov 29, 2023

avasisht23 Nov 29, 2023

moldy530 left a comment

avasisht23 left a comment

feat: aa-core smart account provider fee options to handle more systematic fee options for userops #276

feat: aa-core smart account provider fee options to handle more systematic fee options for userops #276

Conversation

denniswon commented Nov 24, 2023 • edited by pr-codex bot Loading

PR-Codex overview

Detailed summary:

avasisht23 left a comment

Choose a reason for hiding this comment

avasisht23 left a comment

Choose a reason for hiding this comment

avasisht23 Nov 28, 2023

Choose a reason for hiding this comment

avasisht23 left a comment

Choose a reason for hiding this comment

avasisht23 Nov 29, 2023

Choose a reason for hiding this comment

avasisht23 Nov 29, 2023

Choose a reason for hiding this comment

moldy530 left a comment

Choose a reason for hiding this comment

avasisht23 left a comment

Choose a reason for hiding this comment

denniswon commented Nov 24, 2023 •

edited by pr-codex bot

Loading