docs: entrypoint v.7 related update doc #594

denniswon · 2024-04-18T17:25:42Z

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, and guidelines for updating/adding docs can be found in the contribution guide)
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? (e.g. feat!: breaking change)
Did you run lint (yarn lint:check) and fix any issues? (yarn lint:write)
Did you follow the contribution guidelines?

PR-Codex overview

This PR updates documentation and migration guides related to EntryPoint support in aa-sdk.

Detailed summary

Added EntryPoint Support documentation.
Added EntryPoint v0.7 Update Guide.
Updated SmartContractAccount instantiation with entryPoint parameter.
Updated BundlerClient and SmartAccountClient for EntryPoint version compatibility.
Updated UserOperationOverrides for EntryPoint v0.7.

The following files were skipped due to too many changes: site/using-smart-accounts/entrypoint-v7.md

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

denniswon · 2024-04-19T08:15:25Z

@avasisht23 @dphilipson @rthomare @willhennessy @adam-alchemy @dancoombs

This overview/type PR for updating to Entrypoint v0.7 is ready for review.

dphilipson

Looking good! Some initial comments.

site/migration-guides/entrypoint-v7.md

dphilipson · 2024-04-19T22:09:50Z

site/migration-guides/entrypoint-v7.md

+
+#### `stateOverride` field added to `UserOperationOverrides` for validating and estimating gas for transactions
+
+The state overrides during transaction calls (e.g., [`eth_call`](https://docs.alchemy.com/reference/eth-call) and [`eth_estimateGas`](https://docs.alchemy.com/reference/eth-estimategas)) allow for more flexible testing and gas estimation. However, not all networks support this feature. For networks lacking state overrides, `Entrypoint` v0.7 introduced the `delegateAndRevert()` function to be used as a workaround. It aids in validating and estimating gas for transactions by simulating conditions without permanently changing the on-chain state.


As we discussed in person: this is not what delegateAndRevert is for. delegateAndRevert is useful internally for bundlers but not for common uses for most developers.

The new state overrides, as an argument to eth_estimateUserOperationGas are a separate feature and does depend on state overrides being present in the chain using them. This is because general-purpose state overrides can change the state of any address, including balance, code, or storage, while delegateAndRevert is only useful for changing the code of the entry point.

but according to the official v0.7 release note, and the linked [PR](https://github.com/eth-infinitism/account-abstraction/pull/365) for `delegateAndRevert`, it says
"Minimal "static" call from EntryPoint to simulate special cases. Equivalent to the EntryPointSimulations in purpose, but doesn't require stateOverride.
Executes code on behalf of entryPoint using delegateCall, and revert with the result"

This sounds like this enables similar start overrides-like simulation to be done on chains without state overrides support in eth_call/eth_estimateGas?

cc: @dancoombs

site/using-smart-accounts/entrypoint-v7/how-to-estimate-gas.md

moldy530 · 2024-04-23T15:00:40Z

site/.vitepress/sidebar/index.ts

@@ -26,6 +26,18 @@ export const sidebar: DefaultTheme.Sidebar = [
          { text: "Send UserOperations", link: "/send-uos" },
        ],
      },
+      {
+        text: "Migration Guides",


I thought we weren't going to be adding this section based on offline chats?

what offline chats with me? don't remember, so any suggestions on where to put the Entrypoint v.7 doc then?

moldy530 · 2024-04-23T15:03:12Z

site/migration-guides/entrypoint-v7.md

This isn't so much a migration guide as those are meant to just be migrations between versions of the SDK. This to me seems more like it should be a doc under Using smart accounts called Switching entry point versions or something. defer to will on the correct name in the side bar

Agreed. Sounds good. So the plan is remove Migration Guides section, and just put this along side of other guides under Using smart accounts.

updated @willhennessy @moldy530

… sdk

denniswon force-pushed the denniswon/entrypoint-v7-doc branch 6 times, most recently from 1d3f389 to a0a181d Compare April 19, 2024 07:54

denniswon changed the title ~~docs: entrypoint v.7 docs~~ docs: updating to entrypoint v.7 overview Apr 19, 2024

denniswon marked this pull request as ready for review April 19, 2024 07:54

denniswon requested review from moldy530, rthomare, dancoombs, mokok123 and avasisht23 as code owners April 19, 2024 07:54

denniswon requested review from dphilipson and willhennessy April 19, 2024 07:55

denniswon force-pushed the denniswon/entrypoint-v7-doc branch from a0a181d to 09356f6 Compare April 19, 2024 08:13

denniswon force-pushed the denniswon/entrypoint-v7-doc branch 2 times, most recently from 1e7fe6a to 549863f Compare April 19, 2024 22:06

dphilipson reviewed Apr 19, 2024

View reviewed changes

denniswon force-pushed the denniswon/entrypoint-v7-doc branch 4 times, most recently from 603477e to ab62d3d Compare April 21, 2024 01:57

denniswon changed the base branch from main to denniswon/nit-doc April 21, 2024 02:04

denniswon force-pushed the denniswon/entrypoint-v7-doc branch 3 times, most recently from fe12d27 to bc2f34a Compare April 21, 2024 02:17

denniswon changed the base branch from denniswon/nit-doc to denniswon/doc-middleware April 21, 2024 02:24

denniswon force-pushed the denniswon/doc-middleware branch from 0508011 to dc44fa5 Compare April 21, 2024 03:54

denniswon force-pushed the denniswon/entrypoint-v7-doc branch from bc2f34a to f6675ae Compare April 21, 2024 04:00

denniswon deleted the branch main April 21, 2024 16:06

denniswon closed this Apr 21, 2024

denniswon deleted the denniswon/entrypoint-v7-doc branch April 21, 2024 16:07

denniswon restored the denniswon/entrypoint-v7-doc branch April 21, 2024 16:12

denniswon reopened this Apr 21, 2024

denniswon force-pushed the denniswon/doc-middleware branch from dc44fa5 to 2d4dd10 Compare April 21, 2024 17:49

denniswon force-pushed the denniswon/entrypoint-v7-doc branch from f6675ae to e41dcd0 Compare April 21, 2024 17:49

denniswon changed the title ~~docs: updating to entrypoint v.7 overview~~ docs: entrypoint v.7 related update doc Apr 22, 2024

denniswon force-pushed the denniswon/doc-middleware branch 2 times, most recently from 2e8500f to 1a6bdad Compare April 23, 2024 03:31

Base automatically changed from denniswon/doc-middleware to main April 23, 2024 03:37

moldy530 reviewed Apr 23, 2024

View reviewed changes

docs: update account kit documentation with up to date version of the…

9f3bcb5

… sdk

denniswon force-pushed the denniswon/entrypoint-v7-doc branch from e41dcd0 to 975249b Compare April 23, 2024 16:26

docs: entrypoint v.7 overview, types, and v7 migration doc

4355287

denniswon force-pushed the denniswon/entrypoint-v7-doc branch from 975249b to 4355287 Compare April 23, 2024 16:28

denniswon merged commit 124b985 into main Apr 23, 2024
2 checks passed

denniswon deleted the denniswon/entrypoint-v7-doc branch April 23, 2024 16:42

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: entrypoint v.7 related update doc #594

docs: entrypoint v.7 related update doc #594

denniswon commented Apr 18, 2024 •

edited by pr-codex bot

Loading

denniswon commented Apr 19, 2024

dphilipson left a comment

dphilipson Apr 19, 2024

denniswon Apr 20, 2024

moldy530 Apr 23, 2024

denniswon Apr 23, 2024

moldy530 Apr 23, 2024

denniswon Apr 23, 2024

denniswon Apr 23, 2024

denniswon Apr 23, 2024


		#### `stateOverride` field added to `UserOperationOverrides` for validating and estimating gas for transactions

		The state overrides during transaction calls (e.g., [`eth_call`](https://docs.alchemy.com/reference/eth-call) and [`eth_estimateGas`](https://docs.alchemy.com/reference/eth-estimategas)) allow for more flexible testing and gas estimation. However, not all networks support this feature. For networks lacking state overrides, `Entrypoint` v0.7 introduced the `delegateAndRevert()` function to be used as a workaround. It aids in validating and estimating gas for transactions by simulating conditions without permanently changing the on-chain state.

docs: entrypoint v.7 related update doc #594

docs: entrypoint v.7 related update doc #594

Conversation

denniswon commented Apr 18, 2024 • edited by pr-codex bot Loading

Pull Request Checklist

PR-Codex overview

Detailed summary

denniswon commented Apr 19, 2024

dphilipson 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

denniswon commented Apr 18, 2024 •

edited by pr-codex bot

Loading