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 PREFUNDED_ACCOUNTS to @tevm/utils #1248

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 27, 2024 10:59pm
changeset-bot[bot] commented 1 week ago

🦋 Changeset detected

Latest commit: 400bbe7a30a2156172bffeb396d3c724a5d7b1b9

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

This PR includes changesets to release 27 packages | Name | Type | | ---------------------------- | ----- | | @tevm/utils | Minor | | @tevm/ethers | Minor | | @tevm/viem | Minor | | @tevm/actions | Minor | | @tevm/base-client | Minor | | @tevm/block | Minor | | @tevm/blockchain | Minor | | @tevm/client-types | Minor | | @tevm/common | Minor | | @tevm/contract | Minor | | @tevm/decorators | Minor | | @tevm/evm | Minor | | @tevm/http-client | Minor | | @tevm/memory-client | Minor | | @tevm/precompiles | Minor | | @tevm/predeploys | Minor | | @tevm/procedures | Minor | | @tevm/receipt-manager | Minor | | @tevm/server | Minor | | @tevm/state | Minor | | @tevm/tx | Minor | | @tevm/txpool | Minor | | @tevm/vm | Minor | | tevm | Minor | | @tevm/experimental-solc | Minor | | @tevm/test-utils | Minor | | @tevm/sync-storage-persister | Minor |

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

Walkthrough

The update introduces prefunded accounts, private keys, public keys, and seed constants within the @tevm/utils module. These prefunded entities are essential for creating memoryClient easily during development and testing. Documentation was updated accordingly, and exports were adjusted to include these new constants.

Changes

File(s) Change Summary
.changeset/green-ways-mate.md Added summary of prefunded accounts and keys introduced in @tevm/utils.
docs/.../reference/@tevm/utils/globals.md, packages/utils/docs/globals.md Added declarations for PREFUNDED_ACCOUNTS, PREFUNDED_PRIVATE_KEYS, PREFUNDED_PUBLIC_KEYS, and PREFUNDED_SEED variables.
docs/.../reference/@tevm/utils/variables/PREFUNDED_ACCOUNTS.md, packages/utils/docs/variables/... Introduced PREFUNDED_ACCOUNTS variable, documenting its details, type, and source location.
docs/.../reference/@tevm/utils/variables/PREFUNDED_PRIVATE_KEYS.md, packages/utils/docs/variables/... Added documentation for PREFUNDED_PRIVATE_KEYS as a readonly array of private key strings, outlining its definition and location.
docs/.../reference/@tevm/utils/variables/PREFUNDED_PUBLIC_KEYS.md, packages/utils/docs/variables/... Introduced and documented PREFUNDED_PUBLIC_KEYS, a readonly array containing public key strings.
docs/.../reference/@tevm/utils/variables/PREFUNDED_SEED.md, packages/utils/docs/variables/... Documented PREFUNDED_SEED as a constant Readonly object with properties derivationPath and mnemonic.
packages/utils/src/prefundedAccounts.ts Introduced constants for prefunded private keys, public keys, accounts, and seed, making them accessible for development and testing.
packages/utils/src/index.ts Exported new constants from prefundedAccounts.js to other modules within @tevm/utils.
tevm/index.cjs, tevm/index.d.cts, tevm/index.d.ts, tevm/index.js, tevm/index.ts Expanded exports to include PREFUNDED_ACCOUNTS, PREFUNDED_PRIVATE_KEYS, PREFUNDED_PUBLIC_KEYS, and PREFUNDED_SEED. Updated or removed other module exports as required by changed scopes.

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant Module as @tevm/utils
    participant MemoryClient as memoryClient

    Developer->>Module: Access PREFUNDED_ACCOUNTS
    Module-->>Developer: Returns array of PrivateKeyAccount objects
    Developer->>MemoryClient: Pass account from PREFUNDED_ACCOUNTS to createMemoryClient
    MemoryClient-->>Developer: Initializes memoryClient with provided account

Poem

In the realm of code, a rabbit's delight,
Prefunded keys now shine so bright,
With accounts and seeds set in array,
Developers’ tasks made simple today.
MemoryClient springs up with ease,
A bunny's touch, to modern keys. 🐇✨

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