diff options
| author | MarcoFalke <falke.marco@gmail.com> | 2020-06-06 13:28:47 -0400 |
|---|---|---|
| committer | MarcoFalke <falke.marco@gmail.com> | 2021-01-05 09:27:23 +0100 |
| commit | d0c75abb288afdd295c4aa9d7e747f13d5926327 (patch) | |
| tree | af60c25a7bf8bbaf1cc82d0893148a5093fc9938 | |
| parent | bcb655d7d19de9997c5acb4b25a7bf59f4882851 (diff) | |
doc: Extract net permissions doc
Github-Pull: #19192
Rebased-From: fa2c2b50d895ff3402b82ce3db69bfc43053b519
| -rw-r--r-- | src/init.cpp | 7 | ||||
| -rw-r--r-- | src/net_permissions.cpp | 8 | ||||
| -rw-r--r-- | src/net_permissions.h | 8 |
3 files changed, 17 insertions, 6 deletions
diff --git a/src/init.cpp b/src/init.cpp index f381a53b1b..c716af7b23 100644 --- a/src/init.cpp +++ b/src/init.cpp @@ -49,6 +49,7 @@ #include <ui_interface.h> #include <util/asmap.h> #include <util/moneystr.h> +#include <util/string.h> #include <util/system.h> #include <util/threadnames.h> #include <util/translation.h> @@ -460,11 +461,7 @@ void SetupServerArgs() hidden_args.emplace_back("-upnp"); #endif gArgs.AddArg("-whitebind=<[permissions@]addr>", "Bind to given address and whitelist peers connecting to it. " - "Use [host]:port notation for IPv6. Allowed permissions are bloomfilter (allow requesting BIP37 filtered blocks and transactions), " - "noban (do not ban for misbehavior), " - "forcerelay (relay transactions that are already in the mempool; implies relay), " - "relay (relay even in -blocksonly mode), " - "and mempool (allow requesting BIP35 mempool contents). " + "Use [host]:port notation for IPv6. Allowed permissions: " + Join(NET_PERMISSIONS_DOC, ", ") + ". " "Specify multiple permissions separated by commas (default: noban,mempool,relay). Can be specified multiple times.", ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION); gArgs.AddArg("-whitelist=<[permissions@]IP address or network>", "Whitelist peers connecting from the given IP address (e.g. 1.2.3.4) or " diff --git a/src/net_permissions.cpp b/src/net_permissions.cpp index 22fa5ee73b..d76a512a6c 100644 --- a/src/net_permissions.cpp +++ b/src/net_permissions.cpp @@ -8,6 +8,14 @@ #include <util/system.h> #include <util/translation.h> +const std::vector<std::string> NET_PERMISSIONS_DOC{ + "bloomfilter (allow requesting BIP37 filtered blocks and transactions)", + "noban (do not ban for misbehavior)", + "forcerelay (relay transactions that are already in the mempool; implies relay)", + "relay (relay even in -blocksonly mode)", + "mempool (allow requesting BIP35 mempool contents)", +}; + // The parse the following format "perm1,perm2@xxxxxx" bool TryParsePermissionFlags(const std::string str, NetPermissionFlags& output, size_t& readen, std::string& error) { diff --git a/src/net_permissions.h b/src/net_permissions.h index a1b45c4009..39cec15287 100644 --- a/src/net_permissions.h +++ b/src/net_permissions.h @@ -2,12 +2,16 @@ // Distributed under the MIT software license, see the accompanying // file COPYING or http://www.opensource.org/licenses/mit-license.php. +#include <netaddress.h> + #include <string> #include <vector> -#include <netaddress.h> #ifndef BITCOIN_NET_PERMISSIONS_H #define BITCOIN_NET_PERMISSIONS_H + +extern const std::vector<std::string> NET_PERMISSIONS_DOC; + enum NetPermissionFlags { PF_NONE = 0, @@ -27,6 +31,7 @@ enum NetPermissionFlags PF_ISIMPLICIT = (1U << 31), PF_ALL = PF_BLOOMFILTER | PF_FORCERELAY | PF_RELAY | PF_NOBAN | PF_MEMPOOL, }; + class NetPermissions { public: @@ -45,6 +50,7 @@ public: flags = static_cast<NetPermissionFlags>(flags & ~f); } }; + class NetWhitebindPermissions : public NetPermissions { public: |