EOSIO SDK for Java: Android ABIEOS Serialization Provider
Android ABIEOS Serialization Provider is a pluggable serialization provider for EOSIO SDK for Java.
Serialization providers are responsible for ABI-driven transaction and action serialization and deserialization between JSON and binary data representations. This particular serialization provider wraps ABIEOS, a C/C++ library that facilitates this conversion.
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.
The Android robot is reproduced or modified from work created and shared by Google and used according to terms described in the Creative Commons 3.0 Attribution License.
Contents
Prerequisites
- Android Studio 3.3.2 or higher
- NDK 18+ (C++ 17 standard support required)
- Cmake 3.6.0+
- 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+ and the Android NDK. Therefore, any project depending on Android ABIEOS Serialization Provider with EOSIO SDK for Java must be an Android 6+ project.
If you need support for ABIEOS serialization on server side Java, please see the Java ABIEOS Serialization Provider project.
Other serialization providers 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 serialization provider and have questions, please reach out to us by logging an issue.
Installation
Android ABIEOS Serialization Provider is intended to be used in conjunction with EOSIO SDK for Java as a provider plugin.
To use Android ABIEOS Serialization Provider with EOSIO SDK for Java in your app, add the following modules to your build.gradle:
implementation 'one.block:eosiojava:1.0.0'
implementation 'one.block:eosiojavaandroidabieosserializationprovider:1.0.0'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 ABIEOS Serialization 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 ABIEOS Serialization Provider directly, its public methods can be called like this:
try {
AbiEos abieos = new AbiEosSerializationProviderImpl()
} catch (SerializationProviderError serializationProviderError) {
serializationProviderError.printStackTrace();
}
String hex = "1686755CA99DE8E73E1200" // some binary data
String json = "{"name": "John"}" // some JSON
try {
String jsonToBinaryTransaction = abieos.serializeTransaction(json)
} catch (SerializeTransactionError err) {
err.printStackTrace();
}
try {
String binaryToJsonTransaction = abieos.deserializeTransaction(hex)
} catch (DeserializeTransactionError err) {
err.printStackTrace();
}You should explicitly destroy the provider's context (i.e., in a finally block), or you could run into a crash when multithreading, per this call:
abieos.destroyContext();
Android Example App
If you'd like to see EOSIO SDK for Java: Android ABIEOS Serialization 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
- 10/15/20: Version 0.1.3 This version adds support for newer Eosio 2.1 features.
- 6/23/20: Version 0.1.2 This version includes support for newer ABI versions.
- 2/27/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 this library. Check out our #enhancement Issues for ways you can pitch in.
License
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.