Skip to content

Announcement: deprecating faucet v1 API #21775

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

Open
stefan-mysten opened this issue Apr 9, 2025 · 1 comment
Open

Announcement: deprecating faucet v1 API #21775

stefan-mysten opened this issue Apr 9, 2025 · 1 comment
Assignees

Comments

@stefan-mysten
Copy link
Contributor

stefan-mysten commented Apr 9, 2025

The Faucet v1 API will be deprecated April 18, and replaced with Faucet v2 API.

  • If you used /v1/gas → use v2/gas — note that the server response has changed
  • If you used /gas → use v2/gas — note that the server response has changed
  • If you used /v1/status → nothing to replace it. The /v2/gas will give you directly a success/failure response.

The new server response is:
Success

{
 "status":"Success",
 "coin_sent": {
   "amount":5500000000,
   "id":"0xac8b8afbc9074465bf799d0f590e17176b7a05514b9434b338e38f49be14d574",
   "transferTxDigest":"DSHGocWx57BtYDE5Xv4AefeRBBMizPb3LTqRMegx14Ym"
  }
}

Failure

{
 "status":{
   "Failure": {
     "ErrorType": "message"
	 }
 },
 "coin_sent": null
}

where ErrorType is Internal | InvalidUserAgent | TooManyRequests | MissingTurnstileTokenHeader

The response status codes are:
Success --> 200 OK
Internal --> 500 error code
InvalidUserAgent | MissingTurnstileTokenHeader --> 400 error code
TooManyRequest --> 429 error code

@stefan-mysten stefan-mysten self-assigned this Apr 9, 2025
Copy link
Contributor

github-actions bot commented Apr 9, 2025

Thank you for opening this issue, a team member will review it shortly. Until then, please do not interact with any users that claim to be from Sui support and do not click on any links!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant