io.aelf.sdk

类 AElfClient

java.lang.Object

io.aelf.sdk.AElfClient

public class AElfClient
extends Object

构造器概要

构造器

构造器和说明
AElfClient(String url) Object construction through the url path.
AElfClient(String url, String version) Object construction through the url path.

方法概要

限定符和类型	方法和说明
Boolean	addPeer(AddPeerInput input) Attempts to add a node to the connected network nodes wa:/api/net/peer.
CreateRawTransactionOutput	createRawTransaction(CreateRawTransactionInput input) Creates an unsigned serialized transaction wa:/api/blockChain/rawTransaction.
String	executeRawTransaction(ExecuteRawTransactionDto input) Call a method of a contract by given serialized str wa:/api/blockChain/executeRawTransaction.
String	executeTransaction(ExecuteTransactionDto input) Call a read-only method of a contract. wa:/api/blockChain/executeTransaction
KeyPairInfo	generateKeyPairInfo() new generateKeyPairInfo;
Core.Transaction.Builder	generateTransaction(String from, String to, String methodName, byte[] params) Build a transaction from the input parameters.
String	getAddressFromPrivateKey(String privateKey) Get address of a contract by given contractNameHash.
String	getAddressFromPubKey(String pubKey) Get the account address through the public key.
BlockDto	getBlockByHash(String blockHash) Get information of a block by given block hash.
BlockDto	getBlockByHash(String blockHash, boolean includeTransactions) Get information about a given block by block hash.
BlockDto	getBlockByHeight(long blockHeight) Get information of a block by specified height.
BlockDto	getBlockByHeight(long blockHeight, boolean includeTransactions) Get information of a block by specified height.
long	getBlockHeight() Get the height of the current chain. wa:/api/blockChain/blockHeight
int	getChainId() Get id of the chain.
ChainstatusDto	getChainStatus() Get the current status of the block chain. wa:/api/blockChain/chainStatus
String	getContractAddressByName(String privateKey, byte[] contractNameHash) Get address of a contract by given contractNameHash.
byte[]	getContractFileDescriptorSet(String address) Get the protobuf definitions related to a contract /api/blockChain/contractFileDescriptorSet.
String	getFormattedAddress(String privateKey, String address) Convert the Address to the displayed string：symbol_base58-string_base58-string-chain-id.
String	getGenesisContractAddress() Get the address of genesis contract.
MerklePathDto	getMerklePathByTransactionId(String transactionId) Get merkle path of a transaction. wa:/api/blockChain/merklePathByTransactionId
NetworkInfoOutput	getNetworkInfo() Get information about the node’s connection to the network. wa:/api/net/networkInfo
List<PeerDto>	getPeers(Boolean withMetrics) Gets information about the peer nodes of the current node.Optional whether to include metrics.
String	getSignatureWithPrivateKey(String privateKey, byte[] txData) Get the private sha256 signature.
List<TaskQueueInfoDto>	getTaskQueueStatus() Gets the status information of the task queue wa:/api/blockChain/taskQueueStatus.
TransactionPoolStatusOutput	getTransactionPoolStatus() Gets information about the current transaction pool.wa:/api/blockChain/transactionPoolStatus
TransactionResultDto	getTransactionResult(String transactionId) Get the current status of a transaction wa:/api/blockChain/transactionResult.
List<TransactionResultDto>	getTransactionResults(String blockHash) Get results of multiple transactions by specified blockHash and the offset.
List<TransactionResultDto>	getTransactionResults(String blockHash, int offset, int limit) Get multiple transaction results. wa:/api/blockChain/transactionResults
boolean	isConnected() Verify whether this sdk successfully connects the chain.
Boolean	removePeer(String address) Attempts to remove a node from the connected network nodes wa:/api/net/peer.
SendRawTransactionOutput	sendRawTransaction(SendRawTransactionInput input) Broadcast a serialized transaction. wa:/api/blockChain/sendRawTransaction
SendTransactionOutput	sendTransaction(SendTransactionInput input) Broadcast a transaction wa:/api/blockChain/sendTransaction.
List<String>	sendTransactions(SendTransactionsInput input) Broadcast volume transactions wa:/api/blockChain/sendTransactions.
String	signTransaction(String privateKeyHex, Core.Transaction transaction) Sign a transaction using private key.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

AElfClient

public AElfClient(String url)

Object construction through the url path.

参数:

url - Http Request Url exp:(http://xxxx)

AElfClient

public AElfClient(String url,
                  String version)

Object construction through the url path.

参数:

url - Http Request Url exp:(http://xxxx)

version - application/json;v={version}

方法详细资料

getBlockHeight

public long getBlockHeight()
                    throws Exception

Get the height of the current chain. wa:/api/blockChain/blockHeight

抛出:

Exception

getBlockByHash

public BlockDto getBlockByHash(String blockHash)
                        throws Exception

Get information of a block by given block hash. Optional whether to include transaction information.

抛出:

Exception

getBlockByHash

public BlockDto getBlockByHash(String blockHash,
                               boolean includeTransactions)
                        throws Exception

Get information about a given block by block hash. Otionally with the list of its transactions. wa://api/blockChain/block?includeTransactions={includeTransactions}

抛出:

Exception

getBlockByHeight

public BlockDto getBlockByHeight(long blockHeight)
                          throws Exception

Get information of a block by specified height. Optional whether to include transaction information.

抛出:

Exception

getBlockByHeight

public BlockDto getBlockByHeight(long blockHeight,
                                 boolean includeTransactions)
                          throws Exception

Get information of a block by specified height. Optional whether to include transaction information. wa://api/blockChain/blockByHeight?includeTransactions={includeTransactions}

抛出:

Exception

getChainStatus

public ChainstatusDto getChainStatus()
                              throws Exception

Get the current status of the block chain. wa:/api/blockChain/chainStatus

抛出:

Exception

getContractFileDescriptorSet

public byte[] getContractFileDescriptorSet(String address)
                                    throws Exception

Get the protobuf definitions related to a contract /api/blockChain/contractFileDescriptorSet.

抛出:

Exception

getTaskQueueStatus

public List<TaskQueueInfoDto> getTaskQueueStatus()
                                          throws Exception

Gets the status information of the task queue wa:/api/blockChain/taskQueueStatus.

抛出:

Exception

getTransactionPoolStatus

public TransactionPoolStatusOutput getTransactionPoolStatus()
                                                     throws Exception

Gets information about the current transaction pool.wa:/api/blockChain/transactionPoolStatus

抛出:

Exception

executeTransaction

public String executeTransaction(ExecuteTransactionDto input)
                          throws Exception

Call a read-only method of a contract. wa:/api/blockChain/executeTransaction

抛出:

Exception

createRawTransaction

public CreateRawTransactionOutput createRawTransaction(CreateRawTransactionInput input)
                                                throws Exception

Creates an unsigned serialized transaction wa:/api/blockChain/rawTransaction.

抛出:

Exception

executeRawTransaction

public String executeRawTransaction(ExecuteRawTransactionDto input)
                             throws Exception

Call a method of a contract by given serialized str wa:/api/blockChain/executeRawTransaction.

抛出:

Exception

sendRawTransaction

public SendRawTransactionOutput sendRawTransaction(SendRawTransactionInput input)
                                            throws Exception

Broadcast a serialized transaction. wa:/api/blockChain/sendRawTransaction

抛出:

Exception

sendTransaction

public SendTransactionOutput sendTransaction(SendTransactionInput input)
                                      throws Exception

Broadcast a transaction wa:/api/blockChain/sendTransaction.

抛出:

Exception

sendTransactions

public List<String> sendTransactions(SendTransactionsInput input)
                              throws Exception

Broadcast volume transactions wa:/api/blockChain/sendTransactions.

抛出:

Exception

getTransactionResult

public TransactionResultDto getTransactionResult(String transactionId)
                                          throws Exception

Get the current status of a transaction wa:/api/blockChain/transactionResult.

抛出:

Exception

getTransactionResults

public List<TransactionResultDto> getTransactionResults(String blockHash)
                                                 throws Exception

Get results of multiple transactions by specified blockHash and the offset. wa:/api/blockChain/transactionResults

抛出:

Exception

getTransactionResults

public List<TransactionResultDto> getTransactionResults(String blockHash,
                                                        int offset,
                                                        int limit)
                                                 throws Exception

Get multiple transaction results. wa:/api/blockChain/transactionResults

抛出:

Exception

getMerklePathByTransactionId

public MerklePathDto getMerklePathByTransactionId(String transactionId)

Get merkle path of a transaction. wa:/api/blockChain/merklePathByTransactionId

getChainId

public int getChainId()
               throws Exception

Get id of the chain.

抛出:

Exception

addPeer

public Boolean addPeer(AddPeerInput input)
                throws Exception

Attempts to add a node to the connected network nodes wa:/api/net/peer.

抛出:

Exception

removePeer

public Boolean removePeer(String address)
                   throws Exception

Attempts to remove a node from the connected network nodes wa:/api/net/peer.

抛出:

Exception

getPeers

public List<PeerDto> getPeers(Boolean withMetrics)
                       throws Exception

Gets information about the peer nodes of the current node.Optional whether to include metrics. wa:/api/net/peers?withMetrics=false

抛出:

Exception

getNetworkInfo

public NetworkInfoOutput getNetworkInfo()
                                 throws Exception

Get information about the node’s connection to the network. wa:/api/net/networkInfo

抛出:

Exception

generateTransaction

public Core.Transaction.Builder generateTransaction(String from,
                                                    String to,
                                                    String methodName,
                                                    byte[] params)
                                             throws Exception

Build a transaction from the input parameters.

抛出:

Exception

signTransaction

public String signTransaction(String privateKeyHex,
                              Core.Transaction transaction)
                       throws Exception

Sign a transaction using private key.

抛出:

Exception

getGenesisContractAddress

public String getGenesisContractAddress()
                                 throws Exception

Get the address of genesis contract.

返回:

address

抛出:

Exception

getAddressFromPubKey

public String getAddressFromPubKey(@Nullable
                                   String pubKey)

Get the account address through the public key.

参数:

pubKey - pubKey hex

返回:

Str

getFormattedAddress

public String getFormattedAddress(String privateKey,
                                  String address)
                           throws Exception

Convert the Address to the displayed string：symbol_base58-string_base58-string-chain-id.

抛出:

Exception

generateKeyPairInfo

public KeyPairInfo generateKeyPairInfo()
                                throws Exception

new generateKeyPairInfo;

抛出:

Exception

getContractAddressByName

public String getContractAddressByName(String privateKey,
                                       byte[] contractNameHash)
                                throws Exception

Get address of a contract by given contractNameHash.

抛出:

Exception

getAddressFromPrivateKey

public String getAddressFromPrivateKey(String privateKey)

Get address of a contract by given contractNameHash.

getSignatureWithPrivateKey

public String getSignatureWithPrivateKey(String privateKey,
                                         byte[] txData)
                                  throws Exception

Get the private sha256 signature.

抛出:

Exception

isConnected

public boolean isConnected()

Verify whether this sdk successfully connects the chain.

返回:

IsConnected or not