Gno Faucet Hub

The Gno Faucet Hub serves as a collective access point where developers can obtain testnet coins to test and develop applications on a variety of Gno testnets.

The Gno Faucet Hub deployment can be found here.

Development

This project uses vite-plugin-mkcert to enable HTTPS in local development, which requires installing the mkcert software on your operating system. Please refer to the mkcert documentation for installation instructions.

• macOS : brew install mkcert nss
• Linux : sudo apt install libnss3-tools + mkcert binary
• Windows : choco install mkcert or scoop install mkcert

TODO:

A secure cookie is set by the faucet when requesting a GitHub connection. In local development, this requires the server to send a cookie as secure but without proper security settings such as gh-username=USERNAME; Max-Age=3600; HttpOnly; Secure; SameSite=None. This is not secure for a production environment, so we might consider configuring a dedicated server-side API for development in a secure way.

Adding your faucet to the Hub

Running a faucet

The Faucet Hub works with TM2 Faucets, or faucets using TM2 Faucets as a base. To set up a TM2 Faucet, check out the setup guide in the TM2 Faucet repo.

Setting up reCaptcha

To prevent spam and abuse of the faucets, and subsequently the Hub itself, it is strongly advised for each faucet on the Hub to come with a reCaptcha v2 set up.

To set up a reCaptcha for your faucet, check out the reCaptcha Developer guide. Once you have completed setting it up, you should also enable the Faucet Hub domain (https://faucet.gno.land) in the reCaptcha dashboard. With this you will be able to use the site key to add your faucet in the Hub configuration.

Adding your faucet to the Hub

After setting up your faucet and obtaining a reCaptcha keypair, adding your faucet to the Hub is as simple as providing a PR with a JSON config to this repo.

To add your faucet to the Hub, you need to provide your faucet configuration information in src/data/faucets.json. This includes the name of the network the faucet is serving on, the network chain ID, drip options for the faucet (in GNOT), the faucet URL, and the recaptcha site key.

{
    "name": "Portal Loop",
    "chain_id": "portal-loop",
    "amounts": [1, 5, 10],
    "url": "https://faucet-api.gno.land",
    "description": "A nightly staging testnet used for experimenting with the latest versions of Gno, gno.land, and TM2.",
    "recaptcha": "6Ldp0pgpAAAAANZxTw4oy4XkOKhhkmpDl8Yoq6uw"
}

You can find an example PR here.