EOSIO SDK for Java: Android RPC Provider

An Android RPC provider implementation for use within EOSIO SDK for Java as a plugin. RPC providers are responsible for all RPC calls to nodeos, as well as general network handling.

All product and company names are trademarks™ or registered® trademarks of their respective holders. Use of them does not imply any affiliation with or endorsement by them.

Prerequisites
Installation
Direct Usage
Android Example App
Releases
Want to Help?
License & Legal

Prerequisites

Android Studio 3.3.2 or higher
Gradle 4.10.1+
Gradle Plugin 3.3.0+
For Android, Android 6 (Marshmallow)+

This project relies on platform functionality and libraries only present in Android 6+. Therefore, any project depending on Android RPC Provider with EOSIO SDK for Java must be an Android 6+ project. Other RPC providers, however, can be created to support earlier Android versions or other platforms. If your project requires earlier Android version or alternate platform support, or if you'd like to create a RPC provider and have questions, please reach out to us by logging an issue.

Installation

Android RPC Provider is intended to be used in conjunction with EOSIO SDK for Java as a provider plugin.

To use Android RPC Provider with EOSIO SDK for Java in your app, add the following modules to your build.gradle:

implementation 'one.block:eosiojava:0.1.2'
implementation 'one.block:eosiojavarpcprovider:0.1.1'

You must also add the following to the android section of your application's build.gradle:

// Needed to get bitcoin-j to produce a valid apk for android.
packagingOptions {
    exclude 'lib/x86_64/darwin/libscrypt.dylib'
    exclude 'lib/x86_64/freebsd/libscrypt.so'
    exclude 'lib/x86_64/linux/libscrypt.so'
}

The build.gradle files for the project currently include configurations for publishing the project to Artifactory. These should be removed if you are not planning to use Artifactory or you will encounter build errors. To do so, make the changes marked by comments throughout the files.

Then refresh your gradle project.

Now Android RPC Provider is ready for use within EOSIO SDK for Java according to the EOSIO SDK for Java - Basic Usage instructions.

Direct Usage

If you wish to use Android RPC Provider directly, its public methods can be called like this:

// Synchronous call
EosioJavaRpcProviderImpl rpcProvider = new EosioJavaRpcProviderImpl(
    "https://mytestblockchain.net/"
);
GetRawAbiRequest request = new GetRawAbiRequest("eosio.token");
GetRawAbiResponse response = rpcProvider.getRawAbi(request);
String abi = response.getAbi();
String abiHash = response.getAbiHash();

// Asynchronous call
final EosioJavaRpcProviderImpl rpcProvider = new EosioJavaRpcProviderImpl(
    "https://mytestblockchain.net/"
);
GetBlockRequest[] request = { new GetBlockRequest("25260032") };

AsyncTask<GetBlockRequest, Void, GetBlockResponse> asyncTask = new AsyncTask<GetBlockRequest, Void, GetBlockResponse>() {
    GetBlockRpcError getBlockError = null;
    @Override
    protected GetBlockResponse doInBackground(GetBlockRequest... getBlockRequests) {
        // Here we are on a background thread.
        GetBlockResponse response = null;
        try {
            response = rpcProvider.getBlock(getBlockRequests[0]);
        } catch (GetBlockRpcError err) {
            getBlockError = err;
        }
        return response;
    }

    protected void onPostExecute(GetBlockResponse response) {
        // Here we are back on the main thread and could update the UI.
        String blockId = response.getId();
        String blockRefPrefix = response.getRefBlockPrefix();
        // ...

    }
}.execute(request);

Please note that only the following five RPC endpoints have proper response marshalling:

 Call<GetInfoResponse> getInfo();
 Call<GetBlockResponse> getBlock(@Body GetBlockRequest getBlockRequest);
 Call<GetRawAbiResponse> getRawAbi(@Body GetRawAbiRequest getRawAbiRequest);
 Call<GetRequiredKeysResponse> getRequiredKeys(@Body GetRequiredKeysRequest getRequiredKeysRequest);
 Call<PushTransactionResponse> pushTransaction(@Body PushTransactionRequest pushTransactionRequest);

The remaining endpoints accept a RequestBody as the request object and return a raw JSON string as the response. We aim to continue improving response marshalling for all endpoints, and we invite you to help us improve responses too. Check EosioJavaRpcProviderImpl for more details.

Here is an example demonstrating how to call RPC endpoints and handle the raw JSON string responses returned:

EosioJavaRpcProviderImpl rpcProvider = new EosioJavaRpcProviderImpl("https://mytestblockchain.net/");

String getCurrentBalanceRequestJSON = "{\n" +
            "\t\"code\" : \"eosio.token\"\n" +
            "\t\"account\" : \"test_account\"\n" +
            "}";
RequestBody requestBody = RequestBody.create(okhttp3.MediaType.parse("application/json; charset=utf-8"), getCurrentBalanceRequestJSON);
String response = rpcProvider.getCurrencyBalance(requestBody);
JSONArray jsonArray = new JSONArray(response);
String balance = jsonArray.getString(0);

Android Example App

If you'd like to see EOSIO SDK for Java: Android RPC Provider in action, check out our open source Android Example App--a working application that fetches an account's token balance and pushes a transfer action.

Releases

2/26/20

Version 0.1.1 The version consumes the new eosio-java library version 0.1.2.

Want to help?

Interested in contributing? That's awesome! Here are some Contribution Guidelines and the Code of Conduct.

We're always looking for ways to improve EOSIO SDK for Java: Android RPC Provider. Check out our #enhancement Issues for ways you can pitch in.

License

MIT

Important

See LICENSE for copyright and license terms. Block.one makes its contribution on a voluntary basis as a member of the EOSIO community and is not responsible for ensuring the overall performance of the software or any related applications. We make no representation, warranty, guarantee or undertaking in respect of the software or any related documentation, whether expressed or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall we be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or documentation or the use or other dealings in the software or documentation. Any test results or performance figures are indicative and will not reflect performance under all conditions. Any reference to any third party or third-party product, service or other resource is not an endorsement or recommendation by Block.one. We are not responsible, and disclaim any and all responsibility and liability, for your use of or reliance on any of these resources. Third-party resources may be updated, changed or terminated at any time, so the information here may be out of date or inaccurate. Any person using or offering this software in connection with providing software, goods or services to third parties shall advise such third parties of these license terms, disclaimers and exclusions of liability. Block.one, EOSIO, EOSIO Labs, EOS, the heptahedron and associated logos are trademarks of Block.one.

Wallets and related components are complex software that require the highest levels of security. If incorrectly built or used, they may compromise users’ private keys and digital assets. Wallet applications and related components should undergo thorough security evaluations before being used. Only experienced developers should work with this software.

EOSIO / eosio-java-android-rpc-provider

readme