search

evmts / tevm-monorepo

An ecosystem of ethereum tools to build robust TypeScript applications
https://tevm.dev
MIT License
199 stars 16 forks source link

:memo: Docs: Update memoryClient jsdoc #1234

Closed roninjin10 closed 2 weeks ago

roninjin10 commented 2 weeks ago

Description

Concise description of proposed changes

Testing

Explain the quality checks that have been done on the code changes

Additional Information

Your ENS/address:

Summary by CodeRabbit

vercel[bot] commented 2 weeks ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
tevm-monorepo-tevm ❌ Failed (Inspect) Jun 21, 2024 9:51pm
changeset-bot[bot] commented 2 weeks ago

🦋 Changeset detected

Latest commit: f18e9a56fb9f2682502b062c29ad22b01bb7e655

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 4 packages | Name | Type | | ------------------- | ----- | | @tevm/memory-client | Patch | | @tevm/http-client | Patch | | @tevm/server | Patch | | tevm | Patch |

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

coderabbitai[bot] commented 2 weeks ago

[!WARNING]

Review failed

The pull request is closed.

Walkthrough

The changes introduce extensive enhancements to the @tevm/memory-client package, focusing on providing low-level APIs for interacting with the EVM. This includes adding new methods, improving documentation with detailed examples, and emphasizing the use of client.extend for adding test actions. Additionally, various documentation files have been updated to reflect these new functionalities and deprecated entities.

Changes

Files/Groups Change Summaries
.changeset/large-zoos-knock.md Introduced additional JSDoc documentation and removed references to test clients.
memory-client/src/MemoryClient.ts Removed test client references and added information on using client.extend for adding test actions.
memory-client/src/TevmActions.ts Expanded TevmActions with new methods like tevmCall, tevmDeploy, tevmGetAccount, and others. Deprecated tevmScript.
memory-client/src/createMemoryClient.js Updated documentation comments to elaborate on creating MemoryClient, actions API support, and forking networks.
docs/.../functions/createMemoryClient.md Enhanced functionality descriptions with examples and deprecated tevmScript. Detailed new functions like tevmDeploy, tevmMine, etc.
docs/.../type-aliases/MemoryClient.md Updated MemoryClient description to exclude test client references and added a TypeScript example for adding test actions using client.extend.
docs/.../type-aliases/TevmActions.md Documented new powerful actions for EVM interactions, detailed examples for various methods, and deprecated tevmScript.
docs/.../functions/createExpressMiddleware.md Added low-level access to tevm, various new functions with examples, and deprecated tevmScript.
docs/.../functions/createHttpHandler.md Introduced low-level access to tevm, new EVM interaction methods, and examples for each.
docs/.../functions/createNextApiHandler.md Enhanced documentation with new Tevm functionalities, low-level access, and examples.
docs/.../functions/createServer.md Added descriptions and examples for low-level access to tevm, new methods for interacting with Tevm, and deprecated tevmScript.
memory-client/docs/.../createMemoryClient.md Elaborated on the creation of MemoryClient, added examples of low-level EVM operations, and deprecated tevmScript in favor of tevmContract.
memory-client/docs/.../MemoryClient.md Updated the MemoryClient description to reflect wrapping of only the viem public client and added a TypeScript example for adding test actions.
memory-client/docs/.../TevmActions.md Enhanced documentation with powerful new methods for EVM interactions, deprecated tevmScript, and provided detailed examples for each action.
server/docs/.../createExpressMiddleware.md Introduced low-level access to tevm, examples for various Tevm functionalities, and deprecated tevmScript in favor of tevmContract.
server/docs/.../createHttpHandler.md Enhanced documentation with new Tevm functionalities, provided low-level API methods, and added detailed usage examples for each method.

Poem

In memory's virtual halls we delve, New methods for the client we wield. With tevmCall and tevmDeploy, Blockchain’s secrets we'll now enjoy.

Documentation bright and clear, Enhancing paths both far and near. From extend we've learned the way, To code and test in light of day.

🐇✨

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
roninjin10 commented 2 weeks ago

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @roninjin10 and the rest of your teammates on Graphite Graphite