Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add documentation for smart account provider fee options and overrides #277

Merged
merged 4 commits into from
Dec 1, 2023

Conversation

denniswon
Copy link
Contributor

@denniswon denniswon commented Nov 24, 2023

Screenshot 2023-11-23 at 6 47 49 PM
Screenshot 2023-11-23 at 6 47 58 PM
Screenshot 2023-11-23 at 6 54 16 PM


PR-Codex overview

This PR focuses on updating the BytesLike type in types.ts and updating the overrides parameter in multiple files to include additional options.

Detailed summary

  • Updated BytesLike type in types.ts to include Hex type.
  • Updated overrides parameter in multiple files to include callGasLimit, preVerificationGas, and verificationGasLimit options.

The following files were skipped due to too many changes: site/packages/aa-core/types/userOperationFeeOptionsField.md, site/packages/aa-core/types/userOperationFeeOptions.md, site/guides/sponsoring-gas/gas-sponsorship-eligibility.md, site/packages/aa-core/provider/constructor.md, site/packages/aa-core/types/userOperationOverrides.md

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


Copy link
Contributor

@avasisht23 avasisht23 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

have you thought about instead making a type glossary? can do this per package: https://viem.sh/docs/glossary/types.html

right now, these might be too much info around types. additionally, this sets a precedent that we should include docs on each type, which I think bloats our documentation a bit too much for my liking.

most of these types X have an "ifX()" method. Maybe we document those instead?

packages/core/src/types.ts Show resolved Hide resolved
@denniswon denniswon force-pushed the denniswon/update-userop-overrides branch 3 times, most recently from e7a8761 to 15ecb38 Compare November 28, 2023 02:02
Base automatically changed from denniswon/update-userop-overrides to denniswon/feeoptions November 28, 2023 02:05
@denniswon denniswon force-pushed the denniswon/feeoptions branch 6 times, most recently from 9048fcb to f06f1c5 Compare November 29, 2023 17:40
Base automatically changed from denniswon/feeoptions to development November 30, 2023 01:43
@denniswon denniswon force-pushed the denniswon/feeoptions-doc branch 3 times, most recently from 70eec7b to f1906a2 Compare November 30, 2023 02:42
@denniswon denniswon changed the base branch from development to denniswon/userop-overrides-percentage November 30, 2023 02:43
Copy link
Collaborator

@moldy530 moldy530 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

had a comment or two but LGTM otherwise

@denniswon
Copy link
Contributor Author

Screenshot 2023-11-30 at 4 05 08 PM
@avasisht23 @moldy530 I have put the basic types to the glossary section. I kept the user operation provider specific types to Provider/Types section. Following the pattern of what's done on viem doc.

Base automatically changed from denniswon/userop-overrides-percentage to development December 1, 2023 00:10
@denniswon denniswon merged commit bebe702 into development Dec 1, 2023
3 checks passed
@denniswon denniswon deleted the denniswon/feeoptions-doc branch December 1, 2023 00:12
@moldy530 moldy530 mentioned this pull request Dec 1, 2023
8 tasks
moldy530 pushed a commit that referenced this pull request Dec 1, 2023
…errides (#277)

* feat: support one-off percentage overrides for user operations

* feat: apply user op override or fee option utils in aa-core

* docs: add documentation for smart account provider fee options and overrides

* docs: add glossary section and add general types doc in the section
moldy530 pushed a commit that referenced this pull request Dec 1, 2023
…errides (#277)

* feat: support one-off percentage overrides for user operations

* feat: apply user op override or fee option utils in aa-core

* docs: add documentation for smart account provider fee options and overrides

* docs: add glossary section and add general types doc in the section
avasisht23 pushed a commit that referenced this pull request Dec 3, 2023
…errides (#277)

* feat: support one-off percentage overrides for user operations

* feat: apply user op override or fee option utils in aa-core

* docs: add documentation for smart account provider fee options and overrides

* docs: add glossary section and add general types doc in the section
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants