satran004 / aion-graphql

A GraphQL Server for AION Blockchain.

GraphQL interface for Aion Blockchain

Manual

API Doc: Aion GraphQL API

This project provides GraphQL endpoint to query Aion blockchain. It is using AION java api to communicate with Aion blockchain.

It also support REST Api endpoints. The REST api development is still in progress. You can check supported REST apis here.

https://api.aion-graphql.com/swagger-ui.html

Tested on:

• Ubuntu 16.04 LTS, MacOS
• Java 10.x

The following apis are currently supported :

• blockApi
• txnApi
• accountApi
• adminApi
• chainApi
• netApi
• walletApi
• contractApi

For detail information, please visit this API page

The project will be enhanced to support other read and write operations.

1. Setup from Binary

Download the latest release binary from GitHub repo.

$> unzip aion-graphql-dist-[version].zip

or

$> tar xvf aion-graphql-dist-[version].tar

Go to the extracted folder aion-graphql-dist-[version]

Update Config

Edit config/application.yml to provide aion kernel rpc host and port

example: tcp://x.x.x.x:8547

Start GraphQL server

From aion-graphql-dist-[version] folder, execute the following command to start the server.

$> bin/aion-graphql

on Windows :

bin\aion-graphql.bat

Issue with Aion 0.3.2 : If you face any connnection issue with Aion Kernel 0.3.2, please check this issue #10 for workaround.

Note: Make sure you start the server inside aion-graphql-dist-[version] folder only. Starting server inside bin folder will not work.

2. Build from Source

$> git clone https://github.com/satran004/aion-graphql.git

$> ./gradlew clean build -x integrationTest

To run

$> export rpc_endpoint=tcp://[kernel-host]:8547

$> ./gradlew bootRun

If you want to test GraphQL API on the browser, try the following url

http://[host]:[port]/playground.html

After running the above command, GraphQL endpoint can be accessed through the following url from your application :

http://[host]:[port]/graphql

Demo - Aion GraphQL Playground

aion-graphql's Issues

blockApi.blocks() should return blocks in descending order

txApi.contractDeploy doesn't return txId, contract address

Bean copy doesn't work properly for DeployResponseBean as the data type of source and target beans are different.

Usage with different AION releases

Hey Satya, this project is interesting and very useful. Would it be possible to create a Gitter channel to discuss the project. Myself and @arjitkhullar will be exploring this for future projects. Is this library built to work with any AION version or is this a specific version?

Provide api to return transaction payload for contract deploy and method calls

Currently, the contract call apis support transaction signing only in server side through default account in the kernel node. This enhancement plans to return the transaction payload which can be signed independently in the client side.

• Provide api to return transaction payload for contract deploy from both contract source and compiled code. The encoding will be done through Abi encoder.
• Provide api to return transaction payload for contract method call with the encoded constructor arguments.
• The return transaction object can then be signed in client side code and sent to server for processing through txApi's sendTransaction() / call()

sendRawTranaction is throwing exception.

org.satran.blockchain.graphql.exception.BlockChainAcessException: Function exception!
at org.satran.blockchain.graphql.impl.aion.service.TxnServiceImpl.lambda$sendRawTransaction$15(TxnServiceImpl.java:486)
at org.satran.blockchain.graphql.impl.aion.service.dao.AionBlockchainAccessor.call(AionBlockchainAccessor.java:34)
at org.satran.blockchain.graphql.impl.aion.service.TxnServiceImpl.sendRawTransaction(TxnServiceImpl.java:481)
at org.satran.blockchain.graphql.resolvers.TxnMutator.sendRawTransaction(TxnMutator.java:49)
at org.satran

blockApi and txnApi are returing timestamp as 0

Timestamp is returned as zero for blockApi and txnApi

Secure connection to Aion Kernel 0.3.2 is not working

In Aion Kernel 0.3.2, secure connection is enabled by default. The current released version of Aion Graphql (0.4.0) is not able to connect to Aion kernel 0.3.2 when secure connection is true.

Workaround:

1. Disable secure connection for Java Rpc port in Aion kernel.

 <java active="true" ip="0.0.0.0" port="8547"> 
        <secure-connect>**false**</secure-connect>
 </java> 

2. In Aion GraphQL installation folder, edit config/apiconfig.xml to disable secure connection in client.

<secure-connect>false</secure-connect>

Note: apiconfig.xml is automatically generated after the first run of aion-graphql server.