All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.fisco.bcos.sdk.v3.client.Client Maven / Gradle / Ivy

/*
 * Copyright 2014-2020  [fisco-dev]
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 *
 */

package org.fisco.bcos.sdk.v3.client;

import java.math.BigInteger;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import org.fisco.bcos.sdk.jni.BcosSDKJniObj;
import org.fisco.bcos.sdk.v3.client.protocol.request.LogFilterRequest;
import org.fisco.bcos.sdk.v3.client.protocol.request.Transaction;
import org.fisco.bcos.sdk.v3.client.protocol.response.Abi;
import org.fisco.bcos.sdk.v3.client.protocol.response.BcosBlock;
import org.fisco.bcos.sdk.v3.client.protocol.response.BcosGroupInfo;
import org.fisco.bcos.sdk.v3.client.protocol.response.BcosGroupInfoList;
import org.fisco.bcos.sdk.v3.client.protocol.response.BcosGroupList;
import org.fisco.bcos.sdk.v3.client.protocol.response.BcosGroupNodeInfo;
import org.fisco.bcos.sdk.v3.client.protocol.response.BcosTransaction;
import org.fisco.bcos.sdk.v3.client.protocol.response.BcosTransactionReceipt;
import org.fisco.bcos.sdk.v3.client.protocol.response.BlockHash;
import org.fisco.bcos.sdk.v3.client.protocol.response.BlockNumber;
import org.fisco.bcos.sdk.v3.client.protocol.response.Call;
import org.fisco.bcos.sdk.v3.client.protocol.response.Code;
import org.fisco.bcos.sdk.v3.client.protocol.response.ConsensusStatus;
import org.fisco.bcos.sdk.v3.client.protocol.response.GroupPeers;
import org.fisco.bcos.sdk.v3.client.protocol.response.LogFilterResponse;
import org.fisco.bcos.sdk.v3.client.protocol.response.LogWrapper;
import org.fisco.bcos.sdk.v3.client.protocol.response.ObserverList;
import org.fisco.bcos.sdk.v3.client.protocol.response.PbftView;
import org.fisco.bcos.sdk.v3.client.protocol.response.Peers;
import org.fisco.bcos.sdk.v3.client.protocol.response.PendingTxSize;
import org.fisco.bcos.sdk.v3.client.protocol.response.SealerList;
import org.fisco.bcos.sdk.v3.client.protocol.response.SyncStatus;
import org.fisco.bcos.sdk.v3.client.protocol.response.SystemConfig;
import org.fisco.bcos.sdk.v3.client.protocol.response.TotalTransactionCount;
import org.fisco.bcos.sdk.v3.client.protocol.response.UninstallLogFilter;
import org.fisco.bcos.sdk.v3.config.ConfigOption;
import org.fisco.bcos.sdk.v3.crypto.CryptoSuite;
import org.fisco.bcos.sdk.v3.model.EnumNodeVersion;
import org.fisco.bcos.sdk.v3.model.callback.RespCallback;
import org.fisco.bcos.sdk.v3.model.callback.TransactionCallback;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * This is the interface of client module.
 *
 * @author Maggie
 */
public interface Client {
    Logger logger = LoggerFactory.getLogger(Client.class);

    /**
     * Build a client instance GroupId is identified, all interfaces are available
     *
     * @param configOption the config
     * @return a client instance
     */
    static Client build(ConfigOption configOption) {
        logger.info("build, configOption: {}", configOption);
        return build(null, configOption);
    }

    /**
     * Build a client instance GroupId is identified, all interfaces are available
     *
     * @param groupId the group info
     * @param configOption the config
     * @return a client instance
     */
    static Client build(String groupId, ConfigOption configOption) {
        logger.info("build, groupID: {}, configOption: {}", groupId, configOption);
        long nativePointer = BcosSDKJniObj.create(configOption.getJniConfig());
        return build(groupId, configOption, nativePointer);
    }

