Antora docs

docs/antora.yml

@@ -0,0 +1,5 @@
+name: client-sdk-android
+title: Ost Client (Mobile Wallet) SDK Android
+version: '1.0'
+nav:
+- modules/ROOT/nav.adoc

docs/modules/ROOT/examples/OstSdkMessages-CustomLoader.json

@@ -0,0 +1,105 @@
+{
+  "ACTIVATE_USER": {
+    "SUCCESS_MESSAGE": "User activated"
+  },
+  "ADD_SESSION": {
+    "SUCCESS_MESSAGE": "Session added"
+  },
+  "GET_DEVICE_MNEMONICS": {
+  },
+  "PERFORM_QR_ACTION": {
+    "SUCCESS_MESSAGE": "Workflow completed!"
+  },
+  "AUTHORIZE_DEVICE_WITH_QR_CODE": {
+    "SUCCESS_MESSAGE": "Device authorized"
+  },
+  "AUTHORIZE_DEVICE_WITH_MNEMONICS": {
+    "SUCCESS_MESSAGE": "Device authorized"
+  },
+  "INITIATE_DEVICE_RECOVERY": {
+    "SUCCESS_MESSAGE": "Recovery initiated"
+  },
+  "ABORT_DEVICE_RECOVERY": {
+    "SUCCESS_MESSAGE": "Aborted recovery"
+  },
+  "RESET_PIN": {
+    "SUCCESS_MESSAGE": "PIN has been successfully reset"
+  },
+  "LOGOUT_ALL_SESSIONS": {
+    "SUCCESS_MESSAGE": "User Activated Successfully"
+  },
+  "UPDATE_BIOMETRIC_PREFERENCE": {
+    "SUCCESS_MESSAGE": "Biometric updated"
+  },
+  "EXECUTE_TRANSACTION": {
+    "SUCCESS_MESSAGE": "Tranasction executed"
+  },
+  "__DEFAULT_CONTEXT": {
+    "USER_UNAUTHORIZED": "Device is not authorized. Please authorize device again.",
+    "DEVICE_OUT_OF_SYNC": "Device time is out of sync. Please check the time on your device reflects current date and time.",
+    "NETWORK_ERROR": "Request could not be executed due to cancellation, a connectivity problem or timeout.",
+    "INVALID_MNEMONICS": "The 12 word passphrase you provided is incorrect. ",
+    "INVALID_QR_TRANSACTION_DATA": "The QR code for executing a transaction is not well formed. To know the data definition for QR code based on type of operations please visit https://dev.ost.com/platform ",
+    "INVALID_USER_PASSPHRASE": "The 6 digit PIN you entered is not correct.",
+    "MAX_PASSPHRASE_VERIFICATION_LIMIT_REACHED": "The maximum number of 'authenticating with PIN' attempts has been reached. Please try again a bit later.",
+    "DEVICE_CAN_NOT_BE_AUTHORIZED": "Unable to authorize this device. Please ensure the device is 'Registered' for this user with OST platform. Only a registered device can be authorized.",
+    "SESSION_NOT_FOUND": "The device doesn't has any active session. Please authorize a session before doing any transaction. Workflow details provided at https://dev.ost.com/platform/docs/sdk/references ",
+    "INVALID_QR_CODE": "Incorrect QR code.",
+    "RECOVERY_KEY_GENERATION_FAILED": "Failed to generate Recovery key. Inspect if a correct input values required are being sent and re-submit the request. ",
+    "OUT_OF_MEMORY_ERROR": "Device is running low on memory. Reduce the number of App running on your device and re-enter the pin",
+    "WORKFLOW_FAILED": "Something went wrong, please try again",
+    "WORKFLOW_VIEW_DESTROYED": "The application interrupted the workflow. The view got terminated while performing the workflow",
+    "DEVICE_UNAUTHORIZED": "Unable to perform the operation as the device not authorized. For details on how to authorize a device please visit https://dev.ost.com/platform/docs/sdk/references ",
+    "DEVICE_CAN_NOT_BE_REVOKED": "Cannot complete the revoke device operation. Only an authorized device can be revoked. Please ensure you are trying to revoke a valid device and re-submit the request.",
+    "WORKFLOW_CANCELED": "WORKFLOW_CANCELLED",
+    "WORKFLOW_CANCELLED": "WORKFLOW_CANCELLED"
+  },
+  "__DEVELOPER_ERROR_MSG": {
+    "SDK_ERROR": "An internal SDK error has occurred.",
+    "INVALID_CERTIFICATE": "Certificate provided by Ost platform is invalid Or it has been compromised. Please re-try in some other network and if the problem persists contact [email protected] .",
+    "INVALID_USER_ID": "Unable to recognize the user id. Please inspect for what is being sent, rectify and re-submit.",
+    "INVALID_API_END_POINT": "Invalid OST server url",
+    "INVALID_NETWORK_SECURITY_CONFIG": "Invalid network_security_config file",
+    "INVALID_WORKFLOW_CALLBACK": "Callback is essential for a workflow to continue running, it cannot be null.",
+    "API_RESPONSE_ERROR": "OST Platform Api ed error.",
+    "CONFIG_READ_FAILED": "Failed to read config file. Please place the ost-sdk config file in main/assets folder.",
+    "INVALID_BLOCK_GENERATION_TIME": "Invalid configuration 'BLOCK_GENERATION_TIME'. It must be an Integer greater than zero",
+    "INVALID_PIN_MAX_RETRY_COUNT": "Invalid configuration 'PIN_MAX_RETRY_COUNT'. It must be an Integer greater than zero",
+    "INVALID_SESSION_BUFFER_TIME": "Invalid configuration 'SESSION_BUFFER_TIME'. It must be long greater than or equal to zero",
+    "INVALID_PRICE_POINT_CURRENCY_SYMBOL": "Unable to recognize 'PRICE_POINT_CURRENCY_SYMBOL'. For details on how supported currencies please vist https://dev.ost.com/platform/docs/api ",
+    "INVALID_REQUEST_TIMEOUT_DURATION": "Invalid configuration 'REQUEST_TIMEOUT_DURATION'. It must be Integer greater than zero.",
+    "INVALID_NO_OF_SESSIONS_ON_ACTIVATE_USER": "Invalid configuration 'NO_OF_SESSIONS_ON_ACTIVATE_USER'. It must be an Integer greater than zero and less than 6",
+    "INVALID_API_RESPONSE": "Unable to recognize the API response object sent and so cannot be executed.",
+    "INVALID_JSON_STRING": "The provided json string is invalid.",
+    "INVALID_JSON_ARRAY": "The provided json array string is invalid.",
+    "INVALID_REVOKE_DEVICE_ADDRESS": "Unable to recognise revoke device address. Please ensure you are sending a null value and re-submit the request.",
+    "NO_PENDING_RECOVERY": "Could not find any pending device recovery request. For details on how to check the status of the recovery please vist https://dev.ost.com/platform/docs/sdk ",
+    "EIP712_FAILED": "Unable to sign parameters using EIP 712 and verify the signature.",
+    "RULES_NOT_FOUND": "Unable to recognize the Rule. Please inspect a valid rule name that exists in your economy is passed and its not null.",
+    "DEVICE_NOT_SETUP": "Unable to recognize the device. Please setup this device for the user using workflow provided at https://dev.ost.com/platform/docs/sdk/references",
+    "DEVICE_NOT_REGISTERED": "Device is not registered. To make any api to OST server device need to be registered",
+    "POLLING_TIMEOUT": "Polling timeout. This can be intermittent event with a request failing followed by successful one.",
+    "INVALID_TOKEN_ID": "The token id sent in Transaction QR code is not matching with the current user's token id. Rectify the value is being sent in token Id field and re-submit the request.",
+    "INVALID_RECOVER_DEVICE_ADDRESS": "Invalid device address. This address can not be recovered.",
+    "INVALID_SESSION_EXPIRY_TIME": "The expiry time provided is invalid",
+    "INVALID_SESSION_SPENDING_LIMIT": "The spending limit provided is invalid should be more than 0",
+    "RECOVERY_OWNER_ADDRESS_NOT_FOUND": "Recovery owner is not set for this user. This address is set during user activation. Please verify the user has been successfully activated.",
+    "INSUFFICIENT_DATA": "The device does not have sufficient data to perform this action.",
+    "INVALID_SESSION_ADDRESS": "Unable to recognize the session address. Inspect if a correct value is being sent and its not null. ",
+    "FAILED_TO_SIGN_DATA": "Unable to sign data. Visit https://dev.ost.com/platform/docs/sdk for detailed SDK references. Please ensure the input is well formed and re-submit the request.",
+    "INVALID_DEVICE_ADDRESS": "Incorrect device address. Please inspect the value being sent is correct and not null, rectify and re-submit.",
+    "GENERATE_PRIVATE_KEY_FAIL": "This is a generic error that occurs when sdk fails to generate any one of Api Key, Device Key or Session Key. This can be intermittent issue, please re-start the workflow. If Problem persists contact [email protected] .",
+    "INVALID_PASSPHRASE_PREFIX": "Unable to recognize the Passphrase prefix. Please ensure Passphrase prefix is not null or it's string length is not less than 30. ",
+    "USER_NOT_ACTIVATED": "The user is not activated yet. Please setup user's wallet to enable their participation in your economy. ",
+    "USER_ALREADY_ACTIVATED": "The User is already activated",
+    "USER_ACTIVATING": "User activation flow is already in progress. Please check the status a bit later",
+    "WORKFLOW_CANCELLED": "Workflow got cancelled, possibly because one or more input parameters require a different type of information.",
+    "INVALID_NEW_USER_PASSPHRASE": "The new 6 digit PIN you entered is not correct.",
+    "INVALID_ADDRESS_TO_TRANSFER": "INVALID_ADDRESS_TO_TRANSFER",
+    "INVALID_AMOUNT": "INVALID_AMOUNT",
+    "INVALID_WORKFLOW": "INVALID_WORKFLOW",
+    "INVALID_RECOVERY_ADDRESS": "INVALID_RECOVERY_ADDRESS",
+    "USER_PASSPHRASE_VALIDATION_LOCKED": "Can not validate user passphrase because of too many wrong attempts.",
+    "UNKNOWN": "Unknown error"
+  }
+}

