search

evmts / tevm-monorepo

A library that enables next-generation UX and DX via putting an ethereum node in the browser and solidity in javascript
https://tevm.sh
MIT License
266 stars 26 forks source link

:memo: Feat: Add blog feature #1485

Closed roninjin10 closed 4 weeks ago

roninjin10 commented 4 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 4 weeks ago

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

1 Skipped Deployment | Name | Status | Preview | Updated (UTC) | | :--- | :----- | :------ | :------ | | **tevm-monorepo-tevm** | ⬜️ Ignored ([Inspect](https://vercel.com/evmts/tevm-monorepo-tevm/DMUU3vKLHxnJyroBev8FCJm9gkMb)) | | Oct 17, 2024 1:58am |
changeset-bot[bot] commented 4 weeks ago

⚠️ No Changeset found

Latest commit: a9ae9ebf4922fc93f53390cccc1dd721845aa116

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

roninjin10 commented 4 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

coderabbitai[bot] commented 4 weeks ago

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

This pull request integrates the Starlight Blog Plugin into the documentation framework, updates various documentation files, and introduces a new blog post. Key changes include the addition of a new dependency, updates to schema definitions, and clarifications in function parameters and return types across multiple documentation files. Additionally, there are enhancements to the documentation of blocks, transactions, utilities, and client functionalities.

Changes

File Path Change Summary
docs/astro.config.mjs Added import for starlightBlogPlugin and included it in the plugins array.
docs/package.json Added dependency "starlight-blog": "^0.14.0".
docs/src/content/config.ts Updated docs collection to include blogSchema.
docs/src/content/docs/blog/1_the_Vm_Wars.md Added new blog post "Rollup Wars 1: The VM Wars".
docs/src/content/docs/reference/@tevm/actions/functions/callHandler.md Updated line number for callHandler function.
docs/src/content/docs/reference/@tevm/actions/functions/callHandlerOpts.md Updated line number and clarified parameters/return type.
docs/src/content/docs/reference/@tevm/actions/functions/loadStateHandler.md Clarified parameters and return type.
docs/src/content/docs/reference/@tevm/actions/type-aliases/CallHandler.md Updated references to CallParams and CallResult.
docs/src/content/docs/reference/@tevm/actions/type-aliases/CallHandlerOptsError.md Updated line number for CallHandlerOptsError.
docs/src/content/docs/reference/@tevm/actions/type-aliases/ContractHandler.md Updated type parameters and return type.
docs/src/content/docs/reference/@tevm/actions/type-aliases/ContractParams.md Updated type definition and usage example.
docs/src/content/docs/reference/@tevm/actions/type-aliases/ContractResult.md Updated type definition and example usage.
docs/src/content/docs/reference/@tevm/actions/type-aliases/LoadStateResult.md Updated link to TevmLoadStateError.
docs/src/content/docs/reference/@tevm/actions/type-aliases/MineHandler.md Updated references to MineParams and MineResult.
docs/src/content/docs/reference/@tevm/actions/type-aliases/TevmContractError.md Updated link to TevmCallError.
docs/src/content/docs/reference/@tevm/actions/type-aliases/TevmJsonRpcBulkRequestHandler.md Updated references for JSON-RPC types.
docs/src/content/docs/reference/@tevm/actions/type-aliases/TevmJsonRpcRequestHandler.md Updated references for JSON-RPC types.
docs/src/content/docs/reference/@tevm/actions/type-aliases/TevmLoadStateError.md Updated link to InternalError.
docs/src/content/docs/reference/@tevm/address/classes/Address.md Updated link to EthjsAddress class.
docs/src/content/docs/reference/@tevm/address/functions/create2ContractAddress.md Updated link to Address type.
docs/src/content/docs/reference/@tevm/address/functions/createAddress.md Updated links to Address and EthjsAddress types.
docs/src/content/docs/reference/@tevm/address/functions/createContractAddress.md Updated link to Address type.
docs/src/content/docs/reference/@tevm/block/classes/Block.md Updated constructor, properties, methods, and added static factory methods.
docs/src/content/docs/reference/@tevm/block/classes/BlockHeader.md Deprecated constructor and added static factory methods; updated documentation.
docs/src/content/docs/reference/@tevm/block/functions/executionPayloadFromBeaconPayload.md Updated links to types.
docs/src/content/docs/reference/@tevm/block/interfaces/BlockOptions.md Updated links to types.
docs/src/content/docs/reference/@tevm/tx/classes/AccessListEIP2930Transaction.md Clarified usage of methods and properties.
docs/src/content/docs/reference/@tevm/tx/classes/BlobEIP4844Transaction.md Updated constructor, properties, methods, and added static factory methods.
docs/src/content/docs/reference/@tevm/tx/classes/FeeMarketEIP1559Transaction.md Updated documentation for various methods.
docs/src/content/docs/reference/@tevm/tx/functions/createImpersonatedTx.md Updated links to FeeMarketEIP1559Transaction.
docs/src/content/docs/reference/@tevm/tx/interfaces/ImpersonatedTx.md Added isImpersonated property and updated documentation.
docs/src/content/docs/reference/@tevm/utils/classes/AsyncEventEmitter.md Updated documentation for AsyncEventEmitter.
docs/src/content/docs/reference/@tevm/utils/functions/parseAbi.md Updated link reference for JSON ABI type.
docs/src/content/docs/reference/@tevm/utils/interfaces/GenesisState.md Updated link reference for GenesisState documentation.
docs/src/content/docs/reference/@tevm/utils/type-aliases/AbiItemType.md Updated link reference for Abi items.
docs/src/content/docs/reference/@tevm/utils/type-aliases/ExtractAbiEvent.md Updated link references for Abi and AbiEvent.
docs/src/content/docs/reference/@tevm/utils/type-aliases/ExtractAbiEventNames.md Updated link references for AbiEvent and Abi.
docs/src/content/docs/reference/@tevm/utils/type-aliases/ExtractAbiEvents.md Updated link references for AbiEvent and Abi.
docs/src/content/docs/reference/@tevm/utils/type-aliases/ExtractAbiFunction.md Updated link references for Abi and AbiFunction.
docs/src/content/docs/reference/@tevm/utils/type-aliases/ExtractAbiFunctionNames.md Updated link reference for Abi.
docs/src/content/docs/reference/@tevm/utils/type-aliases/ParseAbi.md Updated link reference for JSON ABI documentation.
docs/src/content/docs/reference/@tevm/memory-client/functions/createMemoryClient.md Updated link reference for MemoryClient type alias.
docs/src/content/docs/reference/@tevm/memory-client/functions/createTevmTransport.md Updated link reference for createClient documentation.
docs/src/content/docs/reference/@tevm/memory-client/type-aliases/CreateMemoryClientFn.md Updated link references for MemoryClient.
docs/src/content/docs/reference/@tevm/memory-client/type-aliases/MemoryClient.md Updated link reference for createMemoryClient function.
docs/src/content/docs/reference/@tevm/memory-client/type-aliases/MemoryClientOptions.md Updated link references for MemoryClient and CreateMemoryClientFn.
docs/src/content/docs/reference/@tevm/state/functions/dumpCanonicalGenesis.md Updated link reference for TevmState type alias.
docs/src/content/docs/reference/@tevm/state/functions/generateCanonicalGenesis.md Updated link reference for TevmState type alias.
docs/src/content/docs/reference/@tevm/state/functions/getForkClient.md Added detailed documentation for getForkClient function.
docs/src/content/docs/reference/@tevm/state/interfaces/StateManager.md Updated link reference for TevmState type and notes on experimental APIs.
docs/src/content/docs/reference/@tevm/trie/classes/Trie.md Updated documentation, deprecated fromProof, and added createFromProof method.
docs/src/content/docs/reference/@tevm/config/defineConfig/classes/DefineConfigError.md Updated link reference for defineConfig function.
docs/src/content/docs/reference/@tevm/config/loadConfig/classes/LoadConfigError.md Updated link reference for loadConfig function.
docs/src/content/docs/reference/@tevm/config/types/type-aliases/CompilerConfig.md Updated link reference for ResolvedCompilerConfig.
docs/src/content/docs/reference/@tevm/config/types/type-aliases/ResolvedCompilerConfig.md Updated link reference for CompilerConfig.
docs/src/content/docs/reference/@tevm/contract/functions/createContract.md Clarified functionality and parameters of createContract.
docs/src/content/docs/reference/@tevm/contract/type-aliases/CreateContractParams.md Updated link reference for Contract instance.
docs/src/content/docs/reference/@tevm/vm/interfaces/ApplyBlockResult.md Updated link reference for applyBlock function.
docs/src/content/docs/reference/@tevm/vm/interfaces/BuilderOpts.md Updated link references for BlockHeader and Common.
docs/src/content/docs/reference/@tevm/vm/interfaces/RunBlockOpts.md Added detailed documentation for RunBlockOpts interface.
docs/src/content/docs/reference/@tevm/vm/interfaces/VMOpts.md Updated descriptions and link reference for properties.

Possibly related PRs

🐰 In the garden of code, we hop and play,
With Starlight's glow, we brighten the way.
New posts sprout like flowers in bloom,
While docs dance around, dispelling the gloom.
Let's celebrate changes, both big and small,
For in this code meadow, there's room for us all! 🌼✨

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 , please review it.` - `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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@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 using 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. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration 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](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.