Skip to content

Latest commit

 

History

History
877 lines (642 loc) · 36.3 KB

README.md

File metadata and controls

877 lines (642 loc) · 36.3 KB
Raw

OST Wallet SDK iOS

Introduction

OST iOS Wallet SDK is a mobile application development SDK that enables developers to integrate the functionality of a non-custodial crypto-wallet into consumer applications.

The iOS 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

Starting version 2.3.0 the SDK also provides built-in user interface components which are configurable and support content and theme customization. Please refer to OST Wallet UI.

Support

  • iOS version : 9.0 and above (recommended version 10.3 )
  • Swift version: 4.2

Dependencies

We use open-source code from the projects listed below. The Set-up section below provides instructions on adding the packages to your code.

Table of Contents

Set-up

A). Installing iOS Wallet SDK using Carthage

i). Installing Carthage

Get Carthage by running the following command on terminal

brew install carthage

You can also choose other methods to install Carthage


ii). Installing wallet SDK using Carthage

Carthage looks at a file called Cartfile to determine which libraries to install. Create a file in the same directory as your Xcode project called Cartfile and enter the following to tell Carthage which dependencies we want:

Add following entry in your Cartfile

github "ostdotcom/ost-wallet-sdk-ios"  == 2.4.1

Now to actually install everything run the following in your terminal:

carthage update --platform iOS

A Cartfile.resolved file and a Carthage directory will appear in the same directory where your .xcodeproj or .xcworkspace is.


iii). Copying the OstWalletSdk.framework file in your Xcode project

Open your project in Xcode, click on the project file in the left section of the screen and scroll down to the Linked Frameworks and Libraries section in Xcode.

Carthage folder will have the .framework files that we will add in Xcode project.

Now open the Carthage/Build/iOS folder in Finder:

Run this command

open Carthage/Build/iOS

Open application target, under General tab, drag the built OstWalletSdk.framework binary from Carthage/Build/iOS folder into Linked Frameworks and Libraries section.

copy-framework-file

iv). Adding the OstWalletSdk dependencies in your Xcode project

We need to add the .framework files of dependencies present inside Carthage/Build/iOS.

Open application targets in Xcode. Under Build Phases click + icon and choose New Run Script Phase. Add the following command.

/usr/local/bin/carthage copy-frameworks

Click the + under Input Files and add the following framework entires:

$(SRCROOT)/Carthage/Build/iOS/Alamofire.framework
$(SRCROOT)/Carthage/Build/iOS/BigInt.framework
$(SRCROOT)/Carthage/Build/iOS/CryptoEthereumSwift.framework
$(SRCROOT)/Carthage/Build/iOS/CryptoSwift.framework
$(SRCROOT)/Carthage/Build/iOS/EthereumKit.framework
$(SRCROOT)/Carthage/Build/iOS/FMDB.framework
$(SRCROOT)/Carthage/Build/iOS/SipHash.framework
$(SRCROOT)/Carthage/Build/iOS/TrustKit.framework
$(SRCROOT)/Carthage/Build/iOS/OstWalletSdk.framework

copy-framework-file

v). Adding SDK configuration file

Create OstWalletSdk.plist file. This file has configuration attributes used by OstWalletSdk. You should copy paste the configuration values from below snippet.

Copy paste this configuration file.

<?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
 <plist version="1.0">
 <dict>
    <key>BlockGenerationTime</key>
    <integer>3</integer>
    <key>PricePointTokenSymbol</key>
    <string>OST</string>
    <key>PricePointCurrencySymbol</key>
    <string>USD</string>
    <key>RequestTimeoutDuration</key>
    <integer>30</integer>
    <key>PinMaxRetryCount</key>
    <integer>3</integer>
    <key>SessionBufferTime</key>
    <integer>3600</integer>
    <key>UseSeedPassword</key>
	<false/>
    <key>EnableIOSDeviceRestore</key>
	<false/>
 </dict>
 </plist>
  1. BlockGenerationTime: The time in seconds it takes to mine a block on auxiliary chain.
  2. PricePointTokenSymbol: This is the symbol of base currency. So its value will be OST.
  3. PricePointCurrencySymbol: It is the symbol of quote currency used in price conversion.
  4. RequestTimeoutDuration: Request timeout in seconds for https calls made by ostWalletSdk.
  5. PinMaxRetryCount: Maximum retry count to get the wallet Pin from user.
  6. SessionBufferTime: Buffer expiration time for session keys in seconds. Default value is 3600 seconds.
  7. UseSeedPassword: The seed password is salt to PBKDF2 used to generate seed from the mnemonic. When UseSeedPassword set to true, different deterministic salts are used for different keys.
  8. EnableIOSDeviceRestore: When EnableIOSDeviceRestore set to true, After reinstallation, SDK check for available device key in Keychain for given user id.

