Allows to override deploy parameters

Author: eternauta1337

index.js

@@ -54,6 +54,7 @@ const constants = {
 	AST_FOLDER: 'ast',
 
 	CONFIG_FILENAME: 'config.json',
+	PARAMS_FILENAME: 'params.json',
 	SYNTHS_FILENAME: 'synths.json',
 	STAKING_REWARDS_FILENAME: 'rewards.json',
 	OWNER_ACTIONS_FILENAME: 'owner-actions.json',

publish/deployed/kovan/params.json

@@ -0,0 +1 @@
+[]

publish/deployed/local-ovm/params.json

@@ -0,0 +1 @@
+[]

publish/deployed/local/params.json

@@ -0,0 +1 @@
+[]

publish/deployed/mainnet/params.json

@@ -0,0 +1 @@
+[]

publish/deployed/rinkeby/params.json

@@ -0,0 +1 @@
+[]

publish/deployed/ropsten/params.json

@@ -0,0 +1 @@
+[]

publish/src/commands/deploy.js

@@ -30,21 +30,7 @@ const {
 		ZERO_ADDRESS,
 		inflationStartTimestampInSecs,
 	},
-	defaults: {
-		WAITING_PERIOD_SECS,
-		PRICE_DEVIATION_THRESHOLD_FACTOR,
-		TRADING_REWARDS_ENABLED,
-		ISSUANCE_RATIO,
-		FEE_PERIOD_DURATION,
-		TARGET_THRESHOLD,
-		LIQUIDATION_DELAY,
-		LIQUIDATION_RATIO,
-		LIQUIDATION_PENALTY,
-		RATE_STALE_PERIOD,
-		EXCHANGE_FEE_RATES,
-		MINIMUM_STAKE_TIME,
-		AGGREGATOR_WARNING_FLAGS,
-	},
+	defaults,
 } = require('../../../.');
 
 const DEFAULTS = {
@@ -76,6 +62,7 @@ const deploy = async ({
 
 	const {
 		config,
+		params,
 		configFile,
 		synths,
 		deployment,
@@ -90,6 +77,43 @@ const deploy = async ({
 
 	const standaloneFeeds = Object.values(feeds).filter(({ standalone }) => standalone);
 
+	const getDeployParameter = async name => {
+		const defaultParam = defaults[name];
+		let effectiveValue = defaultParam;
+
+		if (params) {
+			const param = params.find(p => p.name == name);
+
+			if (param) {
+				if (!yes) {
+					try {
+						await confirmAction(
+							yellow(
+								`⚠⚠⚠ WARNING: Found an entry for ${param.name} in params.json. Specified value is ${param.value} and default is ${defaultParam}.` +
+									'\nDo you want to use the specified value (default otherwise)? (y/n) '
+							)
+						);
+
+						effectiveValue = param.value;
+					} catch (err) {}
+				} else {
+					// yes = true
+					effectiveValue = param.value;
+				}
+			}
+		}
+
+		if (effectiveValue !== defaultParam) {
+			console.log(
+				yellow(
+					`PARAMETER OVERRIDE: Overriding default ${name} with ${effectiveValue}, specified in params.json.`
+				)
+			);
+		}
+
+		return effectiveValue;
+	};
+
 	console.log(
 		gray('Checking all contracts not flagged for deployment have addresses in this network...')
 	);
@@ -1296,12 +1320,13 @@ const deploy = async ({
 			synths.map(({ name }) => systemSettings.methods.exchangeFeeRate(toBytes32(name)).call())
 		);
 
+		const exchangeFeeRates = await getDeployParameter('EXCHANGE_FEE_RATES');
 		const synthsRatesToUpdate = synths
 			.map((synth, i) =>
 				Object.assign(
 					{
 						currentRate: w3utils.fromWei(synthRates[i] || '0'),
-						targetRate: EXCHANGE_FEE_RATES[synth.category],
+						targetRate: exchangeFeeRates[synth.category],
 					},
 					synth
 				)
@@ -1342,7 +1367,7 @@ const deploy = async ({
 			read: 'waitingPeriodSecs',
 			expected: input => input !== '0',
 			write: 'setWaitingPeriodSecs',
-			writeArg: WAITING_PERIOD_SECS,
+			writeArg: await getDeployParameter('WAITING_PERIOD_SECS'),
 		});
 
 		await runStep({
@@ -1351,16 +1376,17 @@ const deploy = async ({
 			read: 'priceDeviationThresholdFactor',
 			expected: input => input !== '0', // only change if non-zero
 			write: 'setPriceDeviationThresholdFactor',
-			writeArg: PRICE_DEVIATION_THRESHOLD_FACTOR,
+			writeArg: await getDeployParameter('PRICE_DEVIATION_THRESHOLD_FACTOR'),
 		});
 
+		const tradingRewardsEnabled = await getDeployParameter('TRADING_REWARDS_ENABLED');
 		await runStep({
 			contract: 'SystemSettings',
 			target: systemSettings,
 			read: 'tradingRewardsEnabled',
-			expected: input => input === TRADING_REWARDS_ENABLED, // only change if non-default
+			expected: input => input === tradingRewardsEnabled, // only change if non-default
 			write: 'setTradingRewardsEnabled',
-			writeArg: TRADING_REWARDS_ENABLED,
+			writeArg: tradingRewardsEnabled,
 		});
 
 		await runStep({
@@ -1369,7 +1395,7 @@ const deploy = async ({
 			read: 'issuanceRatio',
 			expected: input => input !== '0', // only change if non-zero
 			write: 'setIssuanceRatio',
-			writeArg: ISSUANCE_RATIO,
+			writeArg: await getDeployParameter('ISSUANCE_RATIO'),
 		});
 
 		await runStep({
@@ -1378,7 +1404,7 @@ const deploy = async ({
 			read: 'feePeriodDuration',
 			expected: input => input !== '0', // only change if non-zero
 			write: 'setFeePeriodDuration',
-			writeArg: FEE_PERIOD_DURATION,
+			writeArg: await getDeployParameter('FEE_PERIOD_DURATION'),
 		});
 
 		await runStep({
@@ -1387,7 +1413,7 @@ const deploy = async ({
 			read: 'targetThreshold',
 			expected: input => input !== '0', // only change if non-zero
 			write: 'setTargetThreshold',
-			writeArg: TARGET_THRESHOLD,
+			writeArg: await getDeployParameter('TARGET_THRESHOLD'),
 		});
 
 		await runStep({
@@ -1396,7 +1422,7 @@ const deploy = async ({
 			read: 'liquidationDelay',
 			expected: input => input !== '0', // only change if non-zero
 			write: 'setLiquidationDelay',
-			writeArg: LIQUIDATION_DELAY,
+			writeArg: await getDeployParameter('LIQUIDATION_DELAY'),
 		});
 
 		await runStep({
@@ -1405,7 +1431,7 @@ const deploy = async ({
 			read: 'liquidationRatio',
 			expected: input => input !== '0', // only change if non-zero
 			write: 'setLiquidationRatio',
-			writeArg: LIQUIDATION_RATIO,
+			writeArg: await getDeployParameter('LIQUIDATION_RATIO'),
 		});
 
 		await runStep({
@@ -1414,7 +1440,7 @@ const deploy = async ({
 			read: 'liquidationPenalty',
 			expected: input => input !== '0', // only change if non-zero
 			write: 'setLiquidationPenalty',
-			writeArg: LIQUIDATION_PENALTY,
+			writeArg: await getDeployParameter('LIQUIDATION_PENALTY'),
 		});
 
 		await runStep({
@@ -1423,7 +1449,7 @@ const deploy = async ({
 			read: 'rateStalePeriod',
 			expected: input => input !== '0', // only change if non-zero
 			write: 'setRateStalePeriod',
-			writeArg: RATE_STALE_PERIOD,
+			writeArg: await getDeployParameter('RATE_STALE_PERIOD'),
 		});
 
 		await runStep({
@@ -1432,11 +1458,10 @@ const deploy = async ({
 			read: 'minimumStakeTime',
 			expected: input => input !== '0', // only change if non-zero
 			write: 'setMinimumStakeTime',
-			writeArg: MINIMUM_STAKE_TIME,
+			writeArg: await getDeployParameter('MINIMUM_STAKE_TIME'),
 		});
 
-		const aggregatorWarningFlags = AGGREGATOR_WARNING_FLAGS[network];
-
+		const aggregatorWarningFlags = (await getDeployParameter('AGGREGATOR_WARNING_FLAGS'))[network];
 		if (aggregatorWarningFlags) {
 			await runStep({
 				contract: 'SystemSettings',

publish/src/util.js

@@ -9,6 +9,7 @@ const w3utils = require('web3-utils');
 const {
 	constants: {
 		CONFIG_FILENAME,
+		PARAMS_FILENAME,
 		DEPLOYMENT_FILENAME,
 		OWNER_ACTIONS_FILENAME,
 		SYNTHS_FILENAME,
@@ -62,6 +63,10 @@ const loadAndCheckRequiredSources = ({ deploymentPath, network }) => {
 	const configFile = path.join(deploymentPath, CONFIG_FILENAME);
 	const config = JSON.parse(fs.readFileSync(configFile));
 
+	console.log(gray(`Loading the list of deployment parameters on ${network.toUpperCase()}...`));
+	const paramsFile = path.join(deploymentPath, PARAMS_FILENAME);
+	const params = JSON.parse(fs.readFileSync(paramsFile));
+
 	const versionsFile = path.join(deploymentPath, VERSIONS_FILENAME);
 	const versions = network !== 'local' ? getVersions({ network, deploymentPath }) : {};
 
@@ -85,6 +90,7 @@ const loadAndCheckRequiredSources = ({ deploymentPath, network }) => {
 
 	return {
 		config,
+		params,
 		configFile,
 		synths,
 		synthsFile,