v1.1 refine part1

Author: qyan-dev

demo/src/main/java/com/webank/wedpr/demo/KtbDemo.java

@@ -5,16 +5,16 @@
 import com.webank.wedpr.ktb.hdk.HdkClient;
 import com.webank.wedpr.ktb.hdk.HdkResult;
 
-/** Minimalist demo of WeDPR Crypto Tools. */
+/** Minimalist demo of key tool box (KTB). */
 public class KtbDemo {
   public static void run(HdkClient hdkClient) throws Exception {
-    System.out.println("\n*******\nHDK DEMO RUN\n*******");
+    System.out.println("\n*******\nKTB DEMO RUN\n*******");
 
     HdkResult hdkResult = hdkClient.createMnemonicEn(24);
     String mnemonic = hdkResult.mnemonic;
     System.out.println("mnemonic = " + mnemonic);
 
-    String password = "123456";
+    String password = "Do not use real password";
     hdkResult = hdkClient.createMasterKeyEn(password, mnemonic);
     String masterKey = hdkResult.masterKey;
     System.out.println("masterKey = " + masterKey);
@@ -24,7 +24,6 @@ public static void run(HdkClient hdkClient) throws Exception {
     int account = 1;
     int change = 0;
     int addressIndex = 1000;
-
     hdkResult =
         hdkClient.deriveExtendedKey(
             masterKey, purposeType, assetType, account, change, addressIndex);

solution/ktb/src/main/java/com/webank/wedpr/ktb/hdk/HdkClient.java

@@ -1,48 +1,49 @@
 // Copyright 2020 WeDPR Lab Project Authors. Licensed under Apache-2.0.
+
 package com.webank.wedpr.ktb.hdk;
 
 import com.webank.wedpr.common.WedprException;
 
 /**
- * Client class used by ktb tools. This is the main interface class for Java apps using crypto
+ * Client class used by KTB-HDK. This is the main interface class for Java apps using HDK
  * functions.
  */
 public class HdkClient {
 
   /**
-   * Create English Mnemonic
+   * Creates an English mnemonic for later generating the master key.
    *
-   * @param wordCount
-   * @return
-   * @throws WedprException
+   * @param wordCount the word count of the mnemonic.
+   * @return HdkResult containing data for mnemonic.
+   * @throws WedprException if any error occurred.
    */
   public HdkResult createMnemonicEn(int wordCount) throws WedprException {
     return NativeInterface.createMnemonicEn(wordCount).expectNoError();
   }
 
   /**
-   * Create Master key
+   * Creates a master key from a English mnemonic and a password.
    *
-   * @param password
-   * @param mnemonic
-   * @return
-   * @throws WedprException
+   * @param password the password used together with the mnemonic.
+   * @param mnemonic the mnemonic for master key recovery.
+   * @return HdkResult containing data for masterKey.
+   * @throws WedprException if any error occurred.
    */
   public HdkResult createMasterKeyEn(String password, String mnemonic) throws WedprException {
     return NativeInterface.createMasterKeyEn(password, mnemonic).expectNoError();
   }
 
   /**
-   * Derive Extended Key
+   * Derives an extended key pair based on a key derivation path.
    *
-   * @param masterKey
-   * @param purposeType
-   * @param assetType
-   * @param account
-   * @param change
-   * @param addressIndex
-   * @return
-   * @throws WedprException
+   * @param masterKey the master key for key derivation.
+   * @param purposeType the purpose type of the derived key.
+   * @param assetType the asset subtype of the derived key.
+   * @param account the account subtype of the derived key.
+   * @param change the change subtype of the derived key.
+   * @param addressIndex the address index of the derived key.
+   * @return HdkResult containing data for extendedPublicKey, extendedPrivateKey.
+   * @throws WedprException if any error occurred.
    */
   public HdkResult deriveExtendedKey(
       String masterKey, int purposeType, int assetType, int account, int change, int addressIndex)

solution/ktb/src/main/java/com/webank/wedpr/ktb/hdk/HdkResult.java

@@ -6,7 +6,7 @@
 import com.webank.wedpr.common.WedprResult;
 
 /**
- * Result class used by Crypto client.
+ * Result class used by HDK client.
  *
  * <p>This is an easy way to return multiple data from a single JNI interface.
  */

solution/ktb/src/main/java/com/webank/wedpr/ktb/hdk/NativeInterface.java

@@ -5,12 +5,12 @@
 import com.webank.wedpr.common.NativeUtils;
 import java.io.IOException;
 
-/** Native interface for Crypto client. */
+/** Native interface for HDK client. */
 public class NativeInterface {
 
   static {
     try {
-      // Load the dynamic library of Crypto on different operating systems.
+      // Load the dynamic library of HDK on different operating systems.
       String osName = System.getProperty("os.name").toLowerCase();
       String libPathInJar;
       if (osName.contains("windows")) {

solution/scd/src/main/java/com/webank/wedpr/scd/PredicateType.java

@@ -4,9 +4,9 @@
 
 /** Predicate types supported by SCD. */
 public enum PredicateType {
-  GE, // >
-  LE, // <
-  GT, // >=
-  LT, // <=
-  EQ // ==
+  GE,  // >
+  LE,  // <
+  GT,  // >=
+  LT,  // <=
+  EQ   // ==
 }

solution/vcl/src/main/java/com/webank/wedpr/vcl/VclClient.java

@@ -1,3 +1,5 @@
+// Copyright 2020 WeDPR Lab Project Authors. Licensed under Apache-2.0.
+
 package com.webank.wedpr.vcl;
 
 import com.webank.wedpr.common.WedprException;