Faucet API

.gitignore

@@ -0,0 +1,3 @@
+node_modules/
+dist/
+.env

.prettierignore

@@ -0,0 +1,4 @@
+# Ignore artifacts:
+builds
+lib
+node_modules

.prettierrc

@@ -0,0 +1 @@
+{}

README.md

@@ -1,12 +1,22 @@
 ## Service Description
 
 This simple API allows users to be funded with native token of the connected network.
-The secret of an account with funds is passed as environment variable. When a user request funds,
+The secret of an account with funds is passed as environment variable. When a user requests funds,
 a transaction from the balances pallet is made to the user's address.
 
+In order to use the faucet, make a GET request to `/fund?to={your-public-address}`, which will trigger
+the transaction and respond to the user if the funding was successful.
+
+## Rate limiting
+
+An address can only be funded X times every 60 minutes, where it must also wait for Y minutes between
+each funding. Both values can be configured in `config.json` by setting `limitPerHour` and `minWaitTimeMinutes`
+respectively.
+Alternatively, the requests per IP can be configured by `RATE_LIMIT_MAX_REQUESTS` and `RATE_LIMIT_WINDOW_MINUTES`.
+
 ## Error handling
 
-If an error arises during the transfer (like a lack of funds from the sender account), a message
+If an error arises during the transfer (like a lack of funds from the sender's account), a message
 will be sent to the corresponding slack channel specified via environment.
 To avoid sending multiple messages, only one type of error will be sent every period of time,
 here defined as 8 hours.
@@ -16,7 +26,7 @@ here defined as 8 hours.
 ### Mandatory
 
 - `SLACK_WEB_HOOK_TOKEN` - Slack web hook token for error reporting.
-- `SUBSTRATE_SECRET_PHRASE` - Substrate account secret used by the service to fund user's accounts.
+- `SUBSTRATE_SECRET_PHRASE` - Substrate account secret used by the service to fund user's account.
 
 ### Optional
 

config.json

@@ -0,0 +1,11 @@
+{
+  "network": {
+    "name": "foucoco",
+    "wss": "wss://rpc-foucoco.pendulumchain.tech",
+    "addressPrefix": 57,
+    "decimals": 12,
+    "fundAmount": 100,
+    "limitPerHour": 2,
+    "minWaitTimeMinutes": 1
+  }
+}