These configurations are MANDATORY for successful operation. Failing to set them will significantly impact usage.

vi). Add NSFaceIDUsageDescription description in info.plist

The iOS Wallet SDK can use FaceID in lieu of fingerprint if the hardware supports it. To support faceID, please include NSFaceIDUsageDescription key in your application's info.plist file and describe its usage.

Note: NSFaceIDUsageDescription key is supported in iOS 11 and later.

vii). Initialize the Wallet SDK

SDK initialization should happen before calling any other workflow. To initialize the SDK, we need to call init workflow of Wallet SDK. It initializes all the required instances and run db migrations.

Recommended location to call OstWalletSdk.initialize() is in application method of UIApplicationDelegate.

func application(_ application: UIApplication,
                didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
    do {
        try OstWalletSdk.init(apiEndPoint: <OST_PLATFORM_API_ENDPOINT>)
     } catch let ostError {
           // Handle error here
     }
     return true
}
OstWalletSdk.initialize(apiEndPoint: String)
Parameter Description
apiEndPoint
String		 OST PLATFORM API ENDPOINT:
1. Sandbox Environment: https://api.ost.com/testnet/v2/
2. Production Environment: https://api.ost.com/mainnet/v2/

OST Wallet SDK APIs

Types of Methods

  1. Workflows: Workflows are the core functions provided by wallet SDK to do wallet related actions. Workflows can be called directly by importing the SDK.

    • Callbacks must confirm to OstWorkflowDelegate protocol. The OstWorkflowDelegate protocol defines methods that allow application to interact with OstWalletSdk.

  2. 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.

  3. JSON APIs: Allows application to access OST Platform APIs.

Workflows

setupDevice

This workflow needs userId and tokenId so setupDevice should be called when the application has determined that the user is logged in state. 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.

OstWalletSdk.setupDevice(
    userId: String,
    tokenId: String,
    delegate: OstWorkflowDelegate
)
Parameter Description
userId
String		 Unique identifier of the user stored in OST Platform
tokenId
String		 Unique identifier of the token economy
delegate
OstWorkflowDelegate		 An instance of a class that implements the callback function available in OstWorkflowDelegate protocol. 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 OstWorkflowDelegate protocol reference.
This object should implement registerDevice callback function. registerDevice will be called during the execution of this workflow.

activateUser

It authorizes the registered device and activates the user. User activation deploys 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. activateUser needs to be executed once for a user in an economy.

OstWalletSdk.activateUser(
    userId: String,
    userPin: String,
    passphrasePrefix: String,
    spendingLimit: String,
    expireAfterInSecs: TimeInterval,
    delegate: OstWorkflowDelegate
)
Parameter Description
userId
String		 Unique identifier of the user stored in OST Platform
userPin
String		 User's PIN created during wallet setup.
passphrasePrefix
String		 A constant unique identifier for your user.
spendingLimit
String		 Spending limit of session key in atto BT.
expireAfterInSec
TimeInterval		 Expire time of session key in seconds.
delegate
OstWorkflowDelegate		 An instance of a class that implements the callback function available in OstWorkflowDelegate protocol. 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 OstWorkflowDelegate protocol reference.

addSession

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.

OstWalletSdk.addSession(
    userId: String,
    spendingLimit: String,
    expireAfterInSecs: TimeInterval,
    delegate: OstWorkflowDelegate
)
Parameter Description
userId
String		 Unique identifier of the user stored in OST Platform
spendingLimit
String		 Spending limit of session key in atto BT.
expireAfterInSecs
long		 Expire time of session key in seconds.
delegate
OstWorkflowDelegate		 An instance of a class that implements the callback function available in OstWorkflowDelegate protocol. 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 OstWorkflowDelegate protocol reference.

performQRAction

This workflow will perform operations after reading data from a QR-Code. This workflow can be used to add a new device and to execute transactions.

OstWalletSdk.performQRAction(
    userId: String,
    payload: String,
    delegate: OstWorkflowDelegate
)
Parameter Description
userId
String		 Unique identifier of the user stored in OST Platform
data
String		 JSON object string scanned from QR code.
Sample QRCode JSON
delegate
OstWorkflowDelegate		 An instance of a class that implements the callback function available in OstWorkflowDelegate protocol. 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 OstWorkflowDelegate protocol reference.

