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 contract.decodeMethodData(...) method to decode contract methods and to contract.deploy(...).decodeData(...) decode constructor parameters #6950

Merged
merged 11 commits into from
Apr 7, 2024

Conversation

Muhammad-Altabba
Copy link
Contributor

@Muhammad-Altabba Muhammad-Altabba commented Apr 3, 2024

Description

Fixes #6220

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 Apr 3, 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 619.77 kB → 620.52 kB (+768 B) +0.12%
Changeset
File Δ Size
../web3-eth-contract/lib/commonjs/contract.js 📈 +3.52 kB (+8.87%) 39.7 kB → 43.22 kB
../web3-eth-contract/lib/commonjs/encoding.js 📈 +504 B (+8.38%) 5.87 kB → 6.36 kB
View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

Asset File Size % Changed
web3.min.js 600.7 kB → 601.45 kB (+768 B) +0.12%

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 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: 27da7ac Previous: 6c075db Ratio
processingTx 9541 ops/sec (±3.47%) 9301 ops/sec (±4.81%) 0.97
processingContractDeploy 41153 ops/sec (±6.69%) 39129 ops/sec (±7.62%) 0.95
processingContractMethodSend 19950 ops/sec (±7.38%) 19443 ops/sec (±5.19%) 0.97
processingContractMethodCall 40676 ops/sec (±6.80%) 38971 ops/sec (±6.34%) 0.96
abiEncode 43381 ops/sec (±7.33%) 44252 ops/sec (±6.92%) 1.02
abiDecode 31312 ops/sec (±7.64%) 30419 ops/sec (±8.89%) 0.97
sign 1612 ops/sec (±3.32%) 1656 ops/sec (±4.08%) 1.03
verify 388 ops/sec (±0.36%) 373 ops/sec (±0.78%) 0.96

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

Copy link

codecov bot commented Apr 3, 2024

Codecov Report

Merging #6950 (f644ab8) into 4.x (4358140) will increase coverage by 4.57%.
Report is 213 commits behind head on 4.x.
The diff coverage is 90.00%.

Additional details and impacted files
@@            Coverage Diff             @@
##              4.x    #6950      +/-   ##
==========================================
+ Coverage   87.37%   91.95%   +4.57%     
==========================================
  Files         197      215      +18     
  Lines        7548     8212     +664     
  Branches     2059     2214     +155     
==========================================
+ Hits         6595     7551     +956     
+ Misses        953      661     -292     
Flag Coverage Δ
UnitTests 91.95% <90.00%> (+4.57%) ⬆️

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 ∅ <ø> (∅)

@Muhammad-Altabba Muhammad-Altabba changed the title [DRAFT] Add decodeABI to contract methods Add contract.decodeMethodData(...) method to decode contract methods and to contract.deploy(...).decodeData(...) decode constructor parameters Apr 4, 2024
@Muhammad-Altabba Muhammad-Altabba marked this pull request as ready for review April 4, 2024 16:08
@Muhammad-Altabba Muhammad-Altabba mentioned this pull request Apr 4, 2024
17 tasks
@@ -964,6 +965,21 @@ export class Contract<Abi extends ContractAbi>
: value;
}

public decodeMethodData(data: HexString): DecodedParams & { __method__: string } {
Copy link
Contributor

Choose a reason for hiding this comment

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

pls add this in docs under generated methods

* ## Generated Methods
like https://docs.web3js.org/libdocs/Contract#generated-methods
Thanks

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, except above doc addition in generated docs.

@Muhammad-Altabba Muhammad-Altabba merged commit ce59737 into 4.x Apr 7, 2024
17 of 18 checks passed
@Muhammad-Altabba Muhammad-Altabba deleted the 6220-add-method-decodeabi-to-method-interface branch April 7, 2024 11:34
@luu-alex luu-alex mentioned this pull request Apr 17, 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.

Add method decodeAbi to method interface
4 participants