ChainSafe · creeppak · Sep 3, 2024 · Jul 24, 2024 · Jul 24, 2024 · Jul 24, 2024
diff --git a/ChainSafe.Gaming.sln.DotSettings b/ChainSafe.Gaming.sln.DotSettings
@@ -1,2 +1,3 @@
 <wpf:ResourceDictionary xml:space="preserve" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:s="clr-namespace:System;assembly=mscorlib" xmlns:ss="urn:shemas-jetbrains-com:settings-storage-xaml" xmlns:wpf="http://schemas.microsoft.com/winfx/2006/xaml/presentation">
-	<s:Boolean x:Key="/Default/UserDictionary/Words/=Nethereum/@EntryIndexedValue">True</s:Boolean></wpf:ResourceDictionary>
+	<s:Boolean x:Key="/Default/UserDictionary/Words/=Nethereum/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/UserDictionary/Words/=Offchain/@EntryIndexedValue">True</s:Boolean></wpf:ResourceDictionary>
diff --git a/Packages/io.chainsafe.web3-unity.mud/Editor.meta b/Packages/io.chainsafe.web3-unity.mud/Editor.meta
diff --git a/Packages/io.chainsafe.web3-unity.mud/Editor/MudConfigAssetInspector.cs b/Packages/io.chainsafe.web3-unity.mud/Editor/MudConfigAssetInspector.cs
@@ -0,0 +1,74 @@
+using System;
+using ChainSafe.Gaming.Mud.Unity;
+using UnityEditor;
+using UnityEngine;
+
+namespace ChainSafe.Gaming.Mud.UnityEditor
+{
+    [CustomEditor(typeof(MudConfigAsset))]
+    public class MudConfigAssetInspector : Editor
+    {
+        private MudConfigAsset asset;
+        private GUIStyle warningStyle;
+
+        public override void OnInspectorGUI()
+        {
+            asset = (MudConfigAsset)target;
+            warningStyle ??= new GUIStyle(EditorStyles.largeLabel)
+            {
+                wordWrap = true
+            };
+
+            serializedObject.Update();
+            var storageProperty = serializedObject.FindProperty(nameof(MudConfigAsset.StorageType));
+
+            EditorGUILayout.PropertyField(storageProperty, new GUIContent("From Block Number"));
+            EditorGUILayout.Space();
+            GUILayout.Label("Storage Settings", EditorStyles.boldLabel);
+
+            EditorGUI.indentLevel++;
+            EditorGUILayout.BeginVertical();
+
+            switch (asset.StorageType)
+            {
+                case MudStorageType.LocalStorage:
+                    DrawLocalStorageGui();
+                    break;
+                case MudStorageType.OffchainIndexer:
+                    DrawOffchainIndexerStorageGui();
+                    break;
+                default:
+                    throw new ArgumentOutOfRangeException();
+            }
+
+            EditorGUILayout.EndVertical();
+            EditorGUI.indentLevel--;
+
+            serializedObject.ApplyModifiedProperties();
+        }
+
+        private void DrawLocalStorageGui()
+        {
+            EditorGUILayout.PropertyField(
+                serializedObject.FindProperty(nameof(MudConfigAsset.InMemoryFromBlockNumber)),
+                new GUIContent("Scan From Block Number"));
+        }
+
+        private void DrawOffchainIndexerStorageGui()
+        {
+            EditorGUILayout.LabelField("Offchain Indexer Storage is not implemented yet. Please use Local Storage for now.", warningStyle);
+
+            EditorGUILayout.Space();
+            EditorGUILayout.BeginHorizontal();
+            GUILayout.FlexibleSpace();
+            if (GUILayout.Button("Switch to Local Storage"))
+            {
+                asset.StorageType = MudStorageType.LocalStorage;
+                EditorUtility.SetDirty(asset);
+            }
+
+            GUILayout.FlexibleSpace();
+            EditorGUILayout.EndHorizontal();
+        }
+    }
+}
diff --git a/Packages/io.chainsafe.web3-unity.mud/Editor/MudConfigAssetInspector.cs.meta b/Packages/io.chainsafe.web3-unity.mud/Editor/MudConfigAssetInspector.cs.meta
diff --git a/Packages/io.chainsafe.web3-unity.mud/Editor/io.chainsafe.web3-unity.mud.editor.asmdef b/Packages/io.chainsafe.web3-unity.mud/Editor/io.chainsafe.web3-unity.mud.editor.asmdef
@@ -0,0 +1,19 @@
+{
+    "name": "io.chainsafe.web3-unity.mud.editor",
+    "rootNamespace": "ChainSafe.Gaming.Mud.UnityEditor",
+    "references": [
+        "GUID:5426c6b788696eb4c88f4198b59839eb",
+        "GUID:92a3dff85d90408b8d1f8462122eb7d5"
+    ],
+    "includePlatforms": [
+        "Editor"
+    ],
+    "excludePlatforms": [],
+    "allowUnsafeCode": false,
+    "overrideReferences": false,
+    "precompiledReferences": [],
+    "autoReferenced": true,
+    "defineConstraints": [],
+    "versionDefines": [],
+    "noEngineReferences": false
+}
diff --git a/Packages/io.chainsafe.web3-unity.mud/Editor/io.chainsafe.web3-unity.mud.editor.asmdef.meta b/Packages/io.chainsafe.web3-unity.mud/Editor/io.chainsafe.web3-unity.mud.editor.asmdef.meta
diff --git a/Packages/io.chainsafe.web3-unity.mud/Runtime/MudConfigAsset.cs b/Packages/io.chainsafe.web3-unity.mud/Runtime/MudConfigAsset.cs
@@ -0,0 +1,33 @@
+using System;
+using ChainSafe.Gaming.Mud.Storages;
+using ChainSafe.Gaming.Mud.Storages.InMemory;
+using ChainSafe.Gaming.Web3;
+using UnityEngine;
+
+namespace ChainSafe.Gaming.Mud.Unity
+{
+    /// <summary>
+    /// Represents a configuration asset for MUD module.
+    /// </summary>
+    [CreateAssetMenu(menuName = "ChainSafe/Mud Config Asset", fileName = "MudConfigAsset", order = 0)]
+    public class MudConfigAsset : ScriptableObject, IMudConfig
+    {
+        public MudStorageType StorageType;
+        public ulong InMemoryFromBlockNumber;
+
+        public IMudStorageConfig StorageConfig => BuildStorageConfig();
+
+        private IMudStorageConfig BuildStorageConfig()
+        {
+            switch (StorageType)
+            {
+                case MudStorageType.LocalStorage:
+                    return new InMemoryMudStorageConfig { FromBlockNumber = InMemoryFromBlockNumber };
+                case MudStorageType.OffchainIndexer:
+                    throw new Web3Exception("Offchain Indexer Storage is not implemented yet.");
+                default:
+                    throw new ArgumentOutOfRangeException();
+            }
+        }
+    }
+}
diff --git a/Packages/io.chainsafe.web3-unity.mud/Runtime/MudConfigAsset.cs.meta b/Packages/io.chainsafe.web3-unity.mud/Runtime/MudConfigAsset.cs.meta
diff --git a/Packages/io.chainsafe.web3-unity.mud/Runtime/MudStorageType.cs b/Packages/io.chainsafe.web3-unity.mud/Runtime/MudStorageType.cs
@@ -0,0 +1,14 @@
+namespace ChainSafe.Gaming.Mud.Unity
+{
+    /// <summary>
+    /// Represents the different types of storage strategies for a MUD World.
+    /// </summary>
+    public enum MudStorageType
+    {
+        /// <summary>Use Local Storage Strategy.</summary>
+        LocalStorage,
+
+        ///<summary>Use Off-Chain Indexer Storage Strategy.</summary>
+        OffchainIndexer
+    }
+}
diff --git a/Packages/io.chainsafe.web3-unity.mud/Runtime/MudStorageType.cs.meta b/Packages/io.chainsafe.web3-unity.mud/Runtime/MudStorageType.cs.meta
diff --git a/Packages/io.chainsafe.web3-unity.mud/Runtime/io.chainsafe.web3-unity.mud.runtime.asmdef b/Packages/io.chainsafe.web3-unity.mud/Runtime/io.chainsafe.web3-unity.mud.runtime.asmdef
@@ -0,0 +1,16 @@
+{
+    "name": "io.chainsafe.web3-unity.mud.runtime",
+    "rootNamespace": "ChainSafe.Gaming.Mud.Unity",
+    "references": [
+        "GUID:5426c6b788696eb4c88f4198b59839eb"
+    ],
+    "includePlatforms": [],
+    "excludePlatforms": [],
+    "allowUnsafeCode": false,
+    "overrideReferences": false,
+    "precompiledReferences": [],
+    "autoReferenced": true,
+    "defineConstraints": [],
+    "versionDefines": [],
+    "noEngineReferences": false
+}
diff --git a/Packages/io.chainsafe.web3-unity.mud/Runtime/io.chainsafe.web3-unity.mud.runtime.asmdef.meta b/Packages/io.chainsafe.web3-unity.mud/Runtime/io.chainsafe.web3-unity.mud.runtime.asmdef.meta
diff --git a/Packages/io.chainsafe.web3-unity/Editor/ServerSettings.cs b/Packages/io.chainsafe.web3-unity/Editor/ServerSettings.cs
@@ -74,7 +74,7 @@ private enum FetchingStatus
     private void Awake()
     {
         // Get saved settings or revert to default
-        var projectConfig = ProjectConfigUtilities.Load();
+        var projectConfig = ProjectConfigUtilities.CreateOrLoad();
         projectID = string.IsNullOrEmpty(projectConfig?.ProjectId) ? ProjectIdPrompt : projectConfig.ProjectId;
         chainID = string.IsNullOrEmpty(projectConfig?.ChainId) ? ChainIdDefault : projectConfig.ChainId;
         chain = string.IsNullOrEmpty(projectConfig?.Chain) ? ChainDefault : projectConfig.Chain;

diff --git a/Packages/io.chainsafe.web3-unity/Runtime/Scripts/ProjectConfigUtilities.cs b/Packages/io.chainsafe.web3-unity/Runtime/Scripts/ProjectConfigUtilities.cs
@@ -8,31 +8,6 @@ namespace ChainSafe.Gaming.UnityPackage
 {
     public static class ProjectConfigUtilities
     {
-        private class LocalhostChainConfig : IChainConfig
-        {
-            public LocalhostChainConfig(string chainId, string symbol, string chain, string network, string port)
-            {
-                var localhostEndPoint = $"127.0.0.1:{port}";
-
-                ChainId = chainId;
-                Symbol = symbol;
-                Chain = chain;
-                Network = network;
-                Rpc = $"http://{localhostEndPoint}";
-                Ws = $"$ws://{localhostEndPoint}";
-                BlockExplorerUrl = $"http://{localhostEndPoint}";
-            }
-
-            public string ChainId { get; }
-            public string Symbol { get; }
-            public string Chain { get; }
-            public string Network { get; }
-            public string Rpc { get; }
-            public string Ipc => null;
-            public string Ws { get; }
-            public string BlockExplorerUrl { get; }
-        }
-
         private const string AssetName = "ProjectConfigData";
 
         public static ProjectConfigScriptableObject Load()
@@ -93,5 +68,29 @@ public static void Save(ProjectConfigScriptableObject projectConfig)
             UnityEditor.AssetDatabase.SaveAssets();
         }
 #endif
+        private class LocalhostChainConfig : IChainConfig
+        {
+            public LocalhostChainConfig(string chainId, string symbol, string chain, string network, string port)
+            {
+                var localhostEndPoint = $"127.0.0.1:{port}";
+
+                ChainId = chainId;
+                Symbol = symbol;
+                Chain = chain;
+                Network = network;
+                Rpc = $"http://{localhostEndPoint}";
+                Ws = $"ws://{localhostEndPoint}";
+                BlockExplorerUrl = $"http://{localhostEndPoint}";
+            }
+
+            public string ChainId { get; }
+            public string Symbol { get; }
+            public string Chain { get; }
+            public string Network { get; }
+            public string Rpc { get; }
+            public string Ipc => null;
+            public string Ws { get; }
+            public string BlockExplorerUrl { get; }
+        }
     }
 }
