Merge pull request #52 from tronprotocol/release_v2.2.0

Release v2.2.0

Author: lvs0075

README.md

@@ -1,26 +1,29 @@
-# Tron eventsubscribe plugin
+# Tron event subscribe plugin
 
-This is an implementation of Tron eventsubscribe model. 
+This is an implementation of Tron event subscribe model.
 
 * **api** module defines IPluginEventListener, a protocol between Java-tron and event plugin. 
 * **app** module is an example for loading plugin, developers could use it for debugging.
 * **kafkaplugin** module is the implementation for kafka, it implements IPluginEventListener, it receives events subscribed from Java-tron and relay events to kafka server. 
 * **mongodbplugin** mongodbplugin module is the implementation for mongodb. 
 ### Setup/Build
-
+Event-plugin can be built with JDK 8 or JDK 17.
 1. Clone the repo
 2. Go to eventplugin `cd eventplugin` 
 3. run `./gradlew build`
 
 * This will produce plugin zips, named `plugin-kafka-1.0.0.zip` and `plugin-mongodb-1.0.0.zip`, located in the `eventplugin/build/plugins/` directory.
 
 
-### Edit **config.conf** of Java-tron, add the following fileds:
+### Edit **config.conf** of Java-tron, add the following fields:
 ```
 event.subscribe = {
     path = "" // absolute path of plugin
     server = "" // target server address to receive event triggers
-    dbconfig = "" // dbname|username|password, if you want to create indexes for collections when the collections are not exist, you can add version and set it to 2, as dbname|username|password|version
+    # dbname|username|password or dbname|username|password|version
+    # If you use version 2 and one collection not exists, it will create index automatically;
+    # In any other case, it will not create index, you must create index manually
+    dbconfig = ""
     topics = [
         {
           triggerName = "block" // block trigger, the value can't be modified
@@ -95,13 +98,14 @@ event.subscribe = {
            remove comment and set listeners=PLAINTEXT://:9092  
            remove comment and set advertised.listeners to PLAINTEXT://host_ip:9092 
 
+### How to use kafka plugin
 ##### Install Kafka
-**On Mac**:
+*On Mac*:
 ```
 brew install kafka
 ```
 
-**On Linux**:
+*On Linux*:
 ```
 cd /usr/local
 wget http://archive.apache.org/dist/kafka/0.10.2.2/kafka_2.10-0.10.2.2.tgz
@@ -115,12 +119,12 @@ source /etc/profile
 **Note**: make sure the version of Kafka is the same as the version set in build.gradle of eventplugin project.(kafka_2.10-0.10.2.2 kafka)
 
 ##### Run Kafka
-**On Mac**:
+*On Mac*:
 ```
 zookeeper-server-start /usr/local/etc/kafka/zookeeper.properties & kafka-server-start /usr/local/etc/kafka/server.properties
 ```
 
-**On Linux**:
+*On Linux*:
 ```
 zookeeper-server-start.sh /usr/local/kafka/config/zookeeper.properties &
 Sleep about 3 seconds 
@@ -129,7 +133,7 @@ kafka-server-start.sh /usr/local/kafka/config/server.properties &
 
 #### Create topics to receive events, the topic is defined in config.conf
 
-**On Mac**:
+*On Mac*:
 ```
 kafka-topics --create --zookeeper localhost:2181 --replication-factor 1 --partitions 1 --topic block
 kafka-topics --create --zookeeper localhost:2181 --replication-factor 1 --partitions 1 --topic transaction
@@ -140,7 +144,7 @@ kafka-topics --create --zookeeper localhost:2181 --replication-factor 1 --partit
 kafka-topics --create --zookeeper localhost:2181 --replication-factor 1 --partitions 1 --topic soliditylog
 ```
 
-**On Linux**:
+*On Linux*:
 ```
 kafka-topics.sh --create --zookeeper localhost:2181 --replication-factor 1 --partitions 1 --topic block
 kafka-topics.sh --create --zookeeper localhost:2181 --replication-factor 1 --partitions 1 --topic transaction