    /**
     * Build a client instance GroupId is identified, all interfaces are available, with specific
     * jniRPC
     *
     * @param groupId the group info
     * @param configOption the config
     * @param nativePointer jni impl native handler
     * @return a client instance
     */
    static Client build(String groupId, ConfigOption configOption, long nativePointer) {
        logger.info(
                "build, groupID: {}, configOption: {}, nativePointer: {}",
                groupId,
                configOption,
                nativePointer);
        return new ClientImpl(groupId, configOption, nativePointer);
    }

    /** @return native pointer */
    long getNativePointer();

    String getExtraData();

    void setExtraData(String extraData);

    /**
     * Get CryptoSuite
     *
     * @return the CryptoSuite
     */
    CryptoSuite getCryptoSuite();

    /**
     * Get crypto type
     *
     * @return the CryptoType, e.g. ECDSA_TYPE
     */
    Integer getCryptoType();

    /**
     * Whether is wasm exec env
     *
     * @return true when wasm exec env
     */
    Boolean isWASM();

    /**
     * Whether is auth check in chain
     *
     * @return true when chain in auth mode
     */
    Boolean isAuthCheck();

    /**
     * Whether is committee enable in chain
     *
     * @return true when chain can use committee
     */
    Boolean isEnableCommittee();

    Boolean isSerialExecute();

    /**
     * get groupId of the client
     *
     * @return the groupId
     */
    String getGroup();

    /**
     * get groupId of the client
     *
     * @return the groupId
     */
    String getChainId();

    /** @return return client config */
    ConfigOption getConfigOption();

    // ------------------------- rpc interface begin ------------------------------------------

    /**
     * Ledger operation: send transaction
     *
     * @param signedTransactionData transaction string
     * @param withProof whether contains merkle proof or not
     * @return Transaction receipt
     */
    BcosTransactionReceipt sendTransaction(String signedTransactionData, boolean withProof);

    /**
     * Ledger operation: send transaction
     *
     * @param node the node rpc request send to
     * @param signedTransactionData transaction string
     * @param withProof whether contains merkle proof or not
     * @return Transaction receipt
     */
    BcosTransactionReceipt sendTransaction(
            String node, String signedTransactionData, boolean withProof);

    /**
     * Ledger operation: async send transaction
     *
     * @param signedTransactionData transaction string
     * @param withProof whether contains merkle proof or not
     * @param callback the callback that will be called when receive the response
     */
    void sendTransactionAsync(
            String signedTransactionData, boolean withProof, TransactionCallback callback);

    /**
     * Ledger operation: async send transaction
     *
     * @param node the node rpc request send to
     * @param signedTransactionData transaction string
     * @param withProof whether contains merkle proof or not
     * @param callback the callback that will be called when receive the response
     */
    void sendTransactionAsync(
            String node,
            String signedTransactionData,
            boolean withProof,
            TransactionCallback callback);

    /**
     * Ledger operation: call contract functions without sending transaction
     *
     * @param transaction transaction instance
     * @return Call
     */
    Call call(Transaction transaction);

    /**
     * Ledger operation: call contract functions without sending transaction
     *
     * @param node the node rpc request send to
     * @param transaction transaction instance
     * @return Call
     */
    Call call(String node, Transaction transaction);

    /**
     * Ledger operation: call contract functions without sending transaction
     *
     * @param transaction transaction instance
     * @param sign the sign of call data hash(to+data)
     * @return Call
     */
    Call call(Transaction transaction, String sign);

    /**
     * Ledger operation: call contract functions without sending transaction
     *
     * @param node the node rpc request send to
     * @param transaction transaction instance
     * @param sign the sign of call data hash(to+data)
     * @return Call
     */
    Call call(String node, Transaction transaction, String sign);

    /**
     * Ledger operation: async call contract functions without sending transaction
     *
     * @param transaction transaction instance
     * @param callback the callback that will be called when receive the response
     */
    void callAsync(Transaction transaction, RespCallback callback);

    /**
     * Ledger operation: async call contract functions without sending transaction
     *
     * @param node the node rpc request send to
     * @param transaction transaction instance
     * @param callback the callback that will be called when receive the response
     */
    void callAsync(String node, Transaction transaction, RespCallback callback);