diff --git a/scripts/debug-publish-to-unity-package.bat b/scripts/debug-publish-to-unity-package.bat
@@ -10,6 +10,11 @@ pushd "%SCRIPT_DIR%\..\src\ChainSafe.Gaming.Unity"
 rem Publish the project
 dotnet publish ChainSafe.Gaming.Unity.csproj -c Debug /property:Unity=true
 
+IF %ERRORLEVEL% NEQ 0 (
+    echo Execution failed
+    exit /b %ERRORLEVEL%
+)
+
 set PUBLISH_PATH=bin\Debug\netstandard2.1\publish
 
 rem List generated DLLs

diff --git a/src/ChainSafe.Gaming.Mud/ChainSafe.Gaming.Mud.csproj b/src/ChainSafe.Gaming.Mud/ChainSafe.Gaming.Mud.csproj
@@ -14,9 +14,6 @@
         <ProjectReference Include="..\ChainSafe.Gaming\ChainSafe.Gaming.csproj" />
     </ItemGroup>
 
-    <ItemGroup>
-    </ItemGroup>
-
     <ItemGroup Condition="'$(Unity)' != 'True'">
         <PackageReference Include="Nethereum.Mud" Version="4.21.2" />
         <PackageReference Include="Nethereum.Mud.Contracts" Version="4.21.2" />

