OmiseGO Android SDK

The OmiseGO Android SDK allows developers to easily interact with a node of the OmiseGO eWallet. This SDK is split into 3 modules : Core, Client and Admin. The Core is a common dependency that contains the shared logic. The Client and Admin modules contain specific logic to respectively access the client or admin API.

Table of Contents

• Requirements
• Installation
• Usage
  • Client
  • Admin
• Lint
• Tests
• Contributing
• License

Requirements

• Minimum Android SDK version 19

Installation

If you only need to integrate and support the Client API, add the following line in the module's build.gradle

dependencies {
    implementation 'co.omisego:omisego-client:<latest-sdk-version>'
}

Or if you want to support the Admin API, you can use:

dependencies {
    implementation 'co.omisego:omisego-admin:<latest-sdk-version>'
}

Usage

Client API Usage

Admin API Usage

Lint

Simply run ./gradlew ktlintCheck under the project root directory.

Tests

Unit Test

Running all tests

./gradlew clean test

Running tests for omisego-core module

./gradlew omisego-core:test -Plive=false

Running tests for omisego-client module

./gradlew omisego-client:test -Plive=false

Running tests for omisego-admin module

./gradlew omisego-admin:test -Plive=false

Live Test

Running live tests for omisego-client module

In order to run the live tests (bound to a working server), you need to create a file secret.json under src/liveTest/resources/ directory in the omisego-client module (You can take a template from secret.example.json there).

The secret.json file will be using the following format which is the same as the secret.example.json file.

{
  "base_url": "YOUR_BASE_URL",
  "socket_base_url": "YOUR_SOCKET_BASE_URL",
  "api_key": "YOUR_API_KEY",
  "auth_token": "YOUR_AUTH_TOKEN"
}

Where:

• base_url is the URL of the OmiseGO Wallet API. Note: This need to be ended with '/' (e.g. https://ewallet.staging.omisego.io/api/client/).
• socket_base_url is the URL of the OmiseGO Wallet API, this needs to be an ws(s) url. Note: This need to be ended with '/' (e.g. https://ewallet.staging.omisego.io/api/client/socket/).
• api_key is the api key generated from your OmiseGO admin panel.
• auth_token is the token corresponding to an OmiseGO Wallet user retrievable using one of our server-side SDKs.

You can find more info on how to retrieve this token in the OmiseGO server SDK documentations.

You will need to fill the corresponding variables, then runs the following command to execute the client live test.

./gradlew omisego-client:test -Plive=true

Running live tests for omisego-admin module

In order to run the live tests (bound to a working server), you need to create a file secret.json under src/liveTest/resources/ directory in the omisego-admin module (You can take a template from secret.example.json there).

The secret.json file will be using the following format which is the same as the secret.example.json file.

{
  "base_url": "YOUR_BASE_URL",
  "email": "YOUR_ADMIN_EMAIL",
  "password": "YOUR_ADMIN_PASSWORD",
  "token_id": "YOUR_TOKEN_ID",
  "account_address": "YOUR_ACCOUNT_ADDRESS",
  "user_address": "YOUR_USER_ADDRESS"
}

Where:

• base_url is an eWallet API endpoint (e.g. https://ewallet.staging.omisego.io/api/admin/) .
• email is an email of the admin account.
• password is a password of the admin account.
• token_id is an id of the token to be used for transfer tests.
• account_address is an address of the account to be used for transfer tests.
• user_address is an address of the user to be used for transfer tests.

You will need to fill the corresponding variables, then runs the following command to execute the admin live test.

./gradlew omisego-admin:test -Plive=true

Contributing

See how you can help.

License

The OmiseGO Android SDK is released under the Apache License.

Sample Project

You can check out the latest sample app from the following repo : [OMGShop](https://github.com/omisego/sample-android