Skip to content

Commit 51e218d

Browse files
author
vividcoder
committed
style: address review feedback on comments, typos and code style
- Fix typo: defalut → default (CLIParameter.java) - Fix comment spacing: //private key → // private key (ConfigKey.java) - Replace Unicode section separators with ASCII // -- Section -- - Change assigned from Map to Set since only contains() is needed - Add @VisibleForTesting to clearParam()
1 parent 9c2c55b commit 51e218d

4 files changed

Lines changed: 50 additions & 46 deletions

File tree

‎common/src/main/java/org/tron/common/parameter/CommonParameter.java‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,12 @@ public class CommonParameter {
3131
@Setter
3232
public static boolean ENERGY_LIMIT_HARD_FORK = false;
3333

34-
// ── Startup parameters ────────────────────────
34+
// -- Startup parameters --
3535
@Getter
3636
public String outputDirectory = "output-directory";
3737
@Getter
3838
public String logbackPath = "";
39-
// ── Flags (CLI + Config) ──────────────────────
39+
// -- Flags (CLI + Config) --
4040
@Getter
4141
@Setter
4242
public boolean witness = false;
@@ -77,7 +77,7 @@ public class CommonParameter {
7777
public List<String> seedNodes = new ArrayList<>();
7878
@Getter
7979
public boolean fastForward = false;
80-
// ── Network / P2P ─────────────────────────────
80+
// -- Network / P2P --
8181
@Getter
8282
@Setter
8383
public String chainId;
@@ -159,7 +159,7 @@ public class CommonParameter {
159159
@Setter
160160
public boolean keystoreFactory = false;
161161

162-
// ── RPC / HTTP ────────────────────────────────
162+
// -- RPC / HTTP --
163163
@Getter
164164
@Setter
165165
public int rpcPort;
@@ -233,7 +233,7 @@ public class CommonParameter {
233233
@Setter
234234
public int checkFrozenTime; // clearParam: 1
235235

236-
// ── Committee parameters ──────────────────────
236+
// -- Committee parameters --
237237
@Getter
238238
@Setter
239239
public long allowCreationOfContracts;
@@ -259,7 +259,7 @@ public class CommonParameter {
259259
@Setter
260260
public long forbidTransferToContract;
261261

262-
// ── Netty ─────────────────────────────────────
262+
// -- Netty --
263263
@Getter
264264
@Setter
265265
public int tcpNettyWorkThreadNum;
@@ -346,7 +346,7 @@ public class CommonParameter {
346346
@Setter
347347
public long trxExpirationTimeInMilliseconds;
348348

349-
// ── Shielded / ZK ─────────────────────────────
349+
// -- Shielded / ZK --
350350
@Getter
351351
@Setter
352352
public String zenTokenId; // clearParam: "000000"

‎framework/src/main/java/org/tron/core/config/args/Args.java‎

Lines changed: 37 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515

1616
import com.beust.jcommander.JCommander;
1717
import com.beust.jcommander.ParameterDescription;
18+
import com.google.common.annotations.VisibleForTesting;
1819
import com.google.common.base.Strings;
1920
import com.typesafe.config.Config;
2021
import com.typesafe.config.ConfigObject;
@@ -34,6 +35,7 @@
3435
import java.util.LinkedHashMap;
3536
import java.util.List;
3637
import java.util.Map;
38+
import java.util.Set;
3739
import java.util.Objects;
3840
import java.util.Optional;
3941
import java.util.Properties;
@@ -991,101 +993,102 @@ public static void applyConfigParams(
991993
* Only assigned parameters override Config values.
992994
*/
993995
private static void applyCLIParams(CLIParameter cmd, JCommander jc) {
994-
Map<String, ParameterDescription> assigned = jc.getParameters().stream()
996+
Set<String> assigned = jc.getParameters().stream()
995997
.filter(ParameterDescription::isAssigned)
996-
.collect(Collectors.toMap(ParameterDescription::getLongestName, p -> p));
998+
.map(ParameterDescription::getLongestName)
999+
.collect(Collectors.toSet());
9971000

998-
if (assigned.containsKey("--output-directory")) {
1001+
if (assigned.contains("--output-directory")) {
9991002
PARAMETER.outputDirectory = cmd.outputDirectory;
10001003
}
1001-
if (assigned.containsKey("--witness")) {
1004+
if (assigned.contains("--witness")) {
10021005
PARAMETER.witness = cmd.witness;
10031006
}
1004-
if (assigned.containsKey("--support-constant")) {
1007+
if (assigned.contains("--support-constant")) {
10051008
PARAMETER.supportConstant = cmd.supportConstant;
10061009
}
1007-
if (assigned.containsKey("--max-energy-limit-for-constant")) {
1010+
if (assigned.contains("--max-energy-limit-for-constant")) {
10081011
PARAMETER.maxEnergyLimitForConstant = cmd.maxEnergyLimitForConstant;
10091012
}
1010-
if (assigned.containsKey("--lru-cache-size")) {
1013+
if (assigned.contains("--lru-cache-size")) {
10111014
PARAMETER.lruCacheSize = cmd.lruCacheSize;
10121015
}
1013-
if (assigned.containsKey("--debug")) {
1016+
if (assigned.contains("--debug")) {
10141017
PARAMETER.debug = cmd.debug;
10151018
}
1016-
if (assigned.containsKey("--min-time-ratio")) {
1019+
if (assigned.contains("--min-time-ratio")) {
10171020
PARAMETER.minTimeRatio = cmd.minTimeRatio;
10181021
}
1019-
if (assigned.containsKey("--max-time-ratio")) {
1022+
if (assigned.contains("--max-time-ratio")) {
10201023
PARAMETER.maxTimeRatio = cmd.maxTimeRatio;
10211024
}
1022-
if (assigned.containsKey("--save-internaltx")) {
1025+
if (assigned.contains("--save-internaltx")) {
10231026
PARAMETER.saveInternalTx = cmd.saveInternalTx;
10241027
}
1025-
if (assigned.containsKey("--save-featured-internaltx")) {
1028+
if (assigned.contains("--save-featured-internaltx")) {
10261029
PARAMETER.saveFeaturedInternalTx = cmd.saveFeaturedInternalTx;
10271030
}
1028-
if (assigned.containsKey("--save-cancel-all-unfreeze-v2-details")) {
1031+
if (assigned.contains("--save-cancel-all-unfreeze-v2-details")) {
10291032
PARAMETER.saveCancelAllUnfreezeV2Details = cmd.saveCancelAllUnfreezeV2Details;
10301033
}
1031-
if (assigned.containsKey("--long-running-time")) {
1034+
if (assigned.contains("--long-running-time")) {
10321035
PARAMETER.longRunningTime = cmd.longRunningTime;
10331036
}
1034-
if (assigned.containsKey("--max-connect-number")) {
1037+
if (assigned.contains("--max-connect-number")) {
10351038
PARAMETER.maxHttpConnectNumber = cmd.maxHttpConnectNumber;
10361039
}
1037-
if (assigned.containsKey("--storage-db-directory")) {
1040+
if (assigned.contains("--storage-db-directory")) {
10381041
PARAMETER.storage.setDbDirectory(cmd.storageDbDirectory);
10391042
}
1040-
if (assigned.containsKey("--storage-db-engine")) {
1043+
if (assigned.contains("--storage-db-engine")) {
10411044
PARAMETER.storage.setDbEngine(cmd.storageDbEngine);
10421045
}
1043-
if (assigned.containsKey("--storage-db-synchronous")) {
1046+
if (assigned.contains("--storage-db-synchronous")) {
10441047
PARAMETER.storage.setDbSync(Boolean.valueOf(cmd.storageDbSynchronous));
10451048
}
1046-
if (assigned.containsKey("--contract-parse-enable")) {
1049+
if (assigned.contains("--contract-parse-enable")) {
10471050
PARAMETER.storage.setContractParseSwitch(Boolean.valueOf(cmd.contractParseEnable));
10481051
}
1049-
if (assigned.containsKey("--storage-index-directory")) {
1052+
if (assigned.contains("--storage-index-directory")) {
10501053
PARAMETER.storage.setIndexDirectory(cmd.storageIndexDirectory);
10511054
}
1052-
if (assigned.containsKey("--storage-index-switch")) {
1055+
if (assigned.contains("--storage-index-switch")) {
10531056
PARAMETER.storage.setIndexSwitch(cmd.storageIndexSwitch);
10541057
}
1055-
if (assigned.containsKey("--storage-transactionHistory-switch")) {
1058+
if (assigned.contains("--storage-transactionHistory-switch")) {
10561059
PARAMETER.storage.setTransactionHistorySwitch(cmd.storageTransactionHistorySwitch);
10571060
}
1058-
if (assigned.containsKey("--fast-forward")) {
1061+
if (assigned.contains("--fast-forward")) {
10591062
PARAMETER.fastForward = cmd.fastForward;
10601063
}
1061-
if (assigned.containsKey("--solidity")) {
1064+
if (assigned.contains("--solidity")) {
10621065
PARAMETER.solidityNode = cmd.solidityNode;
10631066
}
1064-
if (assigned.containsKey("--keystore-factory")) {
1067+
if (assigned.contains("--keystore-factory")) {
10651068
PARAMETER.keystoreFactory = cmd.keystoreFactory;
10661069
}
1067-
if (assigned.containsKey("--rpc-thread")) {
1070+
if (assigned.contains("--rpc-thread")) {
10681071
PARAMETER.rpcThreadNum = cmd.rpcThreadNum;
10691072
}
1070-
if (assigned.containsKey("--solidity-thread")) {
1073+
if (assigned.contains("--solidity-thread")) {
10711074
PARAMETER.solidityThreads = cmd.solidityThreads;
10721075
}
1073-
if (assigned.containsKey("--validate-sign-thread")) {
1076+
if (assigned.contains("--validate-sign-thread")) {
10741077
PARAMETER.validateSignThreadNum = cmd.validateSignThreadNum;
10751078
}
1076-
if (assigned.containsKey("--trust-node")) {
1079+
if (assigned.contains("--trust-node")) {
10771080
PARAMETER.trustNodeAddr = cmd.trustNodeAddr;
10781081
}
1079-
if (assigned.containsKey("--es")) {
1082+
if (assigned.contains("--es")) {
10801083
PARAMETER.eventSubscribe = cmd.eventSubscribe;
10811084
}
1082-
if (assigned.containsKey("--p2p-disable")) {
1085+
if (assigned.contains("--p2p-disable")) {
10831086
PARAMETER.p2pDisable = cmd.p2pDisable;
10841087
}
1085-
if (assigned.containsKey("--history-balance-lookup")) {
1088+
if (assigned.contains("--history-balance-lookup")) {
10861089
PARAMETER.historyBalanceLookup = cmd.historyBalanceLookup;
10871090
}
1088-
if (assigned.containsKey("--log-config")) {
1091+
if (assigned.contains("--log-config")) {
10891092
PARAMETER.logbackPath = cmd.logbackPath;
10901093
}
10911094
if (!cmd.seedNodes.isEmpty()) {
@@ -1138,6 +1141,7 @@ private static void initLocalWitnesses(Config config, CLIParameter cmd) {
11381141
TronError.ErrCode.WITNESS_INIT);
11391142
}
11401143

1144+
@VisibleForTesting
11411145
public static void clearParam() {
11421146
CommonParameter.reset();
11431147
configFilePath = "";

‎framework/src/main/java/org/tron/core/config/args/CLIParameter.java‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
@NoArgsConstructor
1515
public class CLIParameter {
1616

17-
// ── Startup parameters ──────────────────────────
17+
// -- Startup parameters --
1818

1919
@Parameter(names = {"-c", "--config"}, description = "Config file (default:config.conf)")
2020
public String shellConfFileName;
@@ -57,13 +57,13 @@ public class CLIParameter {
5757
public boolean eventSubscribe;
5858

5959
@Parameter(names = {"--p2p-disable"}, description = "Switch for p2p module initialization. "
60-
+ "(defalut: false)", arity = 1)
60+
+ "(default: false)", arity = 1)
6161
public boolean p2pDisable;
6262

6363
@Parameter(description = "--seed-nodes")
6464
public List<String> seedNodes = new ArrayList<>();
6565

66-
// ── Storage parameters ──────────────────────────
66+
// -- Storage parameters --
6767

6868
@Parameter(names = {"--storage-db-directory"}, description = "Storage db directory")
6969
public String storageDbDirectory;
@@ -91,10 +91,10 @@ public class CLIParameter {
9191
+ "java-tron. (default: true)")
9292
public String contractParseEnable;
9393

94-
// ── Runtime parameters ──────────────────────────
94+
// -- Runtime parameters --
9595

9696
@Parameter(names = {"--support-constant"}, description = "Support constant calling for TVM. "
97-
+ "(defalut: false)")
97+
+ "(default: false)")
9898
public boolean supportConstant;
9999

100100
@Parameter(names = {"--max-energy-limit-for-constant"},

‎framework/src/main/java/org/tron/core/config/args/ConfigKey.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ private ConfigKey() {
1010
}
1111

1212
// local witness
13-
public static final String LOCAL_WITNESS = "localwitness"; //private key
13+
public static final String LOCAL_WITNESS = "localwitness"; // private key
1414
public static final String LOCAL_WITNESS_ACCOUNT_ADDRESS = "localWitnessAccountAddress";
1515
public static final String LOCAL_WITNESS_KEYSTORE = "localwitnesskeystore";
1616

0 commit comments

Comments
 (0)