getDeviceMnemonics

To get the 12 words recovery phrase of the current device key. Users will use it to prove that it is their wallet.

OstWalletSdk.getDeviceMnemonics(
    userId: String,
    delegate: OstWorkflowDelegate
)
Parameter Description
userId
String		 Unique identifier of the user stored in OST Platform
delegate
OstWorkflowDelegate		 An instance of a class that implements the callback function available in OstWorkflowDelegate protocol. 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 OstWorkflowDelegate protocol reference.

executeTransaction

Workflow should be used when user wants to transfer tokens.

OstWalletSdk.executeTransaction(
    userId: String,
    tokenHolderAddresses: [String],
    amounts: [String],
    transactionType: OstExecuteTransactionType,
    meta: [String: String],
    options: [String: Any],
    delegate: OstWorkflowDelegate
)
Parameter Description
userId
String		 Unique identifier of the user stored in OST Platform
tokenHolderAddresses
[String]		 TokenHolder addresses of beneficiary users.
amounts
[String]		 Array of Amount to be transferred in atto.
transactionType
OstExecuteTransactionType		 Transaction type can take one of the two values:
1. DirectTransfer: In this type of transaction, the amount of brand token will be transferred directly to the receiver user.
2. Pay: In this type of transaction the amount of fiat passed will first be converted into brand token and after this conversion the transfer will happen in converted brand token amount.
meta
[String: String]		 Dictionary object having extra information that a developer can pass about the transfer. This dictionary object can have 3 properties.

