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

Nikos/5939/eip1193 provider callback types #5971

Merged
merged 47 commits into from
Apr 20, 2023

Conversation

nikoulai
Copy link
Contributor

Description

fixes events' callback types for eip1193 providers
closes #5939

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.

@github-actions
Copy link

github-actions bot commented Mar 29, 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 -42 bytes -0.01%
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 -42 bytes -0.01%
../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%

@nikoulai nikoulai marked this pull request as draft March 30, 2023 09:10
@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Mar 30, 2023

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: 52d48f1
Status: ✅  Deploy successful!
Preview URL: https://ea04fe49.web3-js-docs.pages.dev
Branch Preview URL: https://nikos-5939-eip1193provider-c.web3-js-docs.pages.dev

View logs

@codecov
Copy link

codecov bot commented Mar 30, 2023

Codecov Report

Merging #5971 (52d48f1) into 4.x (be06d3e) will not change coverage.
The diff coverage is 0.00%.

Additional details and impacted files
@@           Coverage Diff           @@
##              4.x    #5971   +/-   ##
=======================================
  Coverage   85.82%   85.82%           
=======================================
  Files         156      156           
  Lines        7408     7408           
  Branches     2006     2006           
=======================================
  Hits         6358     6358           
  Misses       1050     1050           
Flag Coverage Δ
UnitTests 85.82% <0.00%> (ø)

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

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

LGTM.

However, there is tiny stuff. If you can address them, before merging.

packages/web3-core/src/web3_subscriptions.ts Outdated Show resolved Hide resolved
packages/web3-core/src/web3_subscriptions.ts Outdated Show resolved Hide resolved
@github-actions github-actions bot requested a deployment to web3-js-docs (Preview) April 11, 2023 13:00 Abandoned
): void;
public removeListener<T = JsonRpcResult>(
type: string,
listener: Web3Eip1193ProviderEventCallback<any> | Web3ProviderEventCallback<T>,
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
listener: Web3Eip1193ProviderEventCallback<any> | Web3ProviderEventCallback<T>,
listener: Web3Eip1193ProviderEventCallback<unknown> | Web3ProviderEventCallback<T>,

?

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.

lgtm, except few changes required. ( also update change log ) Thanks @nikoulai

Signed-off-by: Nikos Iliakis <nikoulai94@hotmail.com>
@nikoulai nikoulai merged commit 3d80e63 into 4.x Apr 20, 2023
@nikoulai nikoulai deleted the nikos/5939/EIP1193Provider-callback-types branch April 20, 2023 18:19
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