    /**
     * Ledger operation: async call contract functions without sending transaction
     *
     * @param transaction transaction instance
     * @param sign the sign of call data hash(to+data)
     * @param callback the callback that will be called when receive the response
     */
    void callAsync(Transaction transaction, String sign, RespCallback callback);

    /**
     * Ledger operation: async call contract functions without sending transaction
     *
     * @param node the node rpc request send to
     * @param transaction transaction instance
     * @param sign the sign of call data hash(to+data)
     * @param callback the callback that will be called when receive the response
     */
    void callAsync(String node, Transaction transaction, String sign, RespCallback callback);

    /**
     * Ledger operation: get block number
     *
     * @return block number
     */
    BlockNumber getBlockNumber();

    /**
     * Ledger operation: get block number
     *
     * @param node the node rpc request send to
     * @return block number
     */
    BlockNumber getBlockNumber(String node);

    /**
     * Ledger operation: async get block number
     *
     * @param callback the callback that will be called when receive the response
     */
    void getBlockNumberAsync(RespCallback callback);

    /**
     * Ledger operation: async get block number
     *
     * @param node the node rpc request send to
     * @param callback the callback that will be called when receive the response
     */
    void getBlockNumberAsync(String node, RespCallback callback);

    /**
     * Ledger operation: get code
     *
     * @param address the address string
     * @return a code instance
     */
    Code getCode(String address);

    /**
     * Ledger operation: get code
     *
     * @param node the node rpc request send to
     * @param address the address string
     * @return a code instance
     */
    Code getCode(String node, String address);

    /**
     * Ledger operation: async get code
     *
     * @param address the address string
     * @param callback the callback that will be called when receive the response
     */
    void getCodeAsync(String address, RespCallback callback);

    /**
     * Ledger operation: async get code
     *
     * @param node the node rpc request send to
     * @param address the address string
     * @param callback the callback that will be called when receive the response
     */
    void getCodeAsync(String node, String address, RespCallback callback);

    /**
     * Scheduler: get abi
     *
     * @param address the address string
     * @return abi string
     */
    Abi getABI(String address);

    /**
     * Ledger operation: get abi
     *
     * @param node the node rpc request send to
     * @param address the address string
     * @return a code instance
     */
    Abi getABI(String node, String address);

    /**
     * Ledger operation: async get abi
     *
     * @param address the address string
     * @param callback the callback that will be called when receive the response
     */
    void getABIAsync(String address, RespCallback callback);

    /**
     * Ledger operation: async get abi
     *
     * @param node the node rpc request send to
     * @param address the address string
     * @param callback the callback that will be called when receive the response
     */
    void getABIAsync(String node, String address, RespCallback callback);

    /**
     * Ledger operation: get total transaction coun
     *
     * @return TotalTransactionCount
     */
    TotalTransactionCount getTotalTransactionCount();

    /**
     * Ledger operation: get total transaction coun
     *
     * @param node the node rpc request send to
     * @return TotalTransactionCount
     */
    TotalTransactionCount getTotalTransactionCount(String node);

    /**
     * Ledger operation: async get total transaction count
     *
     * @param callback the callback that will be called when receive the response
     */
    void getTotalTransactionCountAsync(RespCallback callback);

    /**
     * Ledger operation: async get total transaction count
     *
     * @param node the node rpc request send to
     * @param callback the callback that will be called when receive the response
     */
    void getTotalTransactionCountAsync(String node, RespCallback callback);

    /**
     * Ledger operation: get block by hash
     *
     * @param blockHash the hashcode of the block
     * @param onlyHeader if true then only return block header
     * @param onlyTxHash the boolean define the tx is full or not
     * @return a block
     */
    BcosBlock getBlockByHash(String blockHash, boolean onlyHeader, boolean onlyTxHash);

    /**
     * Ledger operation: get block by hash
     *
     * @param node the node rpc request send to
     * @param blockHash the hashcode of the block
     * @param onlyHeader if true then only return block header
     * @param onlyTxHash the boolean define the tx is full or not
     * @return a block
     */
    BcosBlock getBlockByHash(String node, String blockHash, boolean onlyHeader, boolean onlyTxHash);

