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: contract method types should allow any param if abi type not supplied #6688

Merged
merged 5 commits into from
Jan 9, 2024

Conversation

mpetrunic
Copy link
Contributor

@mpetrunic mpetrunic commented Jan 4, 2024

Description

Previously type was [] (zero element tuple) instead of any[] which prevented passing parameters if contract aby type was not defined.

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.

Previously type was [] (zero element tuple) instead of any[] which prevented passing parameters if contract aby type was not defined.
Copy link

github-actions bot commented Jan 4, 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

Asset Old size New size Diff Diff %
Total 591 KB 618 KB 27.5 KB 4.65%
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 Old size New size Diff Diff %
web3.min.js 573 KB 601 KB 27.5 KB 4.79%
../lib/commonjs/index.d.ts 8.63 KB 8.63 KB 0 0.00%
../lib/commonjs/accounts.d.ts 3.89 KB 3.89 KB 0 0.00%
../lib/commonjs/types.d.ts 2.45 KB 2.45 KB 0 0.00%
../lib/commonjs/web3.d.ts 1.14 KB 1.14 KB 0 0.00%
../lib/commonjs/abi.d.ts 999 bytes 999 bytes 0 0.00%
../lib/commonjs/eth.exports.d.ts 280 bytes 280 bytes 0 0.00%
../lib/commonjs/providers.exports.d.ts 148 bytes 148 bytes 0 0.00%
../lib/commonjs/version.d.ts 60 bytes 60 bytes 0 0.00%

Copy link

cloudflare-workers-and-pages bot commented Jan 4, 2024

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: 26299b3
Status: ✅  Deploy successful!
Preview URL: https://937d1146.web3-js-docs.pages.dev
Branch Preview URL: https://fix-default-parameter-type.web3-js-docs.pages.dev

View logs

@@ -316,7 +316,7 @@ export type ContractMethodInputParameters<Params extends ReadonlyArray<unknown>
[MatchPrimitiveType<H['type'], H['components']>, ...ContractMethodInputParameters<R>]
: ContractMethodInputParameters<R>
: Params extends undefined | unknown
? []
? any[]
Copy link
Contributor

Choose a reason for hiding this comment

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm not 100% but yours doesn't cover constructor args?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

But this should be fixed regardless of your PR

Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks Marin for the fix and the clarification.
It would be also great if you could add a test. As you see my PR for the methods args types did not work, so I left it for when having time for it. As I worked on it in my free time 😄

By the way, the constructor args types were handled as part of: #6635. Where even if the ABI was not provided, the types are inferred as possible.

Copy link
Contributor

@Muhammad-Altabba Muhammad-Altabba left a comment

Choose a reason for hiding this comment

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

It will be great to add a small test where typescript does not complain about the passed args.
And the Unit and integration tests are failing and needed to be checked, please.
Many thanks,

Signed-off-by: Marin Petrunic <marin.petrunic@gmail.com>
Signed-off-by: Marin Petrunic <marin.petrunic@gmail.com>
@mpetrunic
Copy link
Contributor Author

@Muhammad-Altabba Improved solution and added test^^

Copy link

github-actions bot commented Jan 8, 2024

Benchmark

Benchmark suite Current: 26299b3 Previous: 6c075db Ratio
processingTx 9190 ops/sec (±3.76%) 9301 ops/sec (±4.81%) 1.01
processingContractDeploy 40833 ops/sec (±7.25%) 39129 ops/sec (±7.62%) 0.96
processingContractMethodSend 19334 ops/sec (±8.16%) 19443 ops/sec (±5.19%) 1.01
processingContractMethodCall 39529 ops/sec (±5.87%) 38971 ops/sec (±6.34%) 0.99
abiEncode 45608 ops/sec (±7.56%) 44252 ops/sec (±6.92%) 0.97
abiDecode 30697 ops/sec (±8.33%) 30419 ops/sec (±8.89%) 0.99
sign 1621 ops/sec (±2.95%) 1656 ops/sec (±4.08%) 1.02
verify 376 ops/sec (±0.69%) 373 ops/sec (±0.78%) 0.99

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

Copy link

codecov bot commented Jan 8, 2024

Codecov Report

Merging #6688 (26299b3) into 4.x (f9468a8) will increase coverage by 0.56%.
Report is 7 commits behind head on 4.x.
The diff coverage is n/a.

Additional details and impacted files
@@            Coverage Diff             @@
##              4.x    #6688      +/-   ##
==========================================
+ Coverage   91.46%   92.03%   +0.56%     
==========================================
  Files         214      214              
  Lines        8155     8171      +16     
  Branches     2193     2200       +7     
==========================================
+ Hits         7459     7520      +61     
+ Misses        696      651      -45     
Flag Coverage Δ
UnitTests 92.03% <ø> (+0.56%) ⬆️

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

@mpetrunic mpetrunic changed the title Fix default contractor and method input parameter fix: contract method types should allow any param if abi type not supplied Jan 8, 2024
Signed-off-by: Marin Petrunic <marin.petrunic@gmail.com>
@jdevcs jdevcs merged commit 3cfe56f into 4.x Jan 9, 2024
61 of 66 checks passed
@jdevcs jdevcs deleted the fix-default-parameter-type branch January 9, 2024 11:47
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.

4 participants