There are two different layers in this project. The Node Express backend and the Vue.js frontend.

• Yarn (https://classic.yarnpkg.com/en/docs/install/#mac-stable)
• Node v15.x
• Google reCaptcha keys for reCaptcha v2 with "I'm not a robot" Checkbox. Make sure to have 'localhost' listed in the domains. (https://www.google.com/recaptcha/intro/v3.html)

1. Clone the repository git clone https://github.com/ava-labs/avalanche-faucet.git
2. Go to the root directory cd avalanche-faucet
3. Install javascript dependencies with yarn install.
4. Create a .env file by copying .env.example
5. Install AvalancheGo, our Avalanche node client written in Golang to spin up a network (https://github.com/ava-labs/avalanchego).

Variables beginning with VUE_APP_ will get injected into the vue application.

Refer to .env.example

• AVA_IP The ip address of the AvalancheGo jrpc node.
• AVA_PORT The port of the AvalancheGo jrpc node.
• AVA_PROTOCOL Either http or https
• AVA_NETWORK_ID What is the network id of the Avalanche network you are connecting to.
• AVA_CHAIN_ID The blockchain id of the Avalanche Network you are connecting to.
• CAPTCHA_SECRET Your captcha secret from Google reCaptcha
• VUE_APP_CAPTCHA_SITE_KEY Your public site captcha key from Google reCaptcha
• ASSET_ID The asset id of the asset the faucet will give. If not set, will default to AVAX asset id.
• PRIVATE_KEY_X A private key for the X chain with funds in it. You can use the default for AVAX tokens.
• PRIVATE_KEY_C A private key for the C chain with funds in it. Only needed for the transactions on the C chain.
• DROP_SIZE_X How much nanoAvax is given from this faucet. Used by the X chain.
• DROP_SIZE_C How much wei is given from this faucet. Used by the C chain.

In order for the faucet to work, it needs the Avalanche network to operate on.

1. Make sure you have installed and able to run an Avalanche node properly.
2. All environment variables are correct and your private key has funds in it.
3. Run the project with hot reloading yarn serve

When you go to the website on your browser, you might get a warning saying 'Site is not secure'. This is because we are signing our own SSL Certificates. Please ignore and continue to the website.

This backend is used to verify captchas and make a request to the Avalanche Network to issue tokens. The backend files are stored in the server directory. The node is automatically started with the yarn serve command but can be individually started with node server/index.js

1. Setup environment variables for production
2. Compile and minify to have a production ready application with yarn build.
3. Run the node backend by running node server/index.js.

Requests can use API Keys to request AVAX programmatically. This feature requires a MYSQL database connection. Connection parameters must be set using .env. Refer to .env.example for an example.

You can generate API Keys to request tokens programmatically.

• LABEL is any string to label the key.
• AMOUNT is the daily nAVAX request limit.

Run yarn generate_api_key -- "<LABEL>" <AMOUNT>

You can send a POST request to /api/token_custom in the following JSON body:

{
    "key": "7EKM11P-ATZ4VVN-KZ3JE2R-ZW78STC",
    "amount": 1000000000,
    "to": "0x5f658a6d1928c39b286b48192fea8d46d87ad077"
}

• key API Key to make the request with.
• amount How much nAVAX is requested.
• to Receiving address.

We suggest using Google Chrome to view the AVAX Faucet website.

Firefox does not allow https requests to localhost. But the AVAX Faucet uses https by default, so we will need to change this to http. Make this switch by editing the vue.config.json file in the root directory and change

devServer: {
    https: true
},

to

devServer: {
    https: false
},

and run yarn serve to reflect the change.

You can pass in the fields below to the faucet URL.

1. address for example faucet.ava.network/?address=X-M2fCANtVE6dedYgbW5k6jVVQYf2jiCo7v. Will populate the address field from the query.

Most browsers disable access to cameras if the website is not served over https. For this reason the QR reader at the address input field may fail to find any cameras if served over http.