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(cli): add faucet to newdocs #1879

Merged
merged 5 commits into from
Nov 13, 2023
Merged

docs(cli): add faucet to newdocs #1879

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1a50bbe
docs(cli): add faucet to newdocs
qbzzt Nov 8, 2023
9ef3a07
commented out (because it's not yet available)
qbzzt Nov 10, 2023
f169646
Merge branch 'main' into 231107-faucet
qbzzt Nov 10, 2023
cc6a925
Update next-docs/pages/cli/faucet.mdx
alvrs Nov 13, 2023
f703f48
prettier
alvrs Nov 13, 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
26 changes: 26 additions & 0 deletions next-docs/pages/cli/faucet.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,27 @@
# mud faucet

Ask a [faucet service](/services/faucet) for test ETH.

## Sample use

```sh copy
ADDR=0x863DEAFF47BF8bF8cb4B9AB0F49360aD7046713b
cast to-unit `cast balance --rpc-url https://follower.testnet-chain.linfra.xyz $ADDR` eth
pnpm mud faucet --address $ADDR
sleep 10
cast to-unit `cast balance --rpc-url https://follower.testnet-chain.linfra.xyz $ADDR` eth
```

Note that we have the `sleep 10` because the faucet's transaction transferring the ETH does not happen immediately.]

## Options

These are the command line options you can specify on `mud faucet`:

| Option | Meaning | Type | Default value |
| ------------- | ------------------------------------ | ------- | --------------------------------------------------------------------------------------- |
| `--version` | Show version number | boolean | false |
| `--dripDev` | Request a drip from the dev endpoint | boolean | true |
| `--faucetUrl` | URL of the MUD faucet | string | The faucet for the Lattice test network, https://faucet.testnet-mud-services.linfra.xyz |
| `--address` | The address to fund | string | Empty |
| `--help` | Show help | boolean | false |
Loading