Unity SDK

The Openfort SDK for Unity

SUPPORTED PLATFORMS

Windows (64-bit)
macOS (minimum version 12.5)
Android (minimum version 5.1)
iOS (minimum version 15.2)

SUPPORTED UNITY VERSIONS

Unity 2021.3 or newer for Windows, macOS, Android and iOS
Unity 2019.4 or newer for macOS, Android, and iOS. Windows isn't supported on Unity versions from 2019.4 up through 2021.2.

TARGET PLATFORM VS UNITY EDITOR PLATFORM

We have added compilation flags to the Unity SDK to ensure that specific Unity editors can only build certain platform targets. Please note that the table below indicates which editor you can use to build a platform target, but it does not determine whether you can run the SDK in that editor.

For example, the SDK allows you to build iOS games using a macOS Unity Editor, but you cannot use the Windows Unity Editor.

Target Platform	Windows Unity Editor	macOS Unity Editor
Windows	✅	❌
macOS	❌	✅
Android	✅	✅
iOS	❌	✅

Installation#

Prerequisites

The Unity SDK requires UniTask package (version 2.3.3) as specified in package.json. How to install UniTask: Follow these instructions. Please check the Unity requirements to ensure a successful integration.

Since .dll files are stored on Git Large File Storage, you must download and install git-lfs from here.

Open the Package Manager
Click the add + button and select "Add package from git URL..." Enter https://github.com/openfort-xyz/openfort-csharp-unity.git?path=/src/Packages/OpenfortSDK and click 'Add'

Quickstart#

Initialize OpenfortSDK#

using Openfort.OpenfortSDK;
using Openfort.OpenfortSDK.Model;
public class openfortManager: MonoBehaviour {
    private OpenfortSDK openfort;
    const string PublishableKey = "YOUR_OPENFORT_PUBLISHABLE_KEY";
    const string ShieldApiKey = "YOUR_SHIELD_PUBLISHABLE_KEY";
    const string ShieldEncryptionShare = "YOUR_SHIELD_ENC_SHARE";
    private async void Start()
    {
        openfort = await OpenfortSDK.Init(PublishableKey, ShieldApiKey, ShieldEncryptionShare);
    }
}

Authentication Methods#

1. Email and Password#

await openfort.LogInWithEmailPassword(email, password);

2. OAuth (e.g., Google)#

OAuthInitRequest request = new OAuthInitRequest()
{
    Provider = OAuthProvider.Google,
    UsePooling = true, // For WebGL or standalone Windows
    // For other platforms:
    // UsePooling = false,
    // Options = new OAuthInitRequestOptions()
    // {
    //     RedirectTo = "mygame://callback"
    // },
};
var response = await openfort.AuthenticateWithOAuth();

string address = "0x..."; // User's Ethereum address
string signature = "0x..."; // Signature from the user's wallet
await openfort.InitSiwe(address);
var response = await openfort.AuthenticateWithSiwe(signature);

Stored Credentials#

bool hasCredsSaved = await openfort.GetAccessToken() != null;
if (hasCredsSaved)
{
    await openfort.ValidateAndRefreshToken(new ValidateAndRefreshTokenRequest());
    // Successfully re-logged into OpenfortSDK
}

Log Out#

await openfort.Logout();

Advanced Features#

Sign Message#

SignMessageRequest signMessageRequest = new SignMessageRequest("Hello World!");
string signature = await openfort.SignMessage(signMessageRequest);

Sign Typed Data#

var domain = new TypedDataDomain(
    name: "Openfort",
    version: "0.5",
    chainId: 80002,
    verifyingContract: "0x9b5AB198e042fCF795E4a0Fa4269764A4E8037D2"
);
var types = new Dictionary<string, List<TypedDataField>>
{
    // Define your types here
};
var message = new Dictionary<string, object>
{
    // Define your message here
};
var signTypedDataRequest = new SignTypedDataRequest(domain, types, message);
string signature = await openfort.SignTypedData(signTypedDataRequest);

Send Transaction#

// 1. Request the encoded transaction from your backend
var webRequest = UnityWebRequest.PostWwwForm("https://your-backend-url.com/mint", "");
webRequest.SetRequestHeader("Authorization", "Bearer " + accessToken);
webRequest.SetRequestHeader("Content-Type", "application/json");
webRequest.SetRequestHeader("Accept", "application/json");
await SendWebRequestAsync(webRequest);
if (webRequest.result != UnityWebRequest.Result.Success)
{
    Debug.Log("Mint Failed: " + webRequest.error);
    return;
}
// 2. Parse the response from your backend
var responseText = webRequest.downloadHandler.text;
var responseJson = JsonConvert.DeserializeObject<RootObject>(responseText);
// 3. Create and send the SignatureTransactionIntentRequest
SignatureTransactionIntentRequest request = new SignatureTransactionIntentRequest(responseJson.transactionIntentId, responseJson.userOperationHash);
TransactionIntentResponse intentResponse = await openfort.SendSignatureTransactionIntentRequest(request);
// 4. Get the transaction hash from the response
string transactionHash = intentResponse.Response.TransactionHash;

Note: Obtaining the transaction hash does not guarantee a successful transaction. Use an appropriate method to check the transaction receipt for the final status.

Supported Functionality#

The SDK supports a wide range of methods, including user authentication, wallet management, transaction signing, and more.

Method	Functionality
`Init`	Initializes OpenfortSDK with various parameters
`LogInWithEmailPassword`	Logs the user in using email and password
`SignUpWithEmailPassword`	Signs up a new user with email and password
`LinkEmailPassword`	Links an email and password to the user account
`UnlinkEmailPassword`	Unlinks an email and password from the user account
`RequestResetPassword`	Requests a password reset
`ResetPassword`	Resets the user's password
`RequestEmailVerification`	Requests an email verification
`VerifyEmail`	Verifies the user's email
`InitOAuth`	Initializes OAuth for the user
`AuthenticateWithOAuth`	Authenticates the user with OAuth
`UnlinkOAuth`	Unlinks OAuth from the user account
`PoolOAuth`	Pools OAuth for the user account
`InitLinkOAuth`	Initializes the link OAuth process
`AuthenticateWithThirdPartyProvider`	Authenticates the user with a third-party provider
`InitSiwe`	Initializes Sign-In with Ethereum (SIWE)
`AuthenticateWithSiwe`	Authenticates the user with SIWE
`LinkWallet`	Links a wallet to the user account
`UnlinkWallet`	Unlinks a wallet from the user account
`StoreCredentials`	Stores authentication credentials
`GetUser`	Gets the user information
`Logout`	Logs the user out and removes stored credentials
`GetAccessToken`	Gets the currently saved access token
`ValidateAndRefreshToken`	Validates and refreshes the access token
`SendSignatureTransactionIntentRequest`	Sends a signature transaction intent request
`SignMessage`	Signs a message
`SignTypedData`	Signs typed data
`SendSignatureSessionRequest`	Sends a transaction signed by a session
`GetEmbeddedState`	Gets the embedded state
`GetEthereumProvider`	Gets the Ethereum provider
`ConfigureEmbeddedSigner`	Configures the embedded signer

Examples#

Sample App: Demonstrates how to use the Openfort Unity SDK.
Sample Game: A tutorial on integrating the Openfort Unity SDK into a game.