-
Notifications
You must be signed in to change notification settings - Fork 14
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
docs: ETH Account Funding Guide #57
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @sgerodes for your suggestions. I've made a few inline comments and suggestions that could improve your contribution.
To summarize, I would propose:
- Remove the .env file creation description since it is already above in the Local Testing section.
- Remove the opensea example from the Local Testing section, since the user hasn't yet been instructed to fund their ETH account. We can then use your
send-eth
in the place you've included it a simpler script. - Elaborate on the "Fund your account guide" by adding a
getEthAddress
script to the examples and instructing the user to run that in order to determine the ETH address associated with their near account.
Furthermore, this might be a good place to include a try-catch block directly in the project with a more human readable error that the account they are trying to build a transaction for is not funded:
This part here is the core of the error (when trying to get gas estimates for the transaction payload)
However, it might not hurt to put a more generic try-catch around the call to populateTx here
@bh2smith I have changed the docs according to your review |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey this looks much better thanks. There is another PR that will conflict with a few of these changes, but otherwise it looks good. I guess you're not going to introduce the try-catch?
I have encountered several problem when doing the first setup. I have found the documentation not good enough to get started. Fixed the documentation. This FIx will help newcommers to seamlesly start start working with this project.