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

6355 - allow data to be used in contract methods. #6377

Merged
merged 33 commits into from
Sep 11, 2023
Merged

6355 - allow data to be used in contract methods. #6377

merged 33 commits into from
Sep 11, 2023

Conversation

luu-alex
Copy link
Contributor

@luu-alex luu-alex commented Aug 23, 2023

Description

Fixing issues related to the merge about transaction data/input. As well contains community PR #6378
Should fix these issues #6355 #6400

After removing transactions to contain both input and data, this affected our contracts. contract methods were defaulting to sending only input in the calls which caused some people issues that required their methods to be sent with the data property. If they tried to use data in their contract options, this would error due to our typings only accepting input.

This PR:

  • allows users to provide data in their contract and contract options, instead of just defaulting to using the input property.
  • Adds a web3config contractDataInputFill to web3context option to allow users to pass encodedAbi through data, input or for both properties
    Please include a summary of the changes and be sure to follow our Contribution Guidelines.

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.

@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Aug 23, 2023

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: 4c1d30c
Status: ✅  Deploy successful!
Preview URL: https://5533f738.web3-js-docs.pages.dev
Branch Preview URL: https://6355.web3-js-docs.pages.dev

View logs

@github-actions
Copy link

github-actions bot commented Aug 23, 2023

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 653 KB 654 KB 1.53 KB 0.23%
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 636 KB 637 KB 1.53 KB 0.24%
../lib/commonjs/index.d.ts 8.56 KB 8.56 KB 0 0.00%
../lib/commonjs/accounts.d.ts 3.67 KB 3.67 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 1000 bytes 1000 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%

@codecov
Copy link

codecov bot commented Aug 28, 2023

Codecov Report

Merging #6377 (5aa72ec) into 4.x (3a9f7d7) will increase coverage by 0.04%.
The diff coverage is 100.00%.

Additional details and impacted files
@@            Coverage Diff             @@
##              4.x    #6377      +/-   ##
==========================================
+ Coverage   89.11%   89.15%   +0.04%     
==========================================
  Files         199      199              
  Lines        7723     7752      +29     
  Branches     2128     2144      +16     
==========================================
+ Hits         6882     6911      +29     
  Misses        841      841              
Flag Coverage Δ
UnitTests 89.15% <100.00%> (+0.04%) ⬆️

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

@luu-alex luu-alex marked this pull request as ready for review August 29, 2023 01:44
@luu-alex
Copy link
Contributor Author

luu-alex commented Sep 7, 2023

Updated PR to include web3config contractDataInputFill to web3context option to allow users to pass encodedAbi through data, input or for both properties
re review needed

@@ -37,6 +37,7 @@ export interface Web3ConfigOptions {
transactionConfirmationPollingInterval?: number;
blockHeaderTimeout: number;
maxListenersWarningThreshold: number;
contractDataInputFill: 'data' | 'input' | 'both'
Copy link
Contributor

Choose a reason for hiding this comment

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

@luu-alex This config is specific for contract package only, so imo should be in contract package only instead of in web3_config class.

Copy link
Contributor Author

@luu-alex luu-alex Sep 7, 2023

Choose a reason for hiding this comment

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

Setting it in web3_config class will allow users to only create this option once for all new contracts instantiated. If this was only in the contracts package, users with multiple contracts will need to define this option for every contract instance

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.

Looks good!
However, there are a few questions that I hope to answer and modify before merging.
Thanks,

@luu-alex luu-alex merged commit 355a548 into 4.x Sep 11, 2023
59 of 64 checks passed
@luu-alex luu-alex deleted the 6355 branch September 11, 2023 01:03
@moshmage
Copy link
Contributor

hey @luu-alex will we have a tagged version with this fix oooooor ?

@luu-alex
Copy link
Contributor Author

@moshmage hey, sorry didnt get to u sooner. This will be included in the next release which will be a minor version update. In the meantime you can use the dev branch which includes all the latest merges https://www.npmjs.com/package/web3?activeTab=versions latest dev version is 4.1.2-dev.e4ba45c.0 . As well updated docs for this

@jdevcs jdevcs mentioned this pull request Sep 18, 2023
@luu-alex
Copy link
Contributor Author

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.

5 participants