Skip to content

Renamed @sei-js/evm to @sei-js/precompiles#259

Merged
codebycarson merged 9 commits into
mainfrom
feature/rename-evm-to-precompiles
Jun 11, 2025
Merged

Renamed @sei-js/evm to @sei-js/precompiles#259
codebycarson merged 9 commits into
mainfrom
feature/rename-evm-to-precompiles

Conversation

@codebycarson

@codebycarson codebycarson commented Jun 10, 2025

Copy link
Copy Markdown
Collaborator

Rename @sei-js/evm to @sei-js/precompiles

As these precompiles were the only thing in here, this package is to be renamed to @sei-js/precompiles so that docs and LLMs can better understand it's purpose.

Local Chain ID in Viem

This updates to the new local chain ID that doesn't conflict with devnet.

Typedoc Fixes

This PR also fixes various TypeDoc issues and has more clear docs comments .

@codebycarson
codebycarson requested a review from Copilot June 10, 2025 22:14
@changeset-bot

changeset-bot Bot commented Jun 10, 2025

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: a047553

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

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 comment was marked as outdated.

@codebycarson
codebycarson requested a review from Copilot June 11, 2025 14:31

This comment was marked as outdated.

Comment thread packages/cosmos/tsconfig.json Outdated
"include": ["./library"],
"compilerOptions": {
"outDir": "./dist"
},

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed small typedoc issues in other packages, but this wont affect their builds and doesn't need a release. Just noticed as I was updating the comments inside the /precompiles package

@codebycarson
codebycarson requested review from Copilot and dssei June 11, 2025 14:39

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR renames the @sei-js/evm package to @sei-js/precompiles, adjusts related imports and examples, and adds Typedoc configuration updates across several packages.

  • Rename package identifier, import paths, and documentation to reflect new @sei-js/precompiles name
  • Update example code paths and category tags in Ethers contract factories
  • Add Typedoc options in various tsconfig.json files and update coverage flags

Reviewed Changes

Copilot reviewed 66 out of 66 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
packages/precompiles/src/ethers/ibcPrecompile.ts Updated type imports, example import path, and tags
packages/precompiles/src/ethers/governancePrecompile.ts Fixed example import, updated parseEther usage, and tags
packages/precompiles/src/ethers/distributionPrecompile.ts Updated type imports, example path, and tags
packages/precompiles/src/ethers/confidentialTransfersPrecompile.ts Updated example import and tags
packages/precompiles/src/ethers/bankPrecompile.ts Switched to ETHERS_BANK_PRECOMPILE_ABI, updated imports and tags
packages/precompiles/src/ethers/addressPrecompile.ts Updated type imports, example path, and tags
packages/precompiles/package.json Renamed package and updated description
packages/precompiles/README.md Added new README for @sei-js/precompiles
packages/precompiles/CHANGELOG.md Updated package header
packages/ledger/tsconfig.json Corrected Typedoc project name
packages/evm/README.md Removed outdated EVM README content
packages/create-sei/tsconfig.json Added Typedoc options
packages/create-sei/package.json Added docs script and formatting
packages/cosmos/tsconfig.json Added Typedoc options
codecov.yml Changed coverage flag from evm to precompiles
README.md Updated top-level link to @sei-js/precompiles
.changeset/great-jars-marry.md Added changeset entry for renaming
Comments suppressed due to low confidence (1)

packages/precompiles/README.md:6

  • [nitpick] The plural of ABI should be ABIs (without an apostrophe) rather than ABI's.
TypeScript utilities and helpers for interacting with Sei's precompile contracts. Provides seamless integration with popular Ethereum development tools like Viem and Ethers.js, offering typed interfaces, contract factories, ABI's, contract addresses, and utilities specifically designed for Sei's precompile ecosystem.

*
* // Surround with try/catch for detailed errors
* const depositResponse = await governancePrecompileContract.connect(signer).deposit('1', { value: parseSei(1) });
* const depositResponse = await governancePrecompileContract.connect(signer).deposit('1', { value: parseEther(1) });

Copilot AI Jun 11, 2025

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The parseEther function expects a string argument; passing a number will throw a runtime error. Use parseEther('1') instead of parseEther(1).

Suggested change
* const depositResponse = await governancePrecompileContract.connect(signer).deposit('1', { value: parseEther(1) });
* const depositResponse = await governancePrecompileContract.connect(signer).deposit('1', { value: parseEther('1') });

Copilot uses AI. Check for mistakes.
@codecov-commenter

codecov-commenter commented Jun 11, 2025

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.16%. Comparing base (6d3cf43) to head (a047553).
⚠️ Report is 45 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #259   +/-   ##
=======================================
  Coverage   98.16%   98.16%           
=======================================
  Files          67       67           
  Lines         763      763           
  Branches      128      128           
=======================================
  Hits          749      749           
  Misses         14       14           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@codebycarson
codebycarson merged commit b888b94 into main Jun 11, 2025
3 checks passed
codebycarson added a commit that referenced this pull request Jun 24, 2025
* Renamed `@sei-js/evm` to `@sei-js/precompiles`

* Added changeset

* Removed and hid test files

* Fixed TypeDoc issues

* More typedoc fixes

* Fixed broken tests due to local chain id change

* Fixed ABI in ethers precompile

* Updated yarn lock
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants