feat: add support for custom HTTP headers in Tron RPC client

Author: b0l0k

BTCPayServer.Plugins.USDt/Configuration/Tron/TronUSDtLikeConfigurationItem.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Collections.Generic;
 
 namespace BTCPayServer.Plugins.USDt.Configuration.Tron;
 
@@ -15,4 +16,10 @@ public record TronUSDtLikeConfigurationItem : USDtPluginConfigurationItem
     public required string BlockExplorerLink { get; init; }
     public required string[] DefaultRateRules { get; init; }
     public required string CurrencyDisplayName { get; init; }
+    
+    /// <summary>
+    /// Custom HTTP headers to be sent with every RPC request.
+    /// Useful for API authentication (e.g., TronGrid API key via TRON-PRO-API-KEY header).
+    /// </summary>
+    public Dictionary<string, string>? HttpHeaders { get; init; }
 }

BTCPayServer.Plugins.USDt/Configuration/Tron/TronUSDtLikeServerSettings.cs

@@ -1,9 +1,16 @@
 using System;
+using System.Collections.Generic;
 
 namespace BTCPayServer.Plugins.USDt.Configuration.Tron;
 
 public class TronUSDtLikeServerSettings
 {
     public Uri? JsonRpcUri { get; init; }
     public string? SmartContractAddress { get; init; }
+    
+    /// <summary>
+    /// Custom HTTP headers to be sent with every RPC request.
+    /// Useful for API authentication (e.g., TronGrid API key via TRON-PRO-API-KEY header).
+    /// </summary>
+    public Dictionary<string, string>? HttpHeaders { get; init; }
 }

BTCPayServer.Plugins.USDt/Controllers/UITronUSDtLikeServerController.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Collections.Generic;
 using System.Linq;
 using System.Threading.Tasks;
 using BTCPayServer.Abstractions.Constants;
@@ -45,6 +46,7 @@ public async Task<IActionResult> GetServerConfig()
 
             SmartContractAddress = serverSettings?.SmartContractAddress,
             JsonRpcUri = serverSettings?.JsonRpcUri?.AbsoluteUri,
+            HttpHeaders = HttpHeadersDictionaryToString(serverSettings?.HttpHeaders),
         };
         return View(viewModel);
     }
@@ -69,7 +71,8 @@ public async Task<IActionResult> GetServerConfig(TronUSDtLikeServerConfigViewMod
         var serverSettings = new TronUSDtLikeServerSettings()
         {
             SmartContractAddress = viewModel.SmartContractAddress is null or "" ? null : viewModel.SmartContractAddress,
-            JsonRpcUri = viewModel.JsonRpcUri is null or "" ? null : new Uri(viewModel.JsonRpcUri)
+            JsonRpcUri = viewModel.JsonRpcUri is null or "" ? null : new Uri(viewModel.JsonRpcUri),
+            HttpHeaders = ParseHttpHeadersString(viewModel.HttpHeaders)
         };
 
         await settingsRepository.UpdateSetting(serverSettings, USDtPlugin.ServerSettingsKey(currentConfiguration));
@@ -81,4 +84,43 @@ public async Task<IActionResult> GetServerConfig(TronUSDtLikeServerConfigViewMod
 
         return RedirectToAction("GetServerConfig");
     }
+    
+    /// <summary>
+    /// Parses a newline-separated string of "Header-Name: Value" pairs into a dictionary.
+    /// </summary>
+    private static Dictionary<string, string>? ParseHttpHeadersString(string? headersString)
+    {
+        if (string.IsNullOrWhiteSpace(headersString))
+            return null;
+
+        var headers = new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase);
+        var lines = headersString.Split(['\r', '\n'], StringSplitOptions.RemoveEmptyEntries);
+        
+        foreach (var line in lines)
+        {
+            var colonIndex = line.IndexOf(':');
+            if (colonIndex <= 0) continue;
+            
+            var headerName = line[..colonIndex].Trim();
+            var headerValue = line[(colonIndex + 1)..].Trim();
+            
+            if (!string.IsNullOrEmpty(headerName) && !string.IsNullOrEmpty(headerValue))
+            {
+                headers[headerName] = headerValue;
+            }
+        }
+
+        return headers.Count > 0 ? headers : null;
+    }
+    
+    /// <summary>
+    /// Converts a dictionary of headers to a newline-separated string of "Header-Name: Value" pairs.
+    /// </summary>
+    private static string? HttpHeadersDictionaryToString(Dictionary<string, string>? headers)
+    {
+        if (headers == null || headers.Count == 0)
+            return null;
+
+        return string.Join(Environment.NewLine, headers.Select(h => $"{h.Key}: {h.Value}"));
+    }
 }

BTCPayServer.Plugins.USDt/Controllers/ViewModels/TronUSDtLikeServerConfigViewModel.cs

@@ -14,4 +14,10 @@ public class TronUSDtLikeServerConfigViewModel
     [Uri]
     public string? JsonRpcUri { get; init; }
     public Uri? DefaultJsonRpcUri { get; set; }
+    
+    /// <summary>
+    /// Custom HTTP headers as a newline-separated list of "Header-Name: Header-Value" pairs.
+    /// Example: "TRON-PRO-API-KEY: your-api-key-here"
+    /// </summary>
+    public string? HttpHeaders { get; set; }
 }

BTCPayServer.Plugins.USDt/Services/TronUSDtRPCProvider.cs

@@ -53,6 +53,16 @@ private void LoadClientsFromConfiguration()
                 pair =>
                 {
                     var httpClient = _httpClientFactory.CreateClient($"{pair.Key}client");
+                    
+                    // Add custom HTTP headers if configured (e.g., for TronGrid API key)
+                    if (pair.Value.HttpHeaders != null)
+                    {
+                        foreach (var header in pair.Value.HttpHeaders)
+                        {
+                            httpClient.DefaultRequestHeaders.TryAddWithoutValidation(header.Key, header.Value);
+                        }
+                    }
+                    
                     var rpcClient = new RpcClient(pair.Value.JsonRpcUri, httpClient);
                     return rpcClient;
                 });

BTCPayServer.Plugins.USDt/USDtPlugin.cs

@@ -167,7 +167,8 @@ public static TronUSDtLikeConfigurationItem OverrideWithServerSettings(TronUSDtL
         return config with
         {
             JsonRpcUri = serverSettings.JsonRpcUri ?? config.JsonRpcUri,
-            SmartContractAddress = serverSettings.SmartContractAddress ?? config.SmartContractAddress
+            SmartContractAddress = serverSettings.SmartContractAddress ?? config.SmartContractAddress,
+            HttpHeaders = serverSettings.HttpHeaders ?? config.HttpHeaders
         };
     }
 

BTCPayServer.Plugins.USDt/Views/UITronUSDtLikeServer/GetServerConfig.cshtml

@@ -46,6 +46,24 @@
                     </small> of the node you wish to use for the connection with the TRON chain. By default, it uses the public node.
                 </div>
             </div>
+            <div class="form-group">
+                <div class="d-flex flex-wrap align-items-center justify-content-between gap-3">
+                    <label asp-for="HttpHeaders" class="form-label">HTTP Headers</label>
+                </div>
+                <textarea asp-for="HttpHeaders" class="form-control" rows="3" placeholder="TRON-PRO-API-KEY: your-api-key-here"></textarea>
+                <span asp-validation-for="HttpHeaders" class="text-danger"></span>
+                <div class="form-text">
+                    Optional custom HTTP headers to send with every RPC request (one per line, format: <code>Header-Name: value</code>).
+                    <br/>
+                    For TronGrid API access, add your API key:
+                    <small>
+                        <a href="https://developers.tron.network/reference/select-network" target="_blank" rel="noreferrer noopener">
+                            <vc:icon symbol="info"/>
+                        </a>
+                    </small>
+                    <code>TRON-PRO-API-KEY: your-api-key-here</code>
+                </div>
+            </div>
             <h4>Advanced</h4>
             <div class="alert alert-warning d-flex align-items-center" role="alert">
                 <svg class="bi flex-shrink-0 me-2" width="24" height="24" role="img" aria-label="Warning:">