📦 Feat: Add new @tevm/chain package #1112
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
🦋 Changeset detectedLatest commit: d8591a2 The changes in this PR will be included in the next version bump. This PR includes changesets to release 20 packages
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 |
|
This stack of pull requests is managed by Graphite. Learn more about stacking. Join @roninjin10 and the rest of your teammates on |
|
Important Review SkippedMore than 25% of the files skipped due to max files limit. The review is being skipped to prevent a low-quality review. 115 files out of 172 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 WalkthroughThe recent updates introduce significant enhancements and breaking changes to the Changes
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 19
Outside diff range and nitpick comments (6)
tevm/docs/chains/type-aliases/CommonOptions.md (1)
24-24: Consider specifying a timeline or version for the future hardfork handling feature.This helps in setting expectations and planning for future updates.
docs/src/content/docs/learn/actions/index.md (1)
Line range hint
22-22: Add a comma after 'Currently' for clarity.- Currently on tevm actions are supported and not other actions such as `eth` actions. + Currently, only tevm actions are supported and not other actions such as `eth` actions.docs/src/content/docs/learn/clients/index.md (1)
47-48: Recommendation to pass achainobject when forking is a good practice.Consider changing "It is recomended" to "It is recommended" for correct spelling.
packages/memory-client/src/test/viemPublicActions.spec.ts (1)
179-198: Properly tests thegetEnsAddressmethod using the newcustomCryptofeature.Consider adding a comment explaining the significance of the
kzgmodule in this context for better clarity.packages/base-client/src/createBaseClient.js (1)
251-253: Addition ofgetChainmethod enhances the base client's functionality.Consider using consistent comment styles in the codebase. Some comments use
//while others use/** */for single-line comments.packages/common/docs/classes/Common.md (1)
Line range hint
48-48: Add a missing reference definition for "string,hardforkconfig".+ [string, hardforkconfig]: # (Add appropriate link or description here)
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (3)
pnpm-lock.yamlis excluded by!pnpm-lock.yamltevm/chains/index.cjs.mapis excluded by!**/*.maptevm/chains/index.js.mapis excluded by!**/*.map
Files selected for processing (54)
- .changeset/silent-panthers-camp.md (1 hunks)
- .changeset/wild-balloons-applaud.md (1 hunks)
- docs/src/content/docs/getting-started/getting-started.md (2 hunks)
- docs/src/content/docs/learn/actions/index.md (1 hunks)
- docs/src/content/docs/learn/clients/index.md (1 hunks)
- packages/base-client/docs/functions/createBaseClient.md (2 hunks)
- packages/base-client/docs/type-aliases/BaseClient.md (2 hunks)
- packages/base-client/docs/type-aliases/BaseClientOptions.md (2 hunks)
- packages/base-client/package.json (1 hunks)
- packages/base-client/src/BaseClient.ts (2 hunks)
- packages/base-client/src/BaseClientOptions.ts (3 hunks)
- packages/base-client/src/createBaseClient.js (4 hunks)
- packages/chains/.gitignore (1 hunks)
- packages/chains/LICENSE (1 hunks)
- packages/chains/README.md (1 hunks)
- packages/chains/biome.json (1 hunks)
- packages/chains/docs/README.md (1 hunks)
- packages/chains/docs/functions/createChain.md (1 hunks)
- packages/chains/docs/globals.md (1 hunks)
- packages/chains/docs/type-aliases/CommonOptions.md (1 hunks)
- packages/chains/docs/type-aliases/TevmChain.md (1 hunks)
- packages/chains/docs/variables/base.md (1 hunks)
- packages/chains/docs/variables/baseSepolia.md (1 hunks)
- packages/chains/docs/variables/mainnet.md (1 hunks)
- packages/chains/docs/variables/optimism.md (1 hunks)
- packages/chains/docs/variables/optimismSepolia.md (1 hunks)
- packages/chains/docs/variables/sepolia.md (1 hunks)
- packages/chains/docs/variables/tevmDevnet.md (1 hunks)
- packages/chains/docs/variables/zora.md (1 hunks)
- packages/chains/docs/variables/zoraSepolia.md (1 hunks)
- packages/chains/package.json (1 hunks)
- packages/chains/src/index.ts (1 hunks)
- packages/chains/tsconfig.json (1 hunks)
- packages/chains/tsup.config.js (1 hunks)
- packages/chains/typedoc.json (1 hunks)
- packages/common/docs/classes/Common.md (1 hunks)
- packages/common/docs/globals.md (1 hunks)
- packages/common/docs/interfaces/CustomCrypto.md (1 hunks)
- packages/common/docs/type-aliases/CommonOptions.md (2 hunks)
- packages/common/src/CommonOptions.ts (2 hunks)
- packages/common/src/index.ts (1 hunks)
- packages/memory-client/package.json (2 hunks)
- packages/memory-client/src/createMemoryClient.js (2 hunks)
- packages/memory-client/src/test/viemPublicActions.spec.ts (2 hunks)
- tevm/chains/index.cjs (1 hunks)
- tevm/chains/index.d.cts (1 hunks)
- tevm/chains/index.d.ts (1 hunks)
- tevm/chains/index.js (1 hunks)
- tevm/chains/index.ts (1 hunks)
- tevm/docs/chains/README.md (1 hunks)
- tevm/docs/chains/functions/createChain.md (1 hunks)
- tevm/docs/chains/type-aliases/CommonOptions.md (1 hunks)
- tevm/docs/chains/type-aliases/TevmChain.md (1 hunks)
- tevm/docs/chains/variables/base.md (1 hunks)
Files not processed due to max files limit (15)
- tevm/docs/chains/variables/baseSepolia.md
- tevm/docs/chains/variables/mainnet.md
- tevm/docs/chains/variables/optimism.md
- tevm/docs/chains/variables/optimismSepolia.md
- tevm/docs/chains/variables/sepolia.md
- tevm/docs/chains/variables/tevmDevnet.md
- tevm/docs/chains/variables/zora.md
- tevm/docs/chains/variables/zoraSepolia.md
- tevm/docs/index/type-aliases/BaseClient.md
- tevm/docs/index/type-aliases/BaseClientOptions.md
- tevm/docs/modules.md
- tevm/package.json
- tevm/tsconfig.json
- tevm/tsup.config.js
- tevm/typedoc.json
Files not reviewed due to errors (4)
- packages/memory-client/package.json (no review received)
- packages/chains/package.json (no review received)
- packages/base-client/src/BaseClient.ts (no review received)
- packages/common/docs/interfaces/CustomCrypto.md (no review received)
Files skipped from review due to trivial changes (25)
- packages/base-client/package.json
- packages/chains/.gitignore
- packages/chains/LICENSE
- packages/chains/biome.json
- packages/chains/docs/globals.md
- packages/chains/docs/type-aliases/TevmChain.md
- packages/chains/docs/variables/base.md
- packages/chains/docs/variables/baseSepolia.md
- packages/chains/docs/variables/optimism.md
- packages/chains/docs/variables/optimismSepolia.md
- packages/chains/docs/variables/sepolia.md
- packages/chains/docs/variables/tevmDevnet.md
- packages/chains/docs/variables/zora.md
- packages/chains/docs/variables/zoraSepolia.md
- packages/chains/tsup.config.js
- packages/chains/typedoc.json
- packages/common/src/index.ts
- packages/memory-client/src/createMemoryClient.js
- tevm/chains/index.d.cts
- tevm/chains/index.d.ts
- tevm/chains/index.js
- tevm/chains/index.ts
- tevm/docs/chains/README.md
- tevm/docs/chains/type-aliases/TevmChain.md
- tevm/docs/chains/variables/base.md
Additional comments not posted (10)
packages/chains/tsconfig.json (1)
1-10: The TypeScript configuration appears correctly set up and adheres to standard practices.tevm/chains/index.cjs (1)
1-14: The re-export pattern used here is clean and follows best practices for CommonJS modules.tevm/docs/chains/functions/createChain.md (1)
1-23: The documentation for thecreateChainfunction is clear and well-structured.packages/chains/docs/functions/createChain.md (1)
1-23: The documentation for thecreateChainfunction is clear and well-structured, similar to the other documentation file reviewed.packages/common/docs/globals.md (1)
18-18: The addition of theCustomCryptointerface is correctly documented.packages/common/src/CommonOptions.ts (1)
25-31: Excellent documentation for thecustomCryptoproperty, including potential impacts and future considerations.packages/common/docs/type-aliases/CommonOptions.md (1)
23-31: Documentation is clear and consistent with the source code, effectively highlighting important considerations forcustomCrypto.packages/common/docs/classes/Common.md (1)
118-118: Update tocustomCryptoproperty documentation is accurate and links correctly.docs/src/content/docs/getting-started/getting-started.md (2)
200-200: Add import statement foroptimism.The addition of the
import { optimism } from "tevm/chains";statement aligns with the new functionality described in the PR summary, enabling the use of theoptimismchain configuration in thecreateMemoryClientfunction.
205-205: Addchain: optimismparameter increateMemoryClient.The inclusion of the
chain: optimismparameter in thecreateMemoryClientfunction call is a necessary update to utilize the newly importedoptimismconfiguration. This change is crucial for setting the context of the blockchain network which the memory client will interact with.
|
|
||
| > `const` **mainnet**: [`TevmChain`](../type-aliases/TevmChain.md) | ||
|
|
||
| TODO update op-stack package to use this |
There was a problem hiding this comment.
TODO comment should be tracked in an issue for better management.
Would you like me to open a GitHub issue to track the update of the op-stack package?
There was a problem hiding this comment.
Please add a github issue
There was a problem hiding this comment.
@roninjin10, I have created the GitHub issue to track the update of the op-stack package to use the mainnet variable from @tevm/chains. You can find the issue here: Issue #1113.
Let me know if there is anything else I can assist with!
Analysis chain
Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Create a GitHub issue for updating the op-stack package to use the `mainnet` variable from `@tevm/chains`
gh issue create --title "Update op-stack package to use the `mainnet` variable from `@tevm/chains`" --body "This issue tracks the necessary update for the op-stack package to utilize the `mainnet` variable from the newly introduced `@tevm/chains` package as mentioned in the TODO comment in the PR.
For more context, see the PR and the specific comment:
- PR: https://github.com/evmts/tevm-monorepo/pull/1112
- Comment: https://github.com/evmts/tevm-monorepo/pull/1112#discussion_r1608867155" --repo evmts/tevm-monorepo
Length of output: 907
New Learnings Added
User: roninjin10
PR: evmts/tevm-monorepo#1112
File: packages/chains/docs/variables/mainnet.md:11-11
Timestamp: 2024-05-21T21:40:00.579Z
Learning: When a TODO comment suggests updating a package to use a new variable, and the user requests to track it in an issue, create a GitHub issue with a clear title and detailed body, including links to the relevant PR and comment for context.
Note: Learnings are effective only in the context of specific code segments. To apply general coding guidelines, please configure review instructions.
|
|
||
| ## Source | ||
|
|
||
| [index.ts:79](https://github.com/evmts/tevm-monorepo/blob/main/packages/chains/src/index.ts#L79) |
There was a problem hiding this comment.
Tip
Codebase Verification
The source link provided in the documentation points to a non-existent line in the index.ts file, resulting in a 404 error. The file index.ts does exist in the specified path, but the link needs to be corrected.
- The file
index.tsis located atpackages/chains/src/index.ts. - The content around line 79 is relevant and exists.
Please update the documentation link to ensure it points to the correct file and line number.
Analysis chain
Verify the source link is correct and accessible.
Scripts Executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Check if the source link is accessible.
# Test: Attempt to fetch the URL. Expect: HTTP 200 OK response.
curl -o /dev/null -s -w "%{http_code}\n" https://github.com/evmts/tevm-monorepo/blob/main/packages/chains/src/index.ts#L79
Length of output: 128
Script:
#!/bin/bash
# Description: Search for the index.ts file within the packages/chains/src directory to confirm its existence and correct path.
# Search for index.ts file
fd index.ts packages/chains/src
Length of output: 62
Script:
#!/bin/bash
# Description: Display the contents around line 79 in the index.ts file to verify its relevance.
# Display lines 70-90 from index.ts
sed -n '70,90p' packages/chains/src/index.ts
Length of output: 387
|
|
||
| ## Source | ||
|
|
||
| [index.ts:18](https://github.com/evmts/tevm-monorepo/blob/main/packages/chains/src/index.ts#L18) |
There was a problem hiding this comment.
Tip
Codebase Verification
The URL provided in the documentation returns a 404 error, indicating that the link is broken or the file does not exist at the specified location. The correct path for the index.ts file is packages/chains/src/index.ts, and the relevant content starts at line 18.
- Update the link in the documentation to point to the correct file path:
packages/chains/src/index.ts.
Analysis chain
Verify the source link is correct and accessible.
Let's locate the correct file path for index.ts within the packages/chains/src directory and verify its contents.
Scripts Executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Check if the source link is accessible.
# Test: Attempt to fetch the URL. Expect: HTTP 200 OK response.
curl -o /dev/null -s -w "%{http_code}\n" https://github.com/evmts/tevm-monorepo/blob/main/packages/chains/src/index.ts#L18
Length of output: 128
Script:
#!/bin/bash
# Locate the index.ts file within the packages/chains/src directory
fd index.ts packages/chains/src
# Display the contents of the located index.ts file to verify line 18
cat $(fd index.ts packages/chains/src) | head -n 20
Length of output: 654
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated.⚠️ ⚠️ ⚠️ ⚠️ ⚠️ ⚠️ `main` is currently in **pre mode** so this branch has prereleases rather than normal releases. If you want to exit prereleases, run `changeset pre exit` on `main`.⚠️ ⚠️ ⚠️ ⚠️ ⚠️ ⚠️ # Releases ## @tevm/ethers@1.1.0-next.57 ### Minor Changes - [#1112](#1112) [`72ba692`](72ba692) Thanks [@roninjin10](https://github.com/roninjin10)! - Changed ethers to take a base client rather than a memoryclient so it is not tightly coupled to viem ### Patch Changes - Updated dependencies \[[`72ba692`](72ba692)]: - @tevm/decorators@1.1.0-next.57 - @tevm/procedures-types@1.1.0-next.52 ## @tevm/base-client@1.1.0-next.57 ### Minor Changes - [#1112](#1112) [`72ba692`](72ba692) Thanks [@roninjin10](https://github.com/roninjin10)! - Breaking: Removed the chainId property in favor of `TevmChain` from `@tevm/chains`. TevmChain extends ViemChain and ethereumjs Common for a common interface for specifying chain/common info - [#1112](#1112) [`72ba692`](72ba692) Thanks [@roninjin10](https://github.com/roninjin10)! - Added support for the customCrypto option to @tevm/common and @tevm/base-client. This allows kzg to be passed for 4844 supports ### Patch Changes - Updated dependencies \[[`72ba692`](72ba692), [`72ba692`](72ba692)]: - @tevm/chains@1.1.0-next.57 - @tevm/common@1.1.0-next.57 - @tevm/blockchain@1.1.0-next.57 - @tevm/evm@1.1.0-next.57 - @tevm/receipt-manager@1.1.0-next.57 - @tevm/state@1.1.0-next.57 - @tevm/vm@1.1.0-next.57 - @tevm/txpool@1.1.0-next.57 - @tevm/sync-storage-persister@1.1.0-next.57 ## @tevm/chains@1.1.0-next.57 ### Minor Changes - [#1112](#1112) [`72ba692`](72ba692) Thanks [@roninjin10](https://github.com/roninjin10)! - Breaking: Removed the chainId property in favor of `TevmChain` from `@tevm/chains`. TevmChain extends ViemChain and ethereumjs Common for a common interface for specifying chain/common info ### Patch Changes - Updated dependencies \[[`72ba692`](72ba692)]: - @tevm/common@1.1.0-next.57 ## @tevm/common@1.1.0-next.57 ### Minor Changes - [#1112](#1112) [`72ba692`](72ba692) Thanks [@roninjin10](https://github.com/roninjin10)! - Added support for the customCrypto option to @tevm/common and @tevm/base-client. This allows kzg to be passed for 4844 supports ## @tevm/decorators@1.1.0-next.57 ### Minor Changes - [#1112](#1112) [`72ba692`](72ba692) Thanks [@roninjin10](https://github.com/roninjin10)! - Added TevmSendApi type to decorators package for reuse in ethers package ### Patch Changes - Updated dependencies \[]: - @tevm/actions@1.1.0-next.57 - @tevm/actions-types@1.1.0-next.56 - @tevm/procedures@1.1.0-next.57 - @tevm/procedures-types@1.1.0-next.52 ## @tevm/memory-client@1.1.0-next.57 ### Minor Changes - [#1112](#1112) [`72ba692`](72ba692) Thanks [@roninjin10](https://github.com/roninjin10)! - Breaking: Removed the chainId property in favor of `TevmChain` from `@tevm/chains`. TevmChain extends ViemChain and ethereumjs Common for a common interface for specifying chain/common info - [#1112](#1112) [`72ba692`](72ba692) Thanks [@roninjin10](https://github.com/roninjin10)! - Added support for the customCrypto option to @tevm/common and @tevm/base-client. This allows kzg to be passed for 4844 supports ### Patch Changes - Updated dependencies \[[`72ba692`](72ba692), [`72ba692`](72ba692), [`72ba692`](72ba692)]: - @tevm/decorators@1.1.0-next.57 - @tevm/base-client@1.1.0-next.57 - @tevm/chains@1.1.0-next.57 - @tevm/evm@1.1.0-next.57 ## tevm@1.1.0-next.57 ### Minor Changes - [#1112](#1112) [`72ba692`](72ba692) Thanks [@roninjin10](https://github.com/roninjin10)! - Added TevmSendApi type to decorators package for reuse in ethers package - [#1112](#1112) [`72ba692`](72ba692) Thanks [@roninjin10](https://github.com/roninjin10)! - Breaking: Removed the chainId property in favor of `TevmChain` from `@tevm/chains`. TevmChain extends ViemChain and ethereumjs Common for a common interface for specifying chain/common info - [#1112](#1112) [`72ba692`](72ba692) Thanks [@roninjin10](https://github.com/roninjin10)! - Added support for the customCrypto option to @tevm/common and @tevm/base-client. This allows kzg to be passed for 4844 supports ### Patch Changes - Updated dependencies \[[`72ba692`](72ba692), [`72ba692`](72ba692), [`72ba692`](72ba692)]: - @tevm/decorators@1.1.0-next.57 - @tevm/memory-client@1.1.0-next.57 - @tevm/base-client@1.1.0-next.57 - @tevm/chains@1.1.0-next.57 - @tevm/viem@1.1.0-next.52 - @tevm/http-client@1.1.0-next.56 - @tevm/precompiles@1.1.0-next.56 - @tevm/server@1.1.0-next.52 - @tevm/actions-types@1.1.0-next.56 - @tevm/state@1.1.0-next.57 - @tevm/procedures-types@1.1.0-next.52 - @tevm/sync-storage-persister@1.1.0-next.57 ## @tevm/opstack@1.1.0-next.57 ### Patch Changes - Updated dependencies \[[`72ba692`](72ba692), [`72ba692`](72ba692)]: - @tevm/memory-client@1.1.0-next.57 ## @tevm/actions@1.1.0-next.57 ### Patch Changes - Updated dependencies \[]: - @tevm/block@1.1.0-next.57 - @tevm/blockchain@1.1.0-next.57 - @tevm/receipt-manager@1.1.0-next.57 - @tevm/vm@1.1.0-next.57 - @tevm/procedures-types@1.1.0-next.52 ## @tevm/block@1.1.0-next.57 ### Patch Changes - Updated dependencies \[[`72ba692`](72ba692)]: - @tevm/common@1.1.0-next.57 ## @tevm/blockchain@1.1.0-next.57 ### Patch Changes - Updated dependencies \[]: - @tevm/block@1.1.0-next.57 ## @tevm/evm@1.1.0-next.57 ### Patch Changes - Updated dependencies \[[`72ba692`](72ba692)]: - @tevm/common@1.1.0-next.57 - @tevm/blockchain@1.1.0-next.57 ## @tevm/procedures@1.1.0-next.57 ### Patch Changes - Updated dependencies \[]: - @tevm/actions@1.1.0-next.57 - @tevm/block@1.1.0-next.57 ## @tevm/receipt-manager@1.1.0-next.57 ### Patch Changes - Updated dependencies \[]: - @tevm/block@1.1.0-next.57 - @tevm/blockchain@1.1.0-next.57 ## @tevm/state@1.1.0-next.57 ### Patch Changes - Updated dependencies \[[`72ba692`](72ba692)]: - @tevm/common@1.1.0-next.57 ## @tevm/sync-storage-persister@1.1.0-next.57 ### Patch Changes - Updated dependencies \[]: - @tevm/state@1.1.0-next.57 ## @tevm/txpool@1.1.0-next.57 ### Patch Changes - Updated dependencies \[]: - @tevm/block@1.1.0-next.57 ## @tevm/vm@1.1.0-next.57 ### Patch Changes - Updated dependencies \[[`72ba692`](72ba692)]: - @tevm/common@1.1.0-next.57 - @tevm/block@1.1.0-next.57 - @tevm/blockchain@1.1.0-next.57 - @tevm/evm@1.1.0-next.57 Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Description
Add support for ens support in viem.
Testing
Explain the quality checks that have been done on the code changes
Additional Information
Your ENS/address:
Summary by CodeRabbit
New Features
customCryptooption, enhancing customization for cryptographic operations.getChain()function to retrieve chain information.Improvements
TevmChaininstead ofchainId.Bug Fixes
Documentation
Chores
.gitignoreandLICENSEfiles.package.jsonfor improved development workflow.