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

Write a migration guide from ethers to web3.js #6603

Merged
merged 15 commits into from
Nov 20, 2023

Conversation

Muhammad-Altabba
Copy link
Contributor

Description

#6560

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)

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.

@Muhammad-Altabba Muhammad-Altabba linked an issue Nov 16, 2023 that may be closed by this pull request
Copy link

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

Asset Old size New size Diff Diff %
Total 588 KB 588 KB 0 0.00%
View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

No assets were bigger

Smaller

No assets were smaller

Unchanged

Asset Old size New size Diff Diff %
web3.min.js 571 KB 571 KB 0 0.00%
../lib/commonjs/index.d.ts 8.63 KB 8.63 KB 0 0.00%
../lib/commonjs/accounts.d.ts 3.67 KB 3.67 KB 0 0.00%
../lib/commonjs/types.d.ts 2.45 KB 2.45 KB 0 0.00%
../lib/commonjs/web3.d.ts 1.14 KB 1.14 KB 0 0.00%
../lib/commonjs/abi.d.ts 1000 bytes 1000 bytes 0 0.00%
../lib/commonjs/eth.exports.d.ts 280 bytes 280 bytes 0 0.00%
../lib/commonjs/providers.exports.d.ts 148 bytes 148 bytes 0 0.00%
../lib/commonjs/version.d.ts 60 bytes 60 bytes 0 0.00%

Copy link

cloudflare-workers-and-pages bot commented Nov 16, 2023

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: 544a192
Status: ✅  Deploy successful!
Preview URL: https://62517008.web3-js-docs.pages.dev
Branch Preview URL: https://6560-migration-guide-ethers.web3-js-docs.pages.dev

View logs

@Muhammad-Altabba Muhammad-Altabba changed the title [DRAFT] write a migration guide from ethers to web3.js Write a migration guide from ethers to web3.js Nov 16, 2023
@Muhammad-Altabba Muhammad-Altabba marked this pull request as ready for review November 16, 2023 21:24
Copy link
Contributor

@avkos avkos left a comment

Choose a reason for hiding this comment

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

LGTM, thanks @Muhammad-Altabba
I suggest some very tiny changes

docs/docs/guides/migration_from_other_libs/ethers.md Outdated Show resolved Hide resolved
docs/docs/guides/migration_from_other_libs/ethers.md Outdated Show resolved Hide resolved
docs/docs/guides/migration_from_other_libs/ethers.md Outdated Show resolved Hide resolved
docs/docs/guides/migration_from_other_libs/ethers.md Outdated Show resolved Hide resolved
docs/docs/guides/migration_from_other_libs/ethers.md Outdated Show resolved Hide resolved
docs/docs/guides/migration_from_other_libs/ethers.md Outdated Show resolved Hide resolved
docs/docs/guides/migration_from_other_libs/ethers.md Outdated Show resolved Hide resolved
docs/docs/guides/migration_from_other_libs/ethers.md Outdated Show resolved Hide resolved
@jdevcs
Copy link
Contributor

jdevcs commented Nov 20, 2023

Thanks for your effort @Muhammad-Altabba , This PR needs some minor tailoring.

@Muhammad-Altabba Muhammad-Altabba merged commit be86e25 into 4.x Nov 20, 2023
26 of 29 checks passed
@Muhammad-Altabba Muhammad-Altabba deleted the 6560-migration-guide-ethers-to-web3js branch November 20, 2023 17:13
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.

Migration Guide: Ethers to Web3.js
4 participants