Now the default behaviour for switching the chain is actually to try to add it, if it already exists, we're getting a prompt to switch to it. (#1250)

* Now the default behaviour for switching the chain is actually to try to add it, if it already exists, we're getting a prompt to switch to it.

* Removed unnecessary chain declaration

* Naming conventions and default values.

* Addressed Oleks comments

* Creating the directory if it doesn't exist

* Removed return

* Updated dependencies

Author: kantagara

Packages/io.chainsafe.web3-unity.hyperplay/Runtime/Libraries/ChainSafe.Gaming.HyperPlay.dll

@@ -83,7 +83,7 @@ private async void SetTokens()
             customTokenDisplay.SetActive(false);
         }
         // Set native token
-        nativeTokenSymbolText.text = Web3Unity.Web3.ChainConfig.Symbol.ToUpper();
+        nativeTokenSymbolText.text = Web3Unity.Web3.ChainConfig.NativeCurrency.Symbol.ToUpper();
         var hexBalance = await Web3Unity.Web3.RpcProvider.GetBalance(Web3Unity.Web3.Signer.PublicAddress);
         var weiBalance = BigInteger.Parse(hexBalance.ToString());
         decimal ethBalance = (decimal)weiBalance / (decimal)Math.Pow(10, 18);

Packages/io.chainsafe.web3-unity.lootboxes/Chainlink/Runtime/Libraries/ChainSafe.Gaming.Lootboxes.Chainlink.dll

@@ -92,7 +92,7 @@ public override async Task Initialize(bool rememberSession)
 
         //1155 is a decimal number, we need to convert it to an integer
         InitWeb3Auth(clientId, new HexBigInteger(BigInteger.Parse(chainConfig.ChainId)).HexValue, 
-            chainConfig.Rpc, chainConfig.Network, "", chainConfig.Symbol, "", network.ToString().ToLower(), Initialized, InitializeError);
+            chainConfig.Rpc, chainConfig.Network, "", chainConfig.NativeCurrency.Symbol, "", network.ToString().ToLower(), Initialized, InitializeError);
 
         await _initializeTcs.Task;
     }

Packages/io.chainsafe.web3-unity.lootboxes/Chainlink/Runtime/Libraries/Chainsafe.Gaming.Chainlink.dll

@@ -0,0 +1,21 @@
+using UnityEditor;
+using UnityEngine;
+using System.IO;
+
+public class OpenPersistentDataPath
+{
+    [MenuItem("Edit/Open Persistent Data Path")]
+    private static void OpenPersistentDataPathFolder()
+    {
+        string path = Application.persistentDataPath;
+
+        // Check if the directory exists
+        if (!Directory.Exists(path))
+        {
+            Directory.CreateDirectory(path);
+        }
+
+        // Open the folder in the file explorer
+        EditorUtility.RevealInFinder(path);
+    }
+}

Packages/io.chainsafe.web3-unity.mud/Runtime/Libraries/ChainSafe.Gaming.Mud.dll

@@ -1,9 +1,11 @@
 using System;
 using System.Linq;
 using ChainSafe.Gaming;
+using ChainSafe.Gaming.Web3;
 using UnityEditor;
 using UnityEditor.Experimental.GraphView;
 using UnityEngine;