    /**
     * Ledger operation: async get block by hash
     *
     * @param blockHash the hashcode of the block
     * @param onlyHeader if true then only return block header
     * @param onlyTxHash the boolean define the tx is full or not
     * @param callback the callback that will be called when receive the response
     */
    void getBlockByHashAsync(
            String blockHash,
            boolean onlyHeader,
            boolean onlyTxHash,
            RespCallback callback);

    /**
     * Ledger operation: async get block by hash
     *
     * @param node the node rpc request send to
     * @param blockHash the hashcode of the block
     * @param onlyHeader if true then only return block header
     * @param onlyTxHash the boolean define the tx is full or not
     * @param callback the callback that will be called when receive the response
     */
    void getBlockByHashAsync(
            String node,
            String blockHash,
            boolean onlyHeader,
            boolean onlyTxHash,
            RespCallback callback);

    /**
     * Ledger operation: get block by block number
     *
     * @param blockNumber the number of the block
     * @param onlyHeader the boolean define if only return header
     * @param onlyTxHash the boolean define if only return tx hash
     * @return block
     */
    BcosBlock getBlockByNumber(BigInteger blockNumber, boolean onlyHeader, boolean onlyTxHash);

    /**
     * Ledger operation: get block by block number
     *
     * @param node the node rpc request send to
     * @param blockNumber the number of the block
     * @param onlyHeader the boolean define if only return header
     * @param onlyTxHash the boolean define if only return tx hash
     * @return block
     */
    BcosBlock getBlockByNumber(
            String node, BigInteger blockNumber, boolean onlyHeader, boolean onlyTxHash);

    /**
     * Ledger operation: async get block by block number
     *
     * @param blockNumber the number of the block
     * @param onlyHeader the boolean if only need header
     * @param onlyTxHash the boolean if you need all transactions
     * @param callback the callback that will be called when receive the response
     */
    void getBlockByNumberAsync(
            BigInteger blockNumber,
            boolean onlyHeader,
            boolean onlyTxHash,
            RespCallback callback);

    /**
     * Ledger operation: async get block by block number
     *
     * @param node the node rpc request send to
     * @param blockNumber the number of the block
     * @param onlyHeader the boolean if only need header
     * @param onlyTxHash the boolean if you need all transactions
     * @param callback the callback that will be called when receive the response
     */
    void getBlockByNumberAsync(
            String node,
            BigInteger blockNumber,
            boolean onlyHeader,
            boolean onlyTxHash,
            RespCallback callback);

    /**
     * Ledger operation: async get block hash by block number
     *
     * @param blockNumber the number of the block
     * @return BlockHash
     */
    BlockHash getBlockHashByNumber(BigInteger blockNumber);

    /**
     * Ledger operation: async get block hash by block number
     *
     * @param blockNumber the number of the block
     * @param callback the callback that will be called when receive the response
     */
    void getBlockHashByNumberAsync(BigInteger blockNumber, RespCallback callback);

    /**
     * Ledger operation: async get block hash by block number
     *
     * @param node the node rpc request send to
     * @param blockNumber the number of the block
     * @return BlockHash
     */
    BlockHash getBlockHashByNumber(String node, BigInteger blockNumber);

    /**
     * Ledger operation: async get block hash by block number
     *
     * @param node the node rpc request send to
     * @param blockNumber the number of the block
     * @param callback the callback that will be called when receive the response
     */
    void getBlockHashByNumberAsync(
            String node, BigInteger blockNumber, RespCallback callback);

    /**
     * Ledger operation: get transaction by hash
     *
     * @param transactionHash the hashcode of transaction
     * @param withProof with the transaction proof
     * @return transaction
     */
    BcosTransaction getTransaction(String transactionHash, Boolean withProof);

    /**
     * Ledger operation: get trnasaction by hash
     *
     * @param node the node rpc request send to
     * @param transactionHash the hashcode of transaction
     * @param withProof with the transaction proof
     * @return transaction
     */
    BcosTransaction getTransaction(String node, String transactionHash, Boolean withProof);

