ERC20 Paymaster Support (#141)

0xFirekeeper · web-flow · commit c85d3d753e25 · 2024-02-27T16:09:19.000+03:00
Signed-off-by: Firekeeper &lt;0xFirekeeper@gmail.com&gt;
diff --git a/Assets/Thirdweb/Core/Scripts/AccountAbstraction/Core/BundlerClient.cs b/Assets/Thirdweb/Core/Scripts/AccountAbstraction/Core/BundlerClient.cs
@@ -10,10 +10,16 @@ public static class BundlerClient
     {
         // Bundler requests
 
-        public static async Task<EthGetUserOperationByHasResponse> EthGetUserOperationByHash(string bundlerUrl, string apiKey, object requestId, string userOpHash)
+        public static async Task<EthGetUserOperationByHashResponse> EthGetUserOperationByHash(string bundlerUrl, string apiKey, object requestId, string userOpHash)
         {
             var response = await BundlerRequest(bundlerUrl, apiKey, requestId, "eth_getUserOperationByHash", userOpHash);
-            return JsonConvert.DeserializeObject<EthGetUserOperationByHasResponse>(response.Result.ToString());
+            return JsonConvert.DeserializeObject<EthGetUserOperationByHashResponse>(response.Result.ToString());
+        }
+
+        public static async Task<EthGetUserOperationReceiptResponse> EthGetUserOperationReceipt(string bundlerUrl, string apiKey, object requestId, string userOpHash)
+        {
+            var response = await BundlerRequest(bundlerUrl, apiKey, requestId, "eth_getUserOperationReceipt", userOpHash);
+            return JsonConvert.DeserializeObject<EthGetUserOperationReceiptResponse>(response.Result.ToString());
         }
 
         public static async Task<string> EthSendUserOperation(string bundlerUrl, string apiKey, object requestId, UserOperationHexified userOp, string entryPoint)
diff --git a/Assets/Thirdweb/Core/Scripts/AccountAbstraction/Core/SmartWallet.cs b/Assets/Thirdweb/Core/Scripts/AccountAbstraction/Core/SmartWallet.cs
@@ -38,6 +38,8 @@ public class SmartWallet
         private bool _deployed;
         private bool _deploying;
         private bool _initialized;
+        private bool _approved;
+        private bool _approving;
 
         public List<string> Accounts { get; internal set; }
         public string PersonalAddress { get; internal set; }
@@ -53,6 +55,8 @@ public SmartWallet(Web3 personalWeb3, ThirdwebSDK.SmartWalletConfig config)
             {
                 factoryAddress = config.factoryAddress,
                 gasless = config.gasless,
+                erc20PaymasterAddress = config.erc20PaymasterAddress,
+                erc20TokenAddress = config.erc20TokenAddress,
                 bundlerUrl = string.IsNullOrEmpty(config.bundlerUrl) ? $"https://{ThirdwebManager.Instance.SDK.session.CurrentChainData.chainName}.bundler.thirdweb.com" : config.bundlerUrl,
                 paymasterUrl = string.IsNullOrEmpty(config.paymasterUrl) ? $"https://{ThirdwebManager.Instance.SDK.session.CurrentChainData.chainName}.bundler.thirdweb.com" : config.paymasterUrl,
                 entryPointAddress = string.IsNullOrEmpty(config.entryPointAddress) ? Constants.DEFAULT_ENTRYPOINT_ADDRESS : config.entryPointAddress,
@@ -61,6 +65,8 @@ public SmartWallet(Web3 personalWeb3, ThirdwebSDK.SmartWalletConfig config)
             _deployed = false;
             _initialized = false;
             _deploying = false;
+            _approved = false;
+            _approving = false;
         }
 
         internal async Task<string> GetPersonalAddress()
@@ -197,8 +203,6 @@ private async Task<RpcResponseMessage> CreateUserOpAndSend(RpcRequestMessage req
             var transactionInput = JsonConvert.DeserializeObject<TransactionInput>(JsonConvert.SerializeObject(paramList[0]));
             var dummySig = Constants.DUMMY_SIG;
 
-            var (initCode, gas) = await GetInitCode();
-
             var executeFn = new AccountContract.ExecuteFunction
             {
                 Target = transactionInput.To,
@@ -208,8 +212,37 @@ private async Task<RpcResponseMessage> CreateUserOpAndSend(RpcRequestMessage req
             };
             var executeInput = executeFn.CreateTransactionInput(Accounts[0]);
 
+            // Approve ERC20 tokens if any
+
+            if (!string.IsNullOrEmpty(Config.erc20PaymasterAddress) && !_approved && !_approving)
+            {
+                try
+                {
+                    _approving = true;
+                    var tokenContract = ThirdwebManager.Instance.SDK.GetContract(Config.erc20TokenAddress);
+                    var approvedAmount = await tokenContract.ERC20.AllowanceOf(Accounts[0], Config.erc20PaymasterAddress);
+                    if (BigInteger.Parse(approvedAmount.value) == 0)
+                    {
+                        ThirdwebDebug.Log($"Approving tokens for ERC20Paymaster spending");
+                        _deploying = false;
+                        await tokenContract.ERC20.SetAllowance(Config.erc20PaymasterAddress, (BigInteger.Pow(2, 96) - 1).ToString().ToEth());
+                    }
+                    _approved = true;
+                    _approving = false;
+                    await UpdateDeploymentStatus();
+                }
+                catch (Exception e)
+                {
+                    _approving = false;
+                    _approved = false;
+                    throw new Exception($"Approving tokens for ERC20Paymaster spending failed: {e.Message}");
+                }
+            }
+
             // Create the user operation and its safe (hexified) version
 
+            var (initCode, gas) = await GetInitCode();
+
             var gasPrices = await Utils.GetGasPriceAsync(ThirdwebManager.Instance.SDK.session.ChainId);
 
             var partialUserOp = new EntryPointContract.UserOperation()
@@ -235,7 +268,9 @@ private async Task<RpcResponseMessage> CreateUserOpAndSend(RpcRequestMessage req
 
             var gasEstimates = await BundlerClient.EthEstimateUserOperationGas(Config.bundlerUrl, apiKey, requestMessage.Id, partialUserOp.EncodeUserOperation(), Config.entryPointAddress);
             partialUserOp.CallGasLimit = 50000 + new HexBigInteger(gasEstimates.CallGasLimit).Value;
-            partialUserOp.VerificationGasLimit = new HexBigInteger(gasEstimates.VerificationGas).Value;
+            partialUserOp.VerificationGasLimit = string.IsNullOrEmpty(Config.erc20PaymasterAddress)
+                ? new HexBigInteger(gasEstimates.VerificationGas).Value
+                : new HexBigInteger(gasEstimates.VerificationGas).Value * 3;
             partialUserOp.PreVerificationGas = new HexBigInteger(gasEstimates.PreVerificationGas).Value;
 
             // Update paymaster data if any
@@ -258,8 +293,8 @@ private async Task<RpcResponseMessage> CreateUserOpAndSend(RpcRequestMessage req
             string txHash = null;
             while (txHash == null)
             {
-                var getUserOpResponse = await BundlerClient.EthGetUserOperationByHash(Config.bundlerUrl, apiKey, requestMessage.Id, userOpHash);
-                txHash = getUserOpResponse?.transactionHash;
+                var userOpReceipt = await BundlerClient.EthGetUserOperationReceipt(Config.bundlerUrl, apiKey, requestMessage.Id, userOpHash);
+                txHash = userOpReceipt?.receipt?.TransactionHash;
                 await new WaitForSecondsRealtime(1f);
             }
             ThirdwebDebug.Log("Tx Hash: " + txHash);
@@ -297,9 +332,19 @@ private async Task<BigInteger> GetNonce()
 
         private async Task<byte[]> GetPaymasterAndData(object requestId, UserOperationHexified userOp, string apiKey)
         {
-            return Config.gasless
-                ? (await BundlerClient.PMSponsorUserOperation(Config.paymasterUrl, apiKey, requestId, userOp, Config.entryPointAddress)).paymasterAndData.HexStringToByteArray()
-                : new byte[] { };
+            if (!string.IsNullOrEmpty(Config.erc20PaymasterAddress) && !_approving)
+            {
+                return Config.erc20PaymasterAddress.HexToByteArray();
+            }
+            else if (Config.gasless)
+            {
+                var paymasterAndData = await BundlerClient.PMSponsorUserOperation(Config.paymasterUrl, apiKey, requestId, userOp, Config.entryPointAddress);
+                return paymasterAndData.paymasterAndData.HexToByteArray();
+            }
+            else
+            {
+                return new byte[] { };
+            }
         }
     }
 }
diff --git a/Assets/Thirdweb/Core/Scripts/AccountAbstraction/Core/Types.cs b/Assets/Thirdweb/Core/Scripts/AccountAbstraction/Core/Types.cs
@@ -1,3 +1,5 @@
+using Nethereum.RPC.Eth.DTOs;
+
 namespace Thirdweb.AccountAbstraction
 {
     public class EthEstimateUserOperationGasResponse
@@ -7,14 +9,19 @@ public class EthEstimateUserOperationGasResponse
         public string CallGasLimit { get; set; }
     }
 
-    public class EthGetUserOperationByHasResponse
+    public class EthGetUserOperationByHashResponse
     {
         public string entryPoint { get; set; }
         public string transactionHash { get; set; }
         public string blockHash { get; set; }
         public string blockNumber { get; set; }
     }
 
+    public class EthGetUserOperationReceiptResponse
+    {
+        public TransactionReceipt receipt { get; set; }
+    }
+
     public class EntryPointWrapper
     {
         public string entryPoint { get; set; }
diff --git a/Assets/Thirdweb/Core/Scripts/ThirdwebManager.cs b/Assets/Thirdweb/Core/Scripts/ThirdwebManager.cs
@@ -99,6 +99,12 @@ public class ThirdwebManager : MonoBehaviour
         [Tooltip("Whether it should use a paymaster for gasless transactions or not")]
         public bool gasless;
 
+        [Tooltip("Optional - If you want to use a custom erc20 paymaster, you can provide the contract address here")]
+        public string erc20PaymasterAddress;
+
+        [Tooltip("Optional - If you want to use a custom erc20 token for your paymaster, you can provide the contract address here")]
+        public string erc20TokenAddress;
+
         [Tooltip("Optional - If you want to use a custom relayer, you can provide the URL here")]
         public string bundlerUrl;
 
@@ -281,6 +287,8 @@ public void Initialize(string chainIdentifier)
                 {
                     factoryAddress = factoryAddress,
                     gasless = gasless,
+                    erc20PaymasterAddress = string.IsNullOrEmpty(erc20PaymasterAddress) ? null : erc20PaymasterAddress,
+                    erc20TokenAddress = string.IsNullOrEmpty(erc20TokenAddress) ? null : erc20TokenAddress,
                     bundlerUrl = string.IsNullOrEmpty(bundlerUrl) ? $"https://{activeChainId}.bundler.thirdweb.com" : bundlerUrl,
                     paymasterUrl = string.IsNullOrEmpty(paymasterUrl) ? $"https://{activeChainId}.bundler.thirdweb.com" : paymasterUrl,
                     entryPointAddress = string.IsNullOrEmpty(entryPointAddress) ? Thirdweb.AccountAbstraction.Constants.DEFAULT_ENTRYPOINT_ADDRESS : entryPointAddress,
diff --git a/Assets/Thirdweb/Core/Scripts/ThirdwebSDK.cs b/Assets/Thirdweb/Core/Scripts/ThirdwebSDK.cs
@@ -112,6 +112,16 @@ public struct SmartWalletConfig
             /// </summary>
             public bool gasless;
 
+            /// <summary>
+            /// The address of your ERC20 paymaster contract if used.
+            /// </summary>
+            public string erc20PaymasterAddress;
+
+            /// <summary>
+            /// The address of your ERC20 token if using ERC20 paymaster.
+            /// </summary>
+            public string erc20TokenAddress;
+
             /// <summary>
             /// The URL of the bundler service.
             /// </summary>
diff --git a/Assets/Thirdweb/Core/Scripts/Utils.cs b/Assets/Thirdweb/Core/Scripts/Utils.cs
@@ -524,7 +524,7 @@ public async static Task<GasPriceParameters> GetGasPriceAsync(BigInteger chainId
                 chainId == 1 // mainnet
                 || chainId == 11155111 // sepolia
                 || chainId == 42161 // arbitrum
-                || chainId == 421613 // arbitrum goerli
+                || chainId == 421614 // arbitrum sepolia
                 || chainId == 534352 // scroll
                 || chainId == 534351 // scroll sepolia
                 || chainId == 5000 // mantle
@@ -534,6 +534,8 @@ public async static Task<GasPriceParameters> GetGasPriceAsync(BigInteger chainId
                 || chainId == 44787 // celo alfajores
                 || chainId == 43114 // avalanche
                 || chainId == 43113 // avalanche fuji
+                || chainId == 8453 // base
+                || chainId == 84532 // base sepolia
             )
             {
                 gasPrice = BigInteger.Multiply(gasPrice, 10) / 9;
diff --git a/Assets/Thirdweb/Editor/ThirdwebManagerEditor.cs b/Assets/Thirdweb/Editor/ThirdwebManagerEditor.cs
@@ -27,6 +27,8 @@ public class ThirdwebManagerEditor : Editor
         private SerializedProperty walletConnectExplorerRecommendedWalletIdsProperty;
         private SerializedProperty factoryAddressProperty;
         private SerializedProperty gaslessProperty;
+        private SerializedProperty erc20PaymasterAddressProperty;
+        private SerializedProperty erc20TokenAddressProperty;
         private SerializedProperty bundlerUrlProperty;
         private SerializedProperty paymasterUrlProperty;
         private SerializedProperty entryPointAddressProperty;
@@ -67,6 +69,8 @@ private void OnEnable()
             walletConnectExplorerRecommendedWalletIdsProperty = serializedObject.FindProperty("walletConnectExplorerRecommendedWalletIds");
             factoryAddressProperty = serializedObject.FindProperty("factoryAddress");
             gaslessProperty = serializedObject.FindProperty("gasless");
+            erc20PaymasterAddressProperty = serializedObject.FindProperty("erc20PaymasterAddress");
+            erc20TokenAddressProperty = serializedObject.FindProperty("erc20TokenAddress");
             bundlerUrlProperty = serializedObject.FindProperty("bundlerUrl");
             paymasterUrlProperty = serializedObject.FindProperty("paymasterUrl");
             entryPointAddressProperty = serializedObject.FindProperty("entryPointAddress");
@@ -304,6 +308,8 @@ public override void OnInspectorGUI()
 
                     if (showSmartWalletOptionalFields)
                     {
+                        EditorGUILayout.PropertyField(erc20PaymasterAddressProperty);
+                        EditorGUILayout.PropertyField(erc20TokenAddressProperty);
                         EditorGUILayout.PropertyField(bundlerUrlProperty);
                         EditorGUILayout.PropertyField(paymasterUrlProperty);
                         EditorGUILayout.PropertyField(entryPointAddressProperty);

Original file line number	Diff line number	Diff line change
`@@ -10,10 +10,16 @@ public static class BundlerClient`
`10`	`10`	`{`
`11`	`11`	`// Bundler requests`
`12`	`12`
`13`		`- public static async Task<EthGetUserOperationByHasResponse> EthGetUserOperationByHash(string bundlerUrl, string apiKey, object requestId, string userOpHash)`
	`13`	`+ public static async Task<EthGetUserOperationByHashResponse> EthGetUserOperationByHash(string bundlerUrl, string apiKey, object requestId, string userOpHash)`
`14`	`14`	`{`
`15`	`15`	`var response = await BundlerRequest(bundlerUrl, apiKey, requestId, "eth_getUserOperationByHash", userOpHash);`
`16`		`- return JsonConvert.DeserializeObject<EthGetUserOperationByHasResponse>(response.Result.ToString());`
	`16`	`+ return JsonConvert.DeserializeObject<EthGetUserOperationByHashResponse>(response.Result.ToString());`
	`17`	`+ }`
	`18`	`+`
	`19`	`+ public static async Task<EthGetUserOperationReceiptResponse> EthGetUserOperationReceipt(string bundlerUrl, string apiKey, object requestId, string userOpHash)`
	`20`	`+ {`
	`21`	`+ var response = await BundlerRequest(bundlerUrl, apiKey, requestId, "eth_getUserOperationReceipt", userOpHash);`
	`22`	`+ return JsonConvert.DeserializeObject<EthGetUserOperationReceiptResponse>(response.Result.ToString());`
`17`	`23`	`}`
`18`	`24`
`19`	`25`	`public static async Task<string> EthSendUserOperation(string bundlerUrl, string apiKey, object requestId, UserOperationHexified userOp, string entryPoint)`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+using Nethereum.RPC.Eth.DTOs;`
	`2`	`+`
`1`	`3`	`namespace Thirdweb.AccountAbstraction`
`2`	`4`	`{`
`3`	`5`	`public class EthEstimateUserOperationGasResponse`
`@@ -7,14 +9,19 @@ public class EthEstimateUserOperationGasResponse`
`7`	`9`	`public string CallGasLimit { get; set; }`
`8`	`10`	`}`
`9`	`11`
`10`		`- public class EthGetUserOperationByHasResponse`
	`12`	`+ public class EthGetUserOperationByHashResponse`
`11`	`13`	`{`
`12`	`14`	`public string entryPoint { get; set; }`
`13`	`15`	`public string transactionHash { get; set; }`
`14`	`16`	`public string blockHash { get; set; }`
`15`	`17`	`public string blockNumber { get; set; }`
`16`	`18`	`}`
`17`	`19`
	`20`	`+ public class EthGetUserOperationReceiptResponse`
	`21`	`+ {`
	`22`	`+ public TransactionReceipt receipt { get; set; }`
	`23`	`+ }`
	`24`	`+`
`18`	`25`	`public class EntryPointWrapper`
`19`	`26`	`{`
`20`	`27`	`public string entryPoint { get; set; }`