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

:sparkles: Feat: Add support for viem options #1240

Closed roninjin10 closed 1 week ago

roninjin10 commented 1 week 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 1 week 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 26, 2024 9:43pm
changeset-bot[bot] commented 1 week ago

🦋 Changeset detected

Latest commit: 9f74b44348abc6d53c2d3b954579d9b853f00851

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

This PR includes changesets to release 53 packages | Name | Type | | ---------------------------- | ----- | | @tevm/actions | Major | | @tevm/memory-client | Major | | @tevm/procedures | Major | | @tevm/sync-storage-persister | Major | | @tevm/bundler-cache | Major | | @tevm/base-bundler | Major | | @tevm/resolutions | Major | | @tevm/compiler | Major | | @tevm/unplugin | Major | | @tevm/esbuild-plugin | Major | | @tevm/runtime | Major | | @tevm/webpack-plugin | Major | | @tevm/viem-effect | Major | | @tevm/receipt-manager | Major | | @tevm/config | Major | | @tevm/rollup-plugin | Major | | @tevm/rspack-plugin | Major | | @tevm/solc | Major | | @tevm/vite-plugin | Major | | @tevm/client-types | Major | | @tevm/bun-plugin | Major | | @tevm/cli | Major | | @tevm/schemas | Major | | @tevm/base-client | Major | | @tevm/http-client | Major | | @tevm/precompiles | Major | | @tevm/blockchain | Major | | @tevm/decorators | Major | | @tevm/predeploys | Major | | @tevm/tsupconfig | Major | | @tevm/ethers | Major | | @tevm/contract | Major | | @tevm/jsonrpc | Major | | @tevm/viem | Major | | @tevm/common | Major | | @tevm/effect | Major | | @tevm/errors | Major | | @tevm/logger | Major | | @tevm/server | Major | | @tevm/txpool | Major | | @tevm/test-utils | Major | | @tevm/block | Major | | @tevm/state | Major | | @tevm/utils | Major | | @tevm/ts-plugin | Major | | @tevm/trie | Major | | @tevm/evm | Major | | @tevm/rlp | Major | | @tevm/tx | Major | | @tevm/vm | Major | | tevm | Major | | @tevm/lsp | Major | | @tevm/experimental-solc | Major |

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 1 week ago

[!IMPORTANT]

Review skipped

More than 25% of the files skipped due to max files limit. The review is being skipped to prevent a low-quality review.

237 files out of 294 files are above the max files limit of 50. Please upgrade to Pro plan to get higher limits.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The update enhances the MemoryClient functionalities by adding support for underlying viem options and refining type declarations across multiple packages. It introduces new types and test cases to ensure seamless integration of MemoryClient with specific configurations like account handling, schema definitions, and client creation processes.

Changes

File/Path Summary
.changeset/cool-lamps-double.md Added underlying viem options to MemoryClientOptions in @tevm/memory-client.
.changeset/nasty-bobcats-complain.md Made Common generic optional on BaseClientOptions in @tevm/base-client.
packages/base-client/src/BaseClientOptions.ts Updated BaseClientOptions type declaration with a generic parameter TCommon extends Common = Common.
packages/memory-client/src/CreateMemoryClientFn.ts Introduced CreateMemoryClientFn type for creating a MemoryClient instance based on provided options.
packages/memory-client/src/MemoryClient.ts Updated MemoryClient type to include new type dependencies and refined its signature. Removed and replaced specific type imports accordingly.
packages/memory-client/src/MemoryClientOptions.ts Added MemoryClientOptions type that extends BaseClientOptions and combines different types related to client configuration.
packages/memory-client/src/TevmRpcSchema.ts Introduced TevmRpcSchema type combining elements from various schemas for Tevm RPC operations.
packages/memory-client/src/createMemoryClient.js Updated createMemoryClient function signature to accept different parameter types for options, adjusting the object creation within the function.
packages/memory-client/src/test/viemSigner.spec.ts Added test case demonstrating the usage of MemoryClient as a signer in the Viem framework, including setting up a client with a specific account and testing transaction sending functionality.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CreateMemoryClientFn
    participant MemoryClient
    participant ViemModule

    User->>CreateMemoryClientFn: Call with options
    CreateMemoryClientFn->>MemoryClient: Create instance with options
    MemoryClient->>ViemModule: Pass underlying options
    ViemModule-->>MemoryClient: Return enhanced client
    MemoryClient-->>CreateMemoryClientFn: Return instance
    CreateMemoryClientFn-->>User: Return MemoryClient instance

Poem

In the code where clients dance,
New options spark a bright advance.
Memory's weave with viem's grace,
Accounts and chains find their place.
Schema dreams and types refined,
All in sync, perfectly aligned.
To the future, this update does cheer,
For seamless flow and boundless peer. 🎉🐇

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 1 week 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