-
Notifications
You must be signed in to change notification settings - Fork 3.7k
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
[Faucet] Add integrator's guide #7293
Conversation
95fefcd
to
52d3edb
Compare
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
|
||
## Integrating with the faucet | ||
|
||
This explains how to integrate with the [Aptos Faucet](https://github.com/aptos-labs/aptos-core/tree/main/crates/aptos-faucet). This is targeted at SDK and wallet creators; if you are a developer using either of these tools, access the faucet through the SDK / wallet instead. |
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.
I find this reference confusing and am not sure yet how to fix it?
"This is targeted at SDK and wallet creators; if you are a developer using either of these tools, access the faucet through the SDK / wallet instead."
We are saying these instructions are for SDK and wallet folks and then if you are using those tools to do something else instead?
What is the instead for? Sorry if I am being dense.
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.
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.
No worries, I agree it is a bit confusing. So this guide is intended for people building developer libraries / tools (SDKs / wallets). For example, in the TS SDK we provide functions to let people call the faucet. In this case, the target audience is SDK devs, like us or whoever out there is making SDKs in other languages. For wallets, they usually want to provide a "use faucet" button, so they need to know how to use the faucet (though in that case, they might just use an SDK). So in this case the relevant people are the wallet creators. So the target audience is SDK / wallet devs. Notably this means this guide is not relevant for dapp devs, because they should just invoke the faucet via the wallet / SDK.
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.
Feel free to make whatever changes you think make this clearer and I can take a look!
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.
Please let's address this before landing. @clay-aptos , @saharct
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.
@banool I rewrote that portion. Please review it and let me know if any changes are needed. Thanks!
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.
Looks great, thanks a lot!
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, Daniel. This LGTM with some small changes I made directly and one question I have as a comment. I am adding David and Greg as I recall David wanting Eng review on docs changes. Thanks again!
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
❌ Forge suite
|
✅ Forge suite
|
✅ Forge suite
|
Description
This PR adds a section to the integrator's guide explaining how to integrate with the faucet as a wallet / SDK dev.
Test Plan
Docs.