Skip to content
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: add gnolang/faucet #2122

Open
wants to merge 13 commits into
base: master
Choose a base branch
from
Open

Conversation

leohhhn
Copy link
Contributor

@leohhhn leohhhn commented May 16, 2024

Description

Closes: #2120

This PR introduces the following changes to the docs (text copied over from the issue linked above):

  • Adding a gnolang/faucet reference page in the Gno Tooling section,
  • Adding a tutorial in the new Gno Infra section for setting up and running a faucet.

Matching docs PR (linked in the issue that this PR was created from)

Contributors' checklist...
  • Added new tests, or not needed, or not feasible
  • Provided an example (e.g. screenshot) to aid review or the PR is self-explanatory
  • Updated the official documentation or not needed
  • No breaking changes were made, or a BREAKING CHANGE: xxx message was included in the description
  • Added references to related issues and PRs
  • Provided any useful hints for running manual tests
  • Added new benchmarks to generated graphs, if any. More info here.

@leohhhn leohhhn self-assigned this May 16, 2024
@leohhhn
Copy link
Contributor Author

leohhhn commented May 16, 2024

Posted some questions here to clarify things not found in the reference docs

@leohhhn
Copy link
Contributor Author

leohhhn commented May 16, 2024

Crossposting from the issue for visibility:

  • What kind of security against DDoS do we have implemented in the faucet?
  • What are the request types the faucet can take?
  • How do you actually send batch requests to the faucet?

What is the difference between these flags?

-config string                  the path to the command configuration file [TOML]
-faucet-config string           the path to the faucet TOML configuration, if any

@leohhhn leohhhn marked this pull request as ready for review May 16, 2024 10:36
@leohhhn leohhhn requested a review from moul as a code owner May 16, 2024 10:36
@zivkovicmilos zivkovicmilos self-requested a review May 16, 2024 11:31
Copy link
Member

@zivkovicmilos zivkovicmilos left a comment

Choose a reason for hiding this comment

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

Please link to the accompanying docs.gno.land PR in the description, and add adequate labels 🙏

Also, please update the PR description to have a bit more details

@leohhhn leohhhn added the 📖 documentation Improvements or additions to documentation label May 17, 2024
- `gnoland` & `gnokey` installed
- A Gno.land keypair generated using [`gnokey`](../gno-tooling/cli/gnokey.md)

## Premining funds to an address
Copy link
Member

Choose a reason for hiding this comment

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

We should drop this section completely, and not reference genesis_balances.txt anywhere -- we have adequate genesis balances commands for premining accounts


## Premining funds to an address

Before setting up the faucet, we need to make sure that the address will be used
Copy link
Member

Choose a reason for hiding this comment

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

This is not a correct English sentence:

we need to make sure that the address will be used to serve the funds contain enough testnet funds


```json
{
"To": "g1juz2yxmdsa6audkp6ep9vfv80c8p5u76e03vvh"
Copy link
Member

Choose a reason for hiding this comment

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

This is outdated, please reference the latest gnolang/faucet request structure

}
```

You can test this out buy running the following `curl` command:
Copy link
Member

Choose a reason for hiding this comment

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

Typo here, buy

in the `--remote` flag in the faucet. If your node is listening on a separate
address, make sure to match it accordingly when running the faucet.

## Making faucet requests
Copy link
Member

Choose a reason for hiding this comment

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

Error handling was not covered in this section, please cover it 🙏

@@ -0,0 +1,46 @@
---
id: gno-tooling-tm2-faucet
Copy link
Member

Choose a reason for hiding this comment

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

I'm not sure what the use of this file is, it can become outdated very quickly (help output)

@@ -0,0 +1,173 @@
---
id: setting-up-a-faucet
Copy link
Member

Choose a reason for hiding this comment

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

This tutorial doesn't cover:

  • gnofaucet
  • gnofaucet vs gnolang/faucet
  • different things I've noted as part of the comments

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📖 documentation Improvements or additions to documentation
Projects
Status: In Progress
Development

Successfully merging this pull request may close these issues.

[docs] Add gnolang/faucet
2 participants