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

fix: return type of sendTransaction in docs #7386

Merged
merged 2 commits into from
Nov 13, 2024
Merged

Conversation

krzysu
Copy link
Contributor

@krzysu krzysu commented Nov 13, 2024

Fix return type of sendTransaction in docs. I did pretty much exactly the same as here #7245

Fixes #7185

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 Nov 13, 2024

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 649.08 kB 0%
Changeset
File Δ Size
../web3-eth/lib/commonjs/web3_eth.js 📈 +3.12 kB (+3.17%) 98.26 kB → 101.38 kB
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 630.33 kB 0%
../lib/commonjs/index.d.ts 8.72 kB 0%
../lib/commonjs/accounts.d.ts 3.06 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.28 kB 0%
../lib/commonjs/abi.d.ts 1.06 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: ec12fb1 Previous: 0915cf4 Ratio
processingTx 22514 ops/sec (±8.34%) 21158 ops/sec (±9.09%) 0.94
processingContractDeploy 39234 ops/sec (±7.21%) 39840 ops/sec (±7.22%) 1.02
processingContractMethodSend 16236 ops/sec (±6.41%) 16219 ops/sec (±7.11%) 1.00
processingContractMethodCall 27733 ops/sec (±6.47%) 28092 ops/sec (±7.49%) 1.01
abiEncode 42727 ops/sec (±7.77%) 42384 ops/sec (±8.97%) 0.99
abiDecode 28494 ops/sec (±7.82%) 30530 ops/sec (±6.45%) 1.07
sign 1559 ops/sec (±1.17%) 1490 ops/sec (±3.70%) 0.96
verify 360 ops/sec (±3.00%) 364 ops/sec (±0.63%) 1.01

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

Copy link

codecov bot commented Nov 13, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.51%. Comparing base (0915cf4) to head (ec12fb1).
Report is 1 commits behind head on 4.x.

Additional details and impacted files
@@           Coverage Diff           @@
##              4.x    #7386   +/-   ##
=======================================
  Coverage   94.51%   94.51%           
=======================================
  Files         218      218           
  Lines        8557     8557           
  Branches     2363     2363           
=======================================
  Hits         8088     8088           
  Misses        469      469           
Flag Coverage Δ
UnitTests 94.51% <ø> (ø)

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

Copy link
Contributor

@danforbes danforbes left a comment

Choose a reason for hiding this comment

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

Thanks for taking care of this, Kris 🙏🏻 I also went ahead and included the fix for "encorage" vs "encourage" in infer_contract_types.md that was pointed out in #7383

@danforbes danforbes merged commit 6af068f into 4.x Nov 13, 2024
52 of 54 checks passed
@danforbes danforbes deleted the 7185-sendtransaction-docs branch November 13, 2024 22:03
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.

docs - sendtransaction has wrong return in docs
2 participants