feat: add the db query tool to get latest vote and reward (#57)

Author: Federico2014

README.md

@@ -26,6 +26,7 @@ We also provide tools to facilitate the CI and testing process:
   - `root`: compute merkle root for tiny db. NOTE: large db may GC overhead
   limit exceeded.
   - `fork`: Modify the database of java-tron for shadow fork testing.
+  - `query`: Query the latest vote and reward information from the database.
 - **Stress Test**: Execute the stress test and evaluate the performance of the `java-tron` fullnode.
 
 

tools/toolkit/README.md

@@ -173,15 +173,53 @@ NOTE: large db may GC overhead limit exceeded.
 
 
 ## DB Fork
-Database fork tool can help launch a private java-tron FullNode or network based on the state of public chain database to support shadow fork testing.
+DB fork tool can help launch a private java-tron FullNode or network based on the state of public chain database to support shadow fork testing.
 
 ### Available parameters:
 - `-c, --config=<config>`: config the new witnesses, balances, etc for shadow
 fork. Default: fork.conf
-- `-d, --database-directory=<database>`:
-java-tron database directory path. Default:
+- `-d, --database-directory=<database>`: java-tron database directory path. Default:
 output-directory
 - `-r, --retain-witnesses`: retain the previous witnesses and active witnesses.
 - `-h, --help`: provide the help info
 
 Please refer [DbFork](DbFork.md) guidance for more details.
+
+## DB Query
+The [ListWitnesses](https://developers.tron.network/reference/listwitnesses) and [getReward](https://developers.tron.network/reference/wallet-getreward)
+APIs provide vote and reward data only until the end of the last maintenance period.
+To obtain the latest information, please query the database directly using the DB query tool.
+
+### Available parameters:
+- `-c, --config=<config>`: config the vote and reward options. Default: query.conf
+- `-d, --database-directory=<database>`: java-tron database directory path. Default: output-directory
+- `-h, --help`: provide the help info
+
+### Examples:
+The example of `query.conf`:
+```conf
+vote = {
+  allWitnesses = true
+  witnessList = [
+    "TPDa1KRmFpLA42WffiXBwEykef9exHNPKV",
+    "TXnqPcy9zWHYyCiQ7Kmvt3aCx5jm9Qnq3e",
+  ]
+}
+
+reward = [
+  "TLyqzVGLV1srkB7dToTAEqgDSfPtXRJZYH",
+  "TJvaAeFb8Lykt9RQcVyyTFN2iDvGMuyD4M"
+]
+```
+- `vote.allWitnesses`: configure whether to query the vote information of all witnesses.
+- `vote.witnessList`: configure to query the vote information from specified witness list.
+                      The option is valid only when `vote.allWitnesses = false`.
+- `reward`: configure the address list you need to query the reward.
+
+Execute query command.
+```shell script
+# full command
+  java -jar Toolkit.jar db query [-h] [-c=<config>] [-d=<database>]
+# examples
+  java -jar Toolkit.jar db query -c query.conf -d output-directory
+```

tools/toolkit/build.gradle

@@ -56,6 +56,8 @@ dependencies {
     annotationProcessor 'org.projectlombok:lombok:1.18.12'
     testCompileOnly 'org.projectlombok:lombok:1.18.12'
     testAnnotationProcessor 'org.projectlombok:lombok:1.18.12'
+
+    implementation 'com.alibaba:fastjson:1.2.83'
 }
 
 application {

tools/toolkit/src/main/java/org/tron/plugins/Db.java

@@ -13,7 +13,8 @@
         DbLite.class,
         DbCopy.class,
         DbRoot.class,
-        DbFork.class
+        DbFork.class,
+        DbQuery.class
     },
     commandListHeading = "%nCommands:%n%nThe most commonly used db commands are:%n"
 )

tools/toolkit/src/main/java/org/tron/plugins/DbFork.java

@@ -148,7 +148,7 @@ public Integer call() throws IOException, RocksDBException {
     Config forkConfig = ConfigFactory.load();
     File file = Paths.get(config).toFile();
     if (file.exists() && file.isFile()) {
-      forkConfig = ConfigFactory.parseFile(Paths.get(config).toFile());
+      forkConfig = ConfigFactory.parseFile(file);
     } else {
       logger.error("Fork config file [" + config + "] not exists!");
       spec.commandLine().getErr().format("Fork config file: %s not exists!", config).println();