Thirdweb Engine Relayer Integration (#177)

+ Contract.Write Improvements

Author: 0xFirekeeper

Assets/Thirdweb/Core/Scripts/Contract.cs

@@ -204,44 +204,21 @@ public async Task<TransactionResult> Write(string functionName, TransactionReque
                 if (this.ABI == null)
                     this.ABI = await FetchAbi(this.Address, await ThirdwebManager.Instance.SDK.Wallet.GetChainId());
 
-                var contract = ThirdwebManager.Instance.SDK.Session.Web3.Eth.GetContract(this.ABI, this.Address);
-
-                var function = contract.GetFunction(functionName);
-
-                var value = transactionOverrides?.value != null ? new HexBigInteger(BigInteger.Parse(transactionOverrides?.value)) : new HexBigInteger(0);
-
-                var gas =
-                    transactionOverrides?.gasLimit != null
-                        ? new HexBigInteger(BigInteger.Parse(transactionOverrides?.gasLimit))
-                        : await function.EstimateGasAsync(await ThirdwebManager.Instance.SDK.Wallet.GetAddress(), null, value, args);
-
-                var gasPrice = transactionOverrides?.gasPrice != null ? new HexBigInteger(BigInteger.Parse(transactionOverrides?.gasPrice)) : null;
-
-                string hash;
-                if (gasPrice == null)
+                var service = new Nethereum.Contracts.Contract(null, this.ABI, this.Address);
+                var function = service.GetFunction(functionName);
+                var data = function.GetData(args);
+                var input = new TransactionInput
                 {
-                    var gasFees = await Utils.GetGasPriceAsync(await ThirdwebManager.Instance.SDK.Wallet.GetChainId());
-                    hash = await function.SendTransactionAsync(
-                        from: transactionOverrides?.from ?? await ThirdwebManager.Instance.SDK.Wallet.GetAddress(),
-                        gas: gas,
-                        value: value,
-                        maxFeePerGas: new HexBigInteger(gasFees.MaxFeePerGas),
-                        maxPriorityFeePerGas: new HexBigInteger(gasFees.MaxPriorityFeePerGas),
-                        args
-                    );
-                }
-                else
-                {
-                    hash = await function.SendTransactionAsync(
-                        from: transactionOverrides?.from ?? await ThirdwebManager.Instance.SDK.Wallet.GetAddress(),
-                        gas: gas,
-                        gasPrice: gasPrice,
-                        value: value,
-                        args
-                    );
-                }
-
-                return await Transaction.WaitForTransactionResult(hash);
+                    From = transactionOverrides?.from ?? await ThirdwebManager.Instance.SDK.Wallet.GetAddress(),
+                    To = this.Address,
+                    Data = data,
+                    Value = transactionOverrides?.value != null ? new HexBigInteger(BigInteger.Parse(transactionOverrides?.value)) : new HexBigInteger(0),
+                    Gas = transactionOverrides?.gasLimit != null ? new HexBigInteger(BigInteger.Parse(transactionOverrides?.gasLimit)) : null,
+                    GasPrice = transactionOverrides?.gasPrice != null ? new HexBigInteger(BigInteger.Parse(transactionOverrides?.gasPrice)) : null,
+                };
+
+                var tx = new Transaction(input);
+                return await tx.SendAndWaitForTransactionResult();
             }
         }
 

Assets/Thirdweb/Core/Scripts/ThirdwebManager.cs

@@ -57,10 +57,10 @@ public class ThirdwebManager : MonoBehaviour
         [Tooltip("IPFS Gateway Override")]
         public string storageIpfsGatewayUrl = null;
 
-        [Tooltip("Autotask URL")]
+        [Tooltip("Find out more about relayers here https://portal.thirdweb.com/engine/features/relayers")]
         public string relayerUrl = null;
 
-        [Tooltip("Forwarders can be found here https://github.com/thirdweb-dev/ozdefender-autotask")]
+        [Tooltip("Forwarder Contract Address (Defaults to 0xD04F98C88cE1054c90022EE34d566B9237a1203C if left empty)")]
         public string forwarderAddress = null;
 
         [Tooltip("Forwarder Domain Override (Defaults to GSNv2 Forwarder if left empty)")]