    /**
     * Ledger operation: async get trnasaction by hash
     *
     * @param transactionHash the hashcode of transaction
     * @param withProof with the transaction proof
     * @param callback the callback that will be called when receive the response
     */
    void getTransactionAsync(
            String transactionHash, Boolean withProof, RespCallback callback);

    /**
     * Ledger operation: async get trnasaction by hash
     *
     * @param node the node rpc request send to
     * @param transactionHash the hashcode of transaction
     * @param withProof with the transaction proof
     * @param callback the callback that will be called when receive the response
     */
    void getTransactionAsync(
            String node,
            String transactionHash,
            Boolean withProof,
            RespCallback callback);

    /**
     * Ledger operation: get transaction receipt by transaction hash
     *
     * @param transactionHash the hashcode of transaction
     * @param withProof with the transaction proof
     * @return transaction receipt
     */
    BcosTransactionReceipt getTransactionReceipt(String transactionHash, Boolean withProof);

    /**
     * Ledger operation: get transaction receipt by transaction hash
     *
     * @param node the node rpc request send to
     * @param transactionHash the hashcode of transaction
     * @param withProof with the transaction receipt proof
     * @return transaction receipt
     */
    BcosTransactionReceipt getTransactionReceipt(
            String node, String transactionHash, Boolean withProof);

    /**
     * Ledger operation: async get transaction receipt by transaction hash
     *
     * @param transactionHash the hashcode of transaction
     * @param withProof with the transaction receipt proof
     * @param callback the callback that will be called when receive the response
     */
    void getTransactionReceiptAsync(
            String transactionHash,
            Boolean withProof,
            RespCallback callback);

    /**
     * Ledger operation: async get transaction receipt by transaction hash
     *
     * @param node the node rpc request send to
     * @param transactionHash the hashcode of transaction
     * @param withProof with the transaction receipt proof
     * @param callback the callback that will be called when receive the response
     */
    void getTransactionReceiptAsync(
            String node,
            String transactionHash,
            Boolean withProof,
            RespCallback callback);

    /**
     * Ledger operation: get pending transaction size
     *
     * @param node the node rpc request send to
     * @return PendingTxSize
     */
    PendingTxSize getPendingTxSize(String node);

    /**
     * Ledger operation: async get pending transaction size
     *
     * @param node the node rpc request send to
     * @param callback the callback that will be called when receive the response
     */
    void getPendingTxSizeAsync(String node, RespCallback callback);

    /**
     * Ledger operation: get pending transaction size
     *
     * @return PendingTxSize
     */
    PendingTxSize getPendingTxSize();

    /**
     * Ledger operation: async get pending transaction size
     *
     * @param callback the callback that will be called when receive the response
     */
    void getPendingTxSizeAsync(RespCallback callback);

    /**
     * Get cached block height
     *
     * @return block number
     */
    BigInteger getBlockLimit();

    /**
     * Peer operation: get connected peers
     *
     * @return peers
     */
    Peers getPeers();

    /**
     * get the group peers
     *
     * @return the groupPeers
     */
    GroupPeers getGroupPeers();

    void getGroupPeersAsync(RespCallback callback);

    /**
     * Peer operation: async get connected peers
     *
     * @param callback the callback instance
     */
    void getPeersAsync(RespCallback callback);

    /**
     * Peer operation: get observer node list
     *
     * @return observer node list
     */
    ObserverList getObserverList();

    /**
     * Peer operation: get observer node list
     *
     * @param node the node rpc request send to
     * @return observer node list
     */
    ObserverList getObserverList(String node);

    /**
     * Peer operation: async get observer node list
     *
     * @param callback the callback instance
     */
    void getObserverList(RespCallback callback);

    /**
     * Peer operation: async get observer node list
     *
     * @param node the node rpc request send to
     * @param callback the callback instance
     */
    void getObserverList(String node, RespCallback callback);

