Update Hello World template [Fixes #234] #235
Conversation
|
I welcome input from anyone on this! I highly recommend running the project locally & using the template. It's much easier to grok the new instructions & flow vs. reading the file changes on Github. |
| this.instance = this.Contract.address ? contract_interface.at(this.Contract.address) : { message: () => {} }; | ||
| }; | ||
| ``` | ||
| Dapps typically use a [JavaScript convenience libraries](https://ethereum.org/developers/#frontend-javascript-apis) that provide an API to make integrations with smart contract easier for developers. In this project, you'll be using [web3.js](https://web3js.readthedocs.io/en/v1.2.8/). |
There was a problem hiding this comment.
These are typically called APIs or SDKs, any reason you chose "convenience library"?
There was a problem hiding this comment.
I just noticed that's the terminology MetaMask uses: https://docs.metamask.io/guide/getting-started.html#choosing-a-convenience-library
Figured it'd be good to align with them given they have perhaps the most widely used Ethereum wallet among devs.
There was a problem hiding this comment.
I suppose my personal bias is also that the term "SDK" feels a bit heavy-weight to describe ethers.js or web3.js. They are JavaScript libraries that provide APIs.
There was a problem hiding this comment.
Open to changing this if there's evidence of those terms being consistently used elsewhere.
There was a problem hiding this comment.
Few small things on grammar, and some questions. I'd also like to try running through it myself to see if it makes sense when following the application code.
And… I think it makes sense to re-record the video based around this, so I can test that it makes sense as I do that.
Co-authored-by: Chris Chinchilla <chris.ward@ethereum.org>
|
Thanks for the review @ChrisChinchilla! I incorporated all your suggested changes.
Sure thing, that's what I recommended 😄 .
Perhaps but how long does a video take to record? We potentially have a series of upcoming changes to Ethereum Studio (see all the open issues), I would like to avoid you having to re-record a bunch of times. I suggest we hold off on that for now. |
|
Thanks for the review @javier-tarazaga. @ChrisChinchilla I'll wait for another review from you before merging anything. |
Description of the Change
Refactored the Hello World template (primarily the README) based on the extensive feedback we received from a group of Ethereum developers.
Alternate Designs
See #234
Benefits
See #234
Possible Drawbacks
Users must go to the project files to read the code vs. the README, however, that's intended & based on the feedback we received will improve UX.
Verification Process
Ran the project locally.
Github Issues
#234