+using NativeCurrency = ChainSafe.Gaming.Web3.NativeCurrency;
 
 namespace ChainSafe.GamingSdk.Editor
 {
@@ -85,7 +87,13 @@ public void OnGUI()
 
                 chainConfig.Network = EditorGUILayout.TextField("Network", chainConfig.Network);
                 chainConfig.ChainId = EditorGUILayout.TextField("Chain ID", chainConfig.ChainId);
-                chainConfig.Symbol = EditorGUILayout.TextField("Symbol", chainConfig.Symbol);
+                EditorGUILayout.LabelField("Native Currency", EditorStyles.boldLabel);
+                EditorGUI.indentLevel++;
+                // Draw fields for NativeCurrency
+                chainConfig.NativeCurrency.Name = EditorGUILayout.TextField("Name", chainConfig.NativeCurrency.Name);
+                chainConfig.NativeCurrency.Symbol = EditorGUILayout.TextField("Symbol", chainConfig.NativeCurrency.Symbol);
+                chainConfig.NativeCurrency.Decimals = EditorGUILayout.IntField("Decimals", chainConfig.NativeCurrency.Decimals);
+                EditorGUI.indentLevel--;
                 chainConfig.BlockExplorerUrl = EditorGUILayout.TextField("Block Explorer", chainConfig.BlockExplorerUrl);
 
                 GUI.enabled = true;
@@ -195,7 +203,12 @@ private void UpdateServerMenuInfo(bool chainSwitched = false)
                     {
                         chainConfig.Network = chainPrototype.chain;
                         chainConfig.ChainId = chainPrototype.chainId.ToString();
-                        chainConfig.Symbol = chainPrototype.nativeCurrency.symbol;
+                        chainConfig.NativeCurrency = new NativeCurrency()
+                        {
+                            Name = chainPrototype.nativeCurrency.Name,
+                            Symbol = chainPrototype.nativeCurrency.Symbol,
+                            Decimals = chainPrototype.nativeCurrency.Decimals
+                        };
                         if (chainPrototype.explorers != null)
                         {
                             chainConfig.BlockExplorerUrl = chainPrototype.explorers[0].url;

Packages/io.chainsafe.web3-unity.web3auth/Runtime/WalletGUI/Scripts/Web3AuthWalletGUITokenManager.cs

@@ -1,5 +1,6 @@
 using System;
 using ChainSafe.Gaming.Web3;
+using ChainSafe.Gaming.Web3.Core.Chains;
 using UnityEngine;
 
 namespace ChainSafe.Gaming
@@ -10,13 +11,32 @@ public class ChainConfigEntry : IChainConfig
         private const string ChainIdDefault = "11155111";
         private const string ChainDefault = "Sepolia";
         private const string NetworkDefault = "Sepolia";
-        private const string SymbolDefault = "Seth";
+
+        private static readonly NativeCurrencyUnityWrapper DefaultNativeCurrency = new()
+        {
+            Name = "Sepolia Ether",
+            Symbol = "ETH",
+            Decimals = 18
+        };
+
         private const string RpcDefault = "https://rpc.sepolia.org";
         private const string BlockExplorerUrlDefault = "https://sepolia.etherscan.io";
         private const string WsDefault = "";
 
         [field: SerializeField] public string ChainId { get; set; }
-        [field: SerializeField] public string Symbol { get; set; }
+
+        public INativeCurrency NativeCurrency
+        {
+            get => nativeCurrency;
+            set => nativeCurrency = new NativeCurrencyUnityWrapper()
+            {
+                Name = value.Name,
+                Symbol = value.Symbol,
+                Decimals = value.Decimals
+            };
+        }
+
+        [SerializeField] private NativeCurrencyUnityWrapper nativeCurrency ;
         [field: SerializeField] public string Chain { get; set; }
         [field: SerializeField] public string Network { get; set; }
         [field: SerializeField] public string Rpc { get; set; }
@@ -26,7 +46,7 @@ public class ChainConfigEntry : IChainConfig
         public static ChainConfigEntry Default => new()
         {
             ChainId = ChainIdDefault,
-            Symbol = SymbolDefault,
+            NativeCurrency = DefaultNativeCurrency,
             Chain = ChainDefault,
             Network = NetworkDefault,
             Rpc = RpcDefault,
@@ -37,12 +57,23 @@ public class ChainConfigEntry : IChainConfig
         public static ChainConfigEntry Empty => new()
         {
             ChainId = string.Empty,
-            Symbol = string.Empty,
+            NativeCurrency = new NativeCurrencyUnityWrapper(),
             Chain = "Custom",
             Network = string.Empty,
             Rpc = string.Empty,
             BlockExplorerUrl = string.Empty,
             Ws = string.Empty
         };
     }
+
+    /// <summary>
+    /// This is basically a wrapper for the INativeCurrency interface to allow for Unity serialization.
+    /// </summary>
+    [Serializable]
+    public class NativeCurrencyUnityWrapper : INativeCurrency
+    {
+        [field: SerializeField] public string Name { get; set; } = "Ether";
+        [field: SerializeField] public string Symbol { get; set; } = "ETH";
+        [field: SerializeField] public int Decimals { get; set; } = 18;
+    }
 }

Packages/io.chainsafe.web3-unity.web3auth/Runtime/Web3AuthConnectionProvider.cs

@@ -1,10 +1,17 @@
 using System.Collections.Generic;
+using Newtonsoft.Json;
 
 namespace ChainSafe.Gaming.UnityPackage.Model
 {
     public struct NativeCurrency
     {
-        public string symbol { get; set; }
+        [JsonProperty(PropertyName = "symbol")]        
+        public string Symbol { get; set; }
+        
+        [JsonProperty(PropertyName = "decimals")]  
+        public int Decimals { get; set; }
+        [JsonProperty(PropertyName = "name")]
+        public string Name { get; set; }
     }
 
     public struct Explorer

Packages/io.chainsafe.web3-unity/Editor/OpenPersistenDataPath.cs

@@ -1,6 +1,7 @@
 using System.Collections.Generic;
 using System.IO;
 using ChainSafe.Gaming.Web3;
+using ChainSafe.Gaming.Web3.Core.Chains;
 using UnityEngine;
 
 namespace ChainSafe.Gaming.UnityPackage
@@ -39,7 +40,12 @@ public static Web3ConfigAsset Create(string projectId, string chainId, string ch
                     ChainId = chainId,
                     Chain = chain,
                     Network = network,
-                    Symbol = symbol,
+                    NativeCurrency = new NativeCurrencyUnityWrapper()
+                    {
+                        Name = symbol,
+                        Symbol = symbol,
+                        Decimals = 18
+                    },
                     Rpc = rpc,
                     Ws = ws,
                     BlockExplorerUrl = blockExplorerUrl,
@@ -91,7 +97,7 @@ public LocalhostChainConfig(string chainId, string symbol, string chain, string
                 var localhostEndPoint = $"127.0.0.1:{port}";
 
                 ChainId = chainId;
-                Symbol = symbol;
+                NativeCurrency = new NativeCurrencyUnityWrapper(){ Symbol = symbol, Name = symbol, Decimals = 18 };
                 Chain = chain;
                 Network = network;
                 Rpc = $"http://{localhostEndPoint}";
@@ -100,7 +106,7 @@ public LocalhostChainConfig(string chainId, string symbol, string chain, string
             }
 
             public string ChainId { get; }
-            public string Symbol { get; }
+            public INativeCurrency NativeCurrency { get; }
             public string Chain { get; }
             public string Network { get; }
             public string Rpc { get; }

Packages/io.chainsafe.web3-unity/Editor/OpenPersistenDataPath.cs.meta

@@ -8,10 +8,5 @@ cd ..
 :: Run format command in project root
 dotnet format --verbosity=d --severity=warn ChainSafe.Gaming.sln --exclude /submodules
 
-:: Navigate to the UnitySampleProject within src and run the format command
-pushd .\src\UnitySampleProject
-dotnet format --verbosity=d --severity=warn .\UnitySampleProject.sln
-popd 
-
 :: Restore the original directory
 popd

Packages/io.chainsafe.web3-unity/Editor/Web3SettingsEditor.ChainSettings.cs

@@ -0,0 +1,21 @@
+using System.Collections.Generic;
+using ChainSafe.Gaming.Evm.Network;
+using Reown.Core.Common.Utils;
+using Reown.Core.Network.Models;
+
+namespace ChainSafe.Gaming.Reown.Methods
+{
+    [RpcMethod("wallet_addEthereumChain")]
+    [RpcRequestOptions(Clock.ONE_MINUTE, 99993)]
+    public class WalletAddEthereumChain : List<object>
+    {
+        public WalletAddEthereumChain(object[] chains)
+            : base(chains)
+        {
+        }
+
+        public WalletAddEthereumChain()
+        {
+        }
+    }
+}

Packages/io.chainsafe.web3-unity/Runtime/Libraries/ChainSafe.Gaming.Debugging.dll

@@ -1,8 +1,12 @@
 using System;
 using System.Collections.Generic;
+using System.Globalization;
 using System.Linq;
+using System.Numerics;
 using System.Threading;
 using System.Threading.Tasks;
+using ChainSafe.Gaming.Evm.Network;
+using ChainSafe.Gaming.Evm.Providers;
 using ChainSafe.Gaming.Reown.Connection;
 using ChainSafe.Gaming.Reown.Methods;
 using ChainSafe.Gaming.Reown.Models;
@@ -16,6 +20,7 @@
 using ChainSafe.Gaming.Web3.Core.Operations;
 using ChainSafe.Gaming.Web3.Environment;
 using ChainSafe.Gaming.Web3.Evm.Wallet;
+using Nethereum.Hex.HexTypes;
 using Nethereum.JsonRpc.Client.RpcMessages;
 using Newtonsoft.Json;
 using Reown.Core.Common.Logging;
@@ -48,7 +53,7 @@ public class ReownProvider : WalletProvider, ILifecycleParticipant, IConnectionH
         private readonly Web3Environment environment;
         private readonly IChainConfigSet chainConfigSet;
         private readonly IOperationTracker operationTracker;
-        private readonly IMainThreadRunner mainThreadRunner;
+        private readonly IRpcProvider rpcProvider;
 
         private SessionStruct session;
         private bool connected;
@@ -66,11 +71,11 @@ public ReownProvider(
             Web3Environment environment,
             ReownHttpClient reownHttpClient,
             IOperationTracker operationTracker,
-            IMainThreadRunner mainThreadRunner)
+            IRpcProvider rpcProvider)
             : base(environment, chainConfig, operationTracker)
         {
             this.operationTracker = operationTracker;
-            this.mainThreadRunner = mainThreadRunner;
+            this.rpcProvider = rpcProvider;
             this.chainConfigSet = chainConfigSet;
             this.environment = environment;
             analyticsClient = environment.AnalyticsClient;
@@ -172,6 +177,7 @@ private async Task Initialize()
                             "eth_sendTransaction",
                             "eth_getTransactionByHash",
                             "wallet_switchEthereumChain",
+                            "wallet_addEthereumChain",
                             "eth_blockNumber",
                         },
                         Events = new[]
@@ -234,8 +240,6 @@ public override async Task<string> Connect()
 
                 connected = true;
 
-                await CheckAndSwitchNetwork();
-
                 return address;
             }
             catch (Exception e)
@@ -247,43 +251,6 @@ public override async Task<string> Connect()
             }
         }
 
-        private async Task CheckAndSwitchNetwork()
-        {
-            var chainId = ExtractChainIdFromAddress();
-            if (chainId == $"{EvmNamespace}:{chainConfig.ChainId}")
-            {
-                return;
-            }
-
-            const int maxSwitchAttempts = 3;
-
-            for (var i = 0; ;)
-            {
-                var messageToUser = i == 0
-                    ? "Switching wallet network..."
-                    : $"Switching wallet network (attempt {i + 1})...";
-
-                using (operationTracker.TrackOperation(messageToUser))
-                {
-                    try
-                    {
-                        await SwitchChain(chainConfig.ChainId);
-                        UpdateSessionChainId();
-                        return; // success, exit loop
-                    }
-                    catch (ReownNetworkException)
-                    {
-                        if (++i >= maxSwitchAttempts)
-                        {
-                            throw;
-                        }
-
-                        logWriter.Log("Attempted to switch the network, but was rejected. Trying again...");
-                    }
-                }
-            }
-        }
-
         private void UpdateSessionChainId()
         {
             var defaultChain = session.Namespaces.Keys.FirstOrDefault();
@@ -589,6 +556,8 @@ async Task<T> MakeRequest<TRequest>(bool sendChainId = true)
                     return await MakeRequest<EthSendTransaction>();
                 case "wallet_switchEthereumChain":
                     return await MakeRequest<WalletSwitchEthereumChain>(false);
+                case "wallet_addEthereumChain":
+                    return await MakeRequest<WalletAddEthereumChain>(false);
                 default:
                     try
                     {

Packages/io.chainsafe.web3-unity/Runtime/Libraries/ChainSafe.Gaming.Gelato.dll

@@ -7,11 +7,11 @@ namespace ChainSafe.Gaming.Unity.EthereumWindow.Dto
     /// </summary>
     public struct NativeCurrency
     {
-        public NativeCurrency(string symbol)
+        public NativeCurrency(string name, string symbol, int decimals)
         {
-            Name = symbol;
+            Name = name;
             Symbol = symbol;
-            Decimals = 18;
+            Decimals = decimals;
         }
 
         [JsonProperty("name")]