Core Configuration

INX-Faucet uses a JSON standard format as a config file. If you are unsure about JSON syntax, you can find more information in the official JSON specs.

You can change the path of the config file by using the -c or --config argument while executing inx-faucet executable.

For example:

inx-faucet -c config_defaults.json

You can always get the most up-to-date description of the config parameters by running:

inx-faucet -h --full

1. Application

Name	Description	Type	Default value
checkForUpdates	Whether to check for updates of the application or not	boolean	true
shutdown	Configuration for shutdown	object

Shutdown

Name	Description	Type	Default value
stopGracePeriod	The maximum time to wait for background processes to finish during shutdown before terminating the app	string	"5m"
log	Configuration for log	object

Log

Name	Description	Type	Default value
enabled	Whether to store self-shutdown events to a log file	boolean	true
filePath	The file path to the self-shutdown log	string	"shutdown.log"

Example:

{
  "app": {
    "checkForUpdates": true,
    "shutdown": {
      "stopGracePeriod": "5m",
      "log": {
        "enabled": true,
        "filePath": "shutdown.log"
      }
    }
  }
}

2. Logger

Name	Description	Type	Default value
level	The minimum enabled logging level	string	"info"
disableCaller	Stops annotating logs with the calling function's file name and line number	boolean	true
disableStacktrace	Disables automatic stacktrace capturing	boolean	false
stacktraceLevel	The level stacktraces are captured and above	string	"panic"
encoding	The logger's encoding (options: "json", "console")	string	"console"
outputPaths	A list of URLs, file paths or stdout/stderr to write logging output to	array	stdout
disableEvents	Prevents log messages from being raced as events	boolean	true

Example:

{
  "logger": {
    "level": "info",
    "disableCaller": true,
    "disableStacktrace": false,
    "stacktraceLevel": "panic",
    "encoding": "console",
    "outputPaths": ["stdout"],
    "disableEvents": true
  }
}

3. INX

Name	Description	Type	Default value
address	The INX address to which to connect to	string	"localhost:9029"
maxConnectionAttempts	The amount of times the connection to INX will be attempted before it fails (1 attempt per second)	uint	30
targetNetworkName	The network name on which the node should operate on (optional)	string	""

Example:

{
  "inx": {
    "address": "localhost:9029",
    "maxConnectionAttempts": 30,
    "targetNetworkName": ""
  }
}

4. Faucet

Name	Description	Type	Default value
amount	The amount of funds the requester receives	uint	1000000000
smallAmount	The amount of funds the requester receives if the target address has more funds than the faucet amount and less than maximum	uint	100000000
maxAddressBalance	The maximum allowed amount of funds on the target address	uint	2000000000
maxOutputCount	The maximum output count per faucet message	int	128
tagMessage	The faucet transaction tag payload	string	"HORNET FAUCET"
batchTimeout	The maximum duration for collecting faucet batches	string	"2s"
bindAddress	The bind address on which the faucet website can be accessed from	string	"localhost:8091"
rateLimit	Configuration for rateLimit	object
debugRequestLoggerEnabled	Whether the debug logging for requests should be enabled	boolean	false

RateLimit

Name	Description	Type	Default value
enabled	Whether the rate limiting should be enabled	boolean	true
period	The period for rate limiting	string	"5m"
maxRequests	The maximum number of requests per period	int	10
maxBurst	Additional requests allowed in the burst period	int	20

Example:

{
  "faucet": {
    "amount": 1000000000,
    "smallAmount": 100000000,
    "maxAddressBalance": 2000000000,
    "maxOutputCount": 128,
    "tagMessage": "HORNET FAUCET",
    "batchTimeout": "2s",
    "bindAddress": "localhost:8091",
    "rateLimit": {
      "enabled": true,
      "period": "5m",
      "maxRequests": 10,
      "maxBurst": 20
    },
    "debugRequestLoggerEnabled": false
  }
}

5. Profiling

Name	Description	Type	Default value
enabled	Whether the profiling plugin is enabled	boolean	false
bindAddress	The bind address on which the profiler listens on	string	"localhost:6060"

Example:

{
  "profiling": {
    "enabled": false,
    "bindAddress": "localhost:6060"
  }
}