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

update getTransactionReceipt return type #4872

Closed
wants to merge 6 commits into from
Closed

update getTransactionReceipt return type #4872

wants to merge 6 commits into from

Conversation

Hyun2
Copy link

@Hyun2 Hyun2 commented Mar 19, 2022

Description

Changed the type of effectiveGasPrice number to string in the object returned by the getTransactionReceipt function due to a number overflow issue.

Fixes #4819

Type of change

  • Bug fix (non-breaking change which fixes an issue)

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 dtslint with success and extended the tests and types if necessary.
  • I ran npm run test:unit with success.
  • 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 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.

@jdevcs jdevcs added the 1.x 1.0 related issues label Mar 21, 2022
@coveralls
Copy link

coveralls commented Mar 21, 2022

Pull Request Test Coverage Report for Build 2434375382

  • 0 of 1 (0.0%) changed or added relevant line in 1 file are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 72.211%

Changes Missing Coverage Covered Lines Changed/Added Lines %
packages/web3-core-helpers/src/formatters.js 0 1 0.0%
Totals Coverage Status
Change from base Build 2337627991: 0.0%
Covered Lines: 3372
Relevant Lines: 4401

💛 - Coveralls

@nikoulai
Copy link
Contributor

nikoulai commented Mar 21, 2022

Could you please update the doc here?

@Hyun2
Copy link
Author

Hyun2 commented Mar 22, 2022

Could you please update the doc here?

@nikoulai thanks, updated.

@@ -213,7 +213,7 @@ export interface TransactionReceipt {
contractAddress?: string;
cumulativeGasUsed: number;
gasUsed: number;
effectiveGasPrice: number;
effectiveGasPrice: string;
Copy link
Contributor

Choose a reason for hiding this comment

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

This will be breaking change in 1.x

@jdevcs
Copy link
Contributor

jdevcs commented Jul 6, 2022

This issue is fixed in #5157 without introducing breaking change, so closing this PR. #5157 (review)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1.x 1.0 related issues
Projects
None yet
Development

Successfully merging this pull request may close these issues.

effective gas price should be a big number.
7 participants