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

Proposal: Expose plugin functionality to plugins so it's easier to discover what plugins could do #6538

Merged
merged 5 commits into from
Nov 23, 2023

Conversation

mpetrunic
Copy link
Contributor

Description

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.

@github-actions
Copy link

github-actions bot commented Oct 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 0 588 KB 588 KB -
View detailed bundle breakdown

Added

Asset Old size New size Diff Diff %
web3.min.js 0 571 KB 571 KB -
../lib/commonjs/index.d.ts 0 8.63 KB 8.63 KB -
../lib/commonjs/accounts.d.ts 0 3.67 KB 3.67 KB -
../lib/commonjs/types.d.ts 0 2.45 KB 2.45 KB -
../lib/commonjs/web3.d.ts 0 1.14 KB 1.14 KB -
../lib/commonjs/abi.d.ts 0 1000 bytes 1000 bytes -
../lib/commonjs/eth.exports.d.ts 0 280 bytes 280 bytes -
../lib/commonjs/providers.exports.d.ts 0 148 bytes 148 bytes -
../lib/commonjs/version.d.ts 0 60 bytes 60 bytes -

Removed

No assets were removed

Bigger

No assets were bigger

Smaller

No assets were smaller

Unchanged

No assets were unchanged

@codecov
Copy link

codecov bot commented Oct 23, 2023

Codecov Report

Merging #6538 (bf9368b) into 4.x (72e9bbd) will increase coverage by 0.09%.
Report is 6 commits behind head on 4.x.
The diff coverage is 71.42%.

❗ Current head bf9368b differs from pull request most recent head 297565a. Consider uploading reports for the commit 297565a to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##              4.x    #6538      +/-   ##
==========================================
+ Coverage   89.56%   89.65%   +0.09%     
==========================================
  Files         215      215              
  Lines        8251     8237      -14     
  Branches     2234     2224      -10     
==========================================
- Hits         7390     7385       -5     
+ Misses        861      852       -9     
Flag Coverage Δ
UnitTests 89.65% <71.42%> (+0.09%) ⬆️

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

@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Oct 24, 2023

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: 297565a
Status: ✅  Deploy successful!
Preview URL: https://cf7d2437.web3-js-docs.pages.dev
Branch Preview URL: https://feat-plugin-ux.web3-js-docs.pages.dev

View logs

@avkos avkos self-requested a review October 24, 2023 15:05
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.

Could you please also fix tests
packages/web3/test/integration/web3-plugin-add-tx.test.ts
and
packages/web3-eth-accounts/test/unit/tx/registerNewTx.test.ts
to use this new method registerNewTransactionType

Signed-off-by: Marin Petrunic <marin.petrunic@gmail.com>
Signed-off-by: Marin Petrunic <marin.petrunic@gmail.com>
Signed-off-by: Marin Petrunic <marin.petrunic@gmail.com>
Signed-off-by: Marin Petrunic <marin.petrunic@gmail.com>
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.

Thanks for your contribution.
Just a small comment I think was missed.

packages/web3-core/src/web3_context.ts Show resolved Hide resolved
Co-authored-by: Muhammad Altabba <24407834+Muhammad-Altabba@users.noreply.github.com>
@luu-alex luu-alex merged commit 20cc5da into 4.x Nov 23, 2023
27 of 29 checks passed
@luu-alex luu-alex deleted the feat/plugin-ux branch November 23, 2023 16:58
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