Differential D4120 Diff 13121 contrib/devtools/chainparams/generate_chainparams_constants.py

Changeset View

Standalone View

contrib/devtools/chainparams/generate_chainparams_constants.py

This file was added.

Property	Old Value	New Value
File Mode	null	100755

				#!/usr/bin/env python3
				# Copyright (c) 2019 The Bitcoin developers
				# Distributed under the MIT software license, see the accompanying
				# file COPYING or http://www.opensource.org/licenses/mit-license.php.
				'''
				Script to generate list of chainparams constants (ie. assumevalid and
				minimum chainwork).

				This script expects a text file for each chain in the directory that is passed
				as an argument:

				chainparams_main.txt
				chainparams_test.txt

				These files must consist of lines in the format

				<assumevalid hash>
				<minimum chainwork>

				The outputted constants should be pasted into `src/chainparamsconstants.h`.
				'''

				import sys
				import os


				def process_constants(indir, file_name):
				with open(os.path.join(indir, file_name), 'r', encoding="utf8") as f:
				constants = f.readlines()
				return [line.rstrip() for line in constants]
				FabienUnsubmitted Not Done Inline Actions Assert that there are exactly 2 lines before returning, otherwise the output can silently corrupt. Fabien: Assert that there are exactly 2 lines before returning, otherwise the output can silently…


				def main():
				if len(sys.argv) != 2:
				print('Usage: {} <dir_with_chainparams_txt>'.format(sys.argv[0]), file=sys.stderr)
				sys.exit(1)

				indir = sys.argv[1]

				print('''\
				#ifndef BITCOIN_CHAINPARAMSCONSTANTS_H
				FabienUnsubmitted Not Done Inline Actions Should we add a copyright header to generated files ? Fabien: Should we add a copyright header to generated files ?
				jasonbcoxAuthorUnsubmitted Done Inline Actions Considering that chainparamsseeds.h doesn't have one, it probably doesn't matter much. jasonbcox: Considering that chainparamsseeds.h doesn't have one, it probably doesn't matter much.
				#define BITCOIN_CHAINPARAMSCONSTANTS_H
				/**
				* Chain params constants for each tracked chain.
				* @{} by contrib/devtools/chainparams/generate_chainparams_constants.py
				*/

				#include <uint256.h>

				namespace ChainParamsConstants {{
				const uint256 MAINNET_DEFAULT_ASSUME_VALID = uint256S("{}");
				const uint256 MAINNET_MINIMUM_CHAIN_WORK = uint256S("{}");

				const uint256 TESTNET_DEFAULT_ASSUME_VALID = uint256S("{}");
				const uint256 TESTNET_MINIMUM_CHAIN_WORK = uint256S("{}");
				}} // namespace ChainParamsConstants

				#endif // BITCOIN_CHAINPARAMSCONSTANTS_H\
				'''.format(
				# 'generated' is split out so this file is not identified as generated.
				"generated",
				*process_constants(indir, 'chainparams_main.txt'),
				*process_constants(indir, 'chainparams_test.txt'))
				)


				if __name__ == '__main__':
				main()