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

Add guide for the breaking changes for Iban and IpcProvider #5899

Conversation

Muhammad-Altabba
Copy link
Contributor

@Muhammad-Altabba Muhammad-Altabba commented Mar 7, 2023

Description

Fixes #5737

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 for 1.x:

  • 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 dtslint with success and extended the tests and types if necessary.
  • I ran npm run test:cov and my test cases cover all the lines and branches of the added code.
  • I ran npm run build with success.
  • I have tested the built 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.

Checklist for 4.x:

  • I have selected the correct 4.x base branch.
  • Within the description, the feature or issue is discussed in detail or an issue is linked.
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas.
  • I have added any required tests for the changes I made
  • I have made corresponding changes to the documentation
  • Any dependent changes have been merged and published in downstream modules.
  • I ran yarn successfully
  • I ran yarn lint successfully
  • I ran yarn build:web successfully
  • I ran yarn test:unit successfully
  • I ran yarn test:integration successfully
  • I ran compile:contracts successfully
  • I have tested my code.
  • I have updated the corresponding CHANGELOG.md file in the packages I have edited.

@github-actions github-actions bot temporarily deployed to Preview: (feature/5737/guide-breaking-changes-documenation-for-iban-and-ipcprovider) March 7, 2023 15:46 Inactive
@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Mar 7, 2023

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: d586feb
Status: ✅  Deploy successful!
Preview URL: https://22c1b941.web3-js-docs.pages.dev
Branch Preview URL: https://feature-5737-guide-breaking-.web3-js-docs.pages.dev

View logs

@github-actions github-actions bot temporarily deployed to Preview: (feature/5737/guide-breaking-changes-documenation-for-iban-and-ipcprovider) March 7, 2023 15:51 Inactive
@Muhammad-Altabba Muhammad-Altabba changed the base branch from 1.x to 4.x March 7, 2023 16:41
@Muhammad-Altabba Muhammad-Altabba marked this pull request as ready for review March 7, 2023 16:52
@github-actions github-actions bot temporarily deployed to Preview: (feature/5737/guide-breaking-changes-documenation-for-iban-and-ipcprovider) March 7, 2023 16:52 Inactive
@Muhammad-Altabba Muhammad-Altabba changed the title [DRAFT] Add guide for the breaking changes for Iban and IpcProvider Add guide for the breaking changes for Iban and IpcProvider Mar 7, 2023
@codecov
Copy link

codecov bot commented Mar 7, 2023

Codecov Report

Merging #5899 (d586feb) into 4.x (0a8a8ae) will increase coverage by 0.01%.
The diff coverage is 100.00%.

Additional details and impacted files
@@            Coverage Diff             @@
##              4.x    #5899      +/-   ##
==========================================
+ Coverage   81.00%   81.01%   +0.01%     
==========================================
  Files         137      137              
  Lines        5981     5985       +4     
  Branches     1573     1573              
==========================================
+ Hits         4845     4849       +4     
  Misses       1136     1136              
Flag Coverage Δ
UnitTests 81.01% <100.00%> (+0.01%) ⬆️

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

Components Coverage Δ
web3 ∅ <ø> (∅)
web3-core ∅ <ø> (∅)
web3-errors ∅ <ø> (∅)
web3-eth ∅ <ø> (∅)
web3-eth-abi ∅ <ø> (∅)
web3-eth-accounts ∅ <ø> (∅)
web3-eth-contract ∅ <ø> (∅)
web3-eth-ens ∅ <ø> (∅)
web3-eth-iban ∅ <ø> (∅)
web3-eth-personal ∅ <ø> (∅)
web3-net ∅ <ø> (∅)
web3-providers-http ∅ <ø> (∅)
web3-providers-ipc ∅ <ø> (∅)
web3-providers-ws ∅ <ø> (∅)
web3-rpc-methods ∅ <ø> (∅)
web3-utils ∅ <ø> (∅)
web3-validator ∅ <ø> (∅)

@github-actions
Copy link

github-actions bot commented Mar 7, 2023

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 1.18 MB 1.06 MB -116 KB -9.61%
View detailed bundle breakdown

Added

Asset Old size New size Diff Diff %
../lib/eth.exports.d.ts.map 0 358 bytes 358 bytes -
../lib/eth.exports.d.ts 0 321 bytes 321 bytes -
../lib/providers.exports.d.ts.map 0 292 bytes 292 bytes -
../lib/providers.exports.d.ts 0 238 bytes 238 bytes -

Removed

No assets were removed

Bigger

Asset Old size New size Diff Diff %
../lib/index.d.ts 77 bytes 899 bytes 822 bytes 1067.53%
../lib/index.d.ts.map 155 bytes 919 bytes 764 bytes 492.90%

Smaller

Asset Old size New size Diff Diff %
web3.min.js 1.17 MB 1.05 MB -118 KB -9.88%
../lib/types.d.ts 1.92 KB 1.68 KB -253 bytes -12.84%
../lib/types.d.ts.map 1.75 KB 1.51 KB -241 bytes -13.46%

Unchanged

Asset Old size New size Diff Diff %
../lib/accounts.d.ts 3.42 KB 3.42 KB 0 0.00%
../lib/abi.d.ts 1020 bytes 999 bytes -18 bytes -1.77%
../lib/web3.d.ts 842 bytes 842 bytes 0 0.00%
../lib/web3.d.ts.map 693 bytes 694 bytes 1 bytes 0.14%
../lib/accounts.d.ts.map 528 bytes 528 bytes 0 0.00%
../lib/version.d.ts.map 140 bytes 140 bytes 0 0.00%
../lib/abi.d.ts.map 124 bytes 124 bytes 0 0.00%
../lib/version.d.ts 97 bytes 97 bytes 0 0.00%

@github-actions github-actions bot temporarily deployed to Preview: (feature/5737/guide-breaking-changes-documenation-for-iban-and-ipcprovider) March 7, 2023 17:20 Inactive
@Muhammad-Altabba Muhammad-Altabba marked this pull request as draft March 7, 2023 21:11
Co-authored-by: Junaid <86780488+jdevcs@users.noreply.github.com>
…aking-changes-documenation-for-iban-and-ipcprovider
…an-and-ipcprovider' of https://github.com/ChainSafe/web3.js into feature/5737/guide-breaking-changes-documenation-for-iban-and-ipcprovider
@Muhammad-Altabba Muhammad-Altabba merged commit ff36f73 into 4.x Mar 13, 2023
@Muhammad-Altabba Muhammad-Altabba deleted the feature/5737/guide-breaking-changes-documenation-for-iban-and-ipcprovider branch March 13, 2023 08:22
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/Breaking changes documenation
4 participants