web3auth-unity-sdk

Web3Auth SDK for Unity3D game engine which supports Android, iOS, and Windows. web3auth-unity-sdk is a client-side library which allows you to authenticate users using Web3Auth on Unity3D game engine.

Requirements

• Unity Editor 2019.4.9f1 or greater
• .Net Framework 4.x

Installation

Download .unitypackage and import the package file into your existing Unity3D project.

You may encounter errors when importing this package into your existing project. The type or namespace name 'Newtonsoft' could not be found (are you missing a using directive or an assembly reference?) To fix this problem you need to add the following line into dependencies object which is inside the Packages/manifest.json file.

"com.unity.nuget.newtonsoft-json": "2.0.0"

Building in Unity and Get Started

To get started, open a sample scene Web3AuthSample inside Assets/Plugins/Web3AuthSDK/Samples/Web3AuthSample.scene

Before building the application for Android/IOS you need to register the redirect_uri which can be done easily by the tool provided inside the SDK. To achieve that, you need to follow the steps mentioned below.

• Open deep link generator tool provided by Web3Auth Unity SDK from "Window > Web3Auth > Deep Link Generator"
• Enter the redirect_url (i-e torusapp://com.torus.Web3AuthUnity/auth) and click generate.

  To use your own client_id , register your app on https://web3auth.io/ and replace the client_id inside Assets/Plugins/Web3AuthSDK/Samples/Web3AuthSample.cs script.

Integration

Configure an Web3Auth project

Go to Developer Dashboard, create or select an Web3Auth project:

• Add {{SCHEMA}}://{YOUR_APP_PACKAGE_NAME}://auth to Whitelist URLs. i-e torusapp://com.torus.Web3AuthUnity/auth
• Copy the Project ID for later usage as client_id

Intialize Web3Auth

In your sign-in script', create an Web3Auth instance with your Web3Auth project's configurations and configure it like this:

Web3Auth web3Auth = new Web3Auth(new Web3AuthOptions() {
  redirectUrl = new Uri("torusapp://com.torus.Web3AuthUnity/auth"),
    clientId = "BAwFgL-r7wzQKmtcdiz2uHJKNZdK7gzEf2q-m55xfzSZOw8jLOyIi4AVvvzaEQO5nv2dFLEmf9LBkF8kaq3aErg",
    network = Web3Auth.Network.TESTNET,
    whiteLabel = new WhiteLabelData() {
      name = "Web3Auth Sample App",
        logoLight = null,
        logoDark = null,
        defaultLanguage = "en",
        dark = true,
        theme = new Dictionary < string, string > {
          {
            "primary",
            "#123456"
          }
        }
    }
});
web3Auth.onLogin += onLogin;
web3Auth.onLogout += onLogout;
private void onLogin(Web3AuthResponse response) {
    // Handle user signing in
}
private void onLogout() {
  // Handle user signing out
}

Simulate redirect callback inside Unity Editor

Web3Auth Unity SDK provides a tool to simulate the redirect callback. To open go to "Window > Web3Auth > Debug Deep Link" and paste the redirect uri (it must include the response code)

API Reference

class Web3Auth {
  Web3Auth(Web3AuthOptions web3AuthOptions) {}
  // Trigger login flow that shows a modal for user to select one of supported
  // providers to login, e.g. Google, Facebook, Twitter, Passwordless, etc
  void login() {}
  // Trigger login flow using login params. Specific Login Provider can be set
  // through Login Params
  void login(LoginParams loginParams) {}
}
class Web3AuthOptions {
  string clientId;  // Your Web3Auth project ID
  public Web3Auth.Network network;    // Network to run Web3Auth, either MAINNET or TESTNET
  public Uri redirectUrl;  // URL that Web3Auth will redirect API responses
  public WhiteLabelData whiteLabel;  // Optional param to configure look
  public Dictionary<string, LoginConfigItem> loginConfig;  // Optional
}
public class LoginParams {
  public Provider loginProvider;
  public string dappShare;
  public ExtraLoginOptions;
  public Uri redirectUrl;
  public string appState;
  public MFALevel mfaLevel;
}