feat: entry point address as optional to SmartAccountProvider #180

denniswon · 2023-10-29T18:44:00Z

app.asana.com/0/1205598840815267/1205773893380310/f

Part of the task linked above, removed entrypoint contract address param from SmartAccountProvider constructor params/class fields and instead, made entry point contract of the linked SCA account to be the source of entry point contract address.

In case the entry point contract address is needed prior to account being connected, entry point contract address defaults to the default entry point contract address from the getDefaultEntryPointContract helper.

Follow up PRs will made to make entry point contract address param for SmartContractAccount class as optional (in case user wants to use their own for some reason).

PR-Codex overview

Detailed summary

Added defaults.js and userop.js to the utils directory in packages/core/src/utils.
Modified privy.ts, fireblocks.md, and lit.md in the site/snippets and site/smart-accounts/signers directories.
Added readonly entryPointAddress: Address to types.ts in packages/core/src/provider.
Updated @alchemy/aa-core version in packages/alchemy/package.json and packages/accounts/package.json.
Modified introduction.md in site/packages/aa-alchemy/provider, site/packages/aa-alchemy/middleware, site/packages/aa-ethers/provider-adapter, and site/packages/aa-core/client.
Updated getDefaultSimpleAccountFactoryAddress and getDefaultLightAccountFactoryAddress imports in index.ts and light-account/__tests__/account.test.ts in packages/accounts/src and light-account/utils.js in packages/core/src/account.
Updated @alchemy/aa-accounts, @alchemy/aa-alchemy, and @alchemy/aa-core versions in examples/aa-simple-dapp/package.json and examples/alchemy-daapp/package.json.
Modified fromEthersProvider.md in site/packages/aa-ethers/provider-adapter.
Modified provider.ts in packages/alchemy/src.
Modified introduction.md in site/packages/aa-alchemy/middleware.
Updated getDefaultLightAccountFactoryAddress import in index.ts in packages/core/src.
Modified simple.test.ts in packages/core/src/account/__tests__.
Updated @alchemy/aa-accounts, @alchemy/aa-alchemy, and @alchemy/aa-core versions in examples/aa-simple-dapp/package.json and examples/alchemy-daapp/package.json.
Modified connect.md in site/packages/aa-ethers/account-signer.
Modified createPublicErc4337Client.md in site/packages/aa-core/client.
Modified provider.test.ts in packages/alchemy/src/__tests__.
Modified ethers-provider.ts in site/snippets.
Modified sponsoring-gas.md in site/smart-accounts.
Modified index.tsx in examples/aa-simple-dapp/src/context/wallet.
Modified withAlchemyGasManager.md in site/packages/aa-alchemy/middleware.
Modified types.ts in packages/core/src/account.
Modified userop.ts in packages/core/src/utils.
Modified config.ts in site/.vitepress.
Modified capsule.md in site/smart-accounts/signers.

The following files were skipped due to too many changes: site/smart-accounts/signers/capsule.md, site/smart-accounts/signers/dynamic.md, site/smart-accounts/signers/web3auth.md, packages/accounts/src/kernel-zerodev/e2e-tests/kernel-account.test.ts, packages/core/src/__tests__/utils.test.ts, packages/alchemy/src/middleware/gas-manager.ts, site/smart-accounts/signers/turnkey.md, packages/core/src/provider/schema.ts, site/packages/aa-core/utils/getDefaultEntryPointAddress.md, site/smart-accounts/signers/magic.md, site/packages/aa-core/utils/getDefaultSimpleAccountFactoryAddress.md, site/packages/aa-accounts/utils/getDefaultLightAccountFactoryAddress.md, site/snippets/ethers-signer.ts, site/snippets/core-provider.ts, packages/accounts/src/kernel-zerodev/README.md, packages/accounts/src/light-account/utils.ts, packages/accounts/src/kernel-zerodev/__tests__/account.test.ts, site/snippets/provider.ts, packages/core/src/provider/__tests__/base.test.ts, yarn.lock, site/snippets/account-ethers.ts, examples/alchemy-daapp/src/surfaces/onboarding/OnboardingDataModels.tsx, site/snippets/account-alchemy.ts, packages/ethers/src/provider-adapter.ts, site/snippets/account-core.ts, packages/core/src/provider/base.ts, packages/ethers/e2e-tests/simple-account.test.ts, packages/ethers/src/__tests__/provider-adapter.test.ts, examples/aa-simple-dapp/src/hooks/useAlchemyProvider.ts, packages/accounts/src/light-account/e2e-tests/light-account.test.ts, packages/core/e2e-tests/simple-account.test.ts, packages/core/src/utils/defaults.ts, site/snippets/light-account.ts, packages/alchemy/e2e-tests/simple-account.test.ts, examples/alchemy-daapp/src/surfaces/onboarding/OnboardingController.ts

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

denniswon · 2023-10-29T21:10:40Z

moldy530

couple nits, but LGTM otherwise

packages/accounts/package.json

packages/alchemy/package.json

packages/core/src/utils/defaults.ts

examples/alchemy-daapp/src/surfaces/onboarding/OnboardingController.ts

avasisht23

wanted to discuss current approach re: escape in the opts param vs. if you considered just having the entrypoint be an optional constructor param with a default value if not present.

thanks for reflecting the change across all surfaces 🙏

site/packages/aa-core/utils/getDefaultEntryPointContract.md

