feat(docs): Expand web3 config guide #7131
Conversation
mmyyrroonn
requested review from
avkos,
jdevcs,
luu-alex and
Muhammad-Altabba
as code owners
…nsactionPollingInterval
mmyyrroonn
force-pushed
the
fix-6805-expand-web3config-guide-doc
branch
from
006213d
to
098a245
Compare
Co-authored-by: Junaid <[email protected]>
| ```ts | ||
| import { Web3 } from 'web3'; | ||
|
|
||
| const web3 = new Web3('http://127.0.0.1:7545'); | ||
|
|
||
| web3.defaultAccount = undefined; | ||
|
|
||
| console.log(web3.getContextObject().config); | ||
| ``` |
There was a problem hiding this comment.
I don't understand the benefit of these code blocks - they seem repetitive and don't communicate any new information to the reader. I would prefer to get rid of most of them (I will make note of the instances where I think it would make sense to keep them).
There was a problem hiding this comment.
I agree with you. The original requirement of the issue was to add an example for each config property. Initially, I used a value different from the default to demonstrate other options. However, during the first round of review, it was requested that we use the default value instead. Now, it seems redundant to me as well.
Co-authored-by: Dan Forbes <[email protected]>
…rnFormat and defaultCommon
|
@danforbes Hi, I resolved the review comments. All examples are removed except for the |
Co-authored-by: Dan Forbes <[email protected]>
|
@danforbes Thanks for those suggestions so much 😄. I'm not a native speaker and I appreciate it. I only left one question to discuss |
Description
Fix #6805
This PR expands the web3 config guide, including a detailed explanation for each config property and the code snippet.
transactionConfirmationPollingIntervalis marked as deprecated since I found it useless after this commit and cannot be found in the whole repo right now. Please correct me if I miss anything.contractDataInputFillin the API doc is changed todatafrominput.defaultMaxPriorityFeePerGas.Type of change
Checklist:
npm run lintwith success and extended the tests and types if necessary.npm run test:unitwith success.npm run test:coverageand my test cases cover all the lines and branches of the added code.npm run buildand testeddist/web3.min.jsin a browser.CHANGELOG.mdfile in the root folder.