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 default return format to the context #6947

Conversation

avkos
Copy link
Contributor

@avkos avkos commented Mar 28, 2024

Description

Please include a summary of the changes and be sure to follow our Contribution Guidelines.

Fixes #6281

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.

Copy link

github-actions bot commented Mar 28, 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 621.38 kB → 622.84 kB (+1.46 kB) +0.23%
Changeset
File Δ Size
../web3-eth/lib/commonjs/rpc_method_wrappers.js 📈 +2.51 kB (+6.59%) 38.12 kB → 40.63 kB
../web3-core/lib/commonjs/web3_config.js 📈 +350 B (+2.14%) 16 kB → 16.34 kB
../web3-types/lib/commonjs/data_format_types.js 📈 +9 B (+0.60%) 1.47 kB → 1.48 kB
../web3-eth-contract/lib/commonjs/contract.js 📈 +242 B (+0.55%) 43.22 kB → 43.46 kB
../web3-utils/lib/commonjs/formatter.js 📈 +37 B (+0.30%) 11.99 kB → 12.02 kB
../web3-eth/lib/commonjs/web3_eth.js 📈 +181 B (+0.20%) 90.37 kB → 90.54 kB
../web3-eth-ens/lib/commonjs/ens.js 📈 +9 B (+0.08%) 11.11 kB → 11.12 kB
../web3-eth/lib/commonjs/utils/transaction_builder.js 📈 +2 B (+0.02%) 10.22 kB → 10.22 kB
src/web3.ts 📉 -21 B (-0.26%) 7.98 kB → 7.96 kB
../web3-net/lib/commonjs/net.js 📉 -46 B (-0.93%) 4.84 kB → 4.8 kB
../web3-eth/lib/commonjs/utils/get_revert_reason.js 📉 -47 B (-1.07%) 4.31 kB → 4.26 kB
View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

Asset File Size % Changed
web3.min.js 602.32 kB → 603.77 kB (+1.46 kB) +0.24%

Smaller

No assets were smaller

Unchanged

Asset File Size % Changed
../lib/commonjs/index.d.ts 8.69 kB 0%
../lib/commonjs/accounts.d.ts 3.89 kB 0%
../lib/commonjs/types.d.ts 2.45 kB 0%
../lib/commonjs/web3.d.ts 1.35 kB 0%
../lib/commonjs/web3_eip6963.d.ts 1.2 kB 0%
../lib/commonjs/abi.d.ts 999 B 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 bot commented Mar 28, 2024

Benchmark

Benchmark suite Current: 95de1c7 Previous: 6c075db Ratio
processingTx 9676 ops/sec (±3.81%) 9301 ops/sec (±4.81%) 0.96
processingContractDeploy 39208 ops/sec (±6.77%) 39129 ops/sec (±7.62%) 1.00
processingContractMethodSend 19092 ops/sec (±8.89%) 19443 ops/sec (±5.19%) 1.02
processingContractMethodCall 40440 ops/sec (±5.59%) 38971 ops/sec (±6.34%) 0.96
abiEncode 45526 ops/sec (±6.58%) 44252 ops/sec (±6.92%) 0.97
abiDecode 31395 ops/sec (±7.78%) 30419 ops/sec (±8.89%) 0.97
sign 1604 ops/sec (±3.36%) 1656 ops/sec (±4.08%) 1.03
verify 380 ops/sec (±0.39%) 373 ops/sec (±0.78%) 0.98

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

Copy link

codecov bot commented Mar 28, 2024

Codecov Report

Merging #6947 (5913c9e) into 4.x (1ab7a6b) will increase coverage by 0.00%.
The diff coverage is 94.00%.

Additional details and impacted files
@@           Coverage Diff           @@
##              4.x    #6947   +/-   ##
=======================================
  Coverage   91.96%   91.97%           
=======================================
  Files         215      215           
  Lines        8226     8273   +47     
  Branches     2220     2268   +48     
=======================================
+ Hits         7565     7609   +44     
- Misses        661      664    +3     
Flag Coverage Δ
UnitTests 91.97% <94.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 ∅ <ø> (∅)

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: 5913c9e Previous: 6c075db Ratio
processingTx 8774 ops/sec (±4.18%) 9301 ops/sec (±4.81%) 1.06
processingContractDeploy 37741 ops/sec (±6.91%) 39129 ops/sec (±7.62%) 1.04
processingContractMethodSend 19060 ops/sec (±4.69%) 19443 ops/sec (±5.19%) 1.02
processingContractMethodCall 36683 ops/sec (±6.28%) 38971 ops/sec (±6.34%) 1.06
abiEncode 41143 ops/sec (±6.50%) 44252 ops/sec (±6.92%) 1.08
abiDecode 27821 ops/sec (±7.91%) 30419 ops/sec (±8.89%) 1.09
sign 1554 ops/sec (±3.58%) 1656 ops/sec (±4.08%) 1.07
verify 378 ops/sec (±0.51%) 373 ops/sec (±0.78%) 0.99

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

@avkos avkos changed the title Add default return format to the context [DRAFT] Add default return format to the context Apr 2, 2024
Copy link
Contributor

@jdevcs jdevcs left a comment

Choose a reason for hiding this comment

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

(edited)
@avkos precedence will be following:

  1. local function format ( if defined will be considered first )
  2. else context format
    for all packages

@avkos avkos merged commit 93296c2 into 4.x Apr 18, 2024
54 checks passed
@avkos avkos deleted the ok/6281-Make-possibility-to-setup-return-format-in-global-web3-instance-class branch April 18, 2024 14:59
@luu-alex luu-alex mentioned this pull request May 23, 2024
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.

Make possibility to setup return format in global web3 instance class.
3 participants