GreenField: Generate Store OnChain Wallet (#2708)

* GreenField: Generate Store OnChain Wallet * Greenfield: Do not generate wallet if already configured
2025-12-17 22:14:26 +01:00 · 2021-07-27 16:53:44 +02:00
parent 80483ba76f
commit c59798e9c4
12 changed files with 505 additions and 12 deletions
--- a/BTCPayServer/Controllers/GreenField/StoreOnChainPaymentMethodsController.WalletGeneration.cs
+++ b/BTCPayServer/Controllers/GreenField/StoreOnChainPaymentMethodsController.WalletGeneration.cs
@@ -0,0 +1,103 @@
+using System;
+using System.Threading.Tasks;
+using BTCPayServer.Abstractions.Constants;
+using BTCPayServer.Client;
+using BTCPayServer.Client.Models;
+using BTCPayServer.Data;
+using BTCPayServer.Payments;
+using Microsoft.AspNetCore.Authorization;
+using Microsoft.AspNetCore.Mvc;
+using NBXplorer.Models;
+
+namespace BTCPayServer.Controllers.GreenField
+{
+    public partial class StoreOnChainPaymentMethodsController
+    {
+        [Authorize(Policy = Policies.CanModifyStoreSettings, AuthenticationSchemes = AuthenticationSchemes.Greenfield)]
+        [HttpPost("~/api/v1/stores/{storeId}/payment-methods/onchain/{cryptoCode}/generate")]
+        public async Task<IActionResult> GenerateOnChainWallet(string storeId, string cryptoCode,
+            GenerateWalletRequest request)
+        {
+            var network = _btcPayNetworkProvider.GetNetwork<BTCPayNetwork>(cryptoCode);
+            if (network is null)
+            {
+                return NotFound();
+            }
+
+            if (!_walletProvider.IsAvailable(network))
+            {
+                return this.CreateAPIError("not-available",
+                    $"{cryptoCode} services are not currently available");
+            }
+            
+            var method = GetExistingBtcLikePaymentMethod(cryptoCode);
+            if (method != null)
+            {
+                return this.CreateAPIError("already-configured",
+                    $"{cryptoCode} wallet is already configured for this store");
+            }
+
+            var canUseHotWallet = await CanUseHotWallet();
+            if (request.SavePrivateKeys && !canUseHotWallet.HotWallet)
+            {
+                ModelState.AddModelError(nameof(request.SavePrivateKeys),
+                    "This instance forbids non-admins from having a hot wallet for your store.");
+            }
+
+            if (request.ImportKeysToRPC && !canUseHotWallet.RPCImport)
+            {
+                ModelState.AddModelError(nameof(request.ImportKeysToRPC),
+                    "This instance forbids non-admins from having importing the wallet addresses/keys to the underlying node.");
+            }
+
+            if (!ModelState.IsValid)
+            {
+                return this.CreateValidationError(ModelState);
+            }
+
+            var client = _explorerClientProvider.GetExplorerClient(network);
+            GenerateWalletResponse response;
+            try
+            {
+                response = await client.GenerateWalletAsync(request);
+                if (response == null)
+                {
+                    return this.CreateAPIError("not-available",
+                        $"{cryptoCode} services are not currently available");
+                }
+            }
+            catch (Exception e)
+            {
+                return this.CreateAPIError("not-available",
+                    $"{cryptoCode} error: {e.Message}");
+            }
+
+            var derivationSchemeSettings = new DerivationSchemeSettings(response.DerivationScheme, network);
+
+            derivationSchemeSettings.Source =
+                string.IsNullOrEmpty(request.ExistingMnemonic) ? "NBXplorerGenerated" : "ImportedSeed";
+            derivationSchemeSettings.IsHotWallet = request.SavePrivateKeys;
+
+            var accountSettings = derivationSchemeSettings.GetSigningAccountKeySettings();
+            accountSettings.AccountKeyPath = response.AccountKeyPath.KeyPath;
+            accountSettings.RootFingerprint = response.AccountKeyPath.MasterFingerprint;
+            derivationSchemeSettings.AccountOriginal = response.DerivationScheme.ToString();
+
+            var store = Store;
+            var storeBlob = store.GetStoreBlob();
+            store.SetSupportedPaymentMethod(new PaymentMethodId(cryptoCode, PaymentTypes.BTCLike),
+                derivationSchemeSettings);
+            store.SetStoreBlob(storeBlob);
+            await _storeRepository.UpdateStore(store);
+            var rawResult = GetExistingBtcLikePaymentMethod(cryptoCode, store);
+            var result = new OnChainPaymentMethodDataWithSensitiveData(rawResult.CryptoCode, rawResult.DerivationScheme,
+                rawResult.Enabled, rawResult.Label, rawResult.AccountKeyPath, response.GetMnemonic());
+            return Ok(result);
+        }
+        
+        private async Task<(bool HotWallet, bool RPCImport)> CanUseHotWallet()
+        {
+            return await _authorizationService.CanUseHotWallet(await _settingsRepository.GetPolicies(), User);
+        }
+    }
+}