@@ -206,14 +206,14 @@ public void Initialize(string chainIdentifier)
             {
                 options.storage = new ThirdwebSDK.StorageOptions() { ipfsGatewayUrl = storageIpfsGatewayUrl };
             }
-            if (!string.IsNullOrEmpty(relayerUrl) && !string.IsNullOrEmpty(forwarderAddress))
+            if (!string.IsNullOrEmpty(relayerUrl))
             {
-                options.gasless = new ThirdwebSDK.GaslessOptions()
+                options.gasless = new ThirdwebSDK.RelayerOptions()
                 {
-                    openzeppelin = new ThirdwebSDK.OZDefenderOptions()
+                    engine = new ThirdwebSDK.EngineRelayerOptions()
                     {
                         relayerUrl = this.relayerUrl,
-                        relayerForwarderAddress = this.forwarderAddress,
+                        relayerForwarderAddress = string.IsNullOrEmpty(this.forwarderAddress) ? "0xD04F98C88cE1054c90022EE34d566B9237a1203C" : this.forwarderAddress,
                         domainName = string.IsNullOrEmpty(this.forwarderDomainOverride) ? "GSNv2 Forwarder" : this.forwarderDomainOverride,
                         domainVersion = string.IsNullOrEmpty(this.forwaderVersionOverride) ? "0.0.1" : this.forwaderVersionOverride
                     }

Assets/Thirdweb/Core/Scripts/ThirdwebSDK.cs

@@ -17,9 +17,9 @@ public class ThirdwebSDK
         public struct Options
         {
             /// <summary>
-            /// Gasless configuration options for the Thirdweb SDK.
+            /// Gasless relayer configuration options for Thirdweb Engine..
             /// </summary>
-            public GaslessOptions? gasless;
+            public RelayerOptions? gasless;
 
             /// <summary>
             /// Storage configuration options for the Thirdweb SDK.
@@ -204,33 +204,16 @@ public struct StorageOptions
         }
 
         /// <summary>
-        /// Gasless configuration options.
+        /// Thirdweb Engine Relayer configuration options.
         /// </summary>
         [System.Serializable]
-        public struct GaslessOptions
+        public struct RelayerOptions
         {
-            /// <summary>
-            /// OpenZeppelin Defender Gasless configuration options.
-            /// </summary>
-            public OZDefenderOptions? openzeppelin;
-
-            /// <summary>
-            /// [Obsolete] Biconomy Gasless configuration options. Biconomy is not fully supported and will be removed soon. Use OpenZeppelin Defender instead.
-            /// </summary>
-            [System.Obsolete("Biconomy is not fully supported and will be removed soon. Use OpenZeppelin Defender instead.")]
-            public BiconomyOptions? biconomy;
-
-            /// <summary>
-            /// Indicates whether experimental chainless support is enabled.
-            /// </summary>
-            public bool experimentalChainlessSupport;
+            public EngineRelayerOptions engine;
         }
 
-        /// <summary>
-        /// OpenZeppelin Defender Gasless configuration options.
-        /// </summary>
         [System.Serializable]
-        public struct OZDefenderOptions
+        public struct EngineRelayerOptions
         {
             /// <summary>
             /// The URL of the relayer service.
@@ -253,23 +236,6 @@ public struct OZDefenderOptions
             public string domainVersion;
         }
 
-        /// <summary>
-        /// Biconomy Gasless configuration options.
-        /// </summary>
-        [System.Serializable]
-        public struct BiconomyOptions
-        {
-            /// <summary>
-            /// The API ID for Biconomy.
-            /// </summary>
-            public string apiId;
-
-            /// <summary>
-            /// The API key for Biconomy.
-            /// </summary>
-            public string apiKey;
-        }
-
         private readonly string chainOrRPC;
 
         /// <summary>

Assets/Thirdweb/Core/Scripts/Transaction.cs

@@ -11,6 +11,7 @@
 using Nethereum.Contracts;
 using Nethereum.ABI.FunctionEncoding;
 using System;
+using Newtonsoft.Json.Linq;
 
 #pragma warning disable CS0618
 
@@ -341,9 +342,9 @@ public async Task<string> Send(bool? gasless = null)
                     await EstimateAndSetGasLimitAsync();
                 if (Input.Value == null)
                     Input.Value = new HexBigInteger(0);
-                bool isGaslessSetup = ThirdwebManager.Instance.SDK.Session.Options.gasless.HasValue && ThirdwebManager.Instance.SDK.Session.Options.gasless.Value.openzeppelin.HasValue;
+                bool isGaslessSetup = ThirdwebManager.Instance.SDK.Session.Options.gasless.HasValue && !string.IsNullOrEmpty(ThirdwebManager.Instance.SDK.Session.Options.gasless?.engine.relayerUrl);
                 if (gasless != null && gasless.Value && !isGaslessSetup)
-                    throw new UnityException("Gasless transactions are not enabled. Please enable them in the SDK options.");
+                    throw new UnityException("Gasless relayer transactions are not enabled. Please enable them in the SDK options.");
                 bool sendGaslessly = gasless == null ? isGaslessSetup : gasless.Value;
                 if (sendGaslessly)
                     return await SendGasless();
@@ -484,10 +485,10 @@ private async Task<string> SendGasless()
             }
             else
             {
-                string relayerUrl = ThirdwebManager.Instance.SDK.Session.Options.gasless.Value.openzeppelin?.relayerUrl;
-                string forwarderAddress = ThirdwebManager.Instance.SDK.Session.Options.gasless.Value.openzeppelin?.relayerForwarderAddress;
-                string forwarderDomain = ThirdwebManager.Instance.SDK.Session.Options.gasless.Value.openzeppelin?.domainName;
-                string forwarderVersion = ThirdwebManager.Instance.SDK.Session.Options.gasless.Value.openzeppelin?.domainVersion;
+                string relayerUrl = ThirdwebManager.Instance.SDK.Session.Options.gasless?.engine.relayerUrl ?? throw new UnityException("Relayer URL not set in SDK options.");
+                string forwarderAddress = ThirdwebManager.Instance.SDK.Session.Options.gasless?.engine.relayerForwarderAddress ?? "0xD04F98C88cE1054c90022EE34d566B9237a1203C";
+                string forwarderDomain = ThirdwebManager.Instance.SDK.Session.Options.gasless?.engine.domainName ?? "GSNv2 Forwarder";
+                string forwarderVersion = ThirdwebManager.Instance.SDK.Session.Options.gasless?.engine.domainVersion ?? "0.0.1";
 
                 Input.Nonce = (
                     await TransactionManager.ThirdwebRead<MinimalForwarder.GetNonceFunction, MinimalForwarder.GetNonceOutputDTO>(
@@ -506,6 +507,8 @@ private async Task<string> SendGasless()
                     Data = Input.Data
                 };
 
+                ThirdwebDebug.Log($"Forwarding request: {JsonConvert.SerializeObject(request)}");
+
                 var signature = await EIP712.GenerateSignature_MinimalForwarder(
                     forwarderDomain,
                     forwarderVersion,
@@ -514,7 +517,13 @@ private async Task<string> SendGasless()
                     request
                 );
 
-                var postData = new RelayerRequest(request, signature, forwarderAddress);
+                var postData = new RelayerRequest()
+                {
+                    Type = "forward",
+                    Request = request,
+                    Signature = signature,
+                    ForwarderAddress = forwarderAddress,
+                };
 
                 using UnityWebRequest req = UnityWebRequest.Post(relayerUrl, "");
                 byte[] bodyRaw = System.Text.Encoding.UTF8.GetBytes(JsonConvert.SerializeObject(postData));
@@ -530,17 +539,32 @@ private async Task<string> SendGasless()
                 }
                 else
                 {
-                    var response = JsonConvert.DeserializeObject<RelayerResponse>(req.downloadHandler.text);
-                    if (response.status != "success")
-                    {
-                        throw new UnityException(
-                            $"Forward Request Failed!\nError: {req.downloadHandler.text}\nRelayer URL: {relayerUrl}\nRelayer Forwarder Address: {forwarderAddress}\nRequest: {request}\nSignature: {signature}\nPost Data: {postData}"
-                        );
-                    }
-                    var result = JsonConvert.DeserializeObject<RelayerResult>(response.result);
-                    return result.txHash;
+                    var queueId = JsonConvert.DeserializeObject<JObject>(req.downloadHandler.text)["result"]["queueId"].ToString();
+                    ThirdwebDebug.Log($"Forwarded request to relayer with queue ID: {queueId}");
+                    return await FetchTxHashFromQueueId(new Uri(relayerUrl).GetLeftPart(UriPartial.Authority), queueId);
+                }
+            }
+        }
+
+        private async Task<string> FetchTxHashFromQueueId(string engineUrl, string queueId)
+        {
+            string txHash = null;
+            while (string.IsNullOrEmpty(txHash) && Application.isPlaying)
+            {
+                using UnityWebRequest req = UnityWebRequest.Get($"{engineUrl}/transaction/status/{queueId}");
+                await new WaitForSeconds(1f);
+                await req.SendWebRequest();
+                if (req.result != UnityWebRequest.Result.Success)
+                {
+                    throw new UnityException($"Failed to fetch transaction hash from queue ID {queueId}.\nError: {req.downloadHandler.text}");
+                }
+                else
+                {
+                    txHash = JsonConvert.DeserializeObject<JObject>(req.downloadHandler.text)["result"]["transactionHash"].ToString();
                 }
             }
+            ThirdwebDebug.Log($"Transaction hash fetched from queue ID {queueId}: {txHash}");
+            return txHash;
         }
 
         private string GetTxBuilderRoute(string action)
