Web3.js Adapter for Wagmi: Documenation

[avkos]

Description

Please include a summary of the changes and be sure to follow our Contribution Guidelines.

Fixes #6746 #6751

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[bot]]

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	619 KB	619 KB	-

View detailed bundle breakdown

Added

Asset	Old size	New size	Diff	Diff %
web3.min.js	0	602 KB	602 KB	-
../lib/commonjs/index.d.ts	0	8.63 KB	8.63 KB	-
../lib/commonjs/accounts.d.ts	0	3.89 KB	3.89 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	999 bytes	999 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

[github-actions[bot]]

Benchmark

Benchmark suite	Current: f6d9982a8a2b52780dd00c9019b09a1cd4e6c1ee	Previous: 6c075dba3fefa27c833e5c71bf91319ac2466b0b	Ratio
processingTx	9176 ops/sec (±4.28%)	9301 ops/sec (±4.81%)	1.01
processingContractDeploy	38084 ops/sec (±8.14%)	39129 ops/sec (±7.62%)	1.03
processingContractMethodSend	19464 ops/sec (±6.34%)	19443 ops/sec (±5.19%)	1.00
processingContractMethodCall	39487 ops/sec (±4.99%)	38971 ops/sec (±6.34%)	0.99
abiEncode	43054 ops/sec (±7.15%)	44252 ops/sec (±6.92%)	1.03
abiDecode	30547 ops/sec (±6.76%)	30419 ops/sec (±8.89%)	1.00
sign	1635 ops/sec (±3.57%)	1656 ops/sec (±4.08%)	1.01
verify	371 ops/sec (±0.49%)	373 ops/sec (±0.78%)	1.01

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

[codecov[bot]]

Codecov Report

Merging #6813 (f6d9982) into 4.x (4358140) will increase coverage by 4.66%. Report is 181 commits behind head on 4.x. The diff coverage is n/a.

Additional details and impacted files

@@            Coverage Diff             @@
##              4.x    #6813      +/-   ##
==========================================
+ Coverage   87.37%   92.04%   +4.66%     
==========================================
  Files         197      214      +17     
  Lines        7548     8192     +644     
  Branches     2059     2206     +147     
==========================================
+ Hits         6595     7540     +945     
+ Misses        953      652     -301     

Flag	Coverage Δ
UnitTests	92.04% <ø> (+4.66%)	:arrow_up:

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

[avkos]

Here is the wagmi docs PR https://github.com/wevm/wagmi/pull/3624