Multi-application support (#27)

* Added `XummSdk` class to support multiple Xumm Applications in one .NET application

* File-scoped namespaces

* Updated XML documentation

* Implemented the `XummSdk` in XUMM.NET.WebApp

* Added error message to the alert box

* Added `XummSdk` blazor component for the Xumm API credentials

* Implemented `XummSdk` in XUMM.NET.ServerApp and marked `ResponseAlertBox` and `XummSdkCredentials` as nullable to suppress CS8625

* Updated Readme

* Updated gitignore

Author: DominiqueBlomsma

.gitignore

@@ -140,6 +140,7 @@ _TeamCity*
 # Visual Studio code coverage results
 *.coverage
 *.coveragexml
+*.lutconfig
 
 # NCrunch
 _NCrunch_*

README.md

@@ -46,13 +46,25 @@ More information about the XUMM API, payloads, the API workflow, sending Push no
 - https://xumm.readme.io/docs
 
 
+### Multiple Xumm Applications support
+You can create an instance of `XummSdk` if your .NET application has to connect to multiple Xumm Applications.
+The `XummSdk` class contains client properties instead of using the clients by dependency injection.
+* **IXummMiscAppStorageClient**: `XummSdk.AppStorage`
+* **IXummMiscClient**: `XummSdk.Miscellaneous`
+* **IXummPayloadClient**: `XummSdk.Payload`
+
+```C#
+var xummSdk = new XummSdk("00000000-0000-0000-000-000000000000", "00000000-0000-0000-000-000000000000");
+var pong = await xummSdk.Miscellaneous.GetPingAsync();
+```
+
 ##### IXummMiscClient.GetPingAsync()
 
 The `GetPingAsync()` method allows you to verify API access (valid credentials) and returns some info on your XUMM APP:
 
 ```C#
-@inject IXummMiscClient _miscClient
-var pong = await _miscClient.GetPingAsync();
+@inject IXummMiscClient MiscClient
+var pong = await MiscClient.GetPingAsync();
 ```
 
 Returns: [`XummPong`](https://github.com/XRPL-Labs/XUMM.NET.SDK/blob/main/XUMM.Net/Models/Misc/XummPong.cs)
@@ -95,8 +107,8 @@ Alternatively, KYC status can be retrieved for an XPRL account address: the addr
 XUMM when the session KYC was initiated by.
 
 ```C#
-@inject IXummMiscClient _miscClient
-var kycStatus = await _miscClient.GetKycStatusAsync("rBLomsmaSJ1ttBmS3WPmPpWLAUDKFwiF9Q");
+@inject IXummMiscClient MiscClient
+var kycStatus = await MiscClient.GetKycStatusAsync("rBLomsmaSJ1ttBmS3WPmPpWLAUDKFwiF9Q");
 ```
 
 Returns: [`XummKycStatus`](https://github.com/XRPL-Labs/XUMM.NET.SDK/blob/main/XUMM.Net/Enums/XummKycStatus.cs)
@@ -117,8 +129,8 @@ live from the XRP ledger, as fetched for you by the XUMM backend.
 [![npm version](https://badge.fury.io/js/xrpl-txdata.svg)](https://www.npmjs.com/xrpl-txdata)
 
 ```C#
-@inject IXummMiscClient _miscClient
-var txInfo = await _miscClient.GetTransactionAsync("00000000-0000-0000-0000-000000000000");
+@inject IXummMiscClient MiscClient
+var txInfo = await MiscClient.GetTransactionAsync("00000000-0000-0000-0000-000000000000");
 ```
 
 Returns: [`XummTransaction`](https://github.com/XRPL-Labs/XUMM.NET.SDK/blob/main/XUMM.Net/Models/Misc/XummTransaction.cs)
@@ -132,21 +144,21 @@ Your XUMM APP storage is stored at the XUMM API backend, meaning it persists unt
 This data is private, and accessible only with your own API credentials. This private JSON data can be used to store credentials / config / bootstrap info / ... for your headless application (eg. POS device).
 
 ```C#
-@inject IXummMiscAppStorageClient _miscAppStorageClient
+@inject IXummMiscAppStorageClient MiscAppStorageClient
 
-var storageSet = await _miscAppStorageClient.StoreAsync({name: 'Dominique', age: 32, male: true});
+var storageSet = await MiscAppStorageClient.StoreAsync({name: 'Dominique', age: 32, male: true});
 Console.WriteLine(storageSet.Stored)
 // true
 
-var storageGet = await _miscAppStorageClient.GetAsync()
+var storageGet = await MiscAppStorageClient.GetAsync()
 Console.WriteLine(storageGet.Data)
 // { name: 'Dominique', age: 32, male: true }
 
-var storageDelete = await _miscAppStorageClient.ClearAsync()
+var storageDelete = await MiscAppStorageClient.ClearAsync()
 Console.WriteLine(storageSet.Stored)
 // true
 
-var storageGetAfterDelete = await _miscAppStorageClient.GetAsync()
+var storageGetAfterDelete = await MiscAppStorageClient.GetAsync()
 Console.WriteLine(storageGetAfterDelete.Data)
 // null
 ```
@@ -191,23 +203,23 @@ Note! Please don't use _polling_! The XUMM API offers Webhooks (configure your W
 You can `GetAsync()` a payload by:
 - Payload UUID  
   ```C#
-  @inject IXummPayloadClient _payloadClient
-  var payload = await _payloadClient.GetAsync("00000000-0000-0000-0000-000000000000");
+  @inject IXummPayloadClient PayloadClient
+  var payload = await PayloadClient.GetAsync("00000000-0000-0000-0000-000000000000");
   ```
 
 - Passing a created Payload object (see: [IXummPayloadClient.CreateAsync](#IXummPayloadClient.CreateAsync))  
   ```C#
-  @inject IXummPayloadClient _payloadClient
+  @inject IXummPayloadClient PayloadClient
   var newPayload = new XummPostJsonPayload("{...}");
-  var created = await _payloadClient.CreateAsync(newPayload);
-  var payload = await _payloadClient.GetAsync(created);
+  var created = await PayloadClient.CreateAsync(newPayload);
+  var payload = await PayloadClient.GetAsync(created);
   ```
 
 If a payload can't be fetched (eg. doesn't exist), `null` will be returned, unless a second param (boolean) is provided to get the SDK to throw an exception in case a payload can't be retrieved:
 
 ```C#
-@inject IXummPayloadClient _payloadClient
-var payload = await _payloadClient.GetAsync("00000000-0000-0000-0000-000000000000", true);
+@inject IXummPayloadClient PayloadClient
+var payload = await PayloadClient.GetAsync("00000000-0000-0000-0000-000000000000", true);
 ```
 
 

examples/XUMM.NET.ServerApp/Pages/Misc/AccountMeta.razor

@@ -1,11 +1,9 @@
 @page "/account-meta"
-@using XUMM.NET.SDK.Clients.Interfaces
 @using XUMM.NET.SDK.Extensions
 @using XUMM.NET.SDK.Models.Misc
-@using XUMM.NET.ServerApp.Extensions
 
 @inject IOptions<XrplConfig> Config
-@inject IXummMiscClient _miscClient
+@inject IXummMiscClient MiscClient
 
 <PageTitle>Account Meta</PageTitle>
 
@@ -99,7 +97,7 @@
     </div>
 </div>
 @code {
-    private ResponseAlertBox _responseAlertBox = default!;
+    private ResponseAlertBox? _responseAlertBox;
     private string _account = default!;
     private XummAccountMetaResponse? _accountMeta;
 
@@ -110,7 +108,7 @@
             _account = Config.Value.Account;
         }
 
-        _accountMeta = await _responseAlertBox.GetResponseAndSetAlertAsync(() => _miscClient.AccountMetaAsync(_account));
+        _accountMeta = await _responseAlertBox!.GetResponseAndSetAlertAsync(() => MiscClient.AccountMetaAsync(_account));
         _responseAlertBox.SetAlert("Account Meta", _accountMeta != null);
     }
 }

examples/XUMM.NET.ServerApp/Pages/Misc/UserTokens.razor

@@ -1,9 +1,8 @@
 @page "/user-tokens"
-@using XUMM.NET.SDK.Clients.Interfaces
 @using XUMM.NET.SDK.Models.Misc
 @using System.Text.RegularExpressions
 
-@inject IXummMiscClient _miscClient
+@inject IXummMiscClient MiscClient
 
 <PageTitle>User Tokens</PageTitle>
 
@@ -51,7 +50,7 @@
 }
 
 @code {
-    private ResponseAlertBox _responseAlertBox = default!;
+    private ResponseAlertBox? _responseAlertBox;
     private string _userTokens = default!;
     private XummUserTokens? _xummUserTokens;
 
@@ -70,11 +69,11 @@
 
         if (userTokens.Length == 1)
         {
-            _xummUserTokens = await _responseAlertBox.GetResponseAndSetAlertAsync(() => _miscClient.VerifyUserTokenAsync(userTokens[0]));
+            _xummUserTokens = await _responseAlertBox!.GetResponseAndSetAlertAsync(() => MiscClient.VerifyUserTokenAsync(userTokens[0]));
         }
         else
         {
-            _xummUserTokens = await _responseAlertBox.GetResponseAndSetAlertAsync(() => _miscClient.VerifyUserTokensAsync(userTokens));
+            _xummUserTokens = await _responseAlertBox!.GetResponseAndSetAlertAsync(() => MiscClient.VerifyUserTokensAsync(userTokens));
         }
 
         _responseAlertBox.SetAlert("User Token validity", _xummUserTokens != null);

examples/XUMM.NET.ServerApp/Pages/Payload/Details.razor

@@ -1,11 +1,8 @@
 @page "/payload-details"
-@using XUMM.NET.SDK.Clients.Interfaces
 @using XUMM.NET.SDK.Models.Payload
 @using XUMM.NET.ServerApp.Extensions
 @using System.Text.Json
 
-@inject IXummPayloadClient _payloadClient
-
 <PageTitle>Payload Details</PageTitle>
 
 <ResponseAlertBox @ref="_responseAlertBox"></ResponseAlertBox>
@@ -14,13 +11,15 @@
 <div>Fetch payload details by providing the UUID or Custom Identifier.</div>
 
 <div class="row">
+    <XummSdkCredentials @ref="_xummSdkCredentials"></XummSdkCredentials>
+
     <div class="mb-3">
         <label for="payloadUuid" class="form-label">Payload UUID</label>
         <input id="payloadUuid" type="text" class="form-control" placeholder="Payload UUID" aria-label="Payload UUID" aria-describedby="basic-addon2" @bind="_payloadUuid">
     </div>
     <div class="mb-3">
         <label for="customIdentifier" class="form-label">Custom Identifier</label>
-        <input id="customIdentifier" type="text" class="form-control" placeholder="Custom Identifier" aria-label="Custom Identifier" aria-describedby="basic-addon2" @bind="_customIdentifier">
+        <input id="customIdentifier" type="text" class="form-control" placeholder="Custom Identifier" maxlength="40" aria-label="Custom Identifier" aria-describedby="basic-addon2" @bind="_customIdentifier">
     </div>
     <div class="btn-group mb-3" role="group">
         <button class="btn btn-primary" type="button" @onclick="GetPayloadAsync">Fetch details</button>
@@ -40,7 +39,8 @@
 }
 
 @code {
-    private ResponseAlertBox _responseAlertBox = default!;
+    private ResponseAlertBox? _responseAlertBox;
+    private XummSdkCredentials? _xummSdkCredentials;
     private string? _payloadUuid;
     private string? _customIdentifier;
     private XummPayloadDetails? _payloadDetails;
@@ -49,13 +49,13 @@
     {
         if (!string.IsNullOrWhiteSpace(_payloadUuid))
         {
-            _payloadDetails = await _responseAlertBox.GetResponseAndSetAlertAsync(() => _payloadClient.GetAsync(_payloadUuid));
+            _payloadDetails = await _responseAlertBox!.GetResponseAndSetAlertAsync(() => _xummSdkCredentials!.Payload.GetAsync(_payloadUuid));
         }
         else if (!string.IsNullOrWhiteSpace(_customIdentifier))
         {
-            _payloadDetails = await _responseAlertBox.GetResponseAndSetAlertAsync(() => _payloadClient.GetByCustomIdentifierAsync(_customIdentifier));
+            _payloadDetails = await _responseAlertBox!.GetResponseAndSetAlertAsync(() => _xummSdkCredentials!.Payload.GetByCustomIdentifierAsync(_customIdentifier));
         }
 
-        _responseAlertBox.SetAlert("Payload Details", _payloadDetails != null);
+        _responseAlertBox!.SetAlert("Payload Details", _payloadDetails != null);
     }
 }

examples/XUMM.NET.ServerApp/Pages/XummSdkCredentials.razor

@@ -0,0 +1,50 @@
+@using XUMM.NET.SDK
+@using XUMM.NET.SDK.Clients.Interfaces
+
+@inject IXummMiscClient MiscClient;
+@inject IXummMiscAppStorageClient MiscAppStorageClient;
+@inject IXummPayloadClient PayloadClient;
+
+<div class="mb-3">
+    <label for="apikey" class="form-label">API Key <small>(Optional)</small></label>
+    <input id="apikey" type="password" class="form-control @_cssClass" placeholder="API Key" aria-label="API Key" aria-describedby="basic-addon2" @bind="_apiKey">
+    <small id="apikeyhelp" class="form-text text-muted">Leave empty to use the configured API Key.</small>
+</div>
+<div class="mb-3">
+    <label for="apisecret" class="form-label">API Secret <small>(Optional)</small></label>
+    <input id="apisecret" type="password" min="0" class="form-control @_cssClass" placeholder="API Secret" aria-label="API Secret" aria-describedby="basic-addon2" @bind="_apiSecret">
+    <small id="apisecrethelp" class="form-text text-muted">Leave empty to use the configured API Secret.</small>
+</div>
+
+@code {
+    private string? _apiKey;
+    private string? _apiSecret;
+    private string? _cssClass;
+
+    private XummSdk? GetXummSdk()
+    {
+        if (string.IsNullOrWhiteSpace(_apiKey) || string.IsNullOrWhiteSpace(_apiSecret))
+        {
+            return null;
+        }
+
+        XummSdk? xummSdk = null;
+
+        try
+        {
+            xummSdk = new XummSdk(_apiKey, _apiSecret);
+            _cssClass = null;
+        }
+        catch
+        {
+            _cssClass = "invalid";
+        }
+
+        StateHasChanged();
+        return xummSdk;
+    }
+
+    public IXummMiscAppStorageClient AppStorage => GetXummSdk()?.AppStorage ?? MiscAppStorageClient;
+    public IXummMiscClient Miscellaneous => GetXummSdk()?.Miscellaneous ?? MiscClient;
+    public IXummPayloadClient Payload => GetXummSdk()?.Payload ?? PayloadClient;
+}

examples/XUMM.NET.WebApp/Pages/PingPong.cshtml

@@ -7,15 +7,34 @@
 
 <h1>@ViewData["Title"]</h1>
 
-@if (Model.Pong.Pong)
+@if (Model.Pong != null)
 {
     <div class="alert alert-success" role="alert">
-        <h4 class="alert-heading">Retrieved Pong!</h4>
+        <h4 class="alert-heading">Retrieved pong of @Model.Pong.Auth.Application.Name</h4>
     </div>
 }
-else
+else if (!string.IsNullOrWhiteSpace(Model.ErrorMessage))
 {
     <div class="alert alert-danger" role="alert">
         <h4 class="alert-heading">Failed to retrieve Pong!</h4>
+        <div>@Model.ErrorMessage</div>
     </div>
-}
+}
+
+<form method="post">
+    <div class="col-md-6">
+        <div class="mb-3">
+            <label for="apikey" class="form-label">API Key <small>(Optional)</small></label>
+            <input id="apikey" type="password" class="form-control" placeholder="API Key" aria-label="API Key" aria-describedby="basic-addon2" asp-for="ApiKey">
+            <small id="apikeyhelp" class="form-text text-muted">Leave empty to use the configured API Key.</small>
+        </div>
+        <div class="mb-3">
+            <label for="apisecret" class="form-label">API Secret <small>(Optional)</small></label>
+            <input id="apisecret" type="password" min="0" class="form-control" placeholder="API Secret" aria-label="API Secret" aria-describedby="basic-addon2" asp-for="ApiSecret">
+            <small id="apisecrethelp" class="form-text text-muted">Leave empty to use the configured API Secret.</small>
+        </div>
+        <div class="btn-group mb-3" role="group">
+            <button type="submit" class="btn btn-primary">Ping</button>
+        </div>
+    </div>
+</form>

examples/XUMM.NET.WebApp/Pages/PingPong.cshtml.cs

@@ -1,5 +1,8 @@
-using System.Threading.Tasks;
+using Microsoft.AspNetCore.Mvc;
 using Microsoft.AspNetCore.Mvc.RazorPages;
+using System;
+using System.Threading.Tasks;
+using XUMM.NET.SDK;
 using XUMM.NET.SDK.Clients.Interfaces;
 using XUMM.NET.SDK.Models.Misc;
 
@@ -9,16 +12,33 @@ public class PingPongModel : PageModel
     {
         public XummPong Pong { get; set; }
 
+        [BindProperty]
+        public string ApiKey { get; set; }
+
+        [BindProperty]
+        public string ApiSecret { get; set; }
+
+        public string? ErrorMessage { get; set; }
+
         private readonly IXummMiscClient _miscClient;
 
         public PingPongModel(IXummMiscClient miscClient)
         {
             _miscClient = miscClient;
         }
 
-        public async Task OnGetAsync()
+        public async Task OnPostAsync()
         {
-            Pong = await _miscClient.GetPingAsync();
+            try
+            {
+                var client = !string.IsNullOrWhiteSpace(ApiKey) && !string.IsNullOrWhiteSpace(ApiSecret) ? new XummSdk(ApiKey, ApiSecret).Miscellaneous : _miscClient;
+                Pong = await client.GetPingAsync();
+                ErrorMessage = null;
+            }
+            catch (Exception ex)
+            {
+                ErrorMessage = ex.Message;
+            }
         }
     }
 }

examples/XUMM.Net.ServerApp/Pages/Misc/Avatar.razor

@@ -1,9 +1,8 @@
 @page "/avatar"
-@using XUMM.NET.SDK.Clients.Interfaces
 @using XUMM.NET.SDK.Extensions
 
 @inject IOptions<XrplConfig> Config
-@inject IXummMiscClient _miscClient
+@inject IXummMiscClient MiscClient
 
 <PageTitle>Avatar</PageTitle>
 
@@ -66,6 +65,6 @@
             _padding = 0;
         }
 
-        _avatarUrl = _miscClient.GetAvatarUrl(_account, _dimensions, _padding);
+        _avatarUrl = MiscClient.GetAvatarUrl(_account, _dimensions, _padding);
     }
 }