@@ -550,44 +574,19 @@ private string GetTxBuilderRoute(string action)
         }
     }
 
-    [System.Serializable]
-    public struct RelayerResponse
-    {
-        [JsonProperty("status")]
-        public string status;
-
-        [JsonProperty("result")]
-        public string result;
-    }
-
-    [System.Serializable]
-    public struct RelayerResult
-    {
-        [JsonProperty("txHash")]
-        public string txHash;
-    }
-
     [System.Serializable]
     public struct RelayerRequest
     {
+        [JsonProperty("type")]
+        public string Type;
+
         [JsonProperty("request")]
-        public MinimalForwarder.ForwardRequest request;
+        public MinimalForwarder.ForwardRequest Request;
 
         [JsonProperty("signature")]
-        public string signature;
+        public string Signature;
 
         [JsonProperty("forwarderAddress")]
-        public string forwarderAddress;
-
-        [JsonProperty("type")]
-        public string type;
-
-        public RelayerRequest(MinimalForwarder.ForwardRequest request, string signature, string forwarderAddress)
-        {
-            this.request = request;
-            this.signature = signature;
-            this.forwarderAddress = forwarderAddress;
-            this.type = "forward";
-        }
+        public string ForwarderAddress;
     }
 }

Assets/Thirdweb/Editor/ThirdwebManagerEditor.cs

@@ -263,13 +263,12 @@ public override void OnInspectorGUI()
 
             // OZ Defender Options
             sectionExpanded[3] = DrawSectionWithExpand(
-                "OpenZeppelin Defender Options",
+                "Gasless Relayer Options",
                 sectionExpanded[3],
                 () =>
                 {
                     EditorGUILayout.BeginVertical(EditorStyles.helpBox);
                     EditorGUILayout.PropertyField(relayerUrlProperty);
-                    EditorGUILayout.PropertyField(forwarderAddressProperty);
 
                     EditorGUI.BeginChangeCheck();
                     showGaslessOptionalFields = EditorGUILayout.ToggleLeft("Show Optional Fields", showGaslessOptionalFields);
@@ -280,6 +279,7 @@ public override void OnInspectorGUI()
 
                     if (showGaslessOptionalFields)
                     {
+                        EditorGUILayout.PropertyField(forwarderAddressProperty);
                         EditorGUILayout.PropertyField(forwarderDomainOverrideProperty);
                         EditorGUILayout.PropertyField(forwaderVersionOverrideProperty);
                     }