docs/modules/ROOT/nav.adoc

@@ -0,0 +1,8 @@
+* xref:index.adoc[Overview]
+* xref:OstJsonApi.adoc[Ost JSON API]
+* xref:OstWalletUI.adoc[Ost Wallet UI]
+* xref:ContentConfig.adoc[UI Content Config]
+* xref:ThemeConfig.adoc[UI Theme Config]
+* xref:OstCustomLoader.adoc[Ost Custom Loader]
+* xref:TrustKitPublickeyPinning.adoc[TrustKit Public Key Pinning]
+* xref:CHANGELOG.adoc[Change Log]

docs/modules/ROOT/pages/CHANGELOG.adoc

@@ -0,0 +1,149 @@
+= OST Wallet SDK Changelog
+
+== Version 2.4.1
+
+=== Feature
+
+* User can authorize external session by scanning QR-Code.
+* User can pass QR-Code payload to perform QR-Code actions without opening Scanner in OstWalletUI.
+This functionality is available for `scanQRCodeToAuthorizeSession`, `scanQRCodeToExecuteTransaction`, `scanQRCodeToAuthorizeDevice`.
+
+== Version 2.4.0
+
+=== Feature
+
+* `getRedeemableSkus` and `getRedeemableSkuDetails` apis added in `OstJsonApi`.
+
+== Version 2.3.8
+
+=== Changes:
+
+* Reduced recovery key generation time substantially by leveraging on NDK.
+
+=== Bug Fix:
+
+* In OstWalletSDK UI workflows progress bar crashes in background.
+
+== Version 2.3.7
+
+=== Bug Fix:
+
+* Inaccurate error is thrown when application runs out of memory during recover device workflow.
+
+== Version 2.3.6
+
+=== Changes:
+
+* Added support for custom loader for OstWalletSDK UI workflows.
+* OstWalletSDK now uses custom annotations to provide AndroidX compatibility.
++
+=== Bug Fix:
+* Rectified OST_PLATFORM_ERROR error message.
+
+== Version 2.3.5
+
+=== Security Enhancements:
+
+* Use of FLAG_SECURE flag to protect show mnemonices view against screen recording and screen shotting.
+* Use of filterTouchesWhenObscured security flag in base view to protects against tapjacking attacks.
+
+== Version 2.3.4
+
+=== Bug Fixes:
+
+* Device list inconsistency fix in manage devices.
+* User entity current device caching fix.
+* Converted Toast error message of enter mnemonics view to inline error message
+
+== Version 2.3.3
+
+=== Changes:
+
+* Proguard usage to remove verbose and debug logs.
+
+== Version 2.3.2
+
+=== Bug Fixes:
+
+* Fixed a bug where some android phones were not able to provide pin.
+
+== Version 2.3.1
+
+=== Feature:
+
+* OstWalletUI now supports
+ ** get add device QR-Code
+ ** scan QR-Code to authorize device
+ ** scan QR-Code to execute transaction
+ ** authorize current device with mnemonics
+* Api provided to fetch current device from OstPlatform.
+* Now supports getting active sessions from Sdk.
+
+== Version 2.3.0
+
+=== Feature:
+
+* OstWalletSdk now contains UI.
+* UI components can be modified.
+* Languages for UI workflow components can be modified.
+* OstWalletUI now supports
+ ** activate user
+ ** create session
+ ** get device mnemonics
+ ** revoke device
+ ** reset pin
+ ** initiate device recovery
+ ** abort device recovery
+ ** update biometric preference
+
+== Version 2.2.2
+
+=== Bug Fix:
+
+* Crash fixes in OstWallet
+
+=== Security Enhancements
+
+* Trustkit reinitialization check
+
+== Version 2.2.1
+
+=== Bug Fix:
+
+* Add `No Network Access` error to OstApiError
+
+=== Security Enhancements
+
+* Implemented public-key pinning for api.ost.com
+
+== Version v2.2.0
+
+=== Changes:
+
+* Added Multi Currency Feature which allows developers to specify fiat-currency at runtime while executing a transaction.
+* Added OstJsonApi that allows developers to fetch data from Ost Platform.
+Please see README.MD for supported Api(s).
+
+== Version 2.1.0
+
+=== Changes:
+
+* Biometric preferences are now saved in the SDK
+* Remove hard-coding of OST as the value token that backs Brand Tokens
+* Now supports device access revocation via API
+
+== Version 2.0.1
+
+=== Changes:
+
+* Added CHANGELOG.md
+* Removed OstBaseWorkFlow.loadCurrentDevice method and changed it's usage in OstResetPin
+* Removed OstBaseWorkFlow.loadUser method and changed it's usage in OstResetPin
+* Removed OstBaseWorkFlow.loadToken method
+* Removed OstBaseWorkFlow(String userId, Handler handler, OstWorkFlowCallback callback) constructor
+* Removed unused method OstUser.sign()
+* Removed OstSdkCrypto class & OstCrypto interface
+* Removed utils.KeyGenProcess class & KeyGenProcessTest test-case
+* Use a deterministic password along with Mnemonics to generate keys.
+Using a deterministic password not only increases security, but also ensures that no two users can accidentally generate the same key
+* `USE_SEED_PASSWORD` configuration added to support backwards compatibility with v2.0.0