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

web3modal documentation #7041

Merged
merged 8 commits into from
May 16, 2024
Merged

web3modal documentation #7041

merged 8 commits into from
May 16, 2024

Conversation

luu-alex
Copy link
Contributor

@luu-alex luu-alex commented May 14, 2024

Description

https://e305244d.web3-js-docs.pages.dev/guides/web3_modal_guide/
#6749
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.

Copy link

github-actions bot commented May 14, 2024

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

Files count Total bundle size % Changed
10 624.29 kB → 624.38 kB (+94 B) +0.01%
Changeset
File Δ Size
../web3-core/lib/commonjs/web3_request_manager.js 📈 +637 B (+3.91%) 15.92 kB → 16.54 kB
View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

Asset File Size % Changed
web3.min.js 604.99 kB → 605.08 kB (+94 B) +0.02%

Smaller

No assets were smaller

Unchanged

Asset File Size % Changed
../lib/commonjs/index.d.ts 8.69 kB 0%
../lib/commonjs/accounts.d.ts 3.89 kB 0%
../lib/commonjs/types.d.ts 2.67 kB 0%
../lib/commonjs/web3.d.ts 1.35 kB 0%
../lib/commonjs/web3_eip6963.d.ts 1.2 kB 0%
../lib/commonjs/abi.d.ts 999 B 0%
../lib/commonjs/eth.exports.d.ts 280 B 0%
../lib/commonjs/providers.exports.d.ts 183 B 0%
../lib/commonjs/version.d.ts 60 B 0%

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Benchmark

Benchmark suite Current: 0dd5e23 Previous: 866469d Ratio
processingTx 9049 ops/sec (±4.83%) 8892 ops/sec (±3.98%) 0.98
processingContractDeploy 38278 ops/sec (±6.89%) 38535 ops/sec (±6.62%) 1.01
processingContractMethodSend 19407 ops/sec (±5.97%) 18875 ops/sec (±7.64%) 0.97
processingContractMethodCall 39692 ops/sec (±3.75%) 40251 ops/sec (±5.97%) 1.01
abiEncode 42920 ops/sec (±7.11%) 42727 ops/sec (±6.75%) 1.00
abiDecode 29980 ops/sec (±9.04%) 29052 ops/sec (±7.20%) 0.97
sign 1590 ops/sec (±3.70%) 1560 ops/sec (±0.80%) 0.98
verify 373 ops/sec (±0.90%) 371 ops/sec (±0.49%) 0.99

This comment was automatically generated by workflow using github-action-benchmark.

Copy link

codecov bot commented May 14, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.97%. Comparing base (866469d) to head (0dd5e23).

Additional details and impacted files
@@           Coverage Diff           @@
##              4.x    #7041   +/-   ##
=======================================
  Coverage   91.97%   91.97%           
=======================================
  Files         215      215           
  Lines        8291     8291           
  Branches     2277     2277           
=======================================
  Hits         7626     7626           
  Misses        665      665           
Flag Coverage Δ
UnitTests 91.97% <ø> (ø)

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.

LGTM, just need to fix errors in live code edditor

@luu-alex luu-alex merged commit 2f73aa5 into 4.x May 16, 2024
54 checks passed
@luu-alex luu-alex deleted the docs/web3modal branch May 16, 2024 14:16
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.

None yet

3 participants