Create a game in Unity

To make these instructions concrete, we have created a sample ecosystem wallet called Rapidfire ID. To interact with it, you can find its SDK in the NPM package directory: @rapidfire/id.

You can check out the GitHub repository for Rapidfire Wallet to learn how to create your own wallet.

This guide will walk you through adding support for any ecosystem wallet into a Unity app by integrating the Mobile Wallet Protocol.

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	❌	✅
Web	Coming soon	Coming soon

If you need a template or scaffold to start with, you can check out the Ecosystem Wallet Unity Example.

Setup#

Install Mobile Wallet Protocol Client#

There are two ways to install the SDK:

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

Usage#

Mobile Wallet Protocol Client provides 2 interfaces for mobile app to interact with the Smart Wallet, an EIP-1193 compliant provider interface.

Option 1: EIP-1193 Provider#

Create a new EIP1193Provider instance, which is EIP-1193 compliant.

ClientController.cs

using UnityEngine;
using MobileWalletProtocol;
public class ClientController : MonoBehaviour
{
    [SerializeField]
    MWPClientOptions m_Options = new MWPClientOptions()
    {
        Metadata = new AppMetadata()
        {
            Name = "Smart Wallet",
            CustomScheme = "exp://"
        },
        Wallet = Wallet.CreateWebWallet(
            name: "Rapid fire wallet",
            scheme: "https://id.sample.openfort.xyz#policy=pol_a909d815-9b6c-40b2-9f6c-e93505281137",
            iconUrl: "https://purple-magnificent-bat-958.mypinata.cloud/ipfs/QmfQrh2BiCzugFauYF9Weu9SFddsVh9qV82uw43cxH8UDV"
        )
    };
    MWPClient m_Client;
    string m_Account;
    void Awake()
    {
        m_Client = new MWPClient(m_Options);
    }
    public async void RequestAccounts()
    {
        var result = await m_Client.EthRequestAccounts();
        if (result.IsSuccess)
        {
            var accounts = result.Value;
            m_Account = accounts[0];
            foreach (var account in accounts)
            {
                Debug.Log("Account: " + account);
            }
        }
        else
        {
            Debug.LogError("Error: " + result.Error);
        }
    }
    public void Disconnect()
    {
        m_Client.Reset();
    }
}

Gas Sponsorship#

If you want to sponsor transactions, you need to add #policy=POLICY_ID to the wallet scheme.

#policy=POLICY_ID