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

Specify SignTransaction's argument types #5993

Conversation

Muhammad-Altabba
Copy link
Contributor

Description

Fixes #5892

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 for 1.x:

  • 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 dtslint with success and extended the tests and types if necessary.
  • I ran npm run test:cov and my test cases cover all the lines and branches of the added code.
  • I ran npm run build with success.
  • I have tested the built 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.

Checklist for 4.x:

  • I have selected the correct 4.x base branch.
  • Within the description, the feature or issue is discussed in detail or an issue is linked.
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas.
  • I have added any required tests for the changes I made
  • I have made corresponding changes to the documentation
  • Any dependent changes have been merged and published in downstream modules.
  • I ran yarn successfully
  • I ran yarn lint successfully
  • I ran yarn build:web successfully
  • I ran yarn test:unit successfully
  • I ran yarn test:integration successfully
  • I ran compile:contracts successfully
  • I have tested my code.
  • I have updated the corresponding CHANGELOG.md file in the packages I have edited.

@Muhammad-Altabba Muhammad-Altabba linked an issue Apr 5, 2023 that may be closed by this pull request
1 task
@Muhammad-Altabba Muhammad-Altabba changed the base branch from 1.x to 4.x April 5, 2023 23:12
@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Apr 5, 2023

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: a095170
Status: ✅  Deploy successful!
Preview URL: https://fababd98.web3-js-docs.pages.dev
Branch Preview URL: https://5892-4x-signtransactions-arg.web3-js-docs.pages.dev

View logs

@github-actions
Copy link

github-actions bot commented Apr 5, 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 721 KB 721 KB 388 bytes 0.05%
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 704 KB 704 KB 388 bytes 0.05%
../lib/commonjs/index.d.ts 8.43 KB 8.43 KB 0 0.00%
../lib/commonjs/accounts.d.ts 3.66 KB 3.66 KB 0 0.00%
../lib/commonjs/types.d.ts 2.4 KB 2.4 KB 0 0.00%
../lib/commonjs/abi.d.ts 1000 bytes 1000 bytes 0 0.00%
../lib/commonjs/web3.d.ts 808 bytes 808 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 Apr 5, 2023

Codecov Report

Merging #5993 (a095170) into 4.x (ae0b314) will increase coverage by 0.00%.
The diff coverage is 97.36%.

Additional details and impacted files
@@           Coverage Diff           @@
##              4.x    #5993   +/-   ##
=======================================
  Coverage   85.82%   85.82%           
=======================================
  Files         156      156           
  Lines        7406     7408    +2     
  Branches     2008     2006    -2     
=======================================
+ Hits         6356     6358    +2     
  Misses       1050     1050           
Flag Coverage Δ
UnitTests 85.82% <97.36%> (+<0.01%) ⬆️

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

Copy link
Contributor

@avkos avkos left a comment

Choose a reason for hiding this comment

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

Please, add information to changelog.md files

@nikoulai
Copy link
Contributor

Except for Oleksii's comment LGTM

packages/web3-eth-contract/CHANGELOG.md Outdated Show resolved Hide resolved
@jdevcs
Copy link
Contributor

jdevcs commented Apr 11, 2023

This PR lgtm, except few changes required. Thanks @Muhammad-Altabba

@jdevcs
Copy link
Contributor

jdevcs commented Apr 11, 2023

Some of tests in CI are not passing and there are conflicting files. Could you fix these. Many thanks

@Muhammad-Altabba Muhammad-Altabba merged commit ffe372f into 4.x Apr 13, 2023
@Muhammad-Altabba Muhammad-Altabba deleted the 5892-4x-signtransactions-argument-is-not-typed-in-web3-types branch April 13, 2023 12:52
@jdevcs jdevcs mentioned this pull request Apr 14, 2023
spacesailor24 pushed a commit that referenced this pull request Apr 18, 2023
* move some data-format and contract types to web3-types

* at `signTransaction` use `Transaction` instead of `Record<string, unknown>`

* update CHANGELOG.md files
@Hasinafidahussain
Copy link

#6050

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.x] signTransactions argument is not typed in web3-types
5 participants