Example meta:
[
   "name":"Thanks for like",
   "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
[String: Any]		 Optional settings parameters. You can set following values:
1. currency_code: Currency code for the pay currency.
Example: {"currency_code": "USD"}
delegate
OstWorkflowDelegate		 An instance of a class that implements the callback function available in OstWorkflowDelegate protocol. 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 OstWorkflowDelegate protocol reference.

authorizeCurrentDeviceWithMnemonics

To add a new device using 12 words recovery phrase.

OstWalletSdk.authorizeCurrentDeviceWithMnemonics(
    userId: String,
    mnemonics: [String],
    delegate: OstWorkflowDelegate
)
Parameter Description
userId
String		 Unique identifier of the user stored in OST Platform
mnemonics
[String]		 Array of String having 12 words
delegate
OstWorkflowDelegate		 An instance of a class that implements the callback function available in OstWorkflowDelegate protocol. 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 OstWorkflowDelegate protocol reference.

resetPin

To change the PIN.

User will have to provide the current PIN in order to change it.

OstWalletSdk.resetPin(
    userId: String,
    passPhrasePrefix: String,
    oldUserPin: String,
    newUserPin: String,
    delegate: OstWorkflowDelegate
)
Parameter Description
userId
String		 Unique identifier for the user of economy
passPhrasePrefix
String		 A constant unique identifier for a your user.
oldUserPin
String		 Current wallet PIN
newUserPin
String		 New wallet PIN
delegate
OstWorkflowDelegate		 An instance of a class that implements the callback function available in OstWorkflowDelegate protocol. 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 OstWorkflowDelegate protocol reference.

initiateDeviceRecovery

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.

OstWalletSdk.initiateDeviceRecovery(
    userId: String,
    recoverDeviceAddress: String,
    userPin: String,
    passphrasePrefix: String,
    delegate: OstWorkflowDelegate
    )
Parameter Description
userId
String		 Unique identifier for the user of economy
recoverDeviceAddress
String		 Unique identifier for the user of economy
userPin
String		 User's Wallet PIN
passPhrasePrefix
String		 A constant unique identifier for a your user.
delegate
OstWorkflowDelegate		 An instance of a class that implements the callback function available in OstWorkflowDelegate protocol. 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 OstWorkflowDelegate protocol reference.

abortDeviceRecovery

To abort the initiated device recovery.

OstWalletSdk.abortDeviceRecovery(
    userId: String,
    userPin: String,
    passphrasePrefix: String,
    delegate: OstWorkflowDelegate)
Parameter Description
userId
String		 Unique identifier for the user of economy
userPin
String		 User's Wallet PIN
passPhrasePrefix
String		 A constant unique identifier for a your user.
delegate
OstWorkflowDelegate		 An instance of a class that implements the callback function available in OstWorkflowDelegate protocol. 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 OstWorkflowDelegate protocol reference.

logoutAllSessions

To revoke all sessions associated with the provided userId.

OstWalletSdk.logoutAllSessions(
    userId: String,
    delegate: OstWorkflowDelegate)
Parameter Description
userId
String		 Unique identifier for the user of economy
delegate
OstWorkflowDelegate		 An instance of a class that implements the callback function available in OstWorkflowDelegate protocol. 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 OstWorkflowDelegate protocol reference.

revokeDevice

To revoke device access.

OstWalletSdk.revokeDevice(
    userId: String,
    deviceAddressToRevoke: String,
    delegate: OstWorkflowDelegate)
Parameter Description
userId
String		 Unique identifier for the user of economy
deviceAddressToRevoke
String		 Wallet address of the device to revoke.
delegate
OstWorkflowDelegate		 An instance of a class that implements the callback function available in OstWorkflowDelegate protocol. 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 OstWorkflowDelegate protocol reference.

updateBiometricPreference

To enable or disable the biometric.

OstWalletSdk.updateBiometricPreference(
    userId: String,
    enable: Bool,
    delegate: OstWorkflowDelegate)
Parameter Description
userId
String		 Unique identifier for the user of economy
enable
Bool		 Preference to use the biometric.
delegate
OstWorkflowDelegate		 An instance of a class that implements the callback function available in OstWorkflowDelegate protocol. 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 OstWorkflowDelegate protocol reference.

Getters

getAddDeviceQRCode

This workflow will return the QRCode in the form of CIImage object that can be used to show on screen. This QRCode can then be scanned to add the new device.

OstWalletSdk.getAddDeviceQRCode(
    userId: String
) throws -> CIImage?
Parameter Description
userId
String		 Unique identifier of the user stored in OST Platform

Returns

Type Description
CIImage QRCode CIImage object.

getUser

Get user entity for given userId.

OstWalletSdk.getUser(userId: String)
Parameter Description
userId
String		 Unique identifier of the user stored in OST Platform

Returns

Type Description
User The user object

getToken

Get token entity for given tokenId.

OstWalletSdk.getToken(tokenId: String)
Parameter Description
tokenId
String		 Unique identifier of the token

Returns

Type Description
Token The token object

user.getCurrentDevice

Get current device of user.

let user: OstUser = OstWalletSdk.getUser(userId: String)
let device: OstCurrentDevice = user.getCurrentDevice()
Parameter Description
userId
String		 Unique identifier of the user stored in OST Platform

Returns

Type Description
device The device object

isBiometricEnabled

Get biometric preference of the user.

OstWalletSdk.isBiometricEnabled(userId: String)
Parameter Description
userId
String		 Unique identifier of the user stored in OST Platform

Returns

Type Description
Preference
Bool		 true if user has enabled biometric verfication.

getActiveSessions

Get active sessions for given spending limit. If passed spending limit is nil, return all active sessions.

OstWalletSdk.getActiveSessions(
    userId: String, 
    spendingLimit: String?
) -> [OstSession]
Parameter Description
userId
String		 Unique identifier of the user stored in OST Platform
spendingLimit
String		 Transction amount

Returns

Type Description
OstSession
Array		 List of active sessions

OST Workflow Delegate Protocol

flowComplete

This function will be called by SDK when a workflow is completed. The details of workflow and the entity that was updated during the workflow will be available in the arguments.

func flowComplete(
        workflowContext: OstWorkflowContext, 
        ostContextEntity: OstContextEntity
        )
Argument Description
ostWorkflowContext
OstWorkflowContext		 Information about the workflow
ostContextEntity
OstContextEntity		 Information about the entity

flowInterrupt

This function will be called by SDK when a workflow fails or cancelled. The workflow details and error details will be available in the arguments.

func flowInterrupted(
        workflowContext: OstWorkflowContext, 
        error: OstError
)
Argument Description
ostWorkflowContext
OstWorkflowContext		 Information about the workflow
ostError
OstError		 ostError object will have details about the error that interrupted the flow

requestAcknowledged

This function will be called by 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 function and if the workflow fails then app will receive the details in flowInterrupt function.

func requestAcknowledged(
        workflowContext: OstWorkflowContext, 
        ostContextEntity: OstContextEntity
        )
Argument Description
ostWorkflowContext
OstWorkflowContext		 Information about the workflow
ostContextEntity
OstContextEntity		 Information about the entity

getPin

This function will be called by SDK when it needs to get the PIN from the app user to authenticate any authorized action.


Expected Function Definition: Developers of client company are expected to launch their UI to get the PIN from the user and pass back this PIN to SDK by calling delegate.pinEntered(_ userPin: String, passphrasePrefix: String)

func getPin(
        _ userId: String, 
        delegate: OstPinAcceptDelegate
        )
Argument Description
userId
String		 Unique identifier of the user
delegate
OstPinAcceptDelegate		 delegate.pinEntered(_ userPin: String, passphrasePrefix: String) 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 delegate.cancelFlow()

pinValidated

This function will be called by SDK when PIN is validated.

func pinValidated(_ userId: String)
Argument Description
userId
String		 Unique identifier of the user

invalidPin

This function will be called by SDK when the entered PIN is incorrect and app user has to provide the PIN again. Developers are expected to get the PIN from user again and pass back the PIN back to the SDK by calling delegate.pinEntered(_ userPin: String, passphrasePrefix: String) .

func invalidPin(
        _ userId: String, 
        delegate: OstPinAcceptDelegate
        )
Argument Description
userId
String		 Unique identifier of the user
delegate
OstPinAcceptDelegate		 delegate.pinEntered(_ userPin: String, passphrasePrefix: String) 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 delegate.cancelFlow()

registerDevice

This function will be called by SDK to register the device.
Expected Function Definition: Developers of client company are expected to register the device by communicating with their company's server. On client company's server they can use Server SDK to register this device in OST Platform. Once device is registered on OST 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 delegate.deviceRegistered(_ apiResponse: [String: Any]).

func registerDevice(
        _ apiParams: [String: Any], 
        delegate: OstDeviceRegisteredDelegate
        )
Argument Description
apiParams
[String: Any]		 Device information for registration
delegate
OstDeviceRegisteredDelegate		 delegate.deviceRegistered(_ apiResponse: [String: Any] ) should be called to pass the newly created device entity back to SDK.
In case data if there is some issue while registering the device then the current workflow should be canceled by calling delegate.cancelFlow()

verifyData

This function will be called by SDK to verify the data during performQRAction workflow.

func verifyData(
        workflowContext: OstWorkflowContext, 
        ostContextEntity: OstContextEntity, 
        delegate: OstValidateDataDelegate
        )
Argument Description
workflowContext
OstWorkflowContext		 Information about the current workflow during which this callback will be called
ostContextEntity
OstContextEntity		 Information about the entity
delegate
OstValidateDataDelegate		 delegate.dataVerified() should be called if the data is verified successfully.
In case data is not verified the current workflow should be canceled by calling delegate.cancelFlow()

OST JSON APIs

While the getter methods provide application with data stored in device's database, the JSON API methods make API calls to OST Platform servers. Please refer to OST JSON API for documentation.

Classes

  1. OstApiError
  2. OstError
  3. OstContextEntity

OstApiError

This class is used to provide API related error details in flowInterrupt callback function.

You can call following methods on the object of this class to get more details about the error.

A). Methods

  1. public func getApiErrorCode() -> String?
  2. public func getApiErrorMessage() -> String?
  3. public func getApiInternalId() -> String?
  4. public func isBadRequest() -> Bool
  5. public func isDeviceTimeOutOfSync() -> Bool
  6. public func isApiSignerUnauthorized() -> Bool

