-
Notifications
You must be signed in to change notification settings - Fork 5k
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 migration websocket doc changes #7318
Conversation
Bundle StatsHey 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
Changeset No files were changed View detailed bundle breakdownAdded No assets were added Removed No assets were removed Bigger No assets were bigger Smaller No assets were smaller Unchanged
|
There was a problem hiding this 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: 9b8069c | Previous: f701406 | Ratio |
---|---|---|---|
processingTx |
21899 ops/sec (±6.37% ) |
22830 ops/sec (±7.43% ) |
1.04 |
processingContractDeploy |
38365 ops/sec (±8.85% ) |
39939 ops/sec (±7.35% ) |
1.04 |
processingContractMethodSend |
15522 ops/sec (±7.49% ) |
15792 ops/sec (±6.76% ) |
1.02 |
processingContractMethodCall |
26813 ops/sec (±6.68% ) |
27711 ops/sec (±6.25% ) |
1.03 |
abiEncode |
42550 ops/sec (±7.00% ) |
42219 ops/sec (±7.33% ) |
0.99 |
abiDecode |
30074 ops/sec (±6.62% ) |
29744 ops/sec (±7.55% ) |
0.99 |
sign |
1463 ops/sec (±3.69% ) |
1498 ops/sec (±3.49% ) |
1.02 |
verify |
356 ops/sec (±0.96% ) |
365 ops/sec (±0.60% ) |
1.03 |
This comment was automatically generated by workflow using github-action-benchmark.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## 4.x #7318 +/- ##
=======================================
Coverage 94.44% 94.44%
=======================================
Files 216 216
Lines 8463 8463
Branches 2340 2340
=======================================
Hits 7993 7993
Misses 470 470
Flags with carried forward coverage won't be shown. Click here to find out more. |
In the past few days, I’ve encountered the issue explained in this docs update twice (websocket connection not closed at the end of a program). However, I noticed that the update was only added to the migration guide, which is somewhat buried in the documentation structure. I believe we should include the same information about closing WebSocket connections on the providers page, specifically here, to make it more accessible: https://docs.web3js.org/guides/web3_providers_guide/#websocket-provider |
Description
Added subtitles to make it easier to read, changed 4.x to v4 because thats the nomenclature we agreed to with a while but it still exists in the docs.
Added the migration change of the behavior of websockets, not terminating vs terminating in v4.
Please include a summary of the changes and be sure to follow our Contribution Guidelines.
Type of change
Checklist:
npm run lint
with success and extended the tests and types if necessary.npm run test:unit
with success.npm run test:coverage
and my test cases cover all the lines and branches of the added code.npm run build
and testeddist/web3.min.js
in a browser.CHANGELOG.md
file in the root folder.