Light

pokt-network / pocket-android Goto Github PK

View Code? Open in Web Editor NEW

8.0 9.0 2.0 715 KB

The Official Android Client of the Pocket Network

Home Page: https://pokt.network

License: MIT License

Java 11.74% Kotlin 5.99% JavaScript 82.27%

blockchain decentralized infrastructure android java kotlin mobile dapp pokt pocket-network

pocket-android's Introduction

drawing

PocketAndroid

Official Android client to use with the Pocket Network

Overview

PocketAndroid wraps all of the tools a developer will need to begin interacting with a network. PocketAndroid contains 3 packages:

network.pocket:eth: A library that allows your DApp to communicate to the Ethereum network.
network.pocket:aion: A library that allows your DApp to communicate to the AION network.
network.pocket:core: An implementation of the Pocket protocol that you can use to create your own plugin to interact with a blockchain of your choosing.

Before you can start using the library, you have to get a Developer ID by registering for MVP. To learn how to register please click here.

Requirements

You should have at least have a basic knowledge of blockchain technology and know your way around Java/Kotlin.

Installation

First you need to add the following Maven URL to your project, so the your root build.gradle file add the following:

allprojects {
    repositories {
        google()
        jcenter()
        maven {
          url 'https://dl.bintray.com/pokt-network/pocket-android'
        }
    }
}

Now, you will need to add either of the 3 packages within PocketAndroid to your module's build.gradle file, like this:

// Eth
implementation 'network.pocket:eth:0.0.2'

// Aion
implementation 'network.pocket:aion:0.0.3'

// Core
implementation 'network.pocket:core:0.0.4'

Usage

If you would like to know how to integrate PocketAndroid into your DApp, visit our developer portal that has a lot of useful tutorials and material about the Pocket Network.

Contact Us

We have created a Discord server where you can meet with the Pocket team, as well as fellow App Developers, and Service Nodes. Click here to join!

pocket-android's People

Contributors

Stargazers

Watchers

Forkers

jedsada-gh wdcodecn

pocket-android's Issues

Implement ETH RPC Methods

Create each ETH RPC Methods as per the ethereum json rpc documentation.

https://github.com/aionnetwork/aion/wiki/JSON-RPC-API-Docs

Each method should create a JSON string that will be sent in the payload of the Relay.

Update README to match spec

README should match repo-template / README spec doc

https://docs.google.com/document/d/1DW761zObVqvykSbw-vSlJua1_ABDBHwxbbneTGF_buA/edit

Implement ETH RPC Methods

Create each ETH RPC Methods as per the ethereum json rpc documentation.

https://github.com/ethereum/wiki/wiki/JSON-RPC

Each method should create a JSON string that will be sent in the payload of the Relay.

Define and implement Data layer

Data layer's job is to send and receive data requests with and EndPoint.

Every request is a POST type.

sendRelay
retrieveServiceNodes

Improve error handling when no nodes are available after dispatch call

Currently it's failing whenever no no nodes are available instead of returning the error in the callback.

Integrate CircleCI

Add Tezos Pocket-Plugin

Tezos will be fully pocket supported in JSON rpc calls through a Pocket-Plugin

Separate environments

Currently the SDK is hardcoded to use the staging environment URL with no option to switching out to production.

Update pocket-android README.md

the implementations for: Eth,Aion, and core are on 0.0.1 when it should be 0.0.2.

Setup branching workflow

Add mvp and main branches (mvp-master, mvp-staging, master, staging).

Implement NET RPC Methods

Create each NET RPC Methods as per the ethereum json rpc documentation.

https://github.com/ethereum/wiki/wiki/JSON-RPC

Each method should create a JSON string that will be sent in the payload of the Relay.

Core - Add retry feature for failing Service Nodes

If a Node returns a network error, pocket core should be able to remove the node from the list and retry the request with another node, a retry count should be configurable and also a default value.

Plugins should not need to install core separately

One of the requirements if you install a plugin, let's say Aion, the core functionalities and classes from Core are not available, the developer needs to add Core besides adding Aion in the dependencies.

The objective is to only install the plugin.

implementation 'network.pocket.android:aion:0.0.2'
implementation 'network.pocket.android:core:0.0.2'

