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

Correct web3-eth2- packages types #3865

Closed
wants to merge 26 commits into from
Closed

Conversation

spacesailor24
Copy link
Contributor

@spacesailor24 spacesailor24 commented Jan 19, 2021

Description

  • Wraps web3-eth2-beaconchain function parameter types in an object

E.g.:

Before

getAttestationsFromPool(slot: Slot, committee_index: CommitteeIndex): Promise<Attestation[]>

After

getAttestationsFromPool(params: {slot: Slot, committee_index: CommitteeIndex}): Promise<Attestation[]>
  • Move interfaces IBaseAPISchema and IBaseAPIMethodSchema to index.d.ts for web3-eth2-core
    • Removes no longer needed schema.ts
  • Add ETH2Core class export to index.d.ts for web3-eth2-core
  • Removes IETH2BeaconChain interface in favor of exporting a class type: ETH2BeaconChain

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 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.

@coveralls
Copy link

coveralls commented Jan 19, 2021

Pull Request Test Coverage Report for Build 504755931

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 385 unchanged lines in 7 files lost coverage.
  • Overall coverage decreased (-2.4%) to 73.797%

Files with Coverage Reduction New Missed Lines %
packages/web3-core-requestmanager/src/jsonrpc.js 1 88.0%
packages/web3-core-helpers/src/formatters.js 24 79.65%
packages/web3-core-helpers/src/errors.js 31 4.41%
packages/web3-utils/src/soliditySha3.js 55 5.56%
packages/web3-utils/src/index.js 60 30.0%
packages/web3-utils/src/utils.js 84 13.24%
packages/web3-eth-accounts/src/index.js 130 31.65%
Totals Coverage Status
Change from base Build 504724575: -2.4%
Covered Lines: 3288
Relevant Lines: 4218

💛 - Coveralls

frankiebee
frankiebee previously approved these changes Jan 21, 2021
Copy link
Contributor

@frankiebee frankiebee left a comment

Choose a reason for hiding this comment

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

🤙

GregTheGreek
GregTheGreek previously approved these changes Jan 21, 2021
@spacesailor24 spacesailor24 changed the title Correct web3-eth2-beaconchain types Correct web3-eth2- packages types Jan 21, 2021
GregTheGreek
GregTheGreek previously approved these changes Jan 21, 2021
@spacesailor24 spacesailor24 deleted the wyatt/beaconchain-types-fix branch January 22, 2021 23:42
@spacesailor24 spacesailor24 restored the wyatt/beaconchain-types-fix branch January 22, 2021 23:42
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