diff --git a/Error-Codes.md b/Error-Codes.md index c00e9ca..4330c2b 100644 --- a/Error-Codes.md +++ b/Error-Codes.md @@ -2,16 +2,28 @@ Proposal for consistent error codes across the entire lbrynet API. Code | Name ---:|--- -**1xx** | **Daemon `start` Failures (non-recoverable)** -100 | Daemon does not start. (A philosophical error code, never actually presented.) -10x | 101-109 TBD; covers various OS / runtime errors that prevent `lbrynet` from bootstrapping itself. -110 | Cannot write configuration file. (When writing the default config fails on startup, such as due to permission issues.) -111 | Cannot find provided configuration file. (Can't open the config file user provided via command line args.) -112 | Failed to parse the configuration file. (Includes the syntax error / line number to help user fix it.) -120 | Out of disk space. -130 | Command does not exist. -131 | Command is deprecated. -132 | Invalid arguments for command. +**1xx** | **Daemon `start` other CLI command Failures (non-recoverable)** +**10x** | Meta error codes not presented by `lbrynet` itself but from apps trying to interact with `lbrynet`. +100 | Cannot find the `lbrynet` command. +101 | Permission denied trying to execute `lbrynet` command. +102 | Executing `lbrynet` command does not produce any result. +103 | Executing `lbrynet` produces a result that is not normal (eg. a segfault). +**11x** | Enough of `lbrynet` was able to start to determine external factors causing eventual startup failure. +110 | Out of disk space. +111 | Out of RAM. +**12x** | 120-129 Internal factors preventing `lbrynet` from bootstrapping itself. +120 | Incompatible version of Python. +121 | Incompatible version of some library. +**13x** | 130-139 configuration errors +130 | Cannot write configuration file. (When writing the default config fails on startup, such as due to permission issues.) +131 | Cannot find provided configuration file. (Can't open the config file user provided via command line args.) +132 | Failed to parse the configuration file. (Includes the syntax error / line number to help user fix it.) +133 | Configuration file is missing setting that has no default / fallback. +134 | Configuration file has setting set to an invalid value. +**14x** | 140-149 executing commands +140 | Command does not exist. +141 | Command is deprecated. +142 | Invalid arguments for command. **2xx** | **Networking** 201 | Not internet connection. 202 | Router does not support UPnP.