Merge pull request #1522 from Kukks/view-seed

Add View seed to wallet settings

BTCPayServer.Tests/SeleniumTests.cs

@@ -639,6 +639,13 @@ namespace BTCPayServer.Tests
                 Assert.Equal(parsedBip21.Amount.ToString(false), s.Driver.FindElement(By.Id($"Outputs_0__Amount")).GetAttribute("value"));
                 Assert.Equal(parsedBip21.Address.ToString(), s.Driver.FindElement(By.Id($"Outputs_0__DestinationAddress")).GetAttribute("value"));
                 
+                
+                s.GoToWallet(new WalletId(storeId.storeId, "BTC"), WalletsNavPages.Settings);
+                
+                s.Driver.FindElement(By.Id("SettingsMenu")).ForceClick();
+                s.Driver.FindElement(By.CssSelector("button[value=view-seed]")).Click();
+                s.AssertHappyMessage();
+                Assert.Equal(mnemonic.ToString(), s.Driver.FindElements(By.ClassName("alert-success")).First().FindElement(By.TagName("code")).Text);
             }
         }
         void SetTransactionOutput(SeleniumTester s, int index, BitcoinAddress dest, decimal amount, bool subtract = false)

BTCPayServer/Controllers/WalletsController.cs

@@ -1137,7 +1137,10 @@ namespace BTCPayServer.Controllers
                 Label = derivationSchemeSettings.Label,
                 DerivationScheme = derivationSchemeSettings.AccountDerivation.ToString(),
                 DerivationSchemeInput = derivationSchemeSettings.AccountOriginal,
-                SelectedSigningKey = derivationSchemeSettings.SigningKey.ToString()
+                SelectedSigningKey = derivationSchemeSettings.SigningKey.ToString(),
+                NBXSeedAvailable = await CanUseHotWallet() && !string.IsNullOrEmpty(await ExplorerClientProvider.GetExplorerClient(walletId.CryptoCode)
+                    .GetMetadataAsync<string>(GetDerivationSchemeSettings(walletId).AccountDerivation,
+                        WellknownMetadataKeys.MasterHDKey))
             };
             vm.AccountKeys = derivationSchemeSettings.AccountKeySettings
                             .Select(e => new WalletSettingsAccountKeyViewModel()
@@ -1152,8 +1155,9 @@ namespace BTCPayServer.Controllers
         [Route("{walletId}/settings")]
         [HttpPost]
         public async Task<IActionResult> WalletSettings(
-             [ModelBinder(typeof(WalletIdModelBinder))]
-            WalletId walletId, WalletSettingsViewModel vm, string command = "save", CancellationToken cancellationToken = default)
+            [ModelBinder(typeof(WalletIdModelBinder))]
+            WalletId walletId, WalletSettingsViewModel vm, string command = "save",
+            CancellationToken cancellationToken = default)
         {
             if (!ModelState.IsValid)
                 return View(vm);
@@ -1164,14 +1168,21 @@ namespace BTCPayServer.Controllers
             if (command == "save")
             {
                 derivationScheme.Label = vm.Label;
-                derivationScheme.SigningKey = string.IsNullOrEmpty(vm.SelectedSigningKey) ? null : new BitcoinExtPubKey(vm.SelectedSigningKey, derivationScheme.Network.NBitcoinNetwork);
+                derivationScheme.SigningKey = string.IsNullOrEmpty(vm.SelectedSigningKey)
+                    ? null
+                    : new BitcoinExtPubKey(vm.SelectedSigningKey, derivationScheme.Network.NBitcoinNetwork);
                 for (int i = 0; i < derivationScheme.AccountKeySettings.Length; i++)
                 {
-                    derivationScheme.AccountKeySettings[i].AccountKeyPath = string.IsNullOrWhiteSpace(vm.AccountKeys[i].AccountKeyPath) ? null
-                                                              : new KeyPath(vm.AccountKeys[i].AccountKeyPath);
-                    derivationScheme.AccountKeySettings[i].RootFingerprint = string.IsNullOrWhiteSpace(vm.AccountKeys[i].MasterFingerprint) ? (HDFingerprint?)null
-                                                              : new HDFingerprint(Encoders.Hex.DecodeData(vm.AccountKeys[i].MasterFingerprint));
+                    derivationScheme.AccountKeySettings[i].AccountKeyPath =
+                        string.IsNullOrWhiteSpace(vm.AccountKeys[i].AccountKeyPath)
+                            ? null
+                            : new KeyPath(vm.AccountKeys[i].AccountKeyPath);
+                    derivationScheme.AccountKeySettings[i].RootFingerprint =
+                        string.IsNullOrWhiteSpace(vm.AccountKeys[i].MasterFingerprint)
+                            ? (HDFingerprint?)null
+                            : new HDFingerprint(Encoders.Hex.DecodeData(vm.AccountKeys[i].MasterFingerprint));
                 }
+
                 var store = (await Repository.FindStore(walletId.StoreId, GetUserId()));
                 store.SetSupportedPaymentMethod(derivationScheme);
                 await Repository.UpdateStore(store);
@@ -1180,15 +1191,41 @@ namespace BTCPayServer.Controllers
             }
             else if (command == "prune")
             {
-                var result = await ExplorerClientProvider.GetExplorerClient(walletId.CryptoCode).PruneAsync(derivationScheme.AccountDerivation, new PruneRequest(),  cancellationToken);
+                var result = await ExplorerClientProvider.GetExplorerClient(walletId.CryptoCode)
+                    .PruneAsync(derivationScheme.AccountDerivation, new PruneRequest(), cancellationToken);
                 if (result.TotalPruned == 0)
                 {
                     TempData[WellKnownTempData.SuccessMessage] = $"The wallet is already pruned";
                 }
                 else
                 {
-                    TempData[WellKnownTempData.SuccessMessage] = $"The wallet has been successfully pruned ({result.TotalPruned} transactions have been removed from the history)";
+                    TempData[WellKnownTempData.SuccessMessage] =
+                        $"The wallet has been successfully pruned ({result.TotalPruned} transactions have been removed from the history)";
                 }
+
+                return RedirectToAction(nameof(WalletSettings));
+            }
+            else if (command == "view-seed" && await CanUseHotWallet())
+            {
+                var seed =  await ExplorerClientProvider.GetExplorerClient(walletId.CryptoCode)
+                    .GetMetadataAsync<string>(derivationScheme.AccountDerivation,
+                        WellknownMetadataKeys.Mnemonic, cancellationToken);
+                if (string.IsNullOrEmpty(seed))
+                {
+                    TempData.SetStatusMessageModel(new StatusMessageModel()
+                    {
+                        Severity = StatusMessageModel.StatusSeverity.Error, Message = "The seed was not found"
+                    });
+                }
+                else
+                {
+                    TempData.SetStatusMessageModel(new StatusMessageModel()
+                    {
+                        Severity = StatusMessageModel.StatusSeverity.Success,
+                        Html = $"Please store your seed securely! <br/><code class=\"alert-link\">{seed}</code>"
+                    });
+                }
+                
                 return RedirectToAction(nameof(WalletSettings));
             }
             else
@@ -1196,8 +1233,6 @@ namespace BTCPayServer.Controllers
                 return NotFound();
             }
         }
-        
-
 
         private string GetImage(PaymentMethodId paymentMethodId, BTCPayNetwork network)
         {

BTCPayServer/Models/WalletViewModels/WalletSettingsViewModel.cs

@@ -1,4 +1,4 @@
-using System;
+using System;
 using System.Collections.Generic;
 using System.ComponentModel.DataAnnotations;
 using System.Linq;
@@ -16,6 +16,7 @@ namespace BTCPayServer.Models.WalletViewModels
         public bool IsMultiSig => AccountKeys.Count > 1;
 
         public List<WalletSettingsAccountKeyViewModel> AccountKeys { get; set; } = new List<WalletSettingsAccountKeyViewModel>();
+        public bool NBXSeedAvailable { get; set; }
     }
 
     public class WalletSettingsAccountKeyViewModel

BTCPayServer/Views/Wallets/WalletSettings.cshtml

@@ -71,11 +71,15 @@
             <div class="form-group d-flex mt-2">
                 <button name="command" type="submit" class="btn btn-primary" value="save">Save</button>
                 <div class="dropdown">
-                    <button class="ml-1 btn btn-secondary dropdown-toggle" type="button" id="SendMenu" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
+                    <button class="ml-1 btn btn-secondary dropdown-toggle" type="button" id="SettingsMenu" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
                         Other actions...
                     </button>
                     <div class="dropdown-menu" aria-labelledby="SendMenu">
                         <button name="command" type="submit" class="dropdown-item" value="prune">Prune old transactions from history</button>
+                        @if (Model.NBXSeedAvailable)
+                        {
+                            <button name="command" type="submit" class="dropdown-item" value="view-seed">View seed</button>
+                        }
                     </div>
                 </div>
             </div>