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 uo sim docs #254

Merged
merged 5 commits into from
Nov 17, 2023
Merged

docs: add uo sim docs #254

merged 5 commits into from
Nov 17, 2023

Conversation

avasisht23
Copy link
Contributor

@avasisht23 avasisht23 commented Nov 15, 2023

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

Detailed summary

  • This PR adds a new method withAlchemyUserOpSimulation() to the provider.ts file in the alchemy package.
  • It also adds new code snippets and documentation files related to simulating user operations.
  • The PR also updates the configuration files and documentation to include the new methods and middleware.

The following files were skipped due to too many changes: site/guides/sim-user-operation.md

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

@avasisht23
Copy link
Contributor Author

avasisht23 commented Nov 15, 2023

@avasisht23 avasisht23 force-pushed the 11-13-feat_add_useroperation_simulation branch from 6a047ab to bd3250a Compare November 15, 2023 19:23
@avasisht23 avasisht23 force-pushed the 11-15-docs_add_uo_sim_docs branch 2 times, most recently from 728c1eb to 39d947f Compare November 15, 2023 19:39
@avasisht23 avasisht23 force-pushed the 11-13-feat_add_useroperation_simulation branch from ad0e4c4 to 38f9d40 Compare November 15, 2023 20:16
@avasisht23 avasisht23 force-pushed the 11-15-docs_add_uo_sim_docs branch from 1070225 to bb47770 Compare November 15, 2023 20:16
@avasisht23 avasisht23 force-pushed the 11-13-feat_add_useroperation_simulation branch from 38f9d40 to f9bb661 Compare November 17, 2023 00:44
@avasisht23 avasisht23 force-pushed the 11-15-docs_add_uo_sim_docs branch from bb47770 to f96620c Compare November 17, 2023 00:44
@avasisht23 avasisht23 force-pushed the 11-13-feat_add_useroperation_simulation branch from f9bb661 to a435f08 Compare November 17, 2023 00:45
@avasisht23 avasisht23 force-pushed the 11-15-docs_add_uo_sim_docs branch 3 times, most recently from 0be12bb to 1eaf0cc Compare November 17, 2023 00:50
@avasisht23
Copy link
Contributor Author

avasisht23 commented Nov 17, 2023

Merge activity

  • Nov 16, 9:59 PM: @avasisht23 started a stack merge that includes this pull request via Graphite.
  • Nov 16, 9:59 PM: Graphite rebased this pull request as part of a merge.
  • Nov 16, 10:02 PM: @avasisht23 merged this pull request with Graphite.

Base automatically changed from 11-13-feat_add_useroperation_simulation to development November 17, 2023 02:59
@avasisht23 avasisht23 force-pushed the 11-15-docs_add_uo_sim_docs branch from 1eaf0cc to c5fd729 Compare November 17, 2023 02:59
@avasisht23 avasisht23 merged commit d08e774 into development Nov 17, 2023
3 checks passed
@avasisht23 avasisht23 deleted the 11-15-docs_add_uo_sim_docs branch November 17, 2023 03:02
@moldy530 moldy530 mentioned this pull request Nov 17, 2023
7 tasks
moldy530 pushed a commit that referenced this pull request Nov 17, 2023
# 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](https://www.conventionalcommits.org/en/v1.0.0/) standard?
- [ ] Does your PR title also follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) 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`?

<!-- start pr-codex -->

---

## PR-Codex overview
### Detailed summary
- Added a new method `withAlchemyUserOpSimulation()` to the `AlchemyProvider` class that adds the Alchemy UserOperation Simulation middleware.
- Added a new middleware method `withAlchemyUserOpSimulation()` to the `aa-alchemy` package for simulating asset changes resulting from user operation.
- Added documentation for `withAlchemyUserOpSimulation()` method in the `aa-alchemy` package.
- Added documentation for `simulateUserOperationAssetChanges()` method in the `aa-alchemy` package.
- Added documentation for `withUOSimulationMiddleware()` method in the `aa-core` package.
- Added a new guide on how to simulate a User Operation using Alchemy's Account Kit.

> The following files were skipped due to too many changes: `site/guides/sim-user-operation.md`

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

<!-- end pr-codex -->
moldy530 pushed a commit that referenced this pull request Nov 17, 2023
# 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](https://www.conventionalcommits.org/en/v1.0.0/) standard?
- [ ] Does your PR title also follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) 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`?

<!-- start pr-codex -->

---

## PR-Codex overview
### Detailed summary
- Added a new method `withAlchemyUserOpSimulation()` to the `AlchemyProvider` class that adds the Alchemy UserOperation Simulation middleware.
- Added a new middleware method `withAlchemyUserOpSimulation()` to the `aa-alchemy` package for simulating asset changes resulting from user operation.
- Added documentation for `withAlchemyUserOpSimulation()` method in the `aa-alchemy` package.
- Added documentation for `simulateUserOperationAssetChanges()` method in the `aa-alchemy` package.
- Added documentation for `withUOSimulationMiddleware()` method in the `aa-core` package.
- Added a new guide on how to simulate a User Operation using Alchemy's Account Kit.

> The following files were skipped due to too many changes: `site/guides/sim-user-operation.md`

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

<!-- end pr-codex -->
@moldy530 moldy530 mentioned this pull request Dec 1, 2023
8 tasks
avasisht23 added a commit that referenced this pull request Dec 3, 2023
- [ ] 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](https://www.conventionalcommits.org/en/v1.0.0/) standard?
- [ ] Does your PR title also follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) 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`?

<!-- start pr-codex -->

---

- Added a new method `withAlchemyUserOpSimulation()` to the `AlchemyProvider` class that adds the Alchemy UserOperation Simulation middleware.
- Added a new middleware method `withAlchemyUserOpSimulation()` to the `aa-alchemy` package for simulating asset changes resulting from user operation.
- Added documentation for `withAlchemyUserOpSimulation()` method in the `aa-alchemy` package.
- Added documentation for `simulateUserOperationAssetChanges()` method in the `aa-alchemy` package.
- Added documentation for `withUOSimulationMiddleware()` method in the `aa-core` package.
- Added a new guide on how to simulate a User Operation using Alchemy's Account Kit.

> The following files were skipped due to too many changes: `site/guides/sim-user-operation.md`

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

<!-- end pr-codex -->
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.

2 participants