using System; using System.IO; using System.Linq; using System.Text; using System.Threading.Tasks; using BTCPayServer.Abstractions.Extensions; using BTCPayServer.Abstractions.Models; using BTCPayServer.Client; using BTCPayServer.Data; using BTCPayServer.Events; using BTCPayServer.Models; using BTCPayServer.Models.StoreViewModels; using BTCPayServer.Payments; using BTCPayServer.Services; using ExchangeSharp; using Microsoft.AspNetCore.Authorization; using Microsoft.AspNetCore.Http; using Microsoft.AspNetCore.Mvc; using Microsoft.AspNetCore.Mvc.ModelBinding.Metadata; using NBitcoin; using NBXplorer; using NBXplorer.DerivationStrategy; using NBXplorer.Models; namespace BTCPayServer.Controllers { public partial class StoresController { [HttpGet("{storeId}/onchain/{cryptoCode}")] public ActionResult SetupWallet(WalletSetupViewModel vm) { var checkResult = IsAvailable(vm.CryptoCode, out var store, out _); if (checkResult != null) { return checkResult; } var derivation = GetExistingDerivationStrategy(vm.CryptoCode, store); vm.DerivationScheme = derivation?.AccountDerivation.ToString(); return View(vm); } [HttpGet("{storeId}/onchain/{cryptoCode}/import/{method?}")] public async Task ImportWallet(WalletSetupViewModel vm) { var checkResult = IsAvailable(vm.CryptoCode, out _, out var network); if (checkResult != null) { return checkResult; } var (hotWallet, rpcImport) = await CanUseHotWallet(); vm.Network = network; vm.CanUseHotWallet = hotWallet; vm.CanUseRPCImport = rpcImport; vm.SupportTaproot = network.NBitcoinNetwork.Consensus.SupportTaproot; vm.SupportSegwit = network.NBitcoinNetwork.Consensus.SupportSegwit; vm.IsTaprootActivated = TaprootActivated(vm.CryptoCode); if (vm.Method == null) { vm.Method = WalletSetupMethod.ImportOptions; } else if (vm.Method == WalletSetupMethod.Seed) { vm.SetupRequest = new WalletSetupRequest(); } return View(vm.ViewName, vm); } [HttpPost("{storeId}/onchain/{cryptoCode}/modify")] [HttpPost("{storeId}/onchain/{cryptoCode}/import/{method}")] public async Task UpdateWallet(WalletSetupViewModel vm) { var checkResult = IsAvailable(vm.CryptoCode, out var store, out var network); if (checkResult != null) { return checkResult; } vm.Network = network; DerivationSchemeSettings strategy = null; var wallet = _WalletProvider.GetWallet(network); if (wallet == null) { return NotFound(); } if (vm.WalletFile != null) { if (!DerivationSchemeSettings.TryParseFromWalletFile(await ReadAllText(vm.WalletFile), network, out strategy)) { ModelState.AddModelError(nameof(vm.WalletFile), "Wallet file was not in the correct format"); return View(vm.ViewName, vm); } } else if (!string.IsNullOrEmpty(vm.WalletFileContent)) { if (!DerivationSchemeSettings.TryParseFromWalletFile(vm.WalletFileContent, network, out strategy)) { ModelState.AddModelError(nameof(vm.WalletFileContent), "QR import was not in the correct format"); return View(vm.ViewName, vm); } } else if (!string.IsNullOrEmpty(vm.DerivationScheme)) { try { strategy = ParseDerivationStrategy(vm.DerivationScheme, network); strategy.Source = "ManualDerivationScheme"; if (!string.IsNullOrEmpty(vm.AccountKey)) { var accountKey = new BitcoinExtPubKey(vm.AccountKey, network.NBitcoinNetwork); var accountSettings = strategy.AccountKeySettings.FirstOrDefault(a => a.AccountKey == accountKey); if (accountSettings != null) { accountSettings.AccountKeyPath = vm.KeyPath == null ? null : KeyPath.Parse(vm.KeyPath); accountSettings.RootFingerprint = string.IsNullOrEmpty(vm.RootFingerprint) ? (HDFingerprint?)null : new HDFingerprint( NBitcoin.DataEncoders.Encoders.Hex.DecodeData(vm.RootFingerprint)); } } vm.DerivationScheme = strategy.AccountDerivation.ToString(); ModelState.Remove(nameof(vm.DerivationScheme)); } catch { ModelState.AddModelError(nameof(vm.DerivationScheme), "Invalid wallet format"); return View(vm.ViewName, vm); } } else if (!string.IsNullOrEmpty(vm.Config)) { if (!DerivationSchemeSettings.TryParseFromJson(UnprotectString(vm.Config), network, out strategy)) { ModelState.AddModelError(nameof(vm.Config), "Config file was not in the correct format"); return View(vm.ViewName, vm); } } if (strategy is null) { ModelState.AddModelError(nameof(vm.DerivationScheme), "Please provide your extended public key"); return View(vm.ViewName, vm); } vm.Config = ProtectString(strategy.ToJson()); ModelState.Remove(nameof(vm.Config)); PaymentMethodId paymentMethodId = new PaymentMethodId(network.CryptoCode, PaymentTypes.BTCLike); var storeBlob = store.GetStoreBlob(); if (vm.Confirmation) { try { await wallet.TrackAsync(strategy.AccountDerivation); store.SetSupportedPaymentMethod(paymentMethodId, strategy); storeBlob.SetExcluded(paymentMethodId, false); storeBlob.Hints.Wallet = false; storeBlob.PayJoinEnabled = vm.IsHotWallet && vm.SetupRequest.PayJoinEnabled; store.SetStoreBlob(storeBlob); } catch { ModelState.AddModelError(nameof(vm.DerivationScheme), "Invalid derivation scheme"); return View(vm.ViewName, vm); } await _Repo.UpdateStore(store); _EventAggregator.Publish(new WalletChangedEvent { WalletId = new WalletId(vm.StoreId, vm.CryptoCode) }); TempData[WellKnownTempData.SuccessMessage] = $"Wallet settings for {network.CryptoCode} have been updated."; // This is success case when derivation scheme is added to the store return RedirectToAction(nameof(UpdateStore), new { storeId = vm.StoreId }); } return ConfirmAddresses(vm, strategy); } private string ProtectString(string str) { return Convert.ToBase64String(DataProtector.Protect(Encoding.UTF8.GetBytes(str))); } private string UnprotectString(string str) { return Encoding.UTF8.GetString(DataProtector.Unprotect(Convert.FromBase64String(str))); } [HttpGet("{storeId}/onchain/{cryptoCode}/generate/{method?}")] public async Task GenerateWallet(WalletSetupViewModel vm) { var checkResult = IsAvailable(vm.CryptoCode, out var store, out var network); if (checkResult != null) { return checkResult; } var isHotWallet = vm.Method == WalletSetupMethod.HotWallet; var (hotWallet, rpcImport) = await CanUseHotWallet(); if (isHotWallet && !hotWallet) { return NotFound(); } vm.CanUseHotWallet = hotWallet; vm.CanUseRPCImport = rpcImport; vm.SupportTaproot = network.NBitcoinNetwork.Consensus.SupportTaproot; vm.SupportSegwit = network.NBitcoinNetwork.Consensus.SupportSegwit; vm.IsTaprootActivated = TaprootActivated(vm.CryptoCode); vm.Network = network; if (vm.Method == null) { vm.Method = WalletSetupMethod.GenerateOptions; } else { var canUsePayJoin = hotWallet && isHotWallet && network.SupportPayJoin; vm.SetupRequest = new WalletSetupRequest { SavePrivateKeys = isHotWallet, CanUsePayJoin = canUsePayJoin, PayJoinEnabled = canUsePayJoin }; } return View(vm.ViewName, vm); } internal GenerateWalletResponse GenerateWalletResponse; [HttpPost("{storeId}/onchain/{cryptoCode}/generate/{method}")] public async Task GenerateWallet(string storeId, string cryptoCode, WalletSetupMethod method, WalletSetupRequest request) { var checkResult = IsAvailable(cryptoCode, out var store, out var network); if (checkResult != null) { return checkResult; } var (hotWallet, rpcImport) = await CanUseHotWallet(); if (!hotWallet && request.SavePrivateKeys || !rpcImport && request.ImportKeysToRPC) { return NotFound(); } var client = _ExplorerProvider.GetExplorerClient(cryptoCode); var isImport = method == WalletSetupMethod.Seed; var vm = new WalletSetupViewModel { StoreId = storeId, CryptoCode = cryptoCode, Method = method, SetupRequest = request, Confirmation = string.IsNullOrEmpty(request.ExistingMnemonic), Network = network, Source = isImport ? "SeedImported" : "NBXplorerGenerated", IsHotWallet = isImport ? request.SavePrivateKeys : method == WalletSetupMethod.HotWallet, DerivationSchemeFormat = "BTCPay", CanUseHotWallet = hotWallet, CanUseRPCImport = rpcImport, IsTaprootActivated = TaprootActivated(cryptoCode), SupportTaproot = network.NBitcoinNetwork.Consensus.SupportTaproot, SupportSegwit = network.NBitcoinNetwork.Consensus.SupportSegwit }; if (isImport && string.IsNullOrEmpty(request.ExistingMnemonic)) { ModelState.AddModelError(nameof(request.ExistingMnemonic), "Please provide your existing seed"); return View(vm.ViewName, vm); } GenerateWalletResponse response; try { response = await client.GenerateWalletAsync(request); if (response == null) { throw new Exception("Node unavailable"); } } catch (Exception e) { TempData.SetStatusMessageModel(new StatusMessageModel { Severity = StatusMessageModel.StatusSeverity.Error, Html = $"There was an error generating your wallet: {e.Message}" }); return View(vm.ViewName, vm); } var derivationSchemeSettings = new DerivationSchemeSettings(response.DerivationScheme, network); if (method == WalletSetupMethod.Seed) { derivationSchemeSettings.Source = "ImportedSeed"; derivationSchemeSettings.IsHotWallet = request.SavePrivateKeys; } else { derivationSchemeSettings.Source = "NBXplorerGenerated"; derivationSchemeSettings.IsHotWallet = method == WalletSetupMethod.HotWallet; } var accountSettings = derivationSchemeSettings.GetSigningAccountKeySettings(); accountSettings.AccountKeyPath = response.AccountKeyPath.KeyPath; accountSettings.RootFingerprint = response.AccountKeyPath.MasterFingerprint; derivationSchemeSettings.AccountOriginal = response.DerivationScheme.ToString(); // Set wallet properties from generate response vm.RootFingerprint = response.AccountKeyPath.MasterFingerprint.ToString(); vm.AccountKey = response.AccountHDKey.Neuter().ToWif(); vm.KeyPath = response.AccountKeyPath.KeyPath.ToString(); vm.Config = ProtectString(derivationSchemeSettings.ToJson()); var result = await UpdateWallet(vm); if (!ModelState.IsValid || !(result is RedirectToActionResult)) return result; if (!isImport) { TempData.SetStatusMessageModel(new StatusMessageModel { Severity = StatusMessageModel.StatusSeverity.Success, Html = "Your wallet has been generated." }); var seedVm = new RecoverySeedBackupViewModel { CryptoCode = cryptoCode, Mnemonic = response.Mnemonic, Passphrase = response.Passphrase, IsStored = request.SavePrivateKeys, ReturnUrl = Url.Action(nameof(GenerateWalletConfirm), new { storeId, cryptoCode }) }; if (this._BTCPayEnv.IsDeveloping) { GenerateWalletResponse = response; } return this.RedirectToRecoverySeedBackup(seedVm); } TempData.SetStatusMessageModel(new StatusMessageModel { Severity = StatusMessageModel.StatusSeverity.Warning, Html = "Please check your addresses and confirm." }); return result; } // The purpose of this action is to show the user a success message, which confirms // that the store settings have been updated after generating a new wallet. [HttpGet("{storeId}/onchain/{cryptoCode}/generate/confirm")] public ActionResult GenerateWalletConfirm(string storeId, string cryptoCode) { var checkResult = IsAvailable(cryptoCode, out _, out var network); if (checkResult != null) { return checkResult; } TempData[WellKnownTempData.SuccessMessage] = $"Wallet settings for {network.CryptoCode} have been updated."; return RedirectToAction(nameof(UpdateStore), new { storeId }); } [HttpGet("{storeId}/onchain/{cryptoCode}/modify")] public async Task ModifyWallet(WalletSetupViewModel vm) { var checkResult = IsAvailable(vm.CryptoCode, out var store, out var network); if (checkResult != null) { return checkResult; } var derivation = GetExistingDerivationStrategy(vm.CryptoCode, store); if (derivation == null) { return NotFound(); } var (hotWallet, rpcImport) = await CanUseHotWallet(); vm.CanUseHotWallet = hotWallet; vm.CanUseRPCImport = rpcImport; vm.Network = network; vm.Source = derivation.Source; vm.RootFingerprint = derivation.GetSigningAccountKeySettings().RootFingerprint.ToString(); vm.DerivationScheme = derivation.AccountDerivation.ToString(); vm.KeyPath = derivation.GetSigningAccountKeySettings().AccountKeyPath?.ToString(); vm.Config = ProtectString(derivation.ToJson()); vm.IsHotWallet = derivation.IsHotWallet; ViewData["ReplaceDescription"] = WalletReplaceWarning(derivation.IsHotWallet); ViewData["RemoveDescription"] = WalletRemoveWarning(derivation.IsHotWallet, network.CryptoCode); return View(vm); } [HttpGet("{storeId}/onchain/{cryptoCode}/replace")] public ActionResult ReplaceWallet(string storeId, string cryptoCode) { var checkResult = IsAvailable(cryptoCode, out var store, out var network); if (checkResult != null) { return checkResult; } var derivation = GetExistingDerivationStrategy(cryptoCode, store); return View("Confirm", new ConfirmModel { Title = $"Replace {network.CryptoCode} wallet", Description = WalletReplaceWarning(derivation.IsHotWallet), DescriptionHtml = true, Action = "Setup new wallet" }); } [HttpPost("{storeId}/onchain/{cryptoCode}/replace")] public IActionResult ConfirmReplaceWallet(string storeId, string cryptoCode) { var checkResult = IsAvailable(cryptoCode, out var store, out _); if (checkResult != null) { return checkResult; } var derivation = GetExistingDerivationStrategy(cryptoCode, store); if (derivation == null) { return NotFound(); } return RedirectToAction(nameof(SetupWallet), new { storeId, cryptoCode }); } [HttpGet("{storeId}/onchain/{cryptoCode}/delete")] public ActionResult DeleteWallet(string storeId, string cryptoCode) { var checkResult = IsAvailable(cryptoCode, out var store, out var network); if (checkResult != null) { return checkResult; } var derivation = GetExistingDerivationStrategy(cryptoCode, store); return View("Confirm", new ConfirmModel { Title = $"Remove {network.CryptoCode} wallet", Description = WalletRemoveWarning(derivation.IsHotWallet, network.CryptoCode), DescriptionHtml = true, Action = "Remove" }); } [HttpPost("{storeId}/onchain/{cryptoCode}/status")] public async Task SetWalletEnabled(string storeId, string cryptoCode, bool enabled) { var checkResult = IsAvailable(cryptoCode, out var store, out var network); if (checkResult != null) { return checkResult; } var derivation = GetExistingDerivationStrategy(cryptoCode, store); if (derivation == null) { return NotFound(); } var wallet = _WalletProvider.GetWallet(network); if (wallet == null) { return NotFound(); } var paymentMethodId = new PaymentMethodId(network.CryptoCode, PaymentTypes.BTCLike); var storeBlob = store.GetStoreBlob(); storeBlob.SetExcluded(paymentMethodId, !enabled); store.SetStoreBlob(storeBlob); await _Repo.UpdateStore(store); _EventAggregator.Publish(new WalletChangedEvent { WalletId = new WalletId(storeId, cryptoCode) }); TempData[WellKnownTempData.SuccessMessage] = $"{network.CryptoCode} on-chain payments are now {(enabled ? "enabled" : "disabled")} for this store."; return RedirectToAction(nameof(UpdateStore), new { storeId }); } [HttpPost("{storeId}/onchain/{cryptoCode}/delete")] public async Task ConfirmDeleteWallet(string storeId, string cryptoCode) { var checkResult = IsAvailable(cryptoCode, out var store, out var network); if (checkResult != null) { return checkResult; } var derivation = GetExistingDerivationStrategy(cryptoCode, store); if (derivation == null) { return NotFound(); } PaymentMethodId paymentMethodId = new PaymentMethodId(network.CryptoCode, PaymentTypes.BTCLike); store.SetSupportedPaymentMethod(paymentMethodId, null); await _Repo.UpdateStore(store); _EventAggregator.Publish(new WalletChangedEvent { WalletId = new WalletId(storeId, cryptoCode) }); TempData[WellKnownTempData.SuccessMessage] = $"On-Chain payment for {network.CryptoCode} has been removed."; return RedirectToAction(nameof(UpdateStore), new { storeId }); } private IActionResult ConfirmAddresses(WalletSetupViewModel vm, DerivationSchemeSettings strategy) { vm.DerivationScheme = strategy.AccountDerivation.ToString(); var deposit = new KeyPathTemplates(null).GetKeyPathTemplate(DerivationFeature.Deposit); if (!string.IsNullOrEmpty(vm.DerivationScheme)) { var line = strategy.AccountDerivation.GetLineFor(deposit); for (uint i = 0; i < 10; i++) { var keyPath = deposit.GetKeyPath(i); var rootedKeyPath = vm.GetAccountKeypath()?.Derive(keyPath); var derivation = line.Derive(i); var address = strategy.Network.NBXplorerNetwork.CreateAddress(strategy.AccountDerivation, line.KeyPathTemplate.GetKeyPath(i), derivation.ScriptPubKey).ToString(); vm.AddressSamples.Add((keyPath.ToString(), address, rootedKeyPath)); } } vm.Confirmation = true; ModelState.Remove(nameof(vm.Config)); // Remove the cached value return View("ImportWallet/ConfirmAddresses", vm); } private ActionResult IsAvailable(string cryptoCode, out StoreData store, out BTCPayNetwork network) { store = HttpContext.GetStoreData(); network = cryptoCode == null ? null : _ExplorerProvider.GetNetwork(cryptoCode); return store == null || network == null ? NotFound() : null; } private DerivationSchemeSettings GetExistingDerivationStrategy(string cryptoCode, StoreData store) { var id = new PaymentMethodId(cryptoCode, PaymentTypes.BTCLike); var existing = store.GetSupportedPaymentMethods(_NetworkProvider) .OfType() .FirstOrDefault(d => d.PaymentId == id); return existing; } private async Task<(bool HotWallet, bool RPCImport)> CanUseHotWallet() { var policies = await _settingsRepository.GetSettingAsync(); return await _authorizationService.CanUseHotWallet(policies, User); } private async Task ReadAllText(IFormFile file) { using (var stream = new StreamReader(file.OpenReadStream())) { return await stream.ReadToEndAsync(); } } private string WalletWarning(bool isHotWallet, string info) { var walletType = isHotWallet ? "hot" : "watch-only"; var additionalText = isHotWallet ? "" : " or imported it into an external wallet. If you no longer have access to your private key (recovery seed), immediately replace the wallet"; return $"

Please note that this is a {walletType} wallet!

" + $"

Do not proceed if you have not backed up the wallet{additionalText}.

" + $"

This action will erase the current wallet data from the server. {info}

"; } private string WalletReplaceWarning(bool isHotWallet) { return WalletWarning(isHotWallet, "The current wallet will be replaced once you finish the setup of the new wallet. " + "If you cancel the setup, the current wallet will stay active."); } private string WalletRemoveWarning(bool isHotWallet, string cryptoCode) { return WalletWarning(isHotWallet, $"The store won't be able to receive {cryptoCode} onchain payments until a new wallet is set up."); } } }