https://github.com/aelfproject/aelf-sdk.java
AElf java SDK
https://github.com/aelfproject/aelf-sdk.java
Last synced: 11 months ago
JSON representation
AElf java SDK
- Host: GitHub
- URL: https://github.com/aelfproject/aelf-sdk.java
- Owner: AElfProject
- License: mit
- Created: 2019-12-14T10:21:13.000Z (over 6 years ago)
- Default Branch: dev
- Last Pushed: 2023-10-26T08:46:50.000Z (over 2 years ago)
- Last Synced: 2025-04-08T11:38:25.006Z (about 1 year ago)
- Language: Java
- Size: 1.5 MB
- Stars: 1
- Watchers: 7
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# AElf-Client
## Introduction
This is a Java client library, used to communicate with the [AElf](https://github.com/AElfProject/AElf) API.
### Getting Started
- Make sure [Oracle Jdk](https://www.oracle.com/java/technologies/javase-downloads.html) is installed.
- Execute `mvn clean package ` and `mvn compile ` to build AElfClient (used by test cases).
### System Requirement
- JDK1.8+
- Log4j2.6.2
### Basic usage
``` JAVA
private static final String httpUrl="http://127.0.0.1:8200";
// get client instance
AElfClient AElfClient = new AElfClient(httpUrl);
long blockHeight = client.getBlockHeight();
```
### Class
#### AElfClient
``` JAVA
public AElfClient(String url);
public AElfClient(String url,String version);
public TransactionDto generateTransaction(String from, String to, String methodName, String params) throws Exception;
public TransactionDto signTransaction(String privateKeyHex,TransactionDto transaction);
public String getGenesisContractAddress() throws Exception;
public String getAddressFromPrivateKey(String privateKey);
public String GetSignatureWithToHex(String privateKey, byte[] txData) throws Exception;
public boolean isConnected();
public BlockDto getBlockByHash(String blockHash, boolean includeTransactions) throws Exception;
public BlockDto getBlockByHeight(long blockHeight, boolean includeTransactions) throws Exception;
public BlockStateDto getBlockState(String blockHash) throws Exception;
public ChainstatusDto getChainStatus() throws Exception;
public byte[] getContractFileDescriptorSet(String address) throws Exception;
public List getTaskQueueStatus() throws Exception;
public TransactionPoolStatusOutput getTransactionPoolStatus() throws Exception;
public KeyPairInfo generateKeyPairInfo() throws Exception;
public String executeTransaction(ExecuteTransactionDto input) throws Exception;
public CreateRawTransactionOutput createRawTransaction(CreateRawTransactionInput input) throws Exception;
public String executeRawTransaction(ExecuteRawTransactionDto input) throws Exception;
public SendRawTransactionOutput sendRawTransaction(SendRawTransactionInput input) throws Exception;
public SendTransactionOutput sendTransaction(SendTransactionInput input) throws Exception;
public List sendTransactions(SendTransactionsInput input) throws Exception;
public TransactionResultDto getTransactionResult(String transactionId) throws Exception;
public List getTransactionResults(String blockHash, int offset,int limit) throws Exception;
public MerklePathDto getMerklePathByTransactionId(String transactionId) throws Exception;
public List getTransactionResults(String blockHash) throws Exception;
public BlockDto getBlockByHeight(long blockHeight) throws Exception;
public BlockDto getBlockByHash(String blockHash) throws Exception;
public int getChainId() throws Exception;
public Boolean addPeer(AddPeerInput input) throws Exception;
public Boolean removePeer(String address) throws Exception;
public List getPeers(Boolean withMetrics) throws Exception;
public NetworkInfoOutput getNetworkInfo() throws Exception;
```
### ProtoBuff Build
Default classes defined in the "protobuf/protos" are available in the directory named "protobuf/generated".
You can add new types in protos and generate them by using the scripts in "resources" folder.
- Windows : `./protobuff.bat `
- Linux Or Mac: `./protobuff.sh `
### Test
This module contains tests for all services provided by AElfClient. You can learn how to properly use services provided by sdk here.
You need to firstly set necessary parameters to make sure tests can run successfully.
1. Set baseUrl to your target url.
``` JAVA
String httpUrl="http://127.0.0.1:8200";
```
2. Give a valid privateKey of a node.
``` JAVA
String privateKey="09da44778f8db2e602fb484334f37df19e221c84c4582ce5b7770ccfbc3ddbef";
```
### Note
You need to run a local or remote AElf node to run the unit test successfully. If you're not familiar with how to run a node or multiple nodes, please see [Running a node](https://docs.aelf.io/v/dev/main/main/run-node) / [Running multiple nodes](https://docs.aelf.io/v/dev/main/main/multi-nodes) for more information.