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.

Sign up for GitHub

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 instructions for gnofaucet #1460

Closed
wants to merge 4 commits into from
Closed

docs: add instructions for gnofaucet #1460

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d54991e
docs: add instructions for gnofaucet
iuricmp Dec 18, 2023
5337489
Merge branch 'master' into docs/faucet
iuricmp Dec 19, 2023
156b4b2
Merge branch 'master' into docs/faucet
leohhhn Dec 20, 2023
c0b4bba
Merge branch 'master' into docs/faucet
leohhhn Dec 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/getting-started/setting-up-funds/running-a-faucet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,20 @@ After the chain is up and running locally, you can start the faucet by running t
gnofaucet serve --chain-id dev MyKey
```

:::danger Key MyKey not found
Copy link
Contributor

Choose a reason for hiding this comment

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

Hey @iuricmp, thanks for pointing this out, you were a bit ahead of me on documenting this :)

While I think it is super useful to document common errors, I think doing it this way is a little bit cluttering - this would not be scalable if we keep on adding common errors.

How I would go about documenting this:

  1. accurately define the usages of gnokey and gnofaucet, ie, document the --home argument in both (afaik it's missing in the options list),
  2. mention in this file that gnofaucet relies on the gnokey home dir to look for keys (similar to what you did, just not under ::danger::, but as normal text)
  3. further down the line, have a common errors/issues/faq page for docs, which would be an organized place to dump these things.

Down the line, the plan is to have documentation for tools be auto-exported from the --help option of the tool, allowing for in-sync tool and docs development.

I suggest you do 1. & 2., and we can discuss 3 :)

Thanks!


If you get the above error, it means that `gnofaucet` is not pointing to the same `-home` directory as `gnokey`.

In order for `gnofaucet` to see your keypairs, it needs to read from the same `-home` directory as `gnokey`. You can pass in the home parameter for `gnofaucet` with `-home <path_to_home>`.

```bash
gnofaucet serve --chain-id dev MyKey -home <path_to_gnokey_home>
```

If you don't know where your `gnokey` home directory is, you can run `gnokey --help` to see the path to your home directory.

:::

The command will prompt you to enter the decryption password for the key you've provided.

- **`--chain-id`** - the chain ID of the local running node. The default value is `dev`
Expand Down
Loading