    /**
     * Peer operation: get sealer node list
     *
     * @return sealer node list
     */
    SealerList getSealerList();

    /**
     * Peer operation: get sealer node list
     *
     * @param node the node rpc request send to
     * @return sealer node list
     */
    SealerList getSealerList(String node);

    /**
     * Peer operation: async get sealer node list
     *
     * @param callback the callback instance
     */
    void getSealerListAsync(RespCallback callback);

    /**
     * Peer operation: async get sealer node list
     *
     * @param node the node rpc request send to
     * @param callback the callback instance
     */
    void getSealerListAsync(String node, RespCallback callback);

    /**
     * get node list by type
     *
     * @param type type of node, now support consensus_sealer, consensus_observer and
     *     consensus_candidate_sealer
     * @return node list
     */
    SealerList getNodeListByType(String type);

    /**
     * get node list by type
     *
     * @param node the node rpc request send to
     * @param type type of node, now support consensus_sealer, consensus_observer and
     *     consensus_candidate_sealer
     * @return node list
     */
    SealerList getNodeListByType(String node, String type);

    /**
     * async get node list by type
     *
     * @param type type of node, now support consensus_sealer, consensus_observer and
     *     consensus_candidate_sealer
     * @param callback the callback
     */
    void getNodeListByTypeAsync(String type, RespCallback callback);

    /**
     * async get node list by type
     *
     * @param node the node rpc request send to
     * @param type type of node, now support consensus_sealer, consensus_observer and
     *     consensus_candidate_sealer
     * @param callback the callback
     */
    void getNodeListByTypeAsync(String node, String type, RespCallback callback);

    /**
     * Peer operation: get pbft view
     *
     * @return pbft view
     */
    PbftView getPbftView();

    /**
     * Peer operation: get pbft view
     *
     * @param node the node rpc request send to
     * @return pbft view
     */
    PbftView getPbftView(String node);

    /**
     * Peer operation: async get pbft view
     *
     * @param callback the callback instance
     */
    void getPbftViewAsync(RespCallback callback);

    /**
     * Peer operation: async get pbft view
     *
     * @param node the node rpc request send to
     * @param callback the callback instance
     */
    void getPbftViewAsync(String node, RespCallback callback);

    /**
     * Peer operation: get system config
     *
     * @param key the string of key
     * @return system config
     */
    SystemConfig getSystemConfigByKey(String key);

    /**
     * Peer operation: get system config
     *
     * @param node the node rpc request send to
     * @param key the string of key
     * @return system config
     */
    SystemConfig getSystemConfigByKey(String node, String key);

    /**
     * Peer operation: get system config list, witch will fetch all config
     *
     * @return all config value
     */
    Map> getSystemConfigList();

    /**
     * Peer operation: async get system config
     *
     * @param key the string of key
     * @param callback the callback instance
     */
    void getSystemConfigByKeyAsync(String key, RespCallback callback);

    /**
     * Peer operation: async get system config
     *
     * @param node the node rpc request send to
     * @param key the string of key
     * @param callback the callback instance
     */
    void getSystemConfigByKeyAsync(String node, String key, RespCallback callback);

    /**
     * async get all connect nodes support keys
     *
     * @param callback the callback instance
     */
    void getSupportSysConfigKeysAsync(RespCallback> callback);

    /**
     * Peer operation: async get system config list, witch will fetch all config
     *
     * @param callback the callback instance
     */
    void getSystemConfigListAsync(RespCallback>> callback);

    /**
     * Peer operation: get sync status
     *
     * @param node the node rpc request send to
     * @return sync status
     */
    SyncStatus getSyncStatus(String node);

    /**
     * Peer operation: async get sync status
     *
     * @param node the node rpc request send to
     * @param callback the callback instance
     */
    void getSyncStatusAsync(String node, RespCallback callback);

    /**
     * Peer operation: get sync status
     *
     * @return sync status
     */
    SyncStatus getSyncStatus();

    /**
     * Peer operation: async get sync status
     *
     * @param callback the callback instance
     */
    void getSyncStatusAsync(RespCallback callback);