@@ -153,7 +157,7 @@ kafka-topics.sh --create --zookeeper localhost:2181 --replication-factor 1 --par
 
 #### Kafka consumer
 
-**On Mac**:
+*On Mac*:
 ```
 kafka-console-consumer --bootstrap-server localhost:9092  --topic block
 kafka-console-consumer --bootstrap-server localhost:9092  --topic transaction
@@ -164,7 +168,7 @@ kafka-console-consumer --bootstrap-server localhost:9092  --topic solidityevent
 kafka-console-consumer --bootstrap-server localhost:9092  --topic soliditylog
 ```
 
-**On Linux**:
+*On Linux*:
 ```
 kafka-console-consumer.sh --zookeeper localhost:2181 --topic block
 kafka-console-consumer.sh --zookeeper localhost:2181 --topic transaction
@@ -175,6 +179,29 @@ kafka-console-consumer.sh --zookeeper localhost:2181 --topic solidityevent
 kafka-console-consumer.sh --zookeeper localhost:2181 --topic soliditylog
 ```
 
+See more details on [developers](https://developers.tron.network/docs/event-plugin-deployment-kafka).
+
+### How to use MongoDB plugin
+These are default indexes when build automatically:
+```
+db.block.createIndex({ blockNumber: 1 },{ name: "blockNumber",unique: true});
+
+db.transaction.createIndex({ transactionId: 1 },{ name: "transactionId",unique: true });
+
+db.solidity.createIndex({ latestSolidifiedBlockNumber: 1 },{ name: "latestSolidifiedBlockNumber",unique: true });
+
+db.solidityevent.createIndex({ uniqueId: 1 },{ name: "uniqueId",unique: true });
+
+db.contractevent.createIndex({ uniqueId: 1 },{ name: "uniqueId",unique: true });
+
+db.soliditylog.createIndex({ uniqueId: 1 },{ name: "uniqueId",unique: true });
+db.soliditylog.createIndex({ contractAddress: 1 },{ name: "contractAddress" });
+
+db.contractlog.createIndex({ uniqueId: 1 },{ name: "uniqueId",unique: true });
+db.contractlog.createIndex({ contractAddress: 1 },{ name: "contractAddress" });
+```
+You can also create other indexes as necessary. See more details on [developers](https://developers.tron.network/docs/event-plugin-deployment-mongodb).
+
 ### Load plugin in Java-tron
 * add --es to command line, for example:
 ```

api/src/main/java/org/tron/common/logsfilter/IPluginEventListener.java

@@ -3,28 +3,31 @@
 import org.pf4j.ExtensionPoint;
 
 public interface IPluginEventListener extends ExtensionPoint {
-    void setServerAddress(String address);
 
-    void setTopic(int eventType, String topic);
+  void setServerAddress(String address);
 
-    void setDBConfig(String dbConfig);
+  void setTopic(int eventType, String topic);
 
-    // start should be called after setServerAddress, setTopic, setDBConfig
-    void start();
+  void setDBConfig(String dbConfig);
 
-    void handleBlockEvent(Object data);
+  // start should be called after setServerAddress, setTopic, setDBConfig
+  void start();
 
-    void handleTransactionTrigger(Object data);
+  void stop();
 
-    void handleContractLogTrigger(Object data);
+  void handleBlockEvent(Object data);
 
-    void handleContractEventTrigger(Object data);
+  void handleTransactionTrigger(Object data);
 
-    void handleSolidityTrigger(Object trigger);
+  void handleContractLogTrigger(Object data);
 
-    void handleSolidityLogTrigger(Object trigger);
+  void handleContractEventTrigger(Object data);
 
-    void handleSolidityEventTrigger(Object trigger);
+  void handleSolidityTrigger(Object trigger);
 
-    int getPendingSize();
+  void handleSolidityLogTrigger(Object trigger);
+
+  void handleSolidityEventTrigger(Object trigger);
+
+  int getPendingSize();
 }

api/src/main/java/org/tron/common/logsfilter/trigger/BlockLogTrigger.java

@@ -1,13 +1,12 @@
 package org.tron.common.logsfilter.trigger;
 
 import java.util.ArrayList;
-import java.util.HashMap;
 import java.util.List;
-import java.util.Map;
 import lombok.Getter;
 import lombok.Setter;
 
 public class BlockLogTrigger extends Trigger {
+
   @Getter
   @Setter
   private long blockNumber;
@@ -22,47 +21,24 @@ public class BlockLogTrigger extends Trigger {
 
   @Getter
   @Setter
-  private List<String> transactionList = new ArrayList<>();
-
-
-  /**
-   * address of witness
-   */
-  @Getter
-  @Setter
-  private String witnessAddress;
+  private long latestSolidifiedBlockNumber;
 
   @Getter
   @Setter
-  private long witnessPayPerBlock;
-
-  @Getter
-  @Setter
-  Map<String, Long> witnessMap = new HashMap<>();
+  private List<String> transactionList = new ArrayList<>();
 
   public BlockLogTrigger() {
-    setTriggerName(Trigger.BLOCK_TRIGGER_NAME);
+    setTriggerName(EventTopic.BLOCK_TRIGGER.getName());
   }
 
   @Override
   public String toString() {
-    return new StringBuilder().append("triggerName: ").append(getTriggerName())
-      .append("timestamp: ")
-      .append(timeStamp)
-      .append(", blockNumber: ")
-      .append(blockNumber)
-      .append(", blockhash: ")
-      .append(blockHash)
-      .append(", transactionSize: ")
-      .append(transactionSize)
-      .append(", transactionList: ")
-      .append(transactionList)
-      .append(", witnessAddress: ")
-      .append(witnessAddress)
-      .append(", witnessPayPerBlock: ")
-      .append(witnessPayPerBlock)
-      .append(", witnessMap: ")
-      .append(witnessMap)
-      .toString();
+    return "triggerName: " + getTriggerName()
+        + ", timestamp: " + timeStamp
+        + ", blockNumber: " + blockNumber
+        + ", blockhash: " + blockHash
+        + ", transactionSize: " + transactionSize
+        + ", latestSolidifiedBlockNumber: " + latestSolidifiedBlockNumber
+        + ", transactionList: " + transactionList;
   }
 }

api/src/main/java/org/tron/common/logsfilter/trigger/ContractEventTrigger.java

@@ -37,9 +37,8 @@ public class ContractEventTrigger extends ContractTrigger {
   @Setter
   private Map<String, String> dataMap;
 
-
   public ContractEventTrigger() {
     super();
-    setTriggerName(Trigger.CONTRACTEVENT_TRIGGER_NAME);
+    setTriggerName(EventTopic.CONTRACT_EVENT_TRIGGER.getName());
   }
 }

api/src/main/java/org/tron/common/logsfilter/trigger/ContractLogTrigger.java

@@ -5,6 +5,7 @@
 import lombok.Setter;
 
 public class ContractLogTrigger extends ContractTrigger {
+
   /**
    * topic list produced by the smart contract LOG function
    */
@@ -21,6 +22,6 @@ public class ContractLogTrigger extends ContractTrigger {
 
   public ContractLogTrigger() {
     super();
-    setTriggerName(Trigger.CONTRACTLOG_TRIGGER_NAME);
+    setTriggerName(EventTopic.CONTRACT_LOG_TRIGGER.getName());
   }
 }

api/src/main/java/org/tron/common/logsfilter/trigger/ContractTrigger.java

@@ -3,7 +3,7 @@
 import lombok.Getter;
 import lombok.Setter;
 
-public class ContractTrigger extends Trigger {
+public abstract class ContractTrigger extends Trigger {
 
   /**
    * id of the transaction which produce this event.

api/src/main/java/org/tron/common/logsfilter/trigger/EventTopic.java

@@ -0,0 +1,41 @@
+package org.tron.common.logsfilter.trigger;
+
+
+import lombok.Getter;
+
+@Getter
+public enum EventTopic {
+  BLOCK_TRIGGER(0, "blockTrigger"),
+  TRANSACTION_TRIGGER(1, "transactionTrigger"),
+  CONTRACT_LOG_TRIGGER(2, "contractLogTrigger"),
+  CONTRACT_EVENT_TRIGGER(3, "contractEventTrigger"),
+  SOLIDITY_TRIGGER(4, "solidityTrigger"),
+  SOLIDITY_EVENT(5, "solidityEventTrigger"),
+  SOLIDITY_LOG(6, "solidityLogTrigger");
+
+  private final Integer type;
+  private final String name;
+
+  EventTopic(Integer type, String name) {
+    this.type = type;
+    this.name = name;
+  }
+
+  public static EventTopic getEventTopicByType(int topicType) {
+    for (EventTopic member : values()) {
+      if (member.getType() == topicType) {
+        return member;
+      }
+    }
+    return null;
+  }
+
+  public static EventTopic getEventTopicByName(String topicName) {
+    for (EventTopic member : values()) {
+      if (member.getName().equals(topicName)) {
+        return member;
+      }
+    }
+    return null;
+  }
+}

api/src/main/java/org/tron/common/logsfilter/trigger/SolidityTrigger.java

@@ -4,20 +4,19 @@
 import lombok.Setter;
 
 public class SolidityTrigger extends Trigger {
+
   @Getter
   @Setter
   private long latestSolidifiedBlockNumber;
 
   @Override
   public String toString() {
-    return new StringBuilder().append("triggerName: ").append(getTriggerName())
-        .append("timestamp: ")
-        .append(timeStamp)
-        .append(", latestSolidifiedBlockNumber: ")
-        .append(latestSolidifiedBlockNumber).toString();
+    return "triggerName: " + getTriggerName()
+        + ", timestamp: " + timeStamp
+        + ", latestSolidifiedBlockNumber: " + latestSolidifiedBlockNumber;
   }
 
   public SolidityTrigger() {
-    setTriggerName(Trigger.SOLIDITY_TRIGGER_NAME);
+    setTriggerName(EventTopic.SOLIDITY_TRIGGER.getName());
   }
 }

api/src/main/java/org/tron/common/logsfilter/trigger/TransactionLogTrigger.java

@@ -1,6 +1,5 @@
 package org.tron.common.logsfilter.trigger;
 
-import java.util.ArrayList;
 import java.util.List;
 import lombok.Getter;
 import lombok.Setter;
@@ -96,6 +95,6 @@ public void setTimeStamp(long ts) {
   private List<InternalTransactionPojo> internalTrananctionList;
 
   public TransactionLogTrigger() {
-    setTriggerName(Trigger.TRANSACTION_TRIGGER_NAME);
+    setTriggerName(EventTopic.TRANSACTION_TRIGGER.getName());
   }
 }

api/src/main/java/org/tron/common/logsfilter/trigger/Trigger.java

@@ -3,26 +3,13 @@
 import lombok.Getter;
 import lombok.Setter;
 
-public class Trigger {
+public abstract class Trigger {
+
   @Getter
   @Setter
   protected long timeStamp;
 
   @Getter
   @Setter
   private String triggerName;
-
-  public static final int BLOCK_TRIGGER = 0;
-  public static final int TRANSACTION_TRIGGER = 1;
-  public static final int CONTRACTLOG_TRIGGER = 2;
-  public static final int CONTRACTEVENT_TRIGGER = 3;
-  public static final int SOLIDITY_TRIGGER = 4;
-  public static final int SOLIDITY_EVENT = 5;
-  public static final int SOLIDITY_LOG = 6;
-
-  public static final String BLOCK_TRIGGER_NAME = "blockTrigger";
-  public static final String TRANSACTION_TRIGGER_NAME = "transactionTrigger";
-  public static final String CONTRACTLOG_TRIGGER_NAME = "contractLogTrigger";
-  public static final String CONTRACTEVENT_TRIGGER_NAME = "contractEventTrigger";
-  public static final String SOLIDITY_TRIGGER_NAME = "solidityTrigger";
 }