chainparams.h

Go to the documentation of this file.

// Copyright (c) 2010 Satoshi Nakamoto
// Copyright (c) 2009-2021 The Bitcoin Core developers
// Distributed under the MIT software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
 
#ifndef BITCOIN_KERNEL_CHAINPARAMS_H
#define BITCOIN_KERNEL_CHAINPARAMS_H
 
#include <consensus/params.h>
#include <netaddress.h>
#include <primitives/block.h>
#include <protocol.h>
#include <uint256.h>
#include <util/chaintype.h>
#include <util/hash_type.h>
#include <util/vector.h>
 
#include <cstdint>
#include <iterator>
#include <map>
#include <memory>
#include <optional>
#include <string>
#include <unordered_map>
#include <utility>
#include <vector>
 
struct SeedSpec6 {
    uint8_t addr[16];
    uint16_t port;
};
 
typedef std::map<int, BlockHash> MapCheckpoints;
 
struct CCheckpointData {
    MapCheckpoints mapCheckpoints;
};
 
struct AssumeutxoHash : public BaseHash<uint256> {
    explicit AssumeutxoHash(const uint256 &hash) : BaseHash(hash) {}
};
 
struct AssumeutxoData {
    int height;
 
    AssumeutxoHash hash_serialized;
 
    uint64_t m_chain_tx_count;
 
    BlockHash blockhash;
};
 
struct ChainTxData {
    int64_t nTime;
    uint64_t tx_count;
    double dTxRate;
};
 
class CChainParams {
public:
    enum Base58Type {
        PUBKEY_ADDRESS,
        SCRIPT_ADDRESS,
        SECRET_KEY,
        EXT_PUBLIC_KEY,
        EXT_SECRET_KEY,
 
        MAX_BASE58_TYPES
    };
 
    const Consensus::Params &GetConsensus() const { return consensus; }
    const CMessageHeader::MessageMagic &DiskMagic() const { return diskMagic; }
    const CMessageHeader::MessageMagic &NetMagic() const { return netMagic; }
    uint16_t GetDefaultPort() const { return nDefaultPort; }
    uint16_t GetDefaultPort(Network net) const {
        return net == NET_I2P ? I2P_SAM31_PORT : GetDefaultPort();
    }
    uint16_t GetDefaultPort(const std::string &addr) const {
        CNetAddr a;
        return a.SetSpecial(addr) ? GetDefaultPort(a.GetNetwork())
                                  : GetDefaultPort();
    }
    std::vector<int> GetAvailableSnapshotHeights() const;
 
    const CBlock &GenesisBlock() const { return genesis; }
    bool DefaultConsistencyChecks() const { return fDefaultConsistencyChecks; }
    bool RequireStandard() const { return fRequireStandard; }
    bool IsTestChain() const { return m_is_test_chain; }
    bool IsMockableChain() const { return m_is_mockable_chain; }
    uint64_t PruneAfterHeight() const { return nPruneAfterHeight; }
    uint64_t AssumedBlockchainSize() const { return m_assumed_blockchain_size; }
    uint64_t AssumedChainStateSize() const {
        return m_assumed_chain_state_size;
    }
    bool MineBlocksOnDemand() const { return consensus.fPowNoRetargeting; }
    std::string GetChainTypeString() const {
        return ChainTypeToString(m_chain_type);
    }
    ChainType GetChainType() const { return m_chain_type; }
    const std::vector<uint8_t> &Base58Prefix(Base58Type type) const {
        return base58Prefixes[type];
    }
    const std::string &CashAddrPrefix() const { return cashaddrPrefix; }
    const std::vector<SeedSpec6> &FixedSeeds() const { return vFixedSeeds; }
    const CCheckpointData &Checkpoints() const { return checkpointData; }
 
    std::optional<AssumeutxoData> AssumeutxoForHeight(int height) const {
        return FindFirst(m_assumeutxo_data,
                         [&](const auto &d) { return d.height == height; });
    }
    std::optional<AssumeutxoData>
    AssumeutxoForBlockhash(const BlockHash &blockhash) const {
        return FindFirst(m_assumeutxo_data, [&](const auto &d) {
            return d.blockhash == blockhash;
        });
    }
 
    const ChainTxData &TxData() const { return chainTxData; }
 
    struct ChainOptions {
        bool ecash{true};
        bool fastprune{false};
    };
 
    static std::unique_ptr<const CChainParams>
    RegTest(const ChainOptions &options);
    static std::unique_ptr<const CChainParams>
    Main(const ChainOptions &options);
    static std::unique_ptr<const CChainParams>
    TestNet(const ChainOptions &options);
 
protected:
    CChainParams() = default;
 
    Consensus::Params consensus;
    CMessageHeader::MessageMagic diskMagic;
    CMessageHeader::MessageMagic netMagic;
    uint16_t nDefaultPort;
    uint64_t nPruneAfterHeight;
    uint64_t m_assumed_blockchain_size;
    uint64_t m_assumed_chain_state_size;
    std::vector<std::string> vSeeds;
    std::vector<uint8_t> base58Prefixes[MAX_BASE58_TYPES];
    std::string cashaddrPrefix;
    ChainType m_chain_type;
    CBlock genesis;
    std::vector<SeedSpec6> vFixedSeeds;
    bool fDefaultConsistencyChecks;
    bool fRequireStandard;
    bool m_is_test_chain;
    bool m_is_mockable_chain;
    CCheckpointData checkpointData;
    std::vector<AssumeutxoData> m_assumeutxo_data;
    ChainTxData chainTxData;
 
    friend std::vector<std::string>
    GetRandomizedDNSSeeds(const CChainParams &params);
};
 
const CCheckpointData &CheckpointData(const ChainType chain);
 
std::optional<ChainType>
GetNetworkForMagic(const CMessageHeader::MessageMagic &pchMessageStart);
 
#endif // BITCOIN_KERNEL_CHAINPARAMS_H