    /**
     * async get consensus status
     *
     * @param node the node rpc request send to
     * @param callback the callback
     */
    void getConsensusStatusAsync(String node, RespCallback callback);

    /**
     * async get consensus status
     *
     * @param callback callback when get consensus status
     */
    void getConsensusStatusAsync(RespCallback callback);

    /**
     * sync get consensus status
     *
     * @param node the node rpc request send to
     * @return consensus status info
     */
    ConsensusStatus getConsensusStatus(String node);

    /**
     * sync get consensus status
     *
     * @return consensus status info
     */
    ConsensusStatus getConsensusStatus();

    /**
     * get group list
     *
     * @return group list
     */
    BcosGroupList getGroupList();

    void getGroupListAsync(RespCallback callback);

    /**
     * get group info
     *
     * @return group info
     */
    BcosGroupInfo getGroupInfo();

    void getGroupInfoAsync(RespCallback callback);

    /**
     * get group info list
     *
     * @return group info list
     */
    BcosGroupInfoList getGroupInfoList();

    void getGroupInfoListAsync(RespCallback callback);

    /**
     * get group node info
     *
     * @param node the node rpc request send to
     * @return group node info
     */
    BcosGroupNodeInfo getGroupNodeInfo(String node);

    void getGroupNodeInfoAsync(String node, RespCallback callback);

    // ------------------------- rpc interface end ------------------------------------------

    /**
     * get the chain compatibility version
     *
     * @return the chain compatibility version
     * @deprecated use getChainCompatibilityVersion instead, because older version sdk did not
     *     recognize newer chain node
     */
    @Deprecated
    EnumNodeVersion getChainVersion();

    /**
     * get the chain compatibility version
     *
     * @return the chain compatibility version
     */
    EnumNodeVersion.Version getChainCompatibilityVersion();

    /**
     * async get the chain compatibility version
     *
     * @param versionRespCallback the callback that will be called when receive the response
     */
    void getChainCompatibilityVersionAsync(
            RespCallback versionRespCallback);

    /**
     * Set node name to send rpc request directly, if not set, will use random node in the
     * groupInfoList. Node name should choose from groupInfo.
     *
     * @param nodeToSendRequest the node name
     */
    void setNodeToSendRequest(String nodeToSendRequest);

    /**
     * Check this client whether supporting sending transaction with v1 version or not.
     *
     * @return is this client support sending transaction with v1 version
     */
    boolean isSupportTransactionV1();

    /**
     * Check this client whether supporting sending transaction with v2 version or not.
     *
     * @return is this client support sending transaction with v2 version
     */
    boolean isSupportTransactionV2();

    /**
     * get node name to send rpc request directly
     *
     * @return the node name
     */
    String getNodeToSendRequest();

    /**
     * Get the protocol version after SDK and Blockchain node negotiated. This method returns int
     * with max and min version bits combined, which is (max|min). Max protocol version is in first
     * 16 bit, and min protocol version in the second 16 bit.
     *
     * @return (max|min) bits combined.
     */
    int getNegotiatedProtocol();

    LogFilterResponse newFilter(LogFilterRequest filter);

    void newFilterAsync(LogFilterRequest filter, RespCallback callback);

    LogFilterResponse newBlockFilter();

    void newBlockFilterAsync(RespCallback callback);

    LogFilterResponse newPendingTransactionFilter();

    void newPendingTransactionFilterAsync(RespCallback callback);

    LogWrapper getFilterChanges(LogFilterResponse filter);

    void getFilterChangesAsync(LogFilterResponse filter, RespCallback callback);

    UninstallLogFilter uninstallFilter(LogFilterResponse filter);

    void uninstallFilterAsync(LogFilterResponse filter, RespCallback callback);

    LogWrapper getLogs(LogFilterRequest filter);

    void getLogsAsync(LogFilterRequest filter, RespCallback callback);

    LogWrapper getFilterLogs(LogFilterResponse filter);

    void getFilterLogsAsync(LogFilterResponse filter, RespCallback callback);

    void start();

    void stop();

    void destroy();
}