OstError

This class is used to provide error details in flowInterrupt callback function.

You can read following properties on the object of this class to get more details about the error.

A). Properties

  1. public internal(set) var isApiError = false
  2. public let internalCode:String
  3. public let errorMessage:String
  4. public let messageTextCode:OstErrorText;
  5. public var errorInfo: [String: Any]? = nil

OstContextEntity

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.

entityType property will return one of the values from this enum.

public enum OstEntityType {
    case device,
    user,
    array,
    session,
    transaction,
    recoveryOwner,
    string,
    dictionary,
    tokenHolder
}

You can read the following properties to get more details about the entity.

i) Properties

public private(set) var entity: Any?
public private(set) var entityType: OstEntityType

OST Workflow Context

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.

workflowType property will take one of the values from this enum.

public enum OstWorkflowType {
    case setupDevice,
    activateUser,
    addSession,
    getDeviceMnemonics,
    performQRAction,
    executeTransaction,
    authorizeDeviceWithQRCode,
    authorizeDeviceWithMnemonics,
    initiateDeviceRecovery,
    abortDeviceRecovery,
    revokeDeviceWithQRCode,
    resetPin,
    logoutAllSessions
}

You can read the following properties to get more details about the current workflow.

i) Properties

a) workflowType

public let workflowType: OstWorkflowType