Unity (Android)

20min
This guide is for anyone who wishes to integrate the Enefits Unity SDK for android o the Unity project.

We highly recommend reviewing the General Usage guide to familiarise yourself with general SDK workflow concepts before continuing.

You will need to generate an API key with your Enefits account before continuing with integration.
To obtain an API key, simply register at https://x.enefits.co/, and go to Developer in the account menu in the top right section. From there, generate an API key and save this for SDK initialization.
﻿
We only show this once, so if you lose this API Key, you’ll have to re-generate it from the Developer section.
Run the Demo
To run a live demo, download EnefitsDemoApp.

Open it with Unity and provide your own API key where requested.

Also, note that EnefitsDemoApp requires an android device to work. It will not work in the Unity Editor Or the android Emulator.
Make sure you have android Build options support available in Unity.
﻿
Also, make sure you have support for android build OR android studio installed.

Go to Unity -> File -> Build Settings.
Make sure 'android' option is selected.

Select option 'Build', it will ask for a location where unity will generate Android Project.
Select a location, then it will generate Android Project at a specified location.
Open generated android project with android studio.
Adding SDK dependencies to the Android project
Open build.gradle file of exportAndroid Project.
add jitpack maven to repositories.
Kotlin
maven { url 'https://jitpack.io' }
maven { url 'https://jitpack.io' }
﻿
Also, add wallet connect dependencies.
Kotlin
classpath 'com.github.WalletConnect:kotlin-walletconnect-lib:0.9.9'
classpath 'com.github.WalletConnect:kotlin-walletconnect-lib:0.9.9'
﻿
Open build.gradle file of Launcher module.
add the following dependencies.
Kotlin
implementation 'androidx.core:core-ktx:1.8.0'

implementation 'androidx.appcompat:appcompat:1.4.2'

implementation 'androidx.constraintlayout:constraintlayout:2.1.4'


// WalletConnect

implementation 'com.github.walletconnect:kotlin-walletconnect-lib:0.9.8'

implementation 'com.github.komputing:khex:1.1.2'

// JSON

implementation 'com.squareup.moshi:moshi-adapters:1.13.0'

implementation 'com.squareup.moshi:moshi-kotlin:1.13.0'

// Http

implementation 'com.squareup.okhttp3:okhttp:5.0.0-alpha.3'

implementation 'com.google.code.gson:gson:2.9.1'
implementation 'androidx.core:core-ktx:1.8.0'

implementation 'androidx.appcompat:appcompat:1.4.2'

implementation 'androidx.constraintlayout:constraintlayout:2.1.4'


// WalletConnect

implementation 'com.github.walletconnect:kotlin-walletconnect-lib:0.9.8'

implementation 'com.github.komputing:khex:1.1.2'

// JSON

implementation 'com.squareup.moshi:moshi-adapters:1.13.0'

implementation 'com.squareup.moshi:moshi-kotlin:1.13.0'

// Http

implementation 'com.squareup.okhttp3:okhttp:5.0.0-alpha.3'

implementation 'com.google.code.gson:gson:2.9.1'
﻿
Download Enefits SDK Unity Package
The EnefitsSDK Unity android package can be downloaded from this link.

Import Enefits SDK Unity Package
Select Project layout. Go to the Assets folder. Right-click and select Import Package -> Custom Package.

﻿
Select a downloaded Enefits package and choose 'Open'.

Make sure all components are selected from the package and then click on 'Import'.
﻿
SDK Setup
Please make sure to call any SDK method inside 'UNITY_ANDROID && !UNITY_EDITOR' block, as it is only available for android device:
#if UNITY_ANDROID && !UNITY_EDITOR
    // call SDK method here
#endif

Initialize The SDK
C#
    AndroidJavaClass unityPlayer;
    AndroidJavaObject unityActivity;
    AndroidJavaObject enefitsPlugin;

    EnefitsSessionCallback enefitsSessionCallback;
    EnefitsOffersCallback enefitsOffersCallback;
    AndroidJavaClass unityPlayer;
    AndroidJavaObject unityActivity;
    AndroidJavaObject enefitsPlugin;

    EnefitsSessionCallback enefitsSessionCallback;
    EnefitsOffersCallback enefitsOffersCallback;
