Skip to content
This repository was archived by the owner on Apr 23, 2025. It is now read-only.

update faucet docs #27

Merged
merged 6 commits into from
Oct 7, 2024
Merged

Conversation

pheobeayo
Copy link

Add documentation for Local and Sepolia Faucets

Fixes #24

Types of change

  • Enhancement
  • Documentations with pictures references

Comments (optional)

Copy link
Collaborator

@metalboyrick metalboyrick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @pheobeayo, really appreciate your PR!

However I think you've misunderstood the issue, what i meant is explaining to users that we have a faucet feature that they can use in devnet to fill in their wallet in case they need any gas funds, and the sepolia faucet info that will lead them into the external starknet sepolia faucets.

You can access the faucet on the bottom of the scaffold stark app.

Thank you!

@pheobeayo
Copy link
Author

okay , will make the changes

Copy link
Collaborator

@metalboyrick metalboyrick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left some comments! Don't worry you still have some time to make the changes! All the best!


These three options are available for any user to get Starknet Sepolia Faucets

### [Starknet Foundation](https://starknet-faucet.vercel.app/)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This can be bullet points, no headers here.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pheobeayo not resolved yet

toc_max_heading_level: 5
---

# Faucets (Available)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can just say "Faucets"


Faucets for deployment of smart contracts can be requested from the website.

The button is at the bottom left of the [Demo app] (https://scaffold-stark-demo.vercel.app/debug)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This hyperlink doesn't show what you've intended I think. Can check the syntax again.

image

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pheobeayo This is not resolved yet, you can try editing while running the localhost instance with yarn start. The vscode markdown doesn't necessarily give you the right representation.

![Sepolia Example](/img/Sepolia.jpg)


## Websites available for Starknet Sepolia faucets
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We also need some docs on the Devnet faucet, which looks different from this sepolia window. The devnet one allows user to fill in their own wallet with some tokens

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For this section, we can just say "Starknet Sepolia Faucets"

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pheobeayo I meant the title could just be "Starknet Sepolia Faucets" instead of "Websites available ...."

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

and can remove the sub "Starknet Sepolia Faucets"

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also for the devnet, please indicate the UI path also. as shown by @Nadai2010

![Sepolia Example](/img/Sepolia.jpg)


## Websites available for Starknet Sepolia faucets
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For this section, we can just say "Starknet Sepolia Faucets"

@Nadai2010
Copy link
Collaborator

Nadai2010 commented Oct 6, 2024

Hi @pheobeayo great jobs, thank you, some details

imagen

  • You must indicate in devnet that you can transfer faucet.

Captura desde 2024-10-07 00-29-28

  • Better define a account address and amount as an example and 1 ETH,
curl -d '{"amount":1000000000000000000, "address":"0x064b48806902a367c8598f4f95c305e8c1a1acba5f082d294a43793113115691"}' -H "Content-Type: application/json" -X POST http://localhost:5050/mint

@metalboyrick
Copy link
Collaborator

Hey @pheobeayo, some of the changes are still not addressed, feel free to ping us should you have any questions!

@pheobeayo
Copy link
Author

@Nadai2010, the picture was added for the Devnet local faucets. Where can I get that, please?

@metalboyrick The link in the Demo app which isn't not giving the right link is actually giving the right link with me wherever I click on it, Please what could be wrong?

@Nadai2010
Copy link
Collaborator

Hi @pheobeayo, I think you can use image hat I shared , if you want to access the faucet on devnet, you should follow the Scaffold Stark repository and follow the steps to lift the UI

@metalboyrick
Copy link
Collaborator

@pheobeayo the devnet can only be accessed if you make a local copy of the repo. you cannot use the demo link for that

@pheobeayo
Copy link
Author

Yes, I understand, I did my research too, Kindly review the changes I made on the PR @metalboyrick

@metalboyrick metalboyrick self-requested a review October 7, 2024 14:49
Copy link
Collaborator

@metalboyrick metalboyrick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thanks for the hard work!

@metalboyrick metalboyrick merged commit 481872a into Scaffold-Stark:main Oct 7, 2024
1 check passed
@pheobeayo
Copy link
Author

Thank you for the support all along, it was great contributing to this! @metalboyrick @Nadai2010

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

Successfully merging this pull request may close these issues.

Add documentation for Local and Sepolia Faucets
3 participants