site/packages/aa-core/utils/getDefaultSimpleAccountFactory.md

packages/core/src/utils/index.ts

avasisht23 · 2023-10-30T15:49:15Z

packages/core/src/utils/defaults.ts

+ * @returns a {@link abi.Address} for the given chain
+ * @throws if the chain doesn't have an address currently deployed
+ */
+export const getDefaultEntryPointContract = (chain: Chain): Address => {


nit(naming): to me the method name implies retrieving an object containing details about a contract, not just the address.

should we name it: getDefaultEntryPointAddress

packages/core/src/utils/defaults.ts

packages/core/src/provider/base.ts

avasisht23 · 2023-10-30T15:52:52Z

packages/core/src/provider/base.ts

@@ -87,7 +96,6 @@ export type SmartAccountProviderConfig<
 > = {
  rpcProvider: string | PublicErc4337Client<TTransport>;
  chain: Chain;
-  entryPointAddress: Address;


see above re: question on why we can't just make this optional with a default value,

packages/accounts/src/kernel-zerodev/README.md

packages/accounts/src/light-account/utils.ts

…lass

Co-authored-by: Ajay Vasisht <43521356+avasisht23@users.noreply.github.com>

* feat: abstract out entry point contract address from SCA provider params * feat: make entry point address as an optional param to SCA provider class * feat: update docs for the new utils methods * Update site/packages/aa-core/utils/getDefaultEntryPointContract.md Co-authored-by: Ajay Vasisht <43521356+avasisht23@users.noreply.github.com> * Update site/packages/aa-core/utils/getDefaultSimpleAccountFactory.md Co-authored-by: Ajay Vasisht <43521356+avasisht23@users.noreply.github.com> * chore: nit error message update and refactoring --------- Co-authored-by: Ajay Vasisht <43521356+avasisht23@users.noreply.github.com>

denniswon requested review from moldy530, rthomare, dancoombs, mokok123 and avasisht23 as code owners October 29, 2023 18:44

denniswon force-pushed the denniswon/abstract-entrypoint branch 4 times, most recently from 79efd67 to bc2e02b Compare October 29, 2023 20:52

denniswon force-pushed the denniswon/abstract-entrypoint branch from bc2e02b to f2717f8 Compare October 30, 2023 02:59

denniswon changed the base branch from development to denniswon/chore October 30, 2023 03:00

denniswon force-pushed the denniswon/abstract-entrypoint branch 2 times, most recently from 8ff1972 to 1b90588 Compare October 30, 2023 03:32

denniswon changed the title ~~feat: abstract out entry point contract address from SCA provider params~~ feat: entry point address as optional to SmartAccountProvider Oct 30, 2023

moldy530 approved these changes Oct 30, 2023

View reviewed changes

avasisht23 reviewed Oct 30, 2023

View reviewed changes

Base automatically changed from denniswon/chore to development October 30, 2023 18:12

denniswon force-pushed the denniswon/abstract-entrypoint branch 2 times, most recently from 424329d to 68628f2 Compare October 30, 2023 21:17

denniswon and others added 6 commits October 30, 2023 14:18

feat: abstract out entry point contract address from SCA provider params

8df330b

feat: make entry point address as an optional param to SCA provider c…

4e43b71

…lass

feat: update docs for the new utils methods

e7411c4

Update site/packages/aa-core/utils/getDefaultEntryPointContract.md

9d84538

Co-authored-by: Ajay Vasisht <43521356+avasisht23@users.noreply.github.com>

Update site/packages/aa-core/utils/getDefaultSimpleAccountFactory.md

e2c07cf

Co-authored-by: Ajay Vasisht <43521356+avasisht23@users.noreply.github.com>

chore: nit error message update and refactoring

a05006f

denniswon force-pushed the denniswon/abstract-entrypoint branch from 68628f2 to a05006f Compare October 30, 2023 21:19

denniswon merged commit 96a3f8c into development Oct 30, 2023
3 checks passed

denniswon deleted the denniswon/abstract-entrypoint branch October 30, 2023 21:25

moldy530 mentioned this pull request Nov 10, 2023

feat!: cut new release #233

Merged

moldy530 mentioned this pull request Nov 10, 2023

chore: merge back into main after manual deploys [skip-ci] #235

Merged

moldy530 mentioned this pull request Nov 17, 2023

chore: release/v1.2.0 #268

Merged

7 tasks

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: entry point address as optional to SmartAccountProvider #180

feat: entry point address as optional to SmartAccountProvider #180

denniswon commented Oct 29, 2023 •

edited by pr-codex bot

Loading

denniswon commented Oct 29, 2023

moldy530 left a comment

avasisht23 left a comment

avasisht23 Oct 30, 2023

avasisht23 Oct 30, 2023

feat: entry point address as optional to SmartAccountProvider #180

feat: entry point address as optional to SmartAccountProvider #180

Conversation

denniswon commented Oct 29, 2023 • edited by pr-codex bot Loading

PR-Codex overview

Detailed summary

denniswon commented Oct 29, 2023

moldy530 left a comment

Choose a reason for hiding this comment

avasisht23 left a comment

Choose a reason for hiding this comment

avasisht23 Oct 30, 2023

Choose a reason for hiding this comment

avasisht23 Oct 30, 2023

Choose a reason for hiding this comment

denniswon commented Oct 29, 2023 •

edited by pr-codex bot

Loading