﻿
C#
private void Start()
{

    unityPlayer = new AndroidJavaClass("com.unity3d.player.UnityPlayer");
    enefitsPlugin = new AndroidJavaObject("com.enefits.connect.Enefits");

    #if !UNITY_EDITOR && UNITY_ANDROID
        unityActivity = unityPlayer.GetStatic<AndroidJavaObject>("currentActivity");
    #endif
    enefitsSessionCallback = new EnefitsSessionCallback();
    enefitsOffersCallback = new EnefitsOffersCallback();
}
private void Start()
{

    unityPlayer = new AndroidJavaClass("com.unity3d.player.UnityPlayer");
    enefitsPlugin = new AndroidJavaObject("com.enefits.connect.Enefits");

    #if !UNITY_EDITOR && UNITY_ANDROID
        unityActivity = unityPlayer.GetStatic<AndroidJavaObject>("currentActivity");
    #endif
    enefitsSessionCallback = new EnefitsSessionCallback();
    enefitsOffersCallback = new EnefitsOffersCallback();
}
﻿
C#
 public void isSDKInit(){
     #if UNITY_ANDROID && !UNITY_EDITOR
        enefitsPlugin.Call("init", unityActivity, "<API_key>", "<App_Name>", enefitsSessionCallback);
    #endif
 }
 public void isSDKInit(){
     #if UNITY_ANDROID && !UNITY_EDITOR
        enefitsPlugin.Call("init", unityActivity, "<API_key>", "<App_Name>", enefitsSessionCallback);
    #endif
 }
﻿
<App_Name> - string type - describes your Unity application name
<API_key> - string type - API key provided to you during the registration at  https://x.enefits.co/.
EnefitsSessionCallback.cs has a method 'onInitComplete', where you will get init call status.
C#
  public void onInitComplete(bool status) {
   // status = true : sdk init success.
   // status = false: sdk init failed.
}
  public void onInitComplete(bool status) {
   // status = true : sdk init success.
   // status = false: sdk init failed.
}
﻿

Connect Wallet
Display a button or call-to-action (for example: 'Connect Wallet') which when tapped will prompt the user to connect a wallet.
After the user selects a wallet and initiates a session, the returned address will be available to the Enefits SDK to check NFTs and any offers the user is eligible for.
This function will open a view with a list of supported providers
Enefits SDK fires the callback after successfully connecting with a blockchain account.

C#
 public void ConnectToWallet()
    {
     #if UNITY_ANDROID && !UNITY_EDITOR

        if (isSDKInitSuccess)
        {
            bool isAccountConnected = enefitsPlugin.Call<bool>("connectAccount");
        } else
        {
            // log message: Please init SDK first.
        }
    #endif
    }
 public void ConnectToWallet()
    {
     #if UNITY_ANDROID && !UNITY_EDITOR

        if (isSDKInitSuccess)
        {
            bool isAccountConnected = enefitsPlugin.Call<bool>("connectAccount");
        } else
        {
            // log message: Please init SDK first.
        }
    #endif
    }
﻿
EnefitsSessionCallback.cs has a method called 'onSessionConnected', where you will get information about wallet connection address and info about blockchain.
C#
  public void onSessionConnected(string address, string blockchainInfo)
    {
        
    }
  public void onSessionConnected(string address, string blockchainInfo)
    {
        
    }
﻿
 and if the unity client app is not able to connect to the wallet then,
C#
  public void onSessionDisconnected()    {
        
    }
  public void onSessionDisconnected()    {
        
    }
﻿
and if no supported wallet app is installed in device, then you will get EnefitsSessionCallback.cs callback at:
C#
      public void onAppInstalledOrNot(bool isAppInstalled) {
        //isAppInstalled = false : No supported wallet app installed
      }
      public void onAppInstalledOrNot(bool isAppInstalled) {
        //isAppInstalled = false : No supported wallet app installed
      }
