Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ethers Migration guide #7441

Merged
merged 7 commits into from
Jan 14, 2025
Merged

Ethers Migration guide #7441

merged 7 commits into from
Jan 14, 2025

Conversation

jdevcs
Copy link
Contributor

@jdevcs jdevcs commented Jan 13, 2025

Description

Ethers Migration guide

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation (changes that only address relatively minor typographical errors are not accepted)

Checklist:

  • I have selected the correct base branch.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.
  • Any dependent changes have been merged and published in downstream modules.
  • I ran npm run lint with success and extended the tests and types if necessary.
  • I ran npm run test:unit with success.
  • I ran npm run test:coverage and my test cases cover all the lines and branches of the added code.
  • I ran npm run build and tested dist/web3.min.js in a browser.
  • I have tested my code on the live network.
  • I have checked the Deploy Preview and it looks correct.
  • I have updated the CHANGELOG.md file in the root folder.
  • I have linked Issue(s) with this PR in "Linked Issues" menu.

Copy link

github-actions bot commented Jan 13, 2025

Bundle Stats

Hey there, this message comes from a GitHub action that helps you and reviewers to understand how these changes affect the size of this project's bundle.

As this PR is updated, I'll keep you updated on how the bundle size is impacted.

Total

Files count Total bundle size % Changed
0 → 10 0 B → 646.32 kB (+646.32 kB) -
View detailed bundle breakdown

Added

Asset File Size % Changed
web3.min.js 0 B → 627.37 kB (+627.37 kB) -
../lib/commonjs/index.d.ts 0 B → 8.72 kB (+8.72 kB) -
../lib/commonjs/accounts.d.ts 0 B → 3.19 kB (+3.19 kB) -
../lib/commonjs/types.d.ts 0 B → 2.73 kB (+2.73 kB) -
../lib/commonjs/web3.d.ts 0 B → 1.38 kB (+1.38 kB) -
../lib/commonjs/web3_eip6963.d.ts 0 B → 1.27 kB (+1.27 kB) -
../lib/commonjs/abi.d.ts 0 B → 1.14 kB (+1.14 kB) -
../lib/commonjs/eth.exports.d.ts 0 B → 280 B (+280 B) -
../lib/commonjs/providers.exports.d.ts 0 B → 183 B (+183 B) -
../lib/commonjs/version.d.ts 0 B → 60 B (+60 B) -

Removed

No assets were removed

Bigger

No assets were bigger

Smaller

No assets were smaller

Unchanged

No assets were unchanged

Copy link

codecov bot commented Jan 13, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.54%. Comparing base (ae99434) to head (0f560df).
Report is 1 commits behind head on 4.x.

Additional details and impacted files
@@           Coverage Diff           @@
##              4.x    #7441   +/-   ##
=======================================
  Coverage   94.54%   94.54%           
=======================================
  Files         218      218           
  Lines        8637     8637           
  Branches     2364     2364           
=======================================
  Hits         8166     8166           
  Misses        471      471           
Flag Coverage Δ
UnitTests 94.54% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

@AlexeyKrasnoperov
Copy link

Could you please also add a viem migration page with just "Coming soon"?

@jdevcs jdevcs marked this pull request as ready for review January 14, 2025 10:30
```
npm install ethers

Choose a reason for hiding this comment

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

Please also specify the ethers version here.


```typescript
const contract = new ethers.Contract(CONTRACT_ADDRESS, ABI, providerOrSigner);
const result = await contract.someFunction();
const signer = provider.getSigner();

Choose a reason for hiding this comment

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

Suggested change
const signer = provider.getSigner();
const signer = await provider.getSigner();

Copy link

@AlexeyKrasnoperov AlexeyKrasnoperov left a comment

Choose a reason for hiding this comment

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

looks good to me

@jdevcs jdevcs merged commit 89976a9 into 4.x Jan 14, 2025
54 checks passed
@jdevcs jdevcs deleted the junaid/web3toethersmigrationguide branch January 14, 2025 12:46
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.

3 participants