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 methods input param type any[] #7340

Merged
merged 6 commits into from
Oct 24, 2024

Conversation

avkos
Copy link
Contributor

@avkos avkos commented Oct 17, 2024

Description

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

Fixes #7302

Behavior right now

const abiAsConst = [
			{
				inputs: [
					{ internalType: 'uint256', name: 'testArg1', type: 'uint256' },
					{ internalType: 'uint256', name: 'testArg2', type: 'uint256' },
				],
				name: 'testWithParams',
				outputs: [{ internalType: 'uint256', name: 'testRes1', type: 'uint256' }],
				stateMutability: 'nonpayable',
				type: 'function',
			},
			{
				inputs: [],
				name: 'testWithoutParams',
				outputs: [{ internalType: 'uint256', name: 'testRes1', type: 'uint256' }],
				stateMutability: 'nonpayable',
				type: 'function',
			},
		] as const;

		const abiAsArray = [
			{
				inputs: [
					{ internalType: 'uint256', name: 'testArg1', type: 'uint256' },
					{ internalType: 'uint256', name: 'testArg2', type: 'uint256' },
				],
				name: 'testWithParams',
				outputs: [{ internalType: 'uint256', name: 'testRes1', type: 'uint256' }],
				stateMutability: 'nonpayable',
				type: 'function',
			},
			{
				inputs: [],
				name: 'testWithoutParams',
				outputs: [{ internalType: 'uint256', name: 'testRes1', type: 'uint256' }],
				stateMutability: 'nonpayable',
				type: 'function',
			},
		];
image

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 Oct 17, 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 0%

Changeset

No files were changed

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 622.62 kB 0%
../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: 2122260 Previous: ed85cce Ratio
processingTx 21649 ops/sec (±7.60%) 22475 ops/sec (±7.29%) 1.04
processingContractDeploy 38587 ops/sec (±7.85%) 37859 ops/sec (±7.67%) 0.98
processingContractMethodSend 15284 ops/sec (±7.27%) 16019 ops/sec (±6.80%) 1.05
processingContractMethodCall 27268 ops/sec (±6.34%) 27428 ops/sec (±6.22%) 1.01
abiEncode 42172 ops/sec (±7.05%) 42843 ops/sec (±7.53%) 1.02
abiDecode 29787 ops/sec (±8.57%) 29934 ops/sec (±7.71%) 1.00
sign 1529 ops/sec (±0.57%) 1501 ops/sec (±3.06%) 0.98
verify 358 ops/sec (±2.92%) 368 ops/sec (±0.51%) 1.03

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

@avkos avkos changed the title Fix Contract methods input param type any[] [DRAFT] Fix Contract methods input param type any[] Oct 18, 2024
@avkos avkos changed the title [DRAFT] Fix Contract methods input param type any[] Fix Contract methods input param type any[] Oct 18, 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.

plus check failing tests

Copy link

codecov bot commented Oct 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.45%. Comparing base (ed85cce) to head (2122260).
Report is 6 commits behind head on 4.x.

Additional details and impacted files
@@           Coverage Diff           @@
##              4.x    #7340   +/-   ##
=======================================
  Coverage   94.45%   94.45%           
=======================================
  Files         217      217           
  Lines        8483     8483           
  Branches     2343     2343           
=======================================
  Hits         8013     8013           
  Misses        470      470           
Flag Coverage Δ
UnitTests 94.45% <ø> (ø)

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

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.

All sounds great!
Just a tiny suggestion.

packages/web3-eth-contract/src/contract.ts Show resolved Hide resolved
@avkos avkos merged commit d3baae6 into 4.x Oct 24, 2024
54 checks passed
@avkos avkos deleted the ok/7302-Contract-methods-have-parameters-with-the-type branch October 24, 2024 13:44
MRLab12 pushed a commit to MRLab12/web3.js that referenced this pull request Oct 30, 2024
* fix types

* fix

* Update type.test.ts

* fix tests

* fix test
@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.

Contract methods have parameters with the type any[]
3 participants