doc: Remove explicit network name references

This commit is contained in:
Fabian Jahr 2019-10-28 18:33:40 +01:00
parent d6e493f0c2
commit 3ed8e3d079
7 changed files with 10 additions and 8 deletions

View File

@ -50,7 +50,7 @@ Given a height: returns hash of block in best-block-chain at height provided.
Returns various state info regarding block chain processing. Returns various state info regarding block chain processing.
Only supports JSON as output format. Only supports JSON as output format.
* chain : (string) current network name as defined in BIP70 (main, test, regtest) * chain : (string) current network name (main, test, regtest)
* blocks : (numeric) the current number of blocks processed in the server * blocks : (numeric) the current number of blocks processed in the server
* headers : (numeric) the current number of headers we have validated * headers : (numeric) the current number of headers we have validated
* bestblockhash : (string) the hash of the currently best block * bestblockhash : (string) the hash of the currently best block

View File

@ -75,7 +75,7 @@ public:
uint64_t AssumedChainStateSize() const { return m_assumed_chain_state_size; } uint64_t AssumedChainStateSize() const { return m_assumed_chain_state_size; }
/** Whether it is possible to mine blocks on demand (no retargeting) */ /** Whether it is possible to mine blocks on demand (no retargeting) */
bool MineBlocksOnDemand() const { return consensus.fPowNoRetargeting; } bool MineBlocksOnDemand() const { return consensus.fPowNoRetargeting; }
/** Return the BIP70 network string (main, test or regtest) */ /** Return the network string */
std::string NetworkIDString() const { return strNetworkID; } std::string NetworkIDString() const { return strNetworkID; }
/** Return the list of hostnames to look up for DNS seeds */ /** Return the list of hostnames to look up for DNS seeds */
const std::vector<std::string>& DNSSeeds() const { return vSeeds; } const std::vector<std::string>& DNSSeeds() const { return vSeeds; }
@ -120,7 +120,7 @@ std::unique_ptr<const CChainParams> CreateChainParams(const std::string& chain);
const CChainParams &Params(); const CChainParams &Params();
/** /**
* Sets the params returned by Params() to those for the given BIP70 chain name. * Sets the params returned by Params() to those for the given chain name.
* @throws std::runtime_error when the chain is not supported. * @throws std::runtime_error when the chain is not supported.
*/ */
void SelectParams(const std::string& chain); void SelectParams(const std::string& chain);

View File

@ -15,10 +15,12 @@
class CBaseChainParams class CBaseChainParams
{ {
public: public:
/** BIP70 chain name strings (main, test or regtest) */ ///@{
/** Chain name strings */
static const std::string MAIN; static const std::string MAIN;
static const std::string TESTNET; static const std::string TESTNET;
static const std::string REGTEST; static const std::string REGTEST;
///@}
const std::string& DataDir() const { return strDataDir; } const std::string& DataDir() const { return strDataDir; }
int RPCPort() const { return nRPCPort; } int RPCPort() const { return nRPCPort; }

View File

@ -13,7 +13,7 @@
class NetworkStyle class NetworkStyle
{ {
public: public:
/** Get style associated with provided BIP70 network id, or 0 if not known */ /** Get style associated with provided network id, or 0 if not known */
static const NetworkStyle* instantiate(const std::string& networkId); static const NetworkStyle* instantiate(const std::string& networkId);
const QString &getAppName() const { return appName; } const QString &getAppName() const { return appName; }

View File

@ -1192,7 +1192,7 @@ UniValue getblockchaininfo(const JSONRPCRequest& request)
{}, {},
RPCResult{ RPCResult{
"{\n" "{\n"
" \"chain\": \"xxxx\", (string) current network name as defined in BIP70 (main, test, regtest)\n" " \"chain\": \"xxxx\", (string) current network name (main, test, regtest)\n"
" \"blocks\": xxxxxx, (numeric) the height of the most-work fully-validated chain. The genesis block has height 0\n" " \"blocks\": xxxxxx, (numeric) the height of the most-work fully-validated chain. The genesis block has height 0\n"
" \"headers\": xxxxxx, (numeric) the current number of headers we have validated\n" " \"headers\": xxxxxx, (numeric) the current number of headers we have validated\n"
" \"bestblockhash\": \"...\", (string) the hash of the currently best block\n" " \"bestblockhash\": \"...\", (string) the hash of the currently best block\n"

View File

@ -189,7 +189,7 @@ static UniValue getmininginfo(const JSONRPCRequest& request)
" \"difficulty\": xxx.xxxxx (numeric) The current difficulty\n" " \"difficulty\": xxx.xxxxx (numeric) The current difficulty\n"
" \"networkhashps\": nnn, (numeric) The network hashes per second\n" " \"networkhashps\": nnn, (numeric) The network hashes per second\n"
" \"pooledtx\": n (numeric) The size of the mempool\n" " \"pooledtx\": n (numeric) The size of the mempool\n"
" \"chain\": \"xxxx\", (string) current network name as defined in BIP70 (main, test, regtest)\n" " \"chain\": \"xxxx\", (string) current network name (main, test, regtest)\n"
" \"warnings\": \"...\" (string) any network and blockchain warnings\n" " \"warnings\": \"...\" (string) any network and blockchain warnings\n"
"}\n" "}\n"
}, },

View File

@ -265,7 +265,7 @@ public:
void ForceSetArg(const std::string& strArg, const std::string& strValue); void ForceSetArg(const std::string& strArg, const std::string& strValue);
/** /**
* Looks for -regtest, -testnet and returns the appropriate BIP70 chain name. * Returns the appropriate chain name from the program arguments.
* @return CBaseChainParams::MAIN by default; raises runtime error if an invalid combination is given. * @return CBaseChainParams::MAIN by default; raises runtime error if an invalid combination is given.
*/ */
std::string GetChainName() const; std::string GetChainName() const;