feat(glossary): updated glossary #7168
Conversation
EmmanuelOluwafemi
requested review from
avkos,
jdevcs,
luu-alex and
Muhammad-Altabba
as code owners
| @@ -108,3 +108,85 @@ contract Test { | |||
| } | |||
| ] | |||
| ``` | |||
|
|
|||
| ## Proxy | |||
There was a problem hiding this comment.
@danforbes what do you suggest for keeping glossary section?
There was a problem hiding this comment.
I think a good glossary can be extremely helpful, but it's important that it's managed carefully.
There was a problem hiding this comment.
Thanks for the feedback, I will work on this
docs/docs/glossary/index.md
Outdated
|
|
||
| ## Proxy | ||
|
|
||
| A `proxy` in Web3.js serves as an intermediary between your application and an Ethereum node, **facilitating communication** by **forwarding requests and responses**. Configuring a proxy can help overcome network restrictions, enhance security, and improve load balancing. Understanding how to set up and use proxies with `HttpProvider` and `WebsocketProvider` in Web3.js is crucial for building robust and secure blockchain applications. |
There was a problem hiding this comment.
I think we need to be careful about saying that setting something up properly is crucial for security without providing any additional context or information about how to actually set things up so they are secure. Can we link to some documentation that explains how to securely configure a proxy?
docs/docs/glossary/index.md
Outdated
| A `proxy` in Web3.js serves as an intermediary between your application and an Ethereum node, **facilitating communication** by **forwarding requests and responses**. Configuring a proxy can help overcome network restrictions, enhance security, and improve load balancing. Understanding how to set up and use proxies with `HttpProvider` and `WebsocketProvider` in Web3.js is crucial for building robust and secure blockchain applications. | ||
|
|
||
| ## HttpProvider | ||
| `HttpProvider` in Web3.js connects an application to an Ethereum node over HTTP. It allows for sending transactions, reading blockchain data, and interacting with smart contracts. You create a Web3 instance with the node’s URL to establish the connection. It’s essential for DApps needing blockchain interaction but can block the event loop, so alternatives like `WebSocketProvider` might be used for better performance. Proper security measures are crucial when exposing HTTP endpoints. |
There was a problem hiding this comment.
The use of the word "essential" is confusing to me here. What are you trying to say? I would also be careful about bringing up the idea of crucial security measures without providing additional context about the specific measures that need to be taken.
There was a problem hiding this comment.
Thanks for the feedback, I will work on this
|
Hi @danforbes, I have updated the pr based on your feedbacks |
Description
Hey guys, I updated the glossary with these five words: “Proxy,” “HttpProvider,” “WebSocketProvider,” “Events,” and “Logs.” I was talking to @SantiagoDevRel, and we came up with this idea.
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.