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

Expanded web3config Guide #6839

Open
wants to merge 1 commit into
base: 4.x
Choose a base branch
from
Open

Expanded web3config Guide #6839

wants to merge 1 commit into from

Conversation

MeenuyD
Copy link

@MeenuyD MeenuyD commented Feb 27, 2024

Expanded web3config Guide in Documentation: Added explanations and code samples for handleRevert and defaultAccount parameters.
#6805

@@ -30,6 +30,55 @@ There is list of configuration params that can be set for modifying behavior of

## Global level Config

`handleRevert` is a configuration option that specifies whether the web3 provider should handle revert errors automatically. When set to true, the web3 provider will catch revert errors and return a more informative error message instead of throwing an exception.
Copy link
Contributor

Choose a reason for hiding this comment

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

@MeenuyD Thanks for working on this, I'll suggest to create a new section in this guide, for explaning config options, and we need desc of all of following config params:
image

Copy link
Contributor

Choose a reason for hiding this comment

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

& if you open docs for these params in https://docs.web3js.org/guides/web3_config/ there is already desc that can be reused in this new section,

as second step I'll suggest to add code snippets as well in doc as examples.

Copy link
Author

Choose a reason for hiding this comment

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

Ok

Copy link
Contributor

Choose a reason for hiding this comment

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

@MeenuyD let us know when updates are complete, thx

Copy link

codecov bot commented Mar 5, 2024

Codecov Report

Merging #6839 (c43e4ac) into 4.x (4358140) will increase coverage by 4.68%.
Report is 190 commits behind head on 4.x.
The diff coverage is n/a.

Additional details and impacted files
@@            Coverage Diff             @@
##              4.x    #6839      +/-   ##
==========================================
+ Coverage   87.37%   92.05%   +4.68%     
==========================================
  Files         197      215      +18     
  Lines        7548     8206     +658     
  Branches     2059     2208     +149     
==========================================
+ Hits         6595     7554     +959     
+ Misses        953      652     -301     
Flag Coverage Δ
UnitTests 92.05% <ø> (+4.68%) ⬆️

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.

wait for changes

@jdevcs
Copy link
Contributor

jdevcs commented Apr 16, 2024

@MeenuyD

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