Add administration methods

Author: everoddandeven

Monero.Lws.IntegrationTests/MoneroLwsServiceIntegrationTest.cs

@@ -6,7 +6,7 @@ namespace Monero.Lws.IntegrationTests;
 public class MoneroLwsServiceIntegrationTest
 {
     private static readonly string Address = TestUtils.Address;
-    private static readonly string ViewKey = TestUtils.ViewKey;
+    private static readonly string ViewKey = TestUtils.PrivateViewKey;
     private static readonly MoneroLwsService Lws = TestUtils.GetLwsService();
 
     [Fact]
@@ -26,6 +26,18 @@ public async Task TestGetVersion()
         Assert.False(response.Testnet);
     }
 
+    [Fact]
+    public async Task GetDaemonStatus()
+    {
+        var response = await Lws.GetDaemonStatus();
+        Assert.True(response.OutgoingConnectionsCount >= 0);
+        Assert.True(response.IncomingConnectionsCount >= 0);
+        Assert.True(response.Height >= 0);
+        Assert.True(response.TargetHeight >= 0);
+        Assert.False(string.IsNullOrEmpty(response.Network));
+        Assert.False(string.IsNullOrEmpty(response.State));
+    }
+    
     [Fact]
     public async Task TestLogin()
     {
@@ -179,6 +191,74 @@ public async Task TestGetSubaddrs()
             TestSubaddrsEntry(entry);
         }
     }
+
+    [Fact]
+    public async Task TestRescan()
+    {
+        var response = await Lws.Rescan(0, [Address]);
+        Assert.NotEmpty(response.UpdatedAddresses);
+        Assert.Single(response.UpdatedAddresses);
+        Assert.Equal(Address, response.UpdatedAddresses.First());
+    }
+
+    [Fact]
+    public async Task TestValidate()
+    {
+        var response = await Lws.Validate(TestUtils.PublicViewKey, TestUtils.PublicSpendKey, TestUtils.PrivateViewKey);
+
+        if (response.Error != null)
+        {
+            Assert.Fail($"{response.Error.Field}: {response.Error.Details}");
+        }
+        
+        Assert.False(string.IsNullOrEmpty(response.Address));
+        Assert.Equal(TestUtils.Address, response.Address);
+    }
+
+    [Fact]
+    public async Task TestAddAccount()
+    {
+        var address = "43a1cERdj8rT1513tmMUY5MBcWbt1hgSo2fgLhoRrkYTPXejjRjU9y2WCjYfdZMLfZ6LKVc7YRGJMdtxD3x9Dtjc6fFjH9q";
+        var viewKey = "4f8d491198f5219b80a03ae2be337b37ace5a4626c67e80a68beb7d0e3eaaa08";
+        var response = await Lws.AddAccount(address, viewKey);
+        Assert.NotEmpty(response.UpdatedAddresses);
+        Assert.Single(response.UpdatedAddresses);
+        Assert.Equal(address, response.UpdatedAddresses.First());
+    }
+
+    [Fact]
+    public async Task TestModifyAccountStatus()
+    {
+        // deactivate account
+        var response = await Lws.ModifyAccountStatus("inactive", [TestUtils.Address]);
+        Assert.NotEmpty(response.UpdatedAddresses);
+        Assert.Single(response.UpdatedAddresses);
+        Assert.Equal(TestUtils.Address, response.UpdatedAddresses.First());
+        // wait for lws to catch up
+        Thread.Sleep(5000);
+        // reactivate account
+        response = await Lws.ModifyAccountStatus("active", [TestUtils.Address]);
+        Assert.NotEmpty(response.UpdatedAddresses);
+        Assert.Single(response.UpdatedAddresses);
+        Assert.Equal(TestUtils.Address, response.UpdatedAddresses.First());
+    }
+    
+    [Fact]
+    public async Task TestListAccounts()
+    {
+        var response = await Lws.ListAccounts();
+        TestAccounts(response.Active);
+        TestAccounts(response.Inactive);
+        TestAccounts(response.Hidden);
+    }
+
+    [Fact]
+    public async Task TestListRequests()
+    {
+        var response = await Lws.ListRequests();
+        TestAccounts(response.Create, true);
+        TestAccounts(response.Import, true);
+    }
 
     private static void TestTransaction(MoneroLwsTransaction? tx)
     {
@@ -355,4 +435,31 @@ private static void TestAddressMeta(MoneroLwsAddressMeta? addressMeta)
         Assert.True(addressMeta.MinIndex >= 0);
     }
 
+    private static void TestAccount(MoneroLwsAccount? account, bool request)
+    {
+        Assert.NotNull(account);
+        Assert.False(string.IsNullOrEmpty(account.Address));
+        if (request)
+        {
+            Assert.True(account.StartHeight >= 0);
+            return;
+        }
+        
+        Assert.True(account.ScanHeight >= 0);
+        Assert.True(account.AccessTime >= 0);
+    }
+
+    private static void TestAccounts(List<MoneroLwsAccount>? accounts, bool request)
+    {
+        Assert.NotNull(accounts);
+        foreach (var account in accounts)
+        {
+            TestAccount(account, request);
+        }
+    }
+    
+    private static void TestAccounts(List<MoneroLwsAccount>? accounts)
+    {
+        TestAccounts(accounts, false);
+    }
 }

Monero.Lws.IntegrationTests/Utils/TestUtils.cs

@@ -7,7 +7,9 @@ internal static class TestUtils
     public const string Username = "";
     public const string Password = "";
     public const string Address = "42EhKmBx6pAPYhX4QCHKBPRw8dgc3VVVdA7g2dxr5wz21crqvPUkwPTde64Xac5uawQeFbh6K7PD4YLqiX1VTP5jUH7gZez";
-    public const string ViewKey = "41f55a92b942681e35bf7bb64f71142729039bd8e606a4f4218c543065c15c05";
+    public const string PublicViewKey = "b244f89be70e16db0d8905628480708d590ffd4e820303bb61c96cf2395bfaf1";
+    public const string PublicSpendKey = "1030f7c992ec9b86cc0055d2c44632951104e67b05d28c367ecd8382c0931303";
+    public const string PrivateViewKey = "41f55a92b942681e35bf7bb64f71142729039bd8e606a4f4218c543065c15c05";
 
     private static MoneroLwsService? _lwsService = null;
 

Monero.Lws/Common/MoneroLwsAccount.cs

@@ -0,0 +1,27 @@
+using System.Text.Json.Serialization;
+
+namespace Monero.Lws.Common;
+
+public class MoneroLwsAccount
+{
+    /// <summary>
+    /// Account primary address.
+    /// </summary>
+    [JsonPropertyName("address")] public string Address { get; set; } = "";
+
+    /// <summary>
+    /// Account scan height.
+    /// </summary>
+    [JsonPropertyName("scan_height")] public long ScanHeight { get; set; } = 0;
+
+    /// <summary>
+    /// Account start height.
+    /// </summary>
+    [JsonPropertyName("start_height")] public long StartHeight { get; set; } = 0;
+    
+    /// <summary>
+    /// Account last access time.
+    /// </summary>
+    [JsonPropertyName("access_time")] public long AccessTime { get; set; } = 0;
+
+}

Monero.Lws/Common/MoneroLwsDaemonStatus.cs

@@ -0,0 +1,36 @@
+using System.Text.Json.Serialization;
+
+namespace Monero.Lws.Common;
+
+public class MoneroLwsDaemonStatus
+{
+    /// <summary>
+    /// Outgoing connections from daemon.
+    /// </summary>
+    [JsonPropertyName("outgoing_connections_count")] public long OutgoingConnectionsCount { get; set; } = 0;
+    
+    /// <summary>
+    /// Incoming connections to daemon.
+    /// </summary>
+    [JsonPropertyName("incoming_connections_count")] public long IncomingConnectionsCount { get; set; } = 0;
+
+    /// <summary>
+    /// Daemon height.
+    /// </summary>
+    [JsonPropertyName("height")] public long Height { get; set; } = 0;
+
+    /// <summary>
+    /// Target height.
+    /// </summary>
+    [JsonPropertyName("target_height")] public long TargetHeight { get; set; } = 0;
+
+    /// <summary>
+    /// Network type.
+    /// </summary>
+    [JsonPropertyName("network")] public string Network { get; set; } = "";
+
+    /// <summary>
+    /// Daemon status.
+    /// </summary>
+    [JsonPropertyName("state")] public string State { get; set; } = "";
+}

Monero.Lws/MoneroLwsService.cs

@@ -106,7 +106,16 @@ public void SetCredentials(string username, string password)
         _username = username;
         _password = password;
     }
-
+    
+    /// <summary>
+    /// Get LWS server version.
+    /// </summary>
+    /// <returns></returns>
+    public async Task<MoneroLwsDaemonStatus> GetDaemonStatus()
+    {
+        return await SendCommandAsync<MoneroLwsDaemonStatus>("daemon_status");
+    }
+    
     /// <summary>
     /// Get LWS server version.
     /// </summary>
@@ -322,4 +331,153 @@ public async Task<MoneroLwsSubaddrs> ProvisionSubaddrs(string address, string vi
 
         return await SendCommandAsync<MoneroLwsProvisionSubaddrsRequest, MoneroLwsSubaddrs>("provision_subaddrs", req);
     }
+    
+    #region Administration
+
+    /// <summary>
+    /// Accepts create or import requests in the incoming queue.
+    /// </summary>
+    /// <param name="type"><c>create</c> or <c>import</c>.</param>
+    /// <param name="addresses">Account addresses to accept.</param>
+    /// <returns></returns>
+    public async Task<MoneroLwsUpdateResponse> AcceptRequests(string type, List<string> addresses)
+    {
+        var req = new MoneroLwsAdminRequest
+        {
+            Params = new MoneroLwsAdminParams
+            {
+                RequestType = type,
+                Addresses = addresses
+            }
+        };
+
+        return await SendCommandAsync<MoneroLwsAdminRequest, MoneroLwsUpdateResponse>("accept_requests", req);
+    }
+    
+    /// <summary>
+    /// Reject account creation or import from the incoming queue.
+    /// </summary>
+    /// <param name="type"><c>create</c> or <c>import</c>.</param>
+    /// <param name="addresses">Account addresses to reject.</param>
+    /// <returns></returns>
+    public async Task<MoneroLwsUpdateResponse> RejectRequests(string type, List<string> addresses)
+    {
+        var req = new MoneroLwsAdminRequest
+        {
+            Params = new MoneroLwsAdminParams
+            {
+                RequestType = type,
+                Addresses = addresses
+            }
+        };
+
+        return await SendCommandAsync<MoneroLwsAdminRequest, MoneroLwsUpdateResponse>("reject_requests", req);
+    }
+    
+    /// <summary>
+    /// Add account for view-key scanning.
+    /// </summary>
+    /// <param name="address">Account primary address.</param>
+    /// <param name="viewKey">Account private view key.</param>
+    /// <returns></returns>
+    public async Task<MoneroLwsUpdateResponse> AddAccount(string address, string viewKey)
+    {
+        var req = new MoneroLwsAdminRequest
+        {
+            Params = new MoneroLwsAdminParams
+            {
+                Address = address,
+                Key = viewKey
+            }
+        };
+        
+        return await SendCommandAsync<MoneroLwsAdminRequest, MoneroLwsUpdateResponse>("add_account", req);
+    }
+
+    /// <summary>
+    /// Change an account status to <c>active</c>, <c>inactive</c> or <c>hidden</c>.
+    /// The <c>active</c> state is the normal state: the account is being scanned and returned by the API.
+    /// The <c>inactive</c> state is still returned by the API, but is no longer being scanned.
+    /// The <c>hidden</c> is the current way to <i>delete</i> an account: it is not scanned nor returned by the API.
+    /// Accounts cannot currently be deleted due to internal DB requirements.
+    /// </summary>
+    /// <param name="status">Account status to apply (<c>active</c>, <c>inactive</c> or <c>hidden</c>).</param>
+    /// <param name="addresses">Account addresses.</param>
+    /// <returns></returns>
+    public async Task<MoneroLwsUpdateResponse> ModifyAccountStatus(string status, List<string> addresses)
+    {
+        var req = new MoneroLwsAdminRequest
+        {
+            Params = new MoneroLwsAdminParams
+            {
+                Addresses = addresses,
+                Status = status
+            }
+        };
+        
+        return await SendCommandAsync<MoneroLwsAdminRequest, MoneroLwsUpdateResponse>("modify_account_status", req);
+    }
+
+    /// <summary>
+    /// Request a listing of all active accounts in the database.
+    /// </summary>
+    /// <returns></returns>
+    public async Task<MoneroLwsListAccountsResponse> ListAccounts()
+    {
+        return await SendCommandAsync<MoneroLwsListAccountsResponse>("list_accounts");
+    }
+    
+    /// <summary>
+    /// Return the listing of all pending new account requests and all requests to import from genesis block requests.
+    /// </summary>
+    /// <returns></returns>
+    public async Task<MoneroLwsListRequestsResponse> ListRequests()
+    {
+        return await SendCommandAsync<MoneroLwsListRequestsResponse>("list_requests");
+    }
+
+    /// <summary>
+    /// Rescan specific account(s) from the specified height.
+    /// </summary>
+    /// <param name="height">Blockchain height.</param>
+    /// <param name="addresses">Addresses to rescan.</param>
+    /// <returns></returns>
+    public async Task<MoneroLwsUpdateResponse> Rescan(long height, List<string> addresses)
+    {
+        var req = new MoneroLwsAdminRequest
+        {
+            Params = new MoneroLwsAdminParams
+            {
+                Addresses = addresses,
+                Height = height
+            }
+        };
+        
+        return await SendCommandAsync<MoneroLwsAdminRequest, MoneroLwsUpdateResponse>("rescan", req);
+    }
+
+    /// <summary>
+    /// Validate account keys.
+    /// </summary>
+    /// <param name="viewPublicHex">Account view public key as hex.</param>
+    /// <param name="spendPublicHex">Account spend public key as hex.</param>
+    /// <param name="viewKeyHex">Account private view key as hex.</param>
+    /// <returns></returns>
+    public async Task<MoneroLwsValidateResponse> Validate(string viewPublicHex, string spendPublicHex,
+        string viewKeyHex)
+    {
+        var req = new MoneroLwsAdminRequest
+        {
+            Params = new MoneroLwsAdminParams
+            {
+                ViewPublicHex = viewPublicHex,
+                SpendPublicHex = spendPublicHex,
+                ViewKeyHex = viewKeyHex
+            }
+        };
+        
+        return await SendCommandAsync<MoneroLwsAdminRequest, MoneroLwsValidateResponse>("validate", req);
+    }
+
+    #endregion
 }