diff --git a/src/ChainSafe.Gaming.Mud/IMudConfig.cs b/src/ChainSafe.Gaming.Mud/IMudConfig.cs
@@ -0,0 +1,9 @@
+using ChainSafe.Gaming.Mud.Storages;
+
+namespace ChainSafe.Gaming.Mud
+{
+    public interface IMudConfig
+    {
+        IMudStorageConfig StorageConfig { get; }
+    }
+}
diff --git a/src/ChainSafe.Gaming.Mud/MudConfig.cs b/src/ChainSafe.Gaming.Mud/MudConfig.cs
@@ -0,0 +1,9 @@
+using ChainSafe.Gaming.Mud.Storages;
+
+namespace ChainSafe.Gaming.Mud
+{
+    public class MudConfig : IMudConfig
+    {
+        public IMudStorageConfig StorageConfig { get; set; }
+    }
+}
diff --git a/src/ChainSafe.Gaming.Mud/MudException.cs b/src/ChainSafe.Gaming.Mud/MudException.cs
@@ -0,0 +1,22 @@
+using System;
+using ChainSafe.Gaming.Web3;
+
+namespace ChainSafe.Gaming.Mud
+{
+    /// <summary>
+    /// Represents an exception that is thrown when a MUD-related error occurs.
+    /// </summary>
+    /// <seealso cref="Web3Exception"/>
+    public class MudException : Web3Exception
+    {
+        internal MudException(string message)
+            : base(message)
+        {
+        }
+
+        internal MudException(string message, Exception innerException)
+            : base(message, innerException)
+        {
+        }
+    }
+}