OST Android Wallet SDK is a mobile application development SDK that enables developers to integrate the functionality of a non-custodial crypto-wallet into consumer applications.
OST Android Wallet SDK...
- Safely generates and stores keys on the user's mobile device
- Signs data as defined by contracts using EIP-1077 and EIP-712
- Enables users to recover access to their Brand Tokens in case the user loses their authorized device
- Java Compile version: 1.7
- Android version support: 22 and above
- Setup
- OST SDK Methods
- Workflows
- Getters
- OST JSON APIs
- JSON API Response Callback
- OST Workflow Callback Interface
- Application development supporting documentation
- Classes
- Steps to use Android mobile SDK through AAR lib
- OST Wallet UI
- Public Key Pinning Using TrustKit
android {
defaultConfig {
minSdkVersion 22
...
...
...
}
}
Add following code in your build.gradle file
compileOptions {
sourceCompatibility JavaVersion.VERSION_1_8
targetCompatibility JavaVersion.VERSION_1_8
}
dependencies {
implementation 'com.ost:ost-wallet-sdk-android:2.4.1'
...
...
...
}
Then sync your dependencies through gradle
Note: Gradle sync might fail for the first time due to build time. Please retry if this happens.
A config file is needed for application-specific configuration of OST SDK.
- Create file "ost-mobilesdk.json" with application specific configurations using the JSON below as an example
{
"BLOCK_GENERATION_TIME": 3,
"PIN_MAX_RETRY_COUNT": 3,
"REQUEST_TIMEOUT_DURATION": 60,
"SESSION_BUFFER_TIME": 3600,
"PRICE_POINT_CURRENCY_SYMBOL": "USD",
"PRICE_POINT_TOKEN_SYMBOL": "OST",
"USE_SEED_PASSWORD": false,
"NO_OF_SESSIONS_ON_ACTIVATE_USER": 1
}- BLOCK_GENERATION_TIME: The time in seconds it takes to mine a block on auxiliary chain.
- PRICE_POINT_CURRENCY_SYMBOL: It is the symbol of quote currency used in price conversion.
- REQUEST_TIMEOUT_DURATION: Request timeout in seconds for https calls made by ostWalletSdk.
- PIN_MAX_RETRY_COUNT: Maximum retry count to get the wallet Pin from user.
- SESSION_BUFFER_TIME: Buffer expiration time for session keys in seconds. Default value is 3600 seconds.
- USE_SEED_PASSWORD: The seed password is salt to PBKDF2 used to generate seed from the mnemonic. When
UseSeedPasswordset to true, different deterministic salts are used for different keys. - PRICE_POINT_TOKEN_SYMBOL: This is the symbol of base currency. So its value will be
OST. - NO_OF_SESSIONS_ON_ACTIVATE_USER: No of session keys to be created and whitelisted while activating user.
-
Place the file under main directory's assets folder
File path example: app -> src -> main -> assets -> ost-mobilesdk.json
NOTE: These configurations are MANDATORY for successful operation. Failing to set them will significantly impact usage.
SDK initialization should happen before calling any other workflow. To initialize the SDK, you need to call initialize method of Wallet SDK.
Recommended location to call init() is in Application sub-class.
import android.app.Application;
import com.ost.mobilesdk.OstWalletSdk;
public class App extends Application {
public static final String OST_PLATFORM_API_BASE_URL = "https://api.ost.com/testnet/v2";
@Override
public void onCreate() {
super.onCreate();
OstWalletSdk.initialize(getApplicationContext(), OST_PLATFORM_API_BASE_URL);
}
} void initialize(context, baseUrl)
| Parameter | Description |
|---|---|
| context ApplicationContext |
Application context can be retrieved by calling getApplicationContext() |
| baseUrl String |
OST Platform API endpoints: 1. Sandbox Environment: https://api.ost.com/testnet/v2/ 2. Production Environment: https://api.ost.com/mainnet/v2/ |
-
Workflows: Workflows are the core functions provided by wallet SDK to do wallet related actions. Workflows can be called directly by importing the SDK.- Application must confirm to
OstWorkFlowCallbackinterface. TheOstWorkFlowCallbackinterface defines methods that allow applications to interact with Android Wallet SDK.
- Application must confirm to
-
Getters: The SDK provides getter methods that applications can use for various purposes. These methods provide the application with data as available in the device's database. These functions are synchronous and will return the value when requested. -
JSON APIs: Allows application to access OST Platform APIs
This workflow needs userId and tokenId so setupDevice should be called after your app login or signup is successful.
Using the mapping between userId in OST Platform and your app user, you have access to userId and tokenId.
If the user is logged in, then setupDevice should be called every time the app launches, this ensures that the current device is registered before communicating with OST Platform server.
void setupDevice( String userId,
String tokenId,
OstWorkFlowCallback workFlowCallback)
| Parameter | Description |
|---|---|
| userId String |
Unique identifier of the user stored in OST Platform |
| tokenId String |
Unique identifier for the token economy |
| workFlowCallback OstWorkFlowCallback |
An object that implements the callback functions available in OstWorkFlowCallback interface. These callback functions are needed for communication between app and wallet SDK. Implement flowComplete and flowInterrupt callback functions to get the workflow status. Details about other callback function can be found in OstWorkFlowCallback interface reference.This should implement registerDevice function. registerDevice will be called during the execution of this workflow. |
It authorizes the registered device and activates the user. User activation deploys the TokenHolder and Device manager contracts on blockchain. Session keys are also created and authorized during activateUser workflow. So after user activation, users can perform wallet actions like executing transactions and reset PIN.
void activateUser(UserPassphrase passphrase,
long expiresAfterInSecs,
String spendingLimit,
OstWorkFlowCallback callback)
| Parameter | Description |
|---|---|
| userPassPhrase UserPassphrase |
A simple struct to hold and transfer pin information via app and SDK. |
| expiresAfterInSecs long |
Expire time of session key in seconds. |
| spendingLimit String |
Spending limit of session key in atto BT. |
| workFlowCallback OstWorkFlowCallback |
An object that implements the callback functions available in OstWorkFlowCallback interface. These callback functions are needed for communication between app and wallet SDK. Implement flowComplete and flowInterrupt callback functions to get the workflow status. Details about other callback function can be found in OstWorkFlowCallback interface reference. |
This workflow will create and authorize the session key that is needed to do the transactions. This flow should be called if the session key is expired or not present.
void addSession( String userId,
long expireAfterInSecs,
String spendingLimit,
OstWorkFlowCallback workFlowCallback)
| Parameter | Description |
|---|---|
| userId String |
Unique identifier of the user stored in OST Platform |
| expiresAfterInSecs long |
Expire time of session key in seconds. |
| spendingLimit String |
Spending limit of session key in atto BT. |
| workFlowCallback OstWorkFlowCallback |
An object that implements the callback functions available in OstWorkFlowCallback interface. These callback functions are needed for communication between app and wallet SDK. Implement flowComplete and flowInterrupt callback functions to get the workflow status. Details about other callback function can be found in OstWorkFlowCallback interface reference. |
This workflow will perform operations after reading data from a QRCode. This workflow can used to add a new device and to execute transactions.
void performQRAction(String userId,
String data,
OstWorkFlowCallback workFlowCallback)
| Parameter | Description |
|---|---|
| userId String |
Unique identifier of the user stored in OST Platform |
| data String |
JSON object string scanned from QR code. |
| workFlowCallback OstWorkFlowCallback |
An object that implements the callback functions available in OstWorkFlowCallback interface. These callback functions are needed for communication between app and wallet SDK. Implement flowComplete and flowInterrupt callback functions to get the workflow status. Details about other callback function can be found in OstWorkFlowCallback interface reference. |
To get the 12 words recovery phrase of the current device key. Users will use it to prove that it is their wallet.
void getPaperWallet( String userId,
OstWorkFlowCallback workFlowCallback)
| Parameter | Description |
|---|---|
| userId String |
Unique identifier of the user stored in OST Platform |
| workFlowCallback OstWorkFlowCallback |
An object that implements the callback functions available in OstWorkFlowCallback interface. These callback functions are needed for communication between app and wallet SDK. Implement flowComplete and flowInterrupt callback functions to get the workflow status. Details about other callback function can be found in OstWorkFlowCallback interface reference. |
To do user-to-company and user-to-user transactions.
void executeTransaction(String userId,
String tokenId,
List tokenHolderAddresses,
List amounts,
String ruleName,
Map<String,String> meta,
Map<String,String> options,
OstWorkFlowCallback workFlowCallback)| Parameter | Description |
|---|---|
| userId String |
Unique identifier of the user stored in OST Platform |
| tokenId String |
Unique identifier for the token economy |
| tokenHolderAddresses List |
TokenHolder addresses of amount receiver |
| amounts List |
Amount to be transferred in atto. |
| ruleName String |
Rule name to be executed. |
| meta Map<String,String> |
Transaction Meta properties. Example: {"name": "transaction name", "type": "user-to-user" (it can take one of the following values: user_to_user, user_to_company and company_to_user), "details": "like"} |
| options Map<String,String> |
Optional settings parameters. You can set following values: 1. currency_code: Currency code for the pay currency. Example: {"currency_code": "USD"} |
| workFlowCallback OstWorkFlowCallback |
An object that implements the callback functions available in OstWorkFlowCallback interface. These callback functions are needed for communication between app and wallet SDK. Implement flowComplete and flowInterrupt callback functions to get the workflow status. Details about other callback function can be found in OstWorkFlowCallback interface reference. |
To add a new device using 12 words recovery phrase.
void addDeviceUsingMnemonics( String userId,
byte[] mnemonics,
OstWorkFlowCallback ostWorkFlowCallback)
| Parameter | Description |
|---|---|
| userId String |
Unique identifier of the user stored in OST Platform |
| mnemonics byte[] |
byte array of 12 words. |
| workFlowCallback OstWorkFlowCallback |
An object that implements the callback functions available in OstWorkFlowCallback interface. These callback functions are needed for communication between app and wallet SDK. Implement flowComplete and flowInterrupt callback functions to get the workflow status. Details about other callback function can be found in OstWorkFlowCallback interface reference. |
To change the PIN.
User will have to provide the current PIN in order to change it.
void resetPin(String userId,
String appSalt,
String currentPin,
String newPin,
OstWorkFlowCallback workFlowCallback)
| Parameter | Description |
|---|---|
| userId String |
Unique identifier of the user stored in OST Platform |
| appSalt String |
|
| currentPin String |
Current PIN |
| newPin String |
New PIN |
| workFlowCallback OstWorkFlowCallback |
An object that implements the callback functions available in OstWorkFlowCallback interface. These callback functions are needed for communication between app and wallet SDK. Implement flowComplete and flowInterrupt callback functions to get the workflow status. Details about other callback function can be found in OstWorkFlowCallback interface reference. |
A user can control their tokens using their authorized device(s). If a user loses their authorized device, the user can recover access to her tokens by authorizing a new device by initiating the recovery process.
void initiateDeviceRecovery(String userId,
UserPassphrase passphrase,
String deviceAddressToRecover,
OstWorkFlowCallback workFlowCallback)| Parameter | Description |
|---|---|
| userId String |
Unique identifier of the user stored in OST Platform |
| passphrase UserPassphrase |
A simple struct to hold and transfer pin information via app and SDK. |
| deviceAddressToRecover String |
Address of device to recover |
| workFlowCallback OstWorkFlowCallback |
An object that implements the callback functions available in OstWorkFlowCallback interface. These callback functions are needed for communication between app and wallet SDK. Implement flowComplete and flowInterrupt callback functions to get the workflow status. Details about other callback function can be found in OstWorkFlowCallback interface reference. |
To abort the initiated device recovery.
void abortDeviceRecovery(String userId,
UserPassphrase passphrase,
OstWorkFlowCallback workFlowCallback)| Parameter | Description |
|---|---|
| userId String |
Unique identifier of the user stored in OST Platform |
| passphrase UserPassphrase |
A simple struct to hold and transfer pin information via app and SDK. |
| workFlowCallback OstWorkFlowCallback |
An object that implements the callback functions available in OstWorkFlowCallback interface. These callback functions are needed for communication between app and wallet SDK. Implement flowComplete and flowInterrupt callback functions to get the workflow status. Details about other callback function can be found in OstWorkFlowCallback interface reference. |
To revoke all the sessions associated with provided userId.
void logoutAllSessions(String userId,
OstWorkFlowCallback workFlowCallback)| Parameter | Description |
|---|---|
| userId String |
Unique identifier of the user stored in OST Platform |
| workFlowCallback OstWorkFlowCallback |
An object that implements the callback functions available in OstWorkFlowCallback interface. These callback functions are needed for communication between app and wallet SDK. Implement flowComplete and flowInterrupt callback functions to get the workflow status. Details about other callback function can be found in OstWorkFlowCallback interface reference. |
This getter function will return the QRCode Bitmap that can be used to show on screen. This QRCode can then be scanned to add the new device.
Bitmap getAddDeviceQRCode(String userId)
| Parameter | Description |
|---|---|
| userId String |
Unique identifier of the user stored in OST Platform |
This returns the loggedin User entity.
OstUser getUser(userId)| Parameter | Description |
|---|---|
| userId String |
Unique identifier of the user stored in OST Platform |
Method to get user's current device by Id.
This is a synchronous method and must be used only after calling setupDevice workflow.
This method returns OstToken only if available with SDK. Returns null otherwise.
It does NOT make any server side calls.
OstDevice getCurrentDeviceForUserId(String userId)| Parameter | Description |
|---|---|
| userId String |
Unique identifier of the user stored in OST Platform |
This returns the token entity.
OstToken getToken(tokenId)| Parameter | Description |
|---|---|
| tokenId String |
Unique identifier of token economy in OST Platform |
To get the biometric preferneces call this function.
boolean isBiometricEnabled(userId)| Parameter | Description |
|---|---|
| userId String |
Unique identifier of the user stored in OST Platform |
Method to get user's active sessions available in current device that can execute transactions of given spending limit.
This is a synchronous method and must be used only after calling setupDevice workflow.
List<OstSession> getActiveSessionsForUserId(@NonNull String userId, @Nullable String minimumSpendingLimitInWei)| Parameter | Description |
|---|---|
| userId String |
Unique identifier of the user stored in OST Platform |
| minimumSpendingLimitInWei String |
Minimum spending limit of the sessions |
This can also be initialized without minimumSpendingLimitInWei
List<OstSession> getActiveSessionsForUserId(@NonNull String userId)Api to get user balance. Balance of only current logged-in user can be fetched.
Parameters
parameter userId: User Id of the current logged-in user.
parameter callback: callback where to receive data/error.
getBalance(userId, callback)
OstJsonApi.getBalance(userId, new OstJsonApiCallback() {
@Override
public void onOstJsonApiSuccess(@Nullable JSONObject data) { }
@Override
public void onOstJsonApiError(@NonNull OstError err, @Nullable JSONObject response) { }
}
);Api to get Price Points. It will provide latest conversion rates of base token to fiat currency.
Parameters
parameter userId: User Id of the current logged-in user.
parameter callback: callback where to receive data/error.
getPricePoints(userId, callback)
OstJsonApi.getPricePoints(userId, new OstJsonApiCallback() {
@Override
public void onOstJsonApiSuccess(@Nullable JSONObject data) { }
@Override
public void onOstJsonApiError(@NonNull OstError err, @Nullable JSONObject response) { }
}
);Api to get user balance and Price Points. Balance of only current logged-in user can be fetched. It will also provide latest conversion rates of base token to fiat currency.
Parameters
parameter userId: User Id of the current logged-in user.
parameter callback: callback where to receive data/error.
getBalanceWithPricePoints(userId, callback)
OstJsonApi.getBalanceWithPricePoints(userId, new OstJsonApiCallback() {
@Override
public void onOstJsonApiSuccess(@Nullable JSONObject data) { }
@Override
public void onOstJsonApiError(@NonNull OstError err, @Nullable JSONObject response) { }
}
);Api to get user transactions. Transactions of only current logged-in user can be fetched.
Parameters
parameter userId: User Id of the current logged-in user.
parameter requestPayload: request payload. Such as next-page payload, filters etc.
parameter callback: callback where to receive data/error.
getTransactions(userId, requestPayload, callback)
OstJsonApi.getTransactions(userId, requestPayload, new OstJsonApiCallback() {
@Override
public void onOstJsonApiSuccess(@Nullable JSONObject data) { }
@Override
public void onOstJsonApiError(@NonNull OstError err, @Nullable JSONObject response) { }
}
);Api to get status of pending ongoing recovery.
Parameters
parameter userId: User Id of the current logged-in user.
parameter callback: callback where to receive data/error.
getPendingRecovery(userId, callback)
OstJsonApi.getPendingRecovery(userId, new OstJsonApiCallback() {
@Override
public void onOstJsonApiSuccess(@Nullable JSONObject data) { }
@Override
public void onOstJsonApiError(@NonNull OstError err, @Nullable JSONObject response) { }
}
);Callbacks to be implemented by application before calling any of the above OstJsonApis.
/**
* Inform SDK user about Success of OstJsonApi
* @param data Response data
*/
public void onOstJsonApiSuccess(@Nullable JSONObject data) { }| Argument | Description |
|---|---|
| data JSONObject |
Api Response data |
/**
* Inform SDK user about Failure of OstJsonApi
* @param err OstError object containing error details
* @param response Api response
*/
public void onOstJsonApiError(@NonNull OstError err, @Nullable JSONObject response) { }| Argument | Description |
|---|---|
| err OstError |
OstError object containing error details |
| response JSONObject |
Api Response |
Android SDK provides an interface to be implemented by the Java class calling the workflows.
The interface name is OstWorkFlowCallback
import com.ost.mobilesdk.workflows.interfaces.OstWorkFlowCallback;
This function will be called by wallet SDK when a workflow is completed. The details of workflow and the entity that was updated during the workflow will be available in arguments.
void flowComplete(OstWorkflowContext ostWorkflowContext, OstContextEntity ostContextEntity)
| Argument | Description |
|---|---|
| ostWorkflowContext OstWorkflowContext |
Information about the workflow |
| ostContextEntity OstContextEntity |
Information about the entity |
This function will be called by wallet SDK when a workflow is cancelled. The workflow details and error details will be available in arguments.
void flowInterrupt(OstWorkflowContext ostWorkflowContext, OstError ostError)
| Argument | Description |
|---|---|
| ostWorkflowContext OstWorkflowContext |
Information about the workflow |
| ostError OstError |
ostError object will have details about the error that interrupted the flow |
This function will be called by wallet SDK when the core API request was successful which happens during the execution of workflows. At this stage the workflow is not completed but it shows that the main communication between the wallet SDK and OST Platform server is complete.
Once the workflow is complete the app will receive the details in flowComplete (described below) function.
void requestAcknowledged(OstWorkflowContext ostWorkflowContext, OstContextEntity ostContextEntity)
| Argument | Description |
|---|---|
| ostWorkflowContext OstWorkflowContext |
Information about the workflow |
| ostContextEntity OstContextEntity |
Information about the entity |
This function will be called by wallet SDK when it needs to get the PIN from the app user to authenticate any authorised action.
Expected Function Definition: Developers of client company are expected to launch their user interface to get the PIN from the user and pass back this PIN to SDK by calling ostPinAcceptInterface.pinEntered()
void getPin(String userId, OstPinAcceptInterface ostPinAcceptInterface)
| Argument | Description |
|---|---|
| userId String |
Unique identifier of the user |
| ostPinAcceptInterface OstPinAcceptInterface |
ostPinAcceptInterface.pinEntered() should be called to pass the PIN back to SDK. For some reason if the developer wants to cancel the current workflow they can do it by calling ostPinAcceptInterface.cancelFlow() |
This function will be called by wallet SDK when the last entered PIN is validated.
void pinValidated(String userId)
| Argument | Description |
|---|---|
| userId String |
Unique identifier of the user |
This function will be called by wallet SDK when the last entered PIN was wrong and app user has to provide the PIN again. Developers are expected to repeat the getPin method here and pass back the PIN again back to the SDK by calling ostPinAcceptInterface.pinEntered() .
void invalidPin(String userId, OstPinAcceptInterface ostPinAcceptInterface)
| Argument | Description |
|---|---|
| userId String |
Unique identifier of the user |
| ostPinAcceptInterface OstPinAcceptInterface |
ostPinAcceptInterface.pinEntered() should be called to again pass the PIN back to SDK. For some reason if the developer wants to cancel the current workflow they can do it by calling ostPinAcceptInterface.cancelFlow() |
This function will be called by wallet SDK to register the device.
Expected Function Definition: Developers of client company are expected to register the device by communicating with client company's server. On client company's server they can use Server SDK to register this device in OST Platform. Once the device is registered on OST Platform client company's server will receive the newly created device entity. This device entity should be passed back to the app.
Finally they should pass back this newly created device entity back to the wallet SDK by calling OstDeviceRegisteredInterface.deviceRegistered(JSONObject newDeviceEntity ).
void registerDevice(JSONObject apiParams, OstDeviceRegisteredInterface ostDeviceRegisteredInterface)
| Argument | Description |
|---|---|
| apiParams JSONObject |
Device information for registration |
| ostDeviceRegisteredInterface OstDeviceRegisteredInterface |
OstDeviceRegisteredInterface.deviceRegistered(JSONObject newDeviceEntity ) should be called to pass the newly created device entity back to SDK. In case data is not verified the current workflow should be canceled by developer by calling OstDeviceRegisteredInterface.cancelFlow() |
This function will be called by wallet SDK to verify data during performQRAction workflow.
void verifyData(OstWorkflowContext ostWorkflowContext, OstContextEntity ostContextEntity, OstVerifyDataInterface ostVerifyDataInterface)
| Argument | Description |
|---|---|
| ostWorkflowContext OstWorkflowContext |
Information about the current workflow during which this callback will be called |
| ostContextEntity OstContextEntity |
Information about the entity |
| ostVerifyDataInterface OstVerifyDataInterface |
ostVerifyDataInterface.dataVerified() should be called if the data is verified successfully. In case data is not verified the current workflow should be canceled by developer by calling ostVerifyDataInterface.cancelFlow() |
| User Activity | App State | User Status | Device Status | Session status |
|---|---|---|---|---|
| Installs app for the first time | Not Login | CREATED | UNREGISTED | NA |
| Login in the app for the first time | Log In | CREATED | REGISTERED | NA |
| Initiate Activate Wallet by entering pin | Activating Wallet | ACTIVATING | AUTHORIZING | INITIALIZING |
| Activates Wallet after waiting | Activated Wallet | ACTIVATED | AUTHORIZED | AUTHORISED |
| Performs transactions | Activated Wallet | ACTIVATED | AUTHORIZED | AUTHORISED |
| Session get expired | Activated Wallet | ACTIVATED | AUTHORIZED | EXPIRED |
| Logout all Sessions | Activated Wallet | ACTIVATED | AUTHORIZED | REVOKING -> REVOKED |
| Add Session | Activated Wallet | ACTIVATED | AUTHORIZED | INITIALIZING -> AUTHORISED |
| Log out from app | Not Login | ACTIVATED | AUTHORIZED | AUTHORISED |
| Log in back to App | Activated Wallet | ACTIVATED | AUTHORIZED | AUTHORISED |
| Reinstall the App | No Login | CREATED | UNREGISTED | NA |
| Login in the app | Log In | ACTIVATED | REGISTERED | NA |
| Recover Wallet Or Add Wallet | Activating Wallet | ACTIVATED | AUTHORIZING -> AUTHORISED | NA |
| Revoked Device from other device | Activated Wallet | ACTIVATED | REVOKING -> REVOKED | NA |
To get real time updates of entities like ongoing activation Or transactions, server side SDK's WebHooks services can be used.
- Check whether User need Activation.
- Check whether Wallet need Device Addition Or Recovery.
- For device addition, the current Device which is to be Authorized should used OstSdk.getAddDeviceQRCode to generate QR code And OstSdk.performQRAction() method should be used to process that QR from AUTHORIZED deivce.
- Device can also be added through OstSdk.authorizeCurrentDeviceWithMnemonics() by passing AUTHORIZED device mnemonics.
- Or Device can be recovered through OstSdk.initiateDeviceRecovery() by passing Device address of the Device to be recovered from.
if (!(ostUser.isActivated() || ostUser.isActivating())) {
//TODO:: Wallet need Activation
} else if (ostUser.isActivated() && ostUser.getCurrentDevice().canBeAuthorized()) {
//TODO:: Ask user whether he wants to Add device through QR or Mnemonics Or want to recover device.
} else {
//TODO:: App Dashboard
}- TokenHolder Balance can be shown in Token currency or in Fiat currency.
- For Token currency conversion, the fetched balance is in Wei unit, which needs to be converted to Base unit.
- For Fiat currency conversion, the fetched balance first need to be converted to fiat equivalent using current converion rate from price points and then to its Base unit.
OstJsonApi.getBalanceWithPricePoints(userId, new OstJsonApiCallback() {
@Override
public void onOstJsonApiSuccess(@Nullable JSONObject jsonObject) {
if ( null != jsonObject ) {
String balance = "0";
JSONObject pricePoint = null;
try{
JSONObject balanceData = jsonObject.getJSONObject(jsonObject.getString("result_type"));
balance = balanceData.getString("available_balance");
pricePoint = jsonObject.optJSONObject("price_point");
} catch(Exception e){
}
//To user balance in token currency with two decimals.
convertWeiToTokenCurrency(balance);
//To user balance in fiat(Dollar) with two decimals.
convertBTWeiToFiat(balance, pricePoint)
} else {
//Todo:: Show fetch error
}
}
@Override
public void onOstJsonApiError(@NonNull OstError err, @Nullable JSONObject data) {
//Todo:: Show fetch error
}
});
public static String convertWeiToTokenCurrency(String balance) {
if (null == balance) return "0";
OstToken token = OstSdk.getToken(AppProvider.getTokenId());
Integer decimals = Integer.parseInt(token.getBtDecimals());
BigDecimal btWeiMultiplier = new BigDecimal(10).pow(decimals);
BigDecimal balance = new BigDecimal(balance).divide(btWeiMultiplier);
return balance.setScale(2, RoundingMode.HALF_UP).toString();
}
public static String convertBTWeiToFiat(String balance, JSONObject pricePointObject) {
if (null == balance || null == pricePointObject) return null;
try{
OstToken token = OstSdk.getToken(AppProvider.getTokenId());
double pricePointOSTtoUSD = pricePointObject.getJSONObject(token.getBaseToken()).getDouble("USD");
int fiatDecimalExponent = pricePointObject.getJSONObject(token.getBaseToken()).getInt("decimals");
BigDecimal fiatToEthConversionFactor = new BigDecimal("10").pow(fiatDecimalExponent);
BigDecimal tokenToFiatMultiplier = calTokenToFiatMultiplier(pricePointOSTtoUSD, fiatDecimalExponent, token.getConversionFactor(), Integer.parseInt(token.getBtDecimals()));
BigDecimal fiatBalance = new BigDecimal(balance).multiply(tokenToFiatMultiplier);
return fiatBalance.divide(fiatToEthConversionFactor, 2, RoundingMode.DOWN).toString();
} catch (Exception e){
return null;
}
}- OstError
- OstContextEntity
- OstWorkflowContext
This class is used to provide error details in flowInterrupt callback function.
You can call the following methods on this object to get more details about the error.
public OstErrors.ErrorCode getErrorCode()public String getInternalErrorCode()public boolean isApiError()
This class provides context about the entity that is being changed during a workflow. Callback functions that needs to know about the entity will receive an object of this class as an argument.
You can call the following methods on this object to get more details about the entity.
public OstContextEntity(String message, Object entity, String entityType)public OstContextEntity(Object entity, String entityType)public String getMessage()public Object getEntity()public String getEntityType()
This class provides context about the current workflow. Callback function that needs to know about the current workflow will get the object of this class as an argument.
You can call the following methods on this object to get more details about the current workflow.
The getWorkflow_type() methods will return one of the strings from this enum.
public enum WORKFLOW_TYPE {
UNKNOWN,
SETUP_DEVICE,
ACTIVATE_USER,
ADD_SESSION,
GET_DEVICE_MNEMONICS,
PERFORM_QR_ACTION,
EXECUTE_TRANSACTION,
AUTHORIZE_DEVICE_WITH_QR_CODE,
AUTHORIZE_DEVICE_WITH_MNEMONICS,
INITIATE_DEVICE_RECOVERY,
ABORT_DEVICE_RECOVERY,
REVOKE_DEVICE_WITH_QR_CODE,
RESET_PIN,
LOGOUT_ALL_SESSIONS
}public OstWorkflowContext(WORKFLOW_TYPE workflow_type)public OstWorkflowContext()public WORKFLOW_TYPE getWorkflow_type()
- Download AAR file from S3 Download link
- Create libs folder under app directory in your application project.
- In libs folder add your downloaded aar file.
- Add aar lib dependency to your build.gradle file
implementation files('libs/ostsdk-release.aar')
- Also add dependencies of ostsdk in you build.gradle
dependencies {
// your app dependencies
//--- Section to Copy ----
// Room components
implementation "android.arch.persistence.room:runtime:1.1.1"
annotationProcessor "android.arch.persistence.room:compiler:1.1.1"
implementation 'com.madgag.spongycastle:core:1.56.0.0'
implementation 'org.web3j:core:4.1.0-android'
// Lifecycle components
implementation "android.arch.lifecycle:extensions:1.1.1"
annotationProcessor "android.arch.lifecycle:compiler:1.1.1"
// https://mvnrepository.com/artifact/com.google.guava/guava
implementation 'com.google.guava:guava:18.0'
// Zxing barcode dependency
implementation 'me.dm7.barcodescanner:zxing:1.9.8'
//---Section to Copy ----
}- Clean and then Build your Android project.
For quick and easy integration with SDK, developers can use built-in user interface components which are configurable and support content and theme customization. All OstWalletSdkUI workflows return workflow-id. The application can subscribe to the events of the workflow using the workflow-id. Please refer OstWalletUI.
If your Application is using TrustKit, Please refer TrustKit Public Key Pinning