WalletConnectUnity

This repository is a monorepo of packages that extend WalletConnectSharp and brings WalletConnect to Unity.

Packages

Package	Description	OpenUPM
Core	High-level, Unity-friendly extension of WalletConnectSharp - Automatic active session management - Option to resume session from storage - Deep linking support - IL2CPP support - Lightweight IJsonRpcConnection implementation - QR Code generation utility - API to load wallets data and visual assets
Modal	Simplest and most minimal way to connect your players with WalletConnect
UI	This is a technical package that provides UI for WalletConnect Modal. It is not intended to be used directly, but rather as a dependency of WalletConnect Modal.

Older versions of WalletConnectUnity are available under legacy/* branches

Prerequisites

• Unity 2021.3 or above
• IL2CPP managed code stripping level: Minimal (or lower)

Supported Platforms

• Android
• iOS
• macOS
• Windows
• WebGL (experimental)

Documentation

• WalletConnect Modal
• Sign API
• Core API

Installation

https://github.com/WalletConnect/WalletConnectUnity.git?path=Packages/com.walletconnect.modal#modal/1.0.0

Usage

0. Set up in project id and metadata WalletConnectProjectConfig ScriptableAsset (created automatically located at Assets/WalletConnectUnity/Resources/WalletConnectProjectConfig.asset, do NOT move it outside of Resources directory).
1. Initialize WalletConnect and connect wallet:

// Initialize singleton
await WalletConnect.Instance.InitializeAsync();

// Or handle instancing manually
var walletConnectUnity = new WalletConnect();
await walletConnectUnity.InitializeAsync();


// Try resume last session
var sessionResumed = await WalletConnect.Instance.TryResumeSessionAsync();              
if (!sessionResumed)                                                                         
{                                                                                            
    var connectedData = await WalletConnect.Instance.ConnectAsync(connectOptions);

    // Create QR code texture
    var texture = WalletConnectUnity.Core.Utils.QRCode.EncodeTexture(connectedData.Uri);
    
    // ... Display QR code texture

    // Wait for wallet approval
    await connectedData.Approval;                                                            
}                                                                                            

WalletConnectProjectConfig Fields

• Id - The id of your project. This will be used inside the relay server.
• Client Metadata
  • Name - The name of your app. This will be used inside the authentication request.
  • Description - The description of your app. This will be used inside the authentication request.
  • Url - The url of your app. This will be used inside the authentication request.
  • Icons - The icons of your app. This will be used inside the authentication request.
  • Very Url - The verification URL of your app. Currently used but not enforced

WebGL Usage

Due to WebGL's single-threaded nature, certain asynchronous operations like Task.Run, Task.ContinueWith, Task.Delay, and ConfigureAwait(false) are not natively supported.

To enable these operations in WebGL builds, an additional third-party package, WebGLThreadingPatcher, is required. This package modifies the Unity WebGL build to delegate work to the SynchronizationContext, allowing these operations to be executed on the same thread without blocking the main application. Please note that all tasks are still executed on a single thread, and any blocking calls will freeze the entire application.

The WebGLThreadingPatcher package can be added via git URL:

https://github.com/VolodymyrBS/WebGLThreadingPatcher.git

Sample

• WalletConnect Modal Sample