mirror of
https://github.com/aljazceru/btcpayserver.git
synced 2025-12-18 14:34:23 +01:00
Custodian Account UI: CRUD (#3923)
* WIP New APIs for dealing with custodians/exchanges * Simplified things * More API refinements + index.html file for quick viewing * Finishing touches on spec * Switched cryptoCode to paymentMethod as this allows us to differentiate between onchain and lightning * Moved draft API docs to "/docs-draft" * WIP baby steps * Added DB migration for CustodianAccountData * Rough but working POST /v1/api/custodian-account + GET /v1/api/custodian * WIP + early Kraken API client * Moved service registration to proper location * Working create + list custodian accounts + permissions + WIP Kraken client * Kraken API Balances call is working * Added asset balances to response * List Custodian Accounts call does not load assetBalances by default, because it can fail. Can be requested when needed. * Call to get the details of 1 specific custodian account * Added permissions to swagger * Added "tradableAssetPairs" to Kraken custodian response + cache the tradable pairs in memory for 24 hours * Removed unused file * WIP + Moved files to better locations * Updated docs * Working API endpoint to get info on a trade (same response as creating a new trade) * Working API endpoints for Deposit + Trade + untested Withdraw * Delete custodian account * Trading works, better error handling, cleanup * Working withdrawals + New endpoint for getting bid/ask prices * Completed withdrawals + new endpoint for getting info on a past withdrawal to simplify testing, Enums are output as strings, * Better error handling when withdrawing to a wrong destination * WithdrawalAddressName in config is now a string per currency (dictionary) * Added TODOs * Only show the custodian account "config" to users who are allowed * Added the new permissions to the API Keys UI * Renamed KrakenClient to KrakenExchange * WIP Kraken Config Form * Removed files for UI again, will make separate PR later * Fixed docs + Refactored to use PaymentMethod more + Added "name" to custodian account + Using cancelationToken everywhere * Updated withdrawal info docs * First unit test * Complete tests for /api/v1/custodians and /api/v1/custodian-accounts endpoints + Various improvements and fixes * Mock custodian and more exceptions * Many more tests + cleanup, moved files to better locations * More tests * WIP more tests * Greenfield API tests complete * Added missing "Name" column * Cleanup, TODOs and beginning of Kraken Tests * Added Kraken tests using public endpoints + handling of "SATS" currency * Added 1st mocked Kraken API call: GetAssetBalancesAsync * Added assert for bad config * Mocked more Kraken API responses + added CreationDate to withdrawal response * pr review club changes * Make Kraken Custodian a plugin * Re-added User-Agent header as it is required * Fixed bug in market trade on Kraken using a percentage as qty * A short delay so Kraken has the time to execute the market order and we don't fetch the details too quickly. * Merged the draft swagger into the main swagger since it didn't work anymore * Fixed API permissions test * Removed 2 TODOs * Fixed unit test * After a utxo rescan, the cached balance should be invalidated * Fixed Kraken plugin build issues * Added Kraken plugin to build * WIP UI + config form * Create custodian account almost working - only need to add in the config form * Working form, but lacks refinement * Viewing balances + Editing custodian account works, but cannot change the withdrawal destination config because that is an object using a name with [] in it * cleanup * Minor cleanup, comments * Working: Delete custodian account * Moved the MockCustodian used in tests to a new plugin + linked it to the tests * WIP viewing custodian account balances * Split the Mock custodian into a Mock + Fake, various UI improvements and minor fixes * Minor UI fixes * Removed broken link * Removed links to anchors as they cannot pass the tests since they use JavaScript * Removed non-existing link. Even though it was commented out, the test still broke? * Added TODOs * Now throwing BadConfigException if API key is invalid * UI improvements * Commented out unfinished API endpoints. Can be finished later. * Show fiat value for fiat assets * Removed Kraken plugin so I can make a PR Removed more Kraken files * Add experimental route on UICustodianAccountsControllre * Removed unneeded code * Cleanup code * Processed Nicolas' feedback Co-authored-by: Kukks <evilkukka@gmail.com> Co-authored-by: nicolas.dorier <nicolas.dorier@gmail.com>
This commit is contained in:
Wouter Samaey
340
BTCPayServer/Controllers/UICustodianAccountsController.cs
Normal file
340
BTCPayServer/Controllers/UICustodianAccountsController.cs
Normal file
@@ -0,0 +1,340 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Linq;
|
||||
using System.Threading.Tasks;
|
||||
using BTCPayServer.Abstractions.Constants;
|
||||
using BTCPayServer.Abstractions.Custodians;
|
||||
using BTCPayServer.Abstractions.Extensions;
|
||||
using BTCPayServer.Abstractions.Form;
|
||||
using BTCPayServer.Client;
|
||||
using BTCPayServer.Data;
|
||||
using BTCPayServer.Filters;
|
||||
using BTCPayServer.Models.CustodianAccountViewModels;
|
||||
using BTCPayServer.Services.Custodian.Client;
|
||||
using BTCPayServer.Services.Rates;
|
||||
using Microsoft.AspNetCore.Authorization;
|
||||
using Microsoft.AspNetCore.Identity;
|
||||
using Microsoft.AspNetCore.Mvc;
|
||||
using Newtonsoft.Json.Linq;
|
||||
using CustodianAccountData = BTCPayServer.Data.CustodianAccountData;
|
||||
using StoreData = BTCPayServer.Data.StoreData;
|
||||
|
||||
namespace BTCPayServer.Controllers
|
||||
{
|
||||
[Authorize(Policy = Policies.CanModifyStoreSettings, AuthenticationSchemes = AuthenticationSchemes.Cookie)]
|
||||
[AutoValidateAntiforgeryToken]
|
||||
[ExperimentalRouteAttribute]
|
||||
public class UICustodianAccountsController : Controller
|
||||
{
|
||||
public UICustodianAccountsController(
|
||||
CurrencyNameTable currencyNameTable,
|
||||
UserManager<ApplicationUser> userManager,
|
||||
CustodianAccountRepository custodianAccountRepository,
|
||||
IEnumerable<ICustodian> custodianRegistry
|
||||
)
|
||||
{
|
||||
_currencyNameTable = currencyNameTable ?? throw new ArgumentNullException(nameof(currencyNameTable));
|
||||
_userManager = userManager;
|
||||
_custodianAccountRepository = custodianAccountRepository;
|
||||
_custodianRegistry = custodianRegistry;
|
||||
}
|
||||
|
||||
private readonly IEnumerable<ICustodian> _custodianRegistry;
|
||||
private readonly UserManager<ApplicationUser> _userManager;
|
||||
private readonly CustodianAccountRepository _custodianAccountRepository;
|
||||
private readonly CurrencyNameTable _currencyNameTable;
|
||||
|
||||
public string CreatedCustodianAccountId { get; set; }
|
||||
|
||||
[HttpGet("/stores/{storeId}/custodian-accounts/{accountId}")]
|
||||
public async Task<IActionResult> ViewCustodianAccount(string storeId, string accountId)
|
||||
{
|
||||
var vm = new ViewCustodianAccountViewModel();
|
||||
var custodianAccount = await _custodianAccountRepository.FindById(storeId, accountId);
|
||||
|
||||
if (custodianAccount == null)
|
||||
return NotFound();
|
||||
|
||||
var custodian = _custodianRegistry.GetCustodianByCode(custodianAccount.CustodianCode);
|
||||
if (custodian == null)
|
||||
{
|
||||
// TODO The custodian account is broken. The custodian is no longer available. Maybe delete the custodian account?
|
||||
return NotFound();
|
||||
}
|
||||
|
||||
vm.Custodian = custodian;
|
||||
vm.CustodianAccount = custodianAccount;
|
||||
var store = GetCurrentStore();
|
||||
var storeBlob = BTCPayServer.Data.StoreDataExtensions.GetStoreBlob(store);
|
||||
var defaultCurrency = storeBlob.DefaultCurrency;
|
||||
vm.DefaultCurrency = defaultCurrency;
|
||||
|
||||
|
||||
try
|
||||
{
|
||||
var assetBalances = new Dictionary<string, AssetBalanceInfo>();
|
||||
var assetBalancesData =
|
||||
await custodian.GetAssetBalancesAsync(custodianAccount.GetBlob(), cancellationToken: default);
|
||||
|
||||
foreach (var pair in assetBalancesData)
|
||||
{
|
||||
var asset = pair.Key;
|
||||
|
||||
assetBalances.Add(asset,
|
||||
new AssetBalanceInfo { Asset = asset, Qty = pair.Value }
|
||||
);
|
||||
}
|
||||
|
||||
|
||||
if (custodian is ICanTrade tradingCustodian)
|
||||
{
|
||||
var config = custodianAccount.GetBlob();
|
||||
var tradableAssetPairs = tradingCustodian.GetTradableAssetPairs();
|
||||
|
||||
foreach (var pair in assetBalances)
|
||||
{
|
||||
var asset = pair.Key;
|
||||
var assetBalance = assetBalances[asset];
|
||||
|
||||
if (asset.Equals(defaultCurrency))
|
||||
{
|
||||
assetBalance.FormattedFiatValue = _currencyNameTable.DisplayFormatCurrency(pair.Value.Qty, defaultCurrency);
|
||||
}
|
||||
else
|
||||
{
|
||||
try
|
||||
{
|
||||
var quote = await tradingCustodian.GetQuoteForAssetAsync(defaultCurrency, asset,
|
||||
config, default);
|
||||
assetBalance.Bid = quote.Bid;
|
||||
assetBalance.Ask = quote.Ask;
|
||||
assetBalance.FiatAsset = defaultCurrency;
|
||||
assetBalance.FormattedBid = _currencyNameTable.DisplayFormatCurrency(quote.Bid, quote.FromAsset);
|
||||
assetBalance.FormattedAsk = _currencyNameTable.DisplayFormatCurrency(quote.Ask, quote.FromAsset);
|
||||
assetBalance.FormattedFiatValue = _currencyNameTable.DisplayFormatCurrency(pair.Value.Qty * quote.Bid, pair.Value.FiatAsset);
|
||||
assetBalance.TradableAssetPairs = tradableAssetPairs.Where(o => o.AssetBought == asset || o.AssetSold == asset);
|
||||
}
|
||||
catch (WrongTradingPairException e)
|
||||
{
|
||||
// Cannot trade this asset, just ignore
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (custodian is ICanWithdraw withdrawableCustodian)
|
||||
{
|
||||
var withdrawableePaymentMethods = withdrawableCustodian.GetWithdrawablePaymentMethods();
|
||||
foreach (var withdrawableePaymentMethod in withdrawableePaymentMethods)
|
||||
{
|
||||
var withdrawableAsset = withdrawableePaymentMethod.Split("-")[0];
|
||||
if (assetBalances.ContainsKey(withdrawableAsset))
|
||||
{
|
||||
var assetBalance = assetBalances[withdrawableAsset];
|
||||
assetBalance.CanWithdraw = true;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (custodian is ICanDeposit depositableCustodian)
|
||||
{
|
||||
var depositablePaymentMethods = depositableCustodian.GetDepositablePaymentMethods();
|
||||
foreach (var depositablePaymentMethod in depositablePaymentMethods)
|
||||
{
|
||||
var depositableAsset = depositablePaymentMethod.Split("-")[0];
|
||||
if (assetBalances.ContainsKey(depositableAsset))
|
||||
{
|
||||
var assetBalance = assetBalances[depositableAsset];
|
||||
assetBalance.CanDeposit = true;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
vm.AssetBalances = assetBalances;
|
||||
}
|
||||
catch (Exception e)
|
||||
{
|
||||
vm.GetAssetBalanceException = e;
|
||||
}
|
||||
|
||||
return View(vm);
|
||||
}
|
||||
|
||||
[HttpGet("/stores/{storeId}/custodian-accounts/{accountId}/edit")]
|
||||
public async Task<IActionResult> EditCustodianAccount(string storeId, string accountId)
|
||||
{
|
||||
var custodianAccount = await _custodianAccountRepository.FindById(storeId, accountId);
|
||||
if (custodianAccount == null)
|
||||
return NotFound();
|
||||
|
||||
var custodian = _custodianRegistry.GetCustodianByCode(custodianAccount.CustodianCode);
|
||||
if (custodian == null)
|
||||
{
|
||||
// TODO The custodian account is broken. The custodian is no longer available. Maybe delete the custodian account?
|
||||
return NotFound();
|
||||
}
|
||||
var configForm = await custodian.GetConfigForm(custodianAccount.GetBlob(), "en-US");
|
||||
|
||||
var vm = new EditCustodianAccountViewModel();
|
||||
vm.CustodianAccount = custodianAccount;
|
||||
vm.ConfigForm = configForm;
|
||||
return View(vm);
|
||||
}
|
||||
|
||||
[HttpPost("/stores/{storeId}/custodian-accounts/{accountId}/edit")]
|
||||
public async Task<IActionResult> EditCustodianAccount(string storeId, string accountId,
|
||||
EditCustodianAccountViewModel vm)
|
||||
{
|
||||
// The locale is not important yet, but keeping it here so we can find it easily when localization becomes a thing.
|
||||
var locale = "en-US";
|
||||
|
||||
var custodianAccount = await _custodianAccountRepository.FindById(storeId, accountId);
|
||||
if (custodianAccount == null)
|
||||
return NotFound();
|
||||
|
||||
var custodian = _custodianRegistry.GetCustodianByCode(custodianAccount.CustodianCode);
|
||||
if (custodian == null)
|
||||
{
|
||||
// TODO The custodian account is broken. The custodian is no longer available. Maybe delete the custodian account?
|
||||
return NotFound();
|
||||
}
|
||||
var configForm = await custodian.GetConfigForm(custodianAccount.GetBlob(), locale);
|
||||
|
||||
var newData = new JObject();
|
||||
foreach (var pair in Request.Form)
|
||||
{
|
||||
if ("CustodianAccount.Name".Equals(pair.Key))
|
||||
{
|
||||
custodianAccount.Name = pair.Value;
|
||||
}
|
||||
else
|
||||
{
|
||||
// TODO support posted array notation, like a field called "WithdrawToAddressNamePerPaymentMethod[BTC-OnChain]". The data should be nested in the JSON.
|
||||
newData.Add(pair.Key, pair.Value.ToString());
|
||||
}
|
||||
}
|
||||
|
||||
var newConfigData = RemoveUnusedFieldsFromConfig(custodianAccount.GetBlob(), newData, configForm);
|
||||
var newConfigForm = await custodian.GetConfigForm(newConfigData, locale);
|
||||
|
||||
if (newConfigForm.IsValid())
|
||||
{
|
||||
custodianAccount.SetBlob(newConfigData);
|
||||
custodianAccount = await _custodianAccountRepository.CreateOrUpdate(custodianAccount);
|
||||
|
||||
return RedirectToAction(nameof(ViewCustodianAccount),
|
||||
new { storeId = custodianAccount.StoreId, accountId = custodianAccount.Id });
|
||||
}
|
||||
|
||||
// Form not valid: The user must fix the errors before we can save
|
||||
vm.CustodianAccount = custodianAccount;
|
||||
vm.ConfigForm = newConfigForm;
|
||||
return View(vm);
|
||||
}
|
||||
|
||||
|
||||
[HttpGet("/stores/{storeId}/custodian-accounts/create")]
|
||||
public IActionResult CreateCustodianAccount(string storeId)
|
||||
{
|
||||
var vm = new CreateCustodianAccountViewModel();
|
||||
vm.StoreId = storeId;
|
||||
vm.SetCustodianRegistry(_custodianRegistry);
|
||||
return View(vm);
|
||||
}
|
||||
|
||||
[HttpPost("/stores/{storeId}/custodian-accounts/create")]
|
||||
public async Task<IActionResult> CreateCustodianAccount(string storeId, CreateCustodianAccountViewModel vm)
|
||||
{
|
||||
var store = GetCurrentStore();
|
||||
vm.StoreId = store.Id;
|
||||
vm.SetCustodianRegistry(_custodianRegistry);
|
||||
|
||||
var custodian = _custodianRegistry.GetCustodianByCode(vm.SelectedCustodian);
|
||||
if (custodian == null)
|
||||
{
|
||||
ModelState.AddModelError(nameof(vm.SelectedCustodian), "Invalid Custodian");
|
||||
return View(vm);
|
||||
}
|
||||
if (string.IsNullOrEmpty(vm.Name))
|
||||
{
|
||||
vm.Name = custodian.Name;
|
||||
}
|
||||
|
||||
var custodianAccountData = new CustodianAccountData { CustodianCode = vm.SelectedCustodian, StoreId = vm.StoreId, Name = custodian.Name };
|
||||
|
||||
|
||||
var configData = new JObject();
|
||||
foreach (var pair in Request.Form)
|
||||
{
|
||||
configData.Add(pair.Key, pair.Value.ToString());
|
||||
}
|
||||
|
||||
var configForm = await custodian.GetConfigForm(configData, "en-US");
|
||||
if (configForm.IsValid())
|
||||
{
|
||||
// configForm.removeUnusedKeys();
|
||||
custodianAccountData.SetBlob(configData);
|
||||
custodianAccountData = await _custodianAccountRepository.CreateOrUpdate(custodianAccountData);
|
||||
TempData[WellKnownTempData.SuccessMessage] = "Custodian account successfully created";
|
||||
CreatedCustodianAccountId = custodianAccountData.Id;
|
||||
|
||||
return RedirectToAction(nameof(ViewCustodianAccount),
|
||||
new { storeId = custodianAccountData.StoreId, accountId = custodianAccountData.Id });
|
||||
}
|
||||
|
||||
// Ask for more data
|
||||
vm.ConfigForm = configForm;
|
||||
return View(vm);
|
||||
}
|
||||
|
||||
|
||||
[HttpGet("/stores/{storeId}/custodian-accounts/{accountId}/delete")]
|
||||
public async Task<IActionResult> DeleteCustodianAccount(string storeId, string accountId)
|
||||
{
|
||||
var custodianAccount = await _custodianAccountRepository.FindById(storeId, accountId);
|
||||
if (custodianAccount == null)
|
||||
{
|
||||
return NotFound();
|
||||
}
|
||||
|
||||
var isDeleted = await _custodianAccountRepository.Remove(custodianAccount.Id, custodianAccount.StoreId);
|
||||
if (isDeleted)
|
||||
{
|
||||
TempData[WellKnownTempData.SuccessMessage] = "Custodian account deleted";
|
||||
return RedirectToAction("Dashboard", "UIStores", new { storeId });
|
||||
}
|
||||
|
||||
TempData[WellKnownTempData.ErrorMessage] = "Could not delete custodian account";
|
||||
return RedirectToAction(nameof(ViewCustodianAccount),
|
||||
new { storeId = custodianAccount.StoreId, accountId = custodianAccount.Id });
|
||||
}
|
||||
|
||||
// The JObject may contain too much data because we used ALL post values and this may be more than we needed.
|
||||
// Because we don't know the form fields beforehand, we will filter out the superfluous data afterwards.
|
||||
// We will keep all the old keys + merge the new keys as per the current form.
|
||||
// Since the form can differ by circumstances, we will never remove any keys that were previously stored. We just limit what we add.
|
||||
private JObject RemoveUnusedFieldsFromConfig(JObject storedData, JObject newData, Form form)
|
||||
{
|
||||
JObject filteredData = new JObject();
|
||||
var storedKeys = new List<string>();
|
||||
foreach (var item in storedData)
|
||||
{
|
||||
storedKeys.Add(item.Key);
|
||||
}
|
||||
|
||||
var formKeys = form.GetAllNames();
|
||||
|
||||
foreach (var item in newData)
|
||||
{
|
||||
if (storedKeys.Contains(item.Key) || formKeys.Contains(item.Key))
|
||||
{
|
||||
filteredData[item.Key] = item.Value;
|
||||
}
|
||||
}
|
||||
|
||||
return filteredData;
|
||||
}
|
||||
|
||||
private StoreData GetCurrentStore() => HttpContext.GetStoreData();
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user