diff --git a/build.gradle b/build.gradle index 0139053ad..a4571bb32 100644 --- a/build.gradle +++ b/build.gradle @@ -38,7 +38,7 @@ ext { // integrationTest.mustRunAfter test allprojects { group = 'org.fisco-bcos' - version = '0.1.0-SNAPSHOT' + version = '1.0.0-SNAPSHOT' apply plugin: 'maven' apply plugin: 'maven-publish' apply plugin: 'signing' @@ -119,14 +119,14 @@ subprojects { from sourceSets.main.allSource } - /*task javadocJar(type: Jar, dependsOn: javadoc) { + task javadocJar(type: Jar, dependsOn: javadoc) { classifier = "javadoc" from javadoc.destinationDir - }*/ + } artifacts { archives jar archives sourcesJar - //archives javadocJar + archives javadocJar } } diff --git a/sdk-abi/src/main/java/org/fisco/bcos/sdk/abi/TypeDecoder.java b/sdk-abi/src/main/java/org/fisco/bcos/sdk/abi/TypeDecoder.java index e9710f807..2653b51d5 100644 --- a/sdk-abi/src/main/java/org/fisco/bcos/sdk/abi/TypeDecoder.java +++ b/sdk-abi/src/main/java/org/fisco/bcos/sdk/abi/TypeDecoder.java @@ -168,7 +168,16 @@ static Utf8String decodeUtf8String(String input, int offset) { return new Utf8String(new String(bytes, StandardCharsets.UTF_8)); } - /** Static array length cannot be passed as a type. */ + /** + * Decode the staticArray Static array length cannot be passed as a type + * + * @param input the staticArray need to be decoded + * @param offset the size of the staticArray need to be decoded + * @param type the type of the result + * @param length + * @param + * @return the decoded result + */ @SuppressWarnings("unchecked") public static T decodeStaticArray( String input, int offset, java.lang.reflect.Type type, int length) { diff --git a/sdk-abi/src/main/java/org/fisco/bcos/sdk/abi/datatypes/Int.java b/sdk-abi/src/main/java/org/fisco/bcos/sdk/abi/datatypes/Int.java index adcedddff..874faf38e 100644 --- a/sdk-abi/src/main/java/org/fisco/bcos/sdk/abi/datatypes/Int.java +++ b/sdk-abi/src/main/java/org/fisco/bcos/sdk/abi/datatypes/Int.java @@ -17,7 +17,7 @@ public Int(BigInteger value) { /** * check if value between MIN_INT256 ~ MIN_INT256 * - * @param value + * @param value the value need to be checked * @return true/false */ public boolean validInt(BigInteger value) { diff --git a/sdk-abi/src/main/java/org/fisco/bcos/sdk/abi/datatypes/Uint.java b/sdk-abi/src/main/java/org/fisco/bcos/sdk/abi/datatypes/Uint.java index 6f4faa5bd..d6198d47f 100644 --- a/sdk-abi/src/main/java/org/fisco/bcos/sdk/abi/datatypes/Uint.java +++ b/sdk-abi/src/main/java/org/fisco/bcos/sdk/abi/datatypes/Uint.java @@ -25,7 +25,7 @@ public Uint(BigInteger value) { /** * check if value between 0 ~ MAX_UINT256 * - * @param value + * @param value the value need to be checked * @return true/false */ public boolean validUint(BigInteger value) { diff --git a/sdk-abi/src/main/java/org/fisco/bcos/sdk/abi/tools/ContractAbiUtil.java b/sdk-abi/src/main/java/org/fisco/bcos/sdk/abi/tools/ContractAbiUtil.java index 53463a2d4..61d23acf3 100644 --- a/sdk-abi/src/main/java/org/fisco/bcos/sdk/abi/tools/ContractAbiUtil.java +++ b/sdk-abi/src/main/java/org/fisco/bcos/sdk/abi/tools/ContractAbiUtil.java @@ -33,7 +33,7 @@ public class ContractAbiUtil { public static final String TYPE_EVENT = "event"; /** - * @param contractAbi + * @param contractAbi the contract abi * @return the abi definition */ public static List getFuncABIDefinition(String contractAbi) { diff --git a/sdk-abi/src/main/java/org/fisco/bcos/sdk/abi/wrapper/ABIDefinition.java b/sdk-abi/src/main/java/org/fisco/bcos/sdk/abi/wrapper/ABIDefinition.java index c20ad3666..4809822ac 100644 --- a/sdk-abi/src/main/java/org/fisco/bcos/sdk/abi/wrapper/ABIDefinition.java +++ b/sdk-abi/src/main/java/org/fisco/bcos/sdk/abi/wrapper/ABIDefinition.java @@ -107,8 +107,9 @@ public String getMethodSignatureAsString() { } /** - * method id + * calculate the method id * + * @param cryptoSuite the crypto suite used for hash calculation * @return the method id */ public String getMethodId(CryptoSuite cryptoSuite) { diff --git a/sdk-abi/src/main/java/org/fisco/bcos/sdk/abi/wrapper/ABIDefinitionFactory.java b/sdk-abi/src/main/java/org/fisco/bcos/sdk/abi/wrapper/ABIDefinitionFactory.java index e354d5ffe..f5738ac0f 100644 --- a/sdk-abi/src/main/java/org/fisco/bcos/sdk/abi/wrapper/ABIDefinitionFactory.java +++ b/sdk-abi/src/main/java/org/fisco/bcos/sdk/abi/wrapper/ABIDefinitionFactory.java @@ -18,7 +18,7 @@ public ABIDefinitionFactory(CryptoSuite cryptoSuite) { /** * load ABI and construct ContractABIDefinition. * - * @param abi + * @param abi the abi need to be loaded * @return the contract definition */ public ContractABIDefinition loadABI(String abi) { diff --git a/sdk-abi/src/main/java/org/fisco/bcos/sdk/abi/wrapper/ABIObject.java b/sdk-abi/src/main/java/org/fisco/bcos/sdk/abi/wrapper/ABIObject.java index 5d1bc87c1..1c0b44af9 100644 --- a/sdk-abi/src/main/java/org/fisco/bcos/sdk/abi/wrapper/ABIObject.java +++ b/sdk-abi/src/main/java/org/fisco/bcos/sdk/abi/wrapper/ABIObject.java @@ -435,6 +435,7 @@ public String encode() { /** * decode this object * + * @param input the string to be decoded into ABIObject * @return the decoded ABIObject */ public ABIObject decode(String input) { diff --git a/sdk-abi/src/main/java/org/fisco/bcos/sdk/abi/wrapper/ABIObjectFactory.java b/sdk-abi/src/main/java/org/fisco/bcos/sdk/abi/wrapper/ABIObjectFactory.java index 7025cd5ef..4eaa6875b 100644 --- a/sdk-abi/src/main/java/org/fisco/bcos/sdk/abi/wrapper/ABIObjectFactory.java +++ b/sdk-abi/src/main/java/org/fisco/bcos/sdk/abi/wrapper/ABIObjectFactory.java @@ -41,7 +41,7 @@ private static ABIObject createObject( /** * build ABIObject by raw type name * - * @param rawType + * @param rawType the rawType of the object * @return the built ABIObject */ public static ABIObject buildRawTypeObject(String rawType) { diff --git a/sdk-amop/src/main/java/org/fisco/bcos/sdk/amop/Amop.java b/sdk-amop/src/main/java/org/fisco/bcos/sdk/amop/Amop.java index f8e903618..c246da936 100644 --- a/sdk-amop/src/main/java/org/fisco/bcos/sdk/amop/Amop.java +++ b/sdk-amop/src/main/java/org/fisco/bcos/sdk/amop/Amop.java @@ -33,8 +33,8 @@ public interface Amop { /** * Create a Amop object. * - * @param channel - * @param config + * @param channel the channel to send/receive message + * @param config the config object * @return Amop instance */ static Amop build(Channel channel, ConfigOption config) { @@ -44,7 +44,7 @@ static Amop build(Channel channel, ConfigOption config) { /** * Subscribe a normal topic. * - * @param topicName + * @param topicName the topic name * @param callback callback is called when receive a msg relate to this topic */ void subscribeTopic(String topicName, AmopCallback callback); @@ -52,7 +52,7 @@ static Amop build(Channel channel, ConfigOption config) { /** * Subscribe a private topic which need verify. * - * @param topicName + * @param topicName the topic name * @param privateKeyTool the private key you used to prove your identity. * @param callback callback is called when receive a msg relate to this topic */ @@ -62,7 +62,7 @@ static Amop build(Channel channel, ConfigOption config) { * Config a topic which is need verification, after that user can send message to verified * subscriber. * - * @param topicName + * @param topicName the topic name * @param publicKeyTools the public keys of the target organizations that you want to * communicate with */ @@ -71,22 +71,22 @@ static Amop build(Channel channel, ConfigOption config) { /** * Unsubscribe a topic. * - * @param topicName + * @param topicName the topic name */ void unsubscribeTopic(String topicName); /** * Send amop msg * - * @param content - * @param callback + * @param content the sent message + * @param callback the callback that will be called when receive the AMOP response */ void sendAmopMsg(AmopMsgOut content, ResponseCallback callback); /** * Send amop msg * - * @param content + * @param content the broadcasted AMOP message */ void broadcastAmopMsg(AmopMsgOut content); diff --git a/sdk-amop/src/main/java/org/fisco/bcos/sdk/amop/AmopCallback.java b/sdk-amop/src/main/java/org/fisco/bcos/sdk/amop/AmopCallback.java index e105a7bd2..e4eb264c3 100644 --- a/sdk-amop/src/main/java/org/fisco/bcos/sdk/amop/AmopCallback.java +++ b/sdk-amop/src/main/java/org/fisco/bcos/sdk/amop/AmopCallback.java @@ -21,7 +21,7 @@ public abstract class AmopCallback { /** * receiveAmopMsg is called when get a subscribed topic amop msg. * - * @param msg + * @param msg the received AMOP message * @return response content */ public abstract byte[] receiveAmopMsg(AmopMsgIn msg); diff --git a/sdk-amop/src/main/java/org/fisco/bcos/sdk/amop/topic/TopicManager.java b/sdk-amop/src/main/java/org/fisco/bcos/sdk/amop/topic/TopicManager.java index d8d70ba10..18c85fa36 100644 --- a/sdk-amop/src/main/java/org/fisco/bcos/sdk/amop/topic/TopicManager.java +++ b/sdk-amop/src/main/java/org/fisco/bcos/sdk/amop/topic/TopicManager.java @@ -82,7 +82,11 @@ public void addPrivateTopicCallback(String topicName, AmopCallback callback) { topic2Callback.put(addNeedVerifyTopicPrefix(topicName), callback); } - /** Make sure do not use same name of a normal and a private topic */ + /** + * Make sure do not use same name of a normal and a private topic remove the topic + * + * @param topicName the topic name + */ public void removeTopic(String topicName) { logger.trace("remove topic, topic:{}", topicName); String fullName = topicName2FullName.get(topicName); diff --git a/sdk-core/src/main/java/org/fisco/bcos/sdk/channel/Channel.java b/sdk-core/src/main/java/org/fisco/bcos/sdk/channel/Channel.java index eb05c7e52..3ebdd0603 100644 --- a/sdk-core/src/main/java/org/fisco/bcos/sdk/channel/Channel.java +++ b/sdk-core/src/main/java/org/fisco/bcos/sdk/channel/Channel.java @@ -33,12 +33,12 @@ * @author Maggie */ public interface Channel { - /** * Init channel module * * @param configOption config file path. * @return a channel instance + * @throws ConfigException the configuration exception */ static Channel build(ConfigOption configOption) throws ConfigException { return new ChannelImp(configOption); diff --git a/sdk-core/src/main/java/org/fisco/bcos/sdk/config/Config.java b/sdk-core/src/main/java/org/fisco/bcos/sdk/config/Config.java index 6e7e18a78..9cf0ac7a0 100644 --- a/sdk-core/src/main/java/org/fisco/bcos/sdk/config/Config.java +++ b/sdk-core/src/main/java/org/fisco/bcos/sdk/config/Config.java @@ -17,7 +17,6 @@ import com.moandjiezana.toml.Toml; import java.io.File; -import java.io.IOException; import org.fisco.bcos.sdk.config.exceptions.ConfigException; import org.fisco.bcos.sdk.config.model.ConfigProperty; import org.fisco.bcos.sdk.model.CryptoType; @@ -33,9 +32,9 @@ public static ConfigOption load(String tomlConfigFile) throws ConfigException { return load(tomlConfigFile, CryptoType.ECDSA_TYPE); } /** - * @param tomlConfigFile - * @return ConfigOption - * @throws IOException + * @param tomlConfigFile the toml configuration file path + * @return ConfigOption the configuration object + * @throws ConfigException the configuration exception */ public static ConfigOption load(String tomlConfigFile, int cryptoType) throws ConfigException { // Load a toml config file to an java object diff --git a/sdk-core/src/main/java/org/fisco/bcos/sdk/network/Network.java b/sdk-core/src/main/java/org/fisco/bcos/sdk/network/Network.java index bcdf74d79..7e5b9e294 100644 --- a/sdk-core/src/main/java/org/fisco/bcos/sdk/network/Network.java +++ b/sdk-core/src/main/java/org/fisco/bcos/sdk/network/Network.java @@ -43,15 +43,15 @@ static Network build(ConfigOption configOption, MsgHandler handler) throws Confi /** * Broadcast message * - * @param out + * @param out the message to broadcast */ void broadcast(Message out); /** * Send to peer * - * @param out - * @param peerIpPort + * @param out the sent message + * @param peerIpPort the node to receive the message */ void sendToPeer(Message out, String peerIpPort) throws NetworkException; @@ -65,28 +65,28 @@ static Network build(ConfigOption configOption, MsgHandler handler) throws Confi /** * Start connect peers * - * @throws NetworkException + * @throws NetworkException start the network exceptioned */ void start() throws NetworkException; /** * Get available connection context * - * @return Map String for the IP:Port of a peer + * @return the map between the peer endpoint and the channelHandlerContext */ Map getAvailableConnections(); /** * Remove the connection if version negotiation failed * - * @param peerIpPort + * @param peerIpPort the peer connection to be removed */ void removeConnection(String peerIpPort); /** * Set thread pool * - * @param threadPool + * @param threadPool the threadpool to handle the network message */ void setMsgHandleThreadPool(ExecutorService threadPool); diff --git a/sdk-demo/src/main/java/org/fisco/bcos/sdk/demo/amop/tool/AmopPublisher.java b/sdk-demo/src/main/java/org/fisco/bcos/sdk/demo/amop/tool/AmopPublisher.java index d79a6c1f8..b37ee9f67 100644 --- a/sdk-demo/src/main/java/org/fisco/bcos/sdk/demo/amop/tool/AmopPublisher.java +++ b/sdk-demo/src/main/java/org/fisco/bcos/sdk/demo/amop/tool/AmopPublisher.java @@ -18,7 +18,7 @@ public class AmopPublisher { /** * @param args topicName, isBroadcast, Content(Content you want to send out), Count(how many msg * you want to send out) - * @throws Exception + * @throws Exception AMOP publish exceptioned */ public static void main(String[] args) throws Exception { if (args.length < parameterNum) { diff --git a/sdk-demo/src/main/java/org/fisco/bcos/sdk/demo/amop/tool/AmopPublisherFile.java b/sdk-demo/src/main/java/org/fisco/bcos/sdk/demo/amop/tool/AmopPublisherFile.java index 390062432..e1bf80feb 100644 --- a/sdk-demo/src/main/java/org/fisco/bcos/sdk/demo/amop/tool/AmopPublisherFile.java +++ b/sdk-demo/src/main/java/org/fisco/bcos/sdk/demo/amop/tool/AmopPublisherFile.java @@ -21,8 +21,8 @@ public class AmopPublisherFile { .getPath(); /** - * @param args topicName, isBroadcast: true/false, fileName, count, timeout - * @throws Exception + * @param args topicName, isBroadcast: true/false, fileName, count + * @throws Exception AMOP publish exceptioned */ public static void main(String[] args) throws Exception { if (args.length < parameterNum) { diff --git a/sdk-demo/src/main/java/org/fisco/bcos/sdk/demo/amop/tool/AmopPublisherPrivate.java b/sdk-demo/src/main/java/org/fisco/bcos/sdk/demo/amop/tool/AmopPublisherPrivate.java index 56469f22c..273a62a63 100644 --- a/sdk-demo/src/main/java/org/fisco/bcos/sdk/demo/amop/tool/AmopPublisherPrivate.java +++ b/sdk-demo/src/main/java/org/fisco/bcos/sdk/demo/amop/tool/AmopPublisherPrivate.java @@ -22,7 +22,7 @@ public class AmopPublisherPrivate { /** * @param args topicName, pubKey1, pubKey2, isBroadcast: true/false, content, count. if only one * public key please fill pubKey2 with null - * @throws Exception + * @throws Exception AMOP exceptioned */ public static void main(String[] args) throws Exception { if (args.length < parameterNum) { diff --git a/sdk-demo/src/main/java/org/fisco/bcos/sdk/demo/amop/tool/AmopSubscriberPrivate.java b/sdk-demo/src/main/java/org/fisco/bcos/sdk/demo/amop/tool/AmopSubscriberPrivate.java index 201f6431c..ddac93b18 100644 --- a/sdk-demo/src/main/java/org/fisco/bcos/sdk/demo/amop/tool/AmopSubscriberPrivate.java +++ b/sdk-demo/src/main/java/org/fisco/bcos/sdk/demo/amop/tool/AmopSubscriberPrivate.java @@ -16,7 +16,7 @@ public class AmopSubscriberPrivate { /** * @param args topic, privateKeyFile, password(Option) - * @throws Exception + * @throws Exception AMOP exceptioned */ public static void main(String[] args) throws Exception { if (args.length < 2) { diff --git a/sdk-service/src/main/java/org/fisco/bcos/sdk/client/Client.java b/sdk-service/src/main/java/org/fisco/bcos/sdk/client/Client.java index 58530d6b3..1bd358421 100644 --- a/sdk-service/src/main/java/org/fisco/bcos/sdk/client/Client.java +++ b/sdk-service/src/main/java/org/fisco/bcos/sdk/client/Client.java @@ -140,7 +140,7 @@ static Client build(Channel channel) { * Ledger operation: async send transaction * * @param signedTransactionData - * @param callback + * @param callback the callback that will be called when receive the response */ void sendRawTransactionAsync( String signedTransactionData, RespCallback callback); @@ -157,7 +157,7 @@ void sendRawTransactionAsync( * Ledger operation: async call contract functions without sending transaction * * @param transaction - * @param callback + * @param callback the callback that will be called when receive the response */ void callAsync(Transaction transaction, RespCallback callback); @@ -173,7 +173,7 @@ void sendRawTransactionAsync( * Ledger operation: async send transaction and get proof * * @param signedTransactionData - * @param callback + * @param callback the callback that will be called when receive the response */ void sendRawTransactionAndGetProofAsync( String signedTransactionData, RespCallback callback); @@ -190,7 +190,7 @@ void sendRawTransactionAndGetProofAsync( /** * Ledger operation: async get block number * - * @param callback + * @param callback the callback that will be called when receive the response */ void getBlockNumberAsync(RespCallback callback); @@ -206,7 +206,7 @@ void sendRawTransactionAndGetProofAsync( * Ledger operation: async get code * * @param address - * @param callback + * @param callback the callback that will be called when receive the response */ void getCodeAsync(String address, RespCallback callback); @@ -220,7 +220,7 @@ void sendRawTransactionAndGetProofAsync( /** * Ledger operation: async get total transaction count * - * @param callback + * @param callback the callback that will be called when receive the response */ void getTotalTransactionCountAsync(RespCallback callback); @@ -238,7 +238,7 @@ void sendRawTransactionAndGetProofAsync( * * @param blockHash * @param returnFullTransactionObjects - * @param callback + * @param callback the callback that will be called when receive the response */ void getBlockByHashAsync( String blockHash, @@ -259,7 +259,7 @@ void getBlockByHashAsync( * * @param blockNumber * @param returnFullTransactionObjects - * @param callback + * @param callback the callback that will be called when receive the response */ void getBlockByNumberAsync( BigInteger blockNumber, @@ -278,7 +278,7 @@ void getBlockByNumberAsync( * Ledger operation: async get block hash by block number * * @param blockNumber - * @param callback + * @param callback the callback that will be called when receive the response */ void getBlockHashByNumberAsync(BigInteger blockNumber, RespCallback callback); @@ -327,7 +327,7 @@ void getBlockHeaderByNumberAsync( * Ledger operation: async get trnasaction by hash * * @param transactionHash - * @param callback + * @param callback the callback that will be called when receive the response */ void getTransactionByHashAsync(String transactionHash, RespCallback callback); @@ -343,7 +343,7 @@ void getBlockHeaderByNumberAsync( * Ledger operation: async get transaction and proof by hash * * @param transactionHash - * @param callback + * @param callback the callback that will be called when receive the response */ void getTransactionByHashWithProofAsync( String transactionHash, RespCallback callback); @@ -363,7 +363,7 @@ BcosTransaction getTransactionByBlockNumberAndIndex( * * @param blockNumber * @param transactionIndex - * @param callback + * @param callback the callback that will be called when receive the response */ void getTransactionByBlockNumberAndIndexAsync( BigInteger blockNumber, @@ -388,7 +388,7 @@ void getTransactionByBlockHashAndIndexAsync( * Ledger operation: async get transaction receipt by transaction hash * * @param transactionHash - * @param callback + * @param callback the callback that will be called when receive the response */ void getTransactionReceiptAsync( String transactionHash, RespCallback callback); @@ -405,7 +405,7 @@ void getTransactionReceiptAsync( * Ledger operation: async get transaction receipt and proof by transaction hash * * @param transactionHash - * @param callback + * @param callback the callback that will be called when receive the response */ void getTransactionReceiptByHashWithProofAsync( String transactionHash, RespCallback callback); @@ -420,7 +420,7 @@ void getTransactionReceiptByHashWithProofAsync( /** * Ledger operation: async get pending transactions in transaction pool * - * @param callback + * @param callback the callback that will be called when receive the response */ void getPendingTransactionAsync(RespCallback callback); @@ -434,7 +434,7 @@ void getTransactionReceiptByHashWithProofAsync( /** * Ledger operation: async get pending transaction size * - * @param callback + * @param callback the callback that will be called when receive the response */ void getPendingTxSizeAsync(RespCallback callback); @@ -470,7 +470,7 @@ GenerateGroup generateGroup( * @param enableFreeStorage * @param nodeList * @param peerIpPort send to the specific peer - * @param callback + * @param callback the callback that will be called when receive the response */ void generateGroupAsync( Integer groupId, @@ -494,7 +494,7 @@ void generateGroupAsync( * * @param groupId * @param peerIpPort - * @param callback + * @param callback the callback that will be called when receive the response */ void startGroupAsync(Integer groupId, String peerIpPort, RespCallback callback); @@ -512,7 +512,7 @@ void generateGroupAsync( * * @param groupId * @param peerIpPort - * @param callback + * @param callback the callback that will be called when receive the response */ void stopGroupAsync(Integer groupId, String peerIpPort, RespCallback callback); @@ -530,7 +530,7 @@ void generateGroupAsync( * * @param groupId * @param peerIpPort - * @param callback + * @param callback the callback that will be called when receive the response */ void removeGroupAsync(Integer groupId, String peerIpPort, RespCallback callback); @@ -548,7 +548,7 @@ void generateGroupAsync( * * @param groupId * @param peerIpPort - * @param callback + * @param callback the callback that will be called when receive the response */ void recoverGroupAsync(Integer groupId, String peerIpPort, RespCallback callback); @@ -573,16 +573,16 @@ void generateGroupAsync( * Group operation: async query group status * * @param groupId - * @param callback + * @param callback the callback that will be called when receive the response */ void queryGroupStatusAsync(Integer groupId, RespCallback callback); /** * Group operation: async query group status * - * @param groupId - * @param peerIpPort - * @param callback + * @param groupId the group that the request sent to + * @param peerIpPort the node that the request sent to + * @param callback the callback that will be called when receive the response */ void queryGroupStatusAsync( Integer groupId, String peerIpPort, RespCallback callback); @@ -590,7 +590,7 @@ void queryGroupStatusAsync( /** * Group operation: get peer group list * - * @return grouplist + * @return group list */ GroupList getGroupList(); @@ -598,14 +598,14 @@ void queryGroupStatusAsync( * Group operation: get peer group list * * @param peerIpPort send to the specific peer - * @return grouplist + * @return group list */ GroupList getGroupList(String peerIpPort); /** * Group operation: async get peer group list * - * @param callback + * @param callback the callback that will be called when receive the response */ void getGroupListAsync(RespCallback callback); @@ -613,7 +613,7 @@ void queryGroupStatusAsync( * Group operation: async get peer group list * * @param peerIpPort send to the specific peer - * @param callback + * @param callback the callback that will be called when receive the response */ void getGroupListAsync(String peerIpPort, RespCallback callback); @@ -635,15 +635,15 @@ void queryGroupStatusAsync( /** * Group operation: async get group peers * - * @param callback + * @param callback the callback that will be called when receive the response */ void getGroupPeersAsync(RespCallback callback); /** * Group operation: async get group peers * - * @param peerIpPort - * @param callback + * @param peerIpPort the target node of the request + * @param callback the callback that will be called when receive the response */ void getGroupPeersAsync(String peerIpPort, RespCallback callback); @@ -657,6 +657,7 @@ void queryGroupStatusAsync( /** * Peer operation: get connected peers * + * @param endpoint: the target node that receive the request * @return peers */ Peers getPeers(String endpoint); diff --git a/sdk-transaction/src/main/java/org/fisco/bcos/sdk/transaction/builder/TransactionBuilderService.java b/sdk-transaction/src/main/java/org/fisco/bcos/sdk/transaction/builder/TransactionBuilderService.java index f9d1cf39d..8c656f889 100644 --- a/sdk-transaction/src/main/java/org/fisco/bcos/sdk/transaction/builder/TransactionBuilderService.java +++ b/sdk-transaction/src/main/java/org/fisco/bcos/sdk/transaction/builder/TransactionBuilderService.java @@ -25,7 +25,11 @@ public class TransactionBuilderService implements TransactionBuilderInterface { private SecureRandom secureRandom = new SecureRandom(); private Client client; - /** @param client */ + /** + * create TransactionBuilderService + * + * @param client the client object + */ public TransactionBuilderService(Client client) { super(); this.client = client; diff --git a/sdk-transaction/src/main/java/org/fisco/bcos/sdk/transaction/codec/decode/RevertMessageParser.java b/sdk-transaction/src/main/java/org/fisco/bcos/sdk/transaction/codec/decode/RevertMessageParser.java index a6c93ec8d..e3dae29ed 100644 --- a/sdk-transaction/src/main/java/org/fisco/bcos/sdk/transaction/codec/decode/RevertMessageParser.java +++ b/sdk-transaction/src/main/java/org/fisco/bcos/sdk/transaction/codec/decode/RevertMessageParser.java @@ -69,8 +69,8 @@ public static boolean isOutputStartWithRevertMethod(String output) { } /** - * @param status - * @param output + * @param status the status of the receipt + * @param output the output of the receipt * @return true/false */ public static boolean hasRevertMessage(String status, String output) { @@ -86,8 +86,8 @@ public static boolean hasRevertMessage(String status, String output) { } /** - * @param status - * @param output + * @param status the transaction receipt status + * @param output the output of the transaction receipt * @return the resolved revert message information */ public static Tuple2 tryResolveRevertMessage(String status, String output) { @@ -117,7 +117,7 @@ public static Tuple2 tryResolveRevertMessage(String status, Str } /** - * @param receipt + * @param receipt the receipt need to be parsed * @return the resolved revert message information */ public static Tuple2 tryResolveRevertMessage(TransactionReceipt receipt) { diff --git a/sdk-transaction/src/main/java/org/fisco/bcos/sdk/transaction/codec/decode/TransactionDecoderService.java b/sdk-transaction/src/main/java/org/fisco/bcos/sdk/transaction/codec/decode/TransactionDecoderService.java index 265a0f48a..24ad678f6 100644 --- a/sdk-transaction/src/main/java/org/fisco/bcos/sdk/transaction/codec/decode/TransactionDecoderService.java +++ b/sdk-transaction/src/main/java/org/fisco/bcos/sdk/transaction/codec/decode/TransactionDecoderService.java @@ -48,7 +48,11 @@ public class TransactionDecoderService implements TransactionDecoderInterface { private final ABICodec abiCodec; private EventEncoder eventEncoder; - /** @param cryptoSuite */ + /** + * create TransactionDecoderService + * + * @param cryptoSuite the cryptoSuite used to calculate hash and signatures + */ public TransactionDecoderService(CryptoSuite cryptoSuite) { super(); this.cryptoSuite = cryptoSuite; diff --git a/sdk-transaction/src/main/java/org/fisco/bcos/sdk/transaction/manager/AssembleTransactionProcessor.java b/sdk-transaction/src/main/java/org/fisco/bcos/sdk/transaction/manager/AssembleTransactionProcessor.java index 1b9e139ef..b794b4c0c 100644 --- a/sdk-transaction/src/main/java/org/fisco/bcos/sdk/transaction/manager/AssembleTransactionProcessor.java +++ b/sdk-transaction/src/main/java/org/fisco/bcos/sdk/transaction/manager/AssembleTransactionProcessor.java @@ -123,14 +123,14 @@ public CompletableFuture deployAsync( } /** - * Deploy by bin & abi files. Should init with contractLoader. + * Deploy by bin and abi files. Should init with contractLoader. * - * @param contractName - * @param args + * @param contractName the contract name + * @param args the params when deploy a contract * @return the transaction response - * @throws TransactionBaseException - * @throws ABICodecException - * @throws NoSuchTransactionFileException + * @throws TransactionBaseException send transaction exceptioned + * @throws ABICodecException abi encode exceptioned + * @throws NoSuchTransactionFileException Files related to abi codec were not found */ @Override public TransactionResponse deployByContractLoader(String contractName, List args) diff --git a/sdk-transaction/src/main/java/org/fisco/bcos/sdk/transaction/model/bo/AbiInfo.java b/sdk-transaction/src/main/java/org/fisco/bcos/sdk/transaction/model/bo/AbiInfo.java index 1ab928e75..7d552260d 100644 --- a/sdk-transaction/src/main/java/org/fisco/bcos/sdk/transaction/model/bo/AbiInfo.java +++ b/sdk-transaction/src/main/java/org/fisco/bcos/sdk/transaction/model/bo/AbiInfo.java @@ -11,8 +11,10 @@ public class AbiInfo { private Map contractConstructAbi; /** - * @param contractFuncAbis - * @param contractConstructAbi + * create the AbiInfo object + * + * @param contractFuncAbis maps between the contract name and the contract abi + * @param contractConstructAbi maps between the contract name and the constructor abi */ public AbiInfo( Map> contractFuncAbis, diff --git a/sdk-transaction/src/main/java/org/fisco/bcos/sdk/transaction/model/bo/BinInfo.java b/sdk-transaction/src/main/java/org/fisco/bcos/sdk/transaction/model/bo/BinInfo.java index 03df89422..bfdcadcaf 100644 --- a/sdk-transaction/src/main/java/org/fisco/bcos/sdk/transaction/model/bo/BinInfo.java +++ b/sdk-transaction/src/main/java/org/fisco/bcos/sdk/transaction/model/bo/BinInfo.java @@ -6,6 +6,11 @@ public class BinInfo { private Map bins; /** @param bins */ + /** + * the binary information of the contracts + * + * @param bins maps between contract name and the binary + */ public BinInfo(Map bins) { super(); this.bins = bins; diff --git a/sdk-transaction/src/main/java/org/fisco/bcos/sdk/transaction/model/dto/CallRequest.java b/sdk-transaction/src/main/java/org/fisco/bcos/sdk/transaction/model/dto/CallRequest.java index 3bb8dacc7..7060469cc 100644 --- a/sdk-transaction/src/main/java/org/fisco/bcos/sdk/transaction/model/dto/CallRequest.java +++ b/sdk-transaction/src/main/java/org/fisco/bcos/sdk/transaction/model/dto/CallRequest.java @@ -34,10 +34,10 @@ public CallRequest(String from, String to, String encodedFunction) { } /** - * @param from - * @param to - * @param encodedFunction - * @param abi + * @param from the transaction sender + * @param to the contract address + * @param encodedFunction the encoded methods and params + * @param abi the abi definition of the function */ public CallRequest(String from, String to, String encodedFunction, ABIDefinition abi) { this(from, to, encodedFunction); diff --git a/sdk-transaction/src/main/java/org/fisco/bcos/sdk/transaction/model/dto/CommonResponse.java b/sdk-transaction/src/main/java/org/fisco/bcos/sdk/transaction/model/dto/CommonResponse.java index ec4d1b7cc..32ac334a6 100644 --- a/sdk-transaction/src/main/java/org/fisco/bcos/sdk/transaction/model/dto/CommonResponse.java +++ b/sdk-transaction/src/main/java/org/fisco/bcos/sdk/transaction/model/dto/CommonResponse.java @@ -28,8 +28,8 @@ public CommonResponse() { } /** - * @param returnCode - * @param returnMessage + * @param returnCode the return code of the response + * @param returnMessage the return message of the response */ public CommonResponse(int returnCode, String returnMessage) { super(); diff --git a/sdk-transaction/src/main/java/org/fisco/bcos/sdk/transaction/model/dto/TransactionResponse.java b/sdk-transaction/src/main/java/org/fisco/bcos/sdk/transaction/model/dto/TransactionResponse.java index 51a647b67..7fc4d292f 100644 --- a/sdk-transaction/src/main/java/org/fisco/bcos/sdk/transaction/model/dto/TransactionResponse.java +++ b/sdk-transaction/src/main/java/org/fisco/bcos/sdk/transaction/model/dto/TransactionResponse.java @@ -38,8 +38,8 @@ public TransactionResponse() { } /** - * @param returnCode - * @param returnMessage + * @param returnCode the return code of the receipt + * @param returnMessage the return message of the receipt */ public TransactionResponse(int returnCode, String returnMessage) { super(returnCode, returnMessage); diff --git a/sdk-transaction/src/main/java/org/fisco/bcos/sdk/transaction/model/exception/NoSuchTransactionFileException.java b/sdk-transaction/src/main/java/org/fisco/bcos/sdk/transaction/model/exception/NoSuchTransactionFileException.java index 4d8fec126..1d0bf3207 100644 --- a/sdk-transaction/src/main/java/org/fisco/bcos/sdk/transaction/model/exception/NoSuchTransactionFileException.java +++ b/sdk-transaction/src/main/java/org/fisco/bcos/sdk/transaction/model/exception/NoSuchTransactionFileException.java @@ -20,7 +20,6 @@ * NoSuchTransactionFileException @Description: NoSuchTransactionFileException * * @author maojiayu - * @data Sep 15, 2020 9:11:01 PM */ public class NoSuchTransactionFileException extends TransactionBaseException { private static final long serialVersionUID = -3082997842343754327L; diff --git a/sdk-transaction/src/main/java/org/fisco/bcos/sdk/transaction/model/exception/TransactionRetCodeConstants.java b/sdk-transaction/src/main/java/org/fisco/bcos/sdk/transaction/model/exception/TransactionRetCodeConstants.java index 843218b66..51b7629e3 100644 --- a/sdk-transaction/src/main/java/org/fisco/bcos/sdk/transaction/model/exception/TransactionRetCodeConstants.java +++ b/sdk-transaction/src/main/java/org/fisco/bcos/sdk/transaction/model/exception/TransactionRetCodeConstants.java @@ -20,7 +20,6 @@ * TransactionRetCode @Description: TransactionRetCode * * @author maojiayu - * @data Sep 15, 2020 9:22:21 PM */ public class TransactionRetCodeConstants { diff --git a/sdk-transaction/src/main/java/org/fisco/bcos/sdk/transaction/pusher/TransactionPusherService.java b/sdk-transaction/src/main/java/org/fisco/bcos/sdk/transaction/pusher/TransactionPusherService.java index 5da7f9a09..8e9db8650 100644 --- a/sdk-transaction/src/main/java/org/fisco/bcos/sdk/transaction/pusher/TransactionPusherService.java +++ b/sdk-transaction/src/main/java/org/fisco/bcos/sdk/transaction/pusher/TransactionPusherService.java @@ -25,7 +25,11 @@ public class TransactionPusherService implements TransactionPusherInterface { private Client client; - /** @param client */ + /** + * create the TransactionPusherService + * + * @param client the client object responsible for send transaction + */ public TransactionPusherService(Client client) { super(); this.client = client; diff --git a/sdk-transaction/src/main/java/org/fisco/bcos/sdk/transaction/signer/TransactionSignerServcie.java b/sdk-transaction/src/main/java/org/fisco/bcos/sdk/transaction/signer/TransactionSignerServcie.java index 0d45a832b..c6158c82c 100644 --- a/sdk-transaction/src/main/java/org/fisco/bcos/sdk/transaction/signer/TransactionSignerServcie.java +++ b/sdk-transaction/src/main/java/org/fisco/bcos/sdk/transaction/signer/TransactionSignerServcie.java @@ -19,9 +19,12 @@ import org.fisco.bcos.sdk.crypto.signature.SignatureResult; public class TransactionSignerServcie implements TransactionSignerInterface { - private Signature signature; - /** @param signature */ + /** + * create the TransactionSignerService according the the given signature + * + * @param signature the signature + */ public TransactionSignerServcie(Signature signature) { super(); this.signature = signature;