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

make decodeFunctionCall and decodeFunctionReturn available at web3-eth-abi #7345

Merged
merged 9 commits into from
Oct 22, 2024

Conversation

Muhammad-Altabba
Copy link
Contributor

@Muhammad-Altabba Muhammad-Altabba commented Oct 21, 2024

Description

Fixes #4917

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.

@Muhammad-Altabba Muhammad-Altabba linked an issue Oct 21, 2024 that may be closed by this pull request
2 tasks
Copy link

github-actions bot commented Oct 21, 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 642.15 kB → 642.3 kB (+154 B) +0.02%
Changeset
File Δ Size
../web3-eth-abi/lib/commonjs/api/functions_api.js 📈 +5.09 kB (+104.55%) 4.87 kB → 9.97 kB
../web3-eth-contract/lib/commonjs/contract-deployer-method-class.js 📈 +49 B (+0.69%) 6.9 kB → 6.95 kB
../web3-eth-contract/lib/commonjs/contract.js 📉 -99 B (-0.23%) 42.15 kB → 42.05 kB
../web3-eth-contract/lib/commonjs/encoding.js 📉 -962 B (-14.77%) 6.36 kB → 5.42 kB
View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

Asset File Size % Changed
web3.min.js 622.62 kB → 622.77 kB (+154 B) +0.02%

Smaller

No assets were smaller

Unchanged

Asset File Size % Changed
../lib/commonjs/index.d.ts 8.72 kB 0%
../lib/commonjs/accounts.d.ts 3.89 kB 0%
../lib/commonjs/types.d.ts 2.67 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: dee0899 Previous: 331aa9c Ratio
processingTx 22833 ops/sec (±6.89%) 20042 ops/sec (±7.50%) 0.88
processingContractDeploy 38862 ops/sec (±7.79%) 38574 ops/sec (±5.63%) 0.99
processingContractMethodSend 16065 ops/sec (±7.11%) 14751 ops/sec (±9.38%) 0.92
processingContractMethodCall 27330 ops/sec (±7.66%) 28271 ops/sec (±6.08%) 1.03
abiEncode 43284 ops/sec (±7.45%) 41366 ops/sec (±7.53%) 0.96
abiDecode 30760 ops/sec (±7.00%) 28375 ops/sec (±8.41%) 0.92
sign 1513 ops/sec (±4.18%) 1500 ops/sec (±1.06%) 0.99
verify 363 ops/sec (±0.54%) 356 ops/sec (±0.80%) 0.98

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

Copy link

codecov bot commented Oct 21, 2024

Codecov Report

Attention: Patch coverage is 96.96970% with 1 line in your changes missing coverage. Please review.

Project coverage is 94.50%. Comparing base (331aa9c) to head (dee0899).
Report is 1 commits behind head on 4.x.

Additional details and impacted files
@@            Coverage Diff             @@
##              4.x    #7345      +/-   ##
==========================================
+ Coverage   94.45%   94.50%   +0.04%     
==========================================
  Files         217      217              
  Lines        8483     8487       +4     
  Branches     2343     2343              
==========================================
+ Hits         8013     8021       +8     
+ Misses        470      466       -4     
Flag Coverage Δ
UnitTests 94.50% <96.96%> (+0.04%) ⬆️

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

@Muhammad-Altabba Muhammad-Altabba changed the title [DRAFT] make decodeMethodParams and decodeMethodReturn availlable at web3-eth-abi [DRAFT] make decodeMethodParams and decodeMethodReturn available at web3-eth-abi Oct 21, 2024
@@ -1026,7 +1023,7 @@ export class Contract<Abi extends ContractAbi>
`The ABI for the provided method signature ${methodSignature} was not found.`,
);
}
return { ...decodeMethodParams(abi, data), __method__: jsonInterfaceMethodToString(abi) };
Copy link
Contributor Author

Choose a reason for hiding this comment

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

the property __method__ is now returned by decodeMethodParams.

@Muhammad-Altabba Muhammad-Altabba marked this pull request as ready for review October 21, 2024 19:42
@Muhammad-Altabba Muhammad-Altabba changed the title [DRAFT] make decodeMethodParams and decodeMethodReturn available at web3-eth-abi make decodeMethodParams and decodeMethodReturn available at web3-eth-abi Oct 21, 2024
@Muhammad-Altabba Muhammad-Altabba changed the title make decodeMethodParams and decodeMethodReturn available at web3-eth-abi make decodeFunctionCall and decodeFunctionReturn available at web3-eth-abi Oct 21, 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.

LGTM, only need some docs and unit tests before merging. thanks

@Muhammad-Altabba Muhammad-Altabba merged commit 3687070 into 4.x Oct 22, 2024
37 of 38 checks passed
@Muhammad-Altabba Muhammad-Altabba deleted the 4917-add-decode-function-parameters branch October 22, 2024 11:49
@luu-alex luu-alex mentioned this pull request Nov 6, 2024
17 tasks
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.

Add decode function parameters
3 participants