﻿
Get All Enefits Offers
This method returns all Offers that the user is eligible for based on the address they provided when they connected their wallet.
C#
 public void GetOffers() {
    #if UNITY_ANDROID && !UNITY_EDITOR
        if (isWalletConnected && isSDKInitSuccess) {
            enefitsPlugin.Call("getOffers", enefitsOffersCallback);
        }
    #endif
}
 public void GetOffers() {
    #if UNITY_ANDROID && !UNITY_EDITOR
        if (isWalletConnected && isSDKInitSuccess) {
            enefitsPlugin.Call("getOffers", enefitsOffersCallback);
        }
    #endif
}
﻿
you will receive offers related information in EnefitsOffersCallback.cs 
C#
public void didfinishwithOffers(string error, string offers){

}
public void didfinishwithOffers(string error, string offers){

}
﻿
Helper Functions
Use the functions provided below to create tighter integration with the Enefits SDK and manage user connectivity states.
To Check if SDK init success or failed:
C#
 public void isSDKInit() {
    #if UNITY_ANDROID && !UNITY_EDITOR
        bool issuccess = enefitsPlugin.Call<bool>("isInitComplete");
        Debug.Log("is SDK init complete? : " + issuccess);
    #endif
}
 public void isSDKInit() {
    #if UNITY_ANDROID && !UNITY_EDITOR
        bool issuccess = enefitsPlugin.Call<bool>("isInitComplete");
        Debug.Log("is SDK init complete? : " + issuccess);
    #endif
}
﻿
To Check if Enefits SDK was able to connect to a blockchain account.
C#
 public void isAccountConnnected() {
    #if UNITY_ANDROID && !UNITY_EDITOR
        bool issuccess = enefitsPlugin.Call<bool>("isAccountConnected");
        Debug.Log("is Account Connected ? : " + issuccess);
    #endif
}
 public void isAccountConnnected() {
    #if UNITY_ANDROID && !UNITY_EDITOR
        bool issuccess = enefitsPlugin.Call<bool>("isAccountConnected");
        Debug.Log("is Account Connected ? : " + issuccess);
    #endif
}
﻿
Get the address of the connected account.
C#
 public void ConnectedAccountInfo() {
    #if UNITY_ANDROID && !UNITY_EDITOR
        if (isWalletConnected && isSDKInitSuccess) {
            string accountInfo = enefitsPlugin.Call<string>("getConnectedAccount");
            Debug.Log("Connected Account info : " + accountInfo);
        }
    #endif
}
 public void ConnectedAccountInfo() {
    #if UNITY_ANDROID && !UNITY_EDITOR
        if (isWalletConnected && isSDKInitSuccess) {
            string accountInfo = enefitsPlugin.Call<string>("getConnectedAccount");
            Debug.Log("Connected Account info : " + accountInfo);
        }
    #endif
}
﻿
Get the blockchain info for the connected account.
C#
public void GetChainData() {
    #if UNITY_ANDROID && !UNITY_EDITOR
        if (Logs.isWalletConnected && Logs.isSDKInitSuccess) {
            string chainDataInfo = enefitsPlugin.Call<string>("getChainData");
            Debug.Log("Chain Data info : " + chainDataInfo);
        }
    #endif           
}
public void GetChainData() {
    #if UNITY_ANDROID && !UNITY_EDITOR
        if (Logs.isWalletConnected && Logs.isSDKInitSuccess) {
            string chainDataInfo = enefitsPlugin.Call<string>("getChainData");
            Debug.Log("Chain Data info : " + chainDataInfo);
        }
    #endif           
}
﻿
Disconnect from the blockchain account.
C#
 public void onSessionDisconnected(){
    Debug.Log("onSessionDisconnected");
}

 public void onSessionDisconnected(){
    Debug.Log("onSessionDisconnected");
}
﻿
Once the Wallet becomes disconnected, method onSessionDisconnected will be called from EnefitsSessionCallback.cs.
Updated 03 Mar 2023
Unity
Unity (iOS)