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

viem migration guide #7444

Merged
merged 5 commits into from
Jan 16, 2025
Merged

viem migration guide #7444

merged 5 commits into from
Jan 16, 2025

Conversation

jdevcs
Copy link
Contributor

@jdevcs jdevcs commented Jan 15, 2025

Description

viem 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

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
10 646.32 kB 0%

Changeset

No files were changed

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 File Size % Changed
web3.min.js 627.37 kB 0%
../lib/commonjs/index.d.ts 8.72 kB 0%
../lib/commonjs/accounts.d.ts 3.19 kB 0%
../lib/commonjs/types.d.ts 2.73 kB 0%
../lib/commonjs/web3.d.ts 1.38 kB 0%
../lib/commonjs/web3_eip6963.d.ts 1.27 kB 0%
../lib/commonjs/abi.d.ts 1.14 kB 0%
../lib/commonjs/eth.exports.d.ts 280 B 0%
../lib/commonjs/providers.exports.d.ts 183 B 0%
../lib/commonjs/version.d.ts 60 B 0%

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Benchmark

Benchmark suite Current: d86a7af Previous: 89976a9 Ratio
processingTx 23949 ops/sec (±6.31%) 21670 ops/sec (±6.86%) 0.90
processingContractDeploy 41188 ops/sec (±4.93%) 36939 ops/sec (±8.56%) 0.90
processingContractMethodSend 15556 ops/sec (±9.58%) 15035 ops/sec (±8.97%) 0.97
processingContractMethodCall 28537 ops/sec (±6.28%) 27210 ops/sec (±6.92%) 0.95
abiEncode 43693 ops/sec (±7.55%) 40667 ops/sec (±8.13%) 0.93
abiDecode 30010 ops/sec (±8.69%) 29049 ops/sec (±7.39%) 0.97
sign 1581 ops/sec (±0.72%) 1499 ops/sec (±3.99%) 0.95
verify 373 ops/sec (±0.67%) 362 ops/sec (±0.55%) 0.97

This comment was automatically generated by workflow using github-action-benchmark.

Copy link

codecov bot commented Jan 15, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.54%. Comparing base (89976a9) to head (d86a7af).
Report is 1 commits behind head on 4.x.

Additional details and impacted files
@@           Coverage Diff           @@
##              4.x    #7444   +/-   ##
=======================================
  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.

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, minor changes could make the guide more consistent.

docs/docs/guides/18_migration_viem/index.md Outdated Show resolved Hide resolved
docs/docs/guides/18_migration_viem/index.md Outdated Show resolved Hide resolved
docs/docs/guides/18_migration_viem/index.md Outdated Show resolved Hide resolved
docs/docs/guides/18_migration_viem/index.md Outdated Show resolved Hide resolved
docs/docs/guides/18_migration_viem/index.md Show resolved Hide resolved
docs/docs/guides/18_migration_viem/index.md Outdated Show resolved Hide resolved
@jdevcs
Copy link
Contributor Author

jdevcs commented Jan 16, 2025

Thanks, done @AlexeyKrasnoperov

@jdevcs jdevcs merged commit bc4a34b into 4.x Jan 16, 2025
54 checks passed
@jdevcs jdevcs deleted the junaid/web3toviemmigration branch January 16, 2025 12:21
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.

2 participants