Update docs

2019-04-24 00:18:08 +08:00 · 2019-04-24 00:18:08 +08:00 · 6460f8b1aa
commit 6460f8b1aa
parent 91be741e87
5 changed files with 56 additions and 26 deletions
--- a/README.md
+++ b/README.md
@ -4,6 +4,36 @@
 - io.grpc:grpc-protobuf
 - io.grpc:grpc-stub

+w/ **Gradle**
+```
+compile 'io.grpc:grpc-netty-shaded:' + grpc_java_version
+compile 'io.grpc:grpc-protobuf:' + grpc_java_version
+compile 'io.grpc:grpc-stub:' + grpc_java_version
+```
+
+w/ **Maven**
+```
+<dependency>
+    <groupId>io.grpc</groupId>
+    <artifactId>grpc-netty-shaded</artifactId>
+    <version>${grpc_java_version}</version>
+</dependency>
+<dependency>
+    <groupId>io.grpc</groupId>
+    <artifactId>grpc-protobuf</artifactId>
+    <version>${grpc_java_version}</version>
+</dependency>
+<dependency>
+    <groupId>io.grpc</groupId>
+    <artifactId>grpc-stub</artifactId>
+    <version>${grpc_java_version}</version>
+</dependency>
+```
+
+## Usage
+
+See Javadoc and `src/test/java/bdchain/api/*Tests.java` files.
+
 ## Testing

 1. Download [mock servers](https://public.internetapi.cn/?dir=bdchain/test) for Transaction Ledger &
--- a/src/main/java/bdchain/api/grpc/acchain/Block.java
+++ b/src/main/java/bdchain/api/grpc/acchain/Block.java
@ -316,7 +316,7 @@ private static final long serialVersionUID = 0L;
  private java.util.List<com.google.protobuf.ByteString> transactionHashes_;
  /**
   * <pre>
-   * 32字节的交易哈希的数组，或为空
+   * 20字节的交易哈希的数组，或为空
   * </pre>
   *
   * <code>repeated bytes transaction_hashes = 9;</code>
@ -327,7 +327,7 @@ private static final long serialVersionUID = 0L;
  }
  /**
   * <pre>
-   * 32字节的交易哈希的数组，或为空
+   * 20字节的交易哈希的数组，或为空
   * </pre>
   *
   * <code>repeated bytes transaction_hashes = 9;</code>
@ -337,7 +337,7 @@ private static final long serialVersionUID = 0L;
  }
  /**
   * <pre>
-   * 32字节的交易哈希的数组，或为空
+   * 20字节的交易哈希的数组，或为空
   * </pre>
   *
   * <code>repeated bytes transaction_hashes = 9;</code>
@ -1524,7 +1524,7 @@ private static final long serialVersionUID = 0L;
    }
    /**
     * <pre>
-     * 32字节的交易哈希的数组，或为空
+     * 20字节的交易哈希的数组，或为空
     * </pre>
     *
     * <code>repeated bytes transaction_hashes = 9;</code>
@ -1536,7 +1536,7 @@ private static final long serialVersionUID = 0L;
    }
    /**
     * <pre>
-     * 32字节的交易哈希的数组，或为空
+     * 20字节的交易哈希的数组，或为空
     * </pre>
     *
     * <code>repeated bytes transaction_hashes = 9;</code>
@ -1546,7 +1546,7 @@ private static final long serialVersionUID = 0L;
    }
    /**
     * <pre>
-     * 32字节的交易哈希的数组，或为空
+     * 20字节的交易哈希的数组，或为空
     * </pre>
     *
     * <code>repeated bytes transaction_hashes = 9;</code>
@ -1556,7 +1556,7 @@ private static final long serialVersionUID = 0L;
    }
    /**
     * <pre>
-     * 32字节的交易哈希的数组，或为空
+     * 20字节的交易哈希的数组，或为空
     * </pre>
     *
     * <code>repeated bytes transaction_hashes = 9;</code>
@ -1573,7 +1573,7 @@ private static final long serialVersionUID = 0L;
    }
    /**
     * <pre>
-     * 32字节的交易哈希的数组，或为空
+     * 20字节的交易哈希的数组，或为空
     * </pre>
     *
     * <code>repeated bytes transaction_hashes = 9;</code>
@ -1589,7 +1589,7 @@ private static final long serialVersionUID = 0L;
    }
    /**
     * <pre>
-     * 32字节的交易哈希的数组，或为空
+     * 20字节的交易哈希的数组，或为空
     * </pre>
     *
     * <code>repeated bytes transaction_hashes = 9;</code>
@ -1604,7 +1604,7 @@ private static final long serialVersionUID = 0L;
    }
    /**
     * <pre>
-     * 32字节的交易哈希的数组，或为空
+     * 20字节的交易哈希的数组，或为空
     * </pre>
     *
     * <code>repeated bytes transaction_hashes = 9;</code>
--- a/src/main/java/bdchain/api/grpc/acchain/BlockOrBuilder.java
+++ b/src/main/java/bdchain/api/grpc/acchain/BlockOrBuilder.java
@ -132,7 +132,7 @@ public interface BlockOrBuilder extends

  /**
   * <pre>
-   * 32字节的交易哈希的数组，或为空
+   * 20字节的交易哈希的数组，或为空
   * </pre>
   *
   * <code>repeated bytes transaction_hashes = 9;</code>
@ -140,7 +140,7 @@ public interface BlockOrBuilder extends
  java.util.List<com.google.protobuf.ByteString> getTransactionHashesList();
  /**
   * <pre>
-   * 32字节的交易哈希的数组，或为空
+   * 20字节的交易哈希的数组，或为空
   * </pre>
   *
   * <code>repeated bytes transaction_hashes = 9;</code>
@ -148,7 +148,7 @@ public interface BlockOrBuilder extends
  int getTransactionHashesCount();
  /**
   * <pre>
-   * 32字节的交易哈希的数组，或为空
+   * 20字节的交易哈希的数组，或为空
   * </pre>
   *
   * <code>repeated bytes transaction_hashes = 9;</code>
--- a/src/main/java/bdchain/api/grpc/txledger/Block.java
+++ b/src/main/java/bdchain/api/grpc/txledger/Block.java
@ -343,7 +343,7 @@ private static final long serialVersionUID = 0L;
  private java.util.List<com.google.protobuf.ByteString> transactionHashes_;
  /**
   * <pre>
-   * 32字节的交易哈希的数组，或为空
+   * 20字节的交易哈希的数组，或为空
   * </pre>
   *
   * <code>repeated bytes transaction_hashes = 9;</code>
@ -354,7 +354,7 @@ private static final long serialVersionUID = 0L;
  }
  /**
   * <pre>
-   * 32字节的交易哈希的数组，或为空
+   * 20字节的交易哈希的数组，或为空
   * </pre>
   *
   * <code>repeated bytes transaction_hashes = 9;</code>
@ -364,7 +364,7 @@ private static final long serialVersionUID = 0L;
  }
  /**
   * <pre>
-   * 32字节的交易哈希的数组，或为空
+   * 20字节的交易哈希的数组，或为空
   * </pre>
   *
   * <code>repeated bytes transaction_hashes = 9;</code>
@ -1629,7 +1629,7 @@ private static final long serialVersionUID = 0L;
    }
    /**
     * <pre>
-     * 32字节的交易哈希的数组，或为空
+     * 20字节的交易哈希的数组，或为空
     * </pre>
     *
     * <code>repeated bytes transaction_hashes = 9;</code>
@ -1641,7 +1641,7 @@ private static final long serialVersionUID = 0L;
    }
    /**
     * <pre>
-     * 32字节的交易哈希的数组，或为空
+     * 20字节的交易哈希的数组，或为空
     * </pre>
     *
     * <code>repeated bytes transaction_hashes = 9;</code>
@ -1651,7 +1651,7 @@ private static final long serialVersionUID = 0L;
    }
    /**
     * <pre>
-     * 32字节的交易哈希的数组，或为空
+     * 20字节的交易哈希的数组，或为空
     * </pre>
     *
     * <code>repeated bytes transaction_hashes = 9;</code>
@ -1661,7 +1661,7 @@ private static final long serialVersionUID = 0L;
    }
    /**
     * <pre>
-     * 32字节的交易哈希的数组，或为空
+     * 20字节的交易哈希的数组，或为空
     * </pre>
     *
     * <code>repeated bytes transaction_hashes = 9;</code>
@ -1678,7 +1678,7 @@ private static final long serialVersionUID = 0L;
    }
    /**
     * <pre>
-     * 32字节的交易哈希的数组，或为空
+     * 20字节的交易哈希的数组，或为空
     * </pre>
     *
     * <code>repeated bytes transaction_hashes = 9;</code>
@ -1694,7 +1694,7 @@ private static final long serialVersionUID = 0L;
    }
    /**
     * <pre>
-     * 32字节的交易哈希的数组，或为空
+     * 20字节的交易哈希的数组，或为空
     * </pre>
     *
     * <code>repeated bytes transaction_hashes = 9;</code>
@ -1709,7 +1709,7 @@ private static final long serialVersionUID = 0L;
    }
    /**
     * <pre>
-     * 32字节的交易哈希的数组，或为空
+     * 20字节的交易哈希的数组，或为空
     * </pre>
     *
     * <code>repeated bytes transaction_hashes = 9;</code>
--- a/src/main/java/bdchain/api/grpc/txledger/BlockOrBuilder.java
+++ b/src/main/java/bdchain/api/grpc/txledger/BlockOrBuilder.java
@ -148,7 +148,7 @@ public interface BlockOrBuilder extends

  /**
   * <pre>
-   * 32字节的交易哈希的数组，或为空
+   * 20字节的交易哈希的数组，或为空
   * </pre>
   *
   * <code>repeated bytes transaction_hashes = 9;</code>
@ -156,7 +156,7 @@ public interface BlockOrBuilder extends
  java.util.List<com.google.protobuf.ByteString> getTransactionHashesList();
  /**
   * <pre>
-   * 32字节的交易哈希的数组，或为空
+   * 20字节的交易哈希的数组，或为空
   * </pre>
   *
   * <code>repeated bytes transaction_hashes = 9;</code>
@ -164,7 +164,7 @@ public interface BlockOrBuilder extends
  int getTransactionHashesCount();
  /**
   * <pre>
-   * 32字节的交易哈希的数组，或为空
+   * 20字节的交易哈希的数组，或为空
   * </pre>
   *
   * <code>repeated bytes transaction_hashes = 9;</code>