Data model for freezing UTXOs

docker/docker-compose.yml

@@ -3,7 +3,7 @@ version: '3.4'
 services:
   nodeguard_postgres:
     container_name: nodeguard_postgres
-    image: postgres:13
+    image: postgres:16
     restart: always
     environment:
       POSTGRES_DB: nodeguard
@@ -29,7 +29,7 @@ services:
       NBXPLORER_SIGNALFILESDIR: /datadir
       #Keeping dbtrie for dev until it is fully removed since we would need to modify nbxplorer docker image to wait for the db to be ready
       NBXPLORER_DBTRIE: 1
-      # NBXPLORER_POSTGRES: Host=nodeguard_postgres;Port=5432;Database=nbxplorer;Username=rw_dev;Password=rw_dev
+#      NBXPLORER_POSTGRES: Host=nbxplorer_postgres;Port=5432;Database=nbxplorer;Username=rw_dev;Password=rw_dev
       NBXPLORER_CHAINS: "btc"
       NBXPLORER_BTCRPCUSER: "polaruser"
       NBXPLORER_BTCRPCPASSWORD: "polarpass"
@@ -38,11 +38,26 @@ services:
     command: ["--noauth"]
     volumes:
     - "bitcoin_datadir:/root/.bitcoin"
+
+  nbxplorer_postgres:
+    container_name: nbxplorer_postgres
+    image: postgres:16
+    restart: always
+    environment:
+      POSTGRES_DB: nbxplorer
+      POSTGRES_USER: rw_dev
+      POSTGRES_PASSWORD: rw_dev
+      TZ: Europe/Madrid
+    volumes:
+      - nbxplorer_postgres_data:/var/lib/postgresql/data
+    ports:
+      - 35432:5432
 
 
 
 volumes:
     nodeguard_postgres_data:
     bitcoin_datadir:
     nbxplorer_datadir:
+    nbxplorer_postgres_data:
     nodeguard_data_keys_dir:

src/Data/ApplicationDbContext.cs

@@ -107,6 +107,8 @@ protected override void OnModelCreating(ModelBuilder modelBuilder)
         public DbSet<InternalWallet> InternalWallets { get; set; }
 
         public DbSet<FMUTXO> FMUTXOs { get; set; }
+
+        public DbSet<UTXOTag> UTXOTags { get; set; }
 
         public DbSet<LiquidityRule> LiquidityRules { get; set; }
 

src/Data/Models/FMUTXO.cs

@@ -32,8 +32,11 @@ public class FMUTXO : Entity, IEquatable<FMUTXO>
 
         #region Relationships
 
+        // M-N Because if the UTXO is used in a request that gets cancelled,
+        // the UTXO should be unlocked and assigned to another request
         public List<ChannelOperationRequest> ChannelOperationRequests { get; set; }
 
+        // Idem as ChannelOperationRequests
         public List<WalletWithdrawalRequest> WalletWithdrawalRequests { get; set; }
 
         #endregion Relationships

src/Data/Models/UTXOTag.cs

@@ -0,0 +1,11 @@
+namespace NodeGuard.Data.Models;
+
+public class UTXOTag : Entity
+{
+    public string Key { get; set; }
+
+    public string Value { get; set; }
+
+    // Outpoint of the UTXO in format "hash-index"
+    public string Outpoint { get; set; }
+}

src/Data/Repositories/FUTXORepository.cs

@@ -17,7 +17,7 @@
  *
  */
 
-using NodeGuard.Data.Models;
+using NodeGuard.Data.Models;
 using NodeGuard.Data.Repositories.Interfaces;
 using Microsoft.EntityFrameworkCore;
 

src/Data/Repositories/Interfaces/IFMUTXORepository.cs

@@ -17,7 +17,7 @@
  *
  */
 
-using NodeGuard.Data.Models;
+using NodeGuard.Data.Models;
 
 namespace NodeGuard.Data.Repositories.Interfaces;
 

src/Data/Repositories/Interfaces/IRepository.cs

@@ -49,7 +49,7 @@
         /// </summary>
         /// <param name="T"></param>
         /// <returns>A tuple (bool, string). The bool represents the call success and the string any possible message.</returns>
-        public Task<(bool, string?)> AddRangeAsync(List<T> T, ApplicationDbContext applicationDbContext);
+        public Task<(bool, string?)> AddRangeAsync<T>(List<T> entities, ApplicationDbContext applicationDbContext) where T : class;
 
         /// <summary>
         ///Removes an existing entity of <see cref="IRepository{T}"></see>

src/Data/Repositories/Interfaces/IUTXOTagRepository.cs

@@ -0,0 +1,22 @@
+using NodeGuard.Data.Models;
+
+namespace NodeGuard.Data.Repositories.Interfaces;
+
+public interface IUTXOTagRepository
+{
+    Task<UTXOTag?> GetByOutpoint(string outpoint);
+
+    Task<UTXOTag?> GetByKeyAndOutpoint(string key, string outpoint);
+
+    Task<List<UTXOTag>> GetByKeyValue(string key, string value);
+
+    Task<(bool, string?)> AddAsync(UTXOTag type);
+
+    Task<(bool, string?)> AddRangeAsync(List<UTXOTag> type);
+
+    (bool, string?) Remove(UTXOTag type);
+
+    (bool, string?) RemoveRange(List<UTXOTag> types);
+
+    (bool, string?) Update(UTXOTag type);
+}