Create Core Module

Pocket Core Android module is a sub-package of the main project.

Create a folder inside "packages" with the name "core".
Create a new project with the name "PocketAndroid-Core"

Modify `PocketApiCallback` to respond with `String` instead of `JSONObject`

Currently it's being assumed that any Relay responses will be in the JSON format, however many interfaces return plain text to queries, so in order to generalize, will change the response type from JSONObject to String and let the caller decide how to parse the response.

Wallet save fails - SecretKeyFactory not available

Wallet save functionality fails with error:
W/System.err: java.security.NoSuchAlgorithmException: PBEwithHmacSHA512AndAES_256 SecretKeyFactory not available

The issue is happening with the Ethereum plugin.

// Wallet this.wallet = pocketEth.getRinkeby().createWallet();

this.wallet.save("123", appContext, new Function1<WalletPersistenceError, Unit>() { @Override public Unit invoke(WalletPersistenceError walletPersistenceError) { return null; } });

Create Eth Module

Pocket Eth Android module is a sub-package of the main project.

Create a folder inside "packages" with the name "eth".
Create a new project with the name "PocketAndroid-Eth"

Add resourcePrefix for Core

Fix Wallet management tests

Currently there's a concurrency issue with the design of the wallet management making the tests fail intermitently.

Create project structure

Create the project structure:

1- Jitpack capable
2- Jitpack name "PocketAndroid"
3- Create a folder called "Packages" for the other plugins

Add issue templates & feature requests

Implement Import Wallet

Sign transaction creates bad data

If the param field "value" is null, the sign transaction function returns bad data.

When the value param is passed to sign the transaction, it reads the literal value = "null", causing the signed tx to be invalid.

Note: verify if the issue exists in both Aion and Eth

Define programmatic interfaces

Create a Wallet
Import a Wallet
Create Relay request
Send Relay request

Pocket Core Rest API support

Pocket Core module should suppport REST API requests.

A view of how the Relay payload should be:
{"Blockchain":"POKT","NetID":"1","METHOD":"GET", "DATA":"foo", "PATH":"/v1/","DevID":"DEVID1"}

New fields:
METHOD - HTTP Methods
PATH - URL path with params support

Implement Create Wallet

Implement REST in Android Core

REST Relay Calls needed to be implemented in android-core

Fix Node Selection

Right now on the following line:

https://github.com/pokt-network/pocket-android/blob/master/pocket-android-core/src/main/java/network/pocket/core/Pocket.kt#L68

We pick out a random node from the dispatcher, however the correct way of doing so should be:

nodes[(0 until nodes.count() - 1).random()]

In order to avoid the following exception:

Throwing new exception 'length=6; index=7' with unexpected pending exception: java.lang.ArrayIndexOutOfBoundsException: length=6; index=6

Add class/methods documentation

Core module documentation
Eth module documentation
Aion module documentation

Plugins should not need to install core separately

One of the requirements if you install a plugin, let's say Aion, the core functionalities and classes from Core are not available, the developer needs to add Core besides adding Aion in the dependencies.

The objective is to only install the plugin.

implementation 'network.pocket.android:aion:0.0.2'
implementation 'network.pocket.android:core:0.0.2'

Define and implement models

The main models needed are:

Wallet
Relay
RelayResponse
ServiceNodes

Remove example application from project

Create Aion Module

Pocket Aion Android module is a sub-package of the main project.

Create a folder inside "packages" with the name "aion".
Create a new project with the name "PocketAndroid-Aion"

Implement Import Wallet

Implement NET RPC Methods

Create each NET RPC Methods as per the ethereum json rpc documentation.

https://github.com/aionnetwork/aion/wiki/JSON-RPC-API-Docs

Each method should create a JSON string that will be sent in the payload of the Relay.

Implement Create Wallet

Implement AION AVM contract interactions

Implement the AION ABIStreamingEncoder utility class found in the link below, to allow calling AVM contract functions using the pocket-android-aion plugin.

https://github.com/aionnetwork/AVM/blob/master/org.aion.avm.userlib/src/org/aion/avm/userlib/abi/ABIStreamingEncoder.java

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.