src/Data/Repositories/Repository.cs

@@ -65,19 +65,20 @@
             return (rowsChanged, null);
         }
 
-        public async Task<(bool, string?)> AddRangeAsync(List<T> T, ApplicationDbContext applicationDbContext)
+        public async Task<(bool, string?)> AddRangeAsync<T>(List<T> entities, ApplicationDbContext applicationDbContext) where T : class
         {
-            if (T == null) throw new ArgumentNullException(nameof(T));
+            if (entities == null) throw new ArgumentNullException(nameof(entities));
 
             var rowsChanged = false;
             try
             {
-                await applicationDbContext.AddRangeAsync(T);
+                await applicationDbContext.AddRangeAsync(entities);
                 rowsChanged = await applicationDbContext.SaveChangesAsync() > 0;
             }
             catch (Exception e)
             {
                 _logger.LogError(e, "Error on repository");
+                return (false, e.Message);
             }
 
             return (rowsChanged, null);

src/Data/Repositories/UTXOTagRepository.cs

@@ -0,0 +1,82 @@
+using Microsoft.EntityFrameworkCore;
+using NodeGuard.Data.Models;
+using NodeGuard.Data.Repositories.Interfaces;
+
+namespace NodeGuard.Data.Repositories;
+
+public class UTXOTagRepository : IUTXOTagRepository
+{
+    private readonly IRepository<UTXOTag> _repository;
+    private readonly ILogger<UTXOTagRepository> _logger;
+    private readonly IDbContextFactory<ApplicationDbContext> _dbContextFactory;
+
+    public UTXOTagRepository(IRepository<UTXOTag> repository,
+        ILogger<UTXOTagRepository> logger,
+        IDbContextFactory<ApplicationDbContext> dbContextFactory)
+    {
+        _repository = repository;
+        _logger = logger;
+        _dbContextFactory = dbContextFactory;
+    }
+
+    public async Task<UTXOTag?> GetByOutpoint(string outpoint)
+    {
+        await using var applicationDbContext = await _dbContextFactory.CreateDbContextAsync();
+
+        return await applicationDbContext.UTXOTags.FirstOrDefaultAsync(x => x.Outpoint == outpoint);
+    }
+
+    public async Task<UTXOTag?> GetByKeyAndOutpoint(string key, string outpoint)
+    {
+        await using var applicationDbContext = await _dbContextFactory.CreateDbContextAsync();
+
+        return await applicationDbContext.UTXOTags.FirstOrDefaultAsync(x => x.Key == key && x.Outpoint == outpoint);
+    }
+
+    public async Task<List<UTXOTag>> GetByKeyValue(string key, string value)
+    {
+        await using var applicationDbContext = await _dbContextFactory.CreateDbContextAsync();
+
+        return await applicationDbContext.UTXOTags
+            .Where(x => x.Key == key && x.Value == value).ToListAsync();
+    }
+
+    public async Task<(bool, string?)> AddAsync(UTXOTag type)
+    {
+        await using var applicationDbContext = await _dbContextFactory.CreateDbContextAsync();
+
+        type.SetCreationDatetime();
+
+        return await _repository.AddAsync(type, applicationDbContext);
+    }
+
+    public async Task<(bool, string?)> AddRangeAsync(List<UTXOTag> type)
+    {
+        await using var applicationDbContext = await _dbContextFactory.CreateDbContextAsync();
+
+        return await _repository.AddRangeAsync(type, applicationDbContext);
+    }
+
+    public (bool, string?) Remove(UTXOTag type)
+    {
+        using var applicationDbContext = _dbContextFactory.CreateDbContext();
+
+        return _repository.Remove(type, applicationDbContext);
+    }
+
+    public (bool, string?) RemoveRange(List<UTXOTag> types)
+    {
+        using var applicationDbContext = _dbContextFactory.CreateDbContext();
+
+        return _repository.RemoveRange(types, applicationDbContext);
+    }
+
+    public (bool, string?) Update(UTXOTag type)
+    {
+        using var applicationDbContext = _dbContextFactory.CreateDbContext();
+
+        type.SetUpdateDatetime();
+
+        return _repository.Update(type, applicationDbContext);
+    }
+}

src/Helpers/Constants.cs

@@ -85,7 +85,9 @@ public class Constants
     /// Max ratio of the tx total input sum that could be used as fee
     /// </summary>
     public static decimal MAX_TX_FEE_RATIO =0.5m;
-
+
+    public static string IsFrozenTag = "frozen";
+
     private static string? GetEnvironmentalVariableOrThrowIfNotTesting(string envVariableName, string? errorMessage = null)
     {
         // If it is a command from ef or a test, ignore the empty env variables