feat: added option for destination folder

Igor Goldobin · Igor Goldobin · commit 30fa6217ae48 · 2023-12-22T16:01:11.000+10:00
diff --git a/AddressOwnershipTool/Commands/Claim/ClaimCommand.cs b/AddressOwnershipTool/Commands/Claim/ClaimCommand.cs
@@ -23,4 +23,6 @@ public class ClaimCommand : ICommand<Result>
     public bool Testnet { get; set; }
 
     public string DataFolder { get; set; }
+
+    public string OutputFolder { get; set; }
 }
diff --git a/AddressOwnershipTool/Commands/Claim/ClaimCommandHandler.cs b/AddressOwnershipTool/Commands/Claim/ClaimCommandHandler.cs
@@ -72,7 +72,7 @@ public async Task<Result> Handle(ClaimCommand request, CancellationToken cancell
         }
         else
         {
-            var addressOwnershipService = _addressOwnershipServiceFactory.CreateAddressOwnershipService(request.Testnet, request.UseCirrus, false);
+            var addressOwnershipService = _addressOwnershipServiceFactory.CreateAddressOwnershipService(request.Testnet, request.UseCirrus, false, outputPath: request.OutputFolder);
             addressOwnershipService.SbfnExport(request.WalletName, request.WalletPassword, request.Destination, request.Deep, request.DataFolder);
         }
 
diff --git a/AddressOwnershipTool/Commands/Claim/ClaimCommandValidator.cs b/AddressOwnershipTool/Commands/Claim/ClaimCommandValidator.cs
@@ -20,6 +20,14 @@ public ClaimCommandValidator()
             .WithName("--datafolder");
         });
 
+        When(x => !string.IsNullOrEmpty(x.OutputFolder), () => {
+            RuleFor(x => x.OutputFolder)
+            .NotEmpty()
+            .Must(x => Path.IsPathFullyQualified(x))
+            .WithMessage("Please specify a valid output folder path")
+            .WithName("--outputFolder");
+        });
+
         When(x => !string.IsNullOrEmpty(x.PrivateKeyFile), () => {
             RuleFor(x => x.PrivateKeyFile)
                 .Must(x => Path.IsPathFullyQualified(x))
diff --git a/AddressOwnershipTool/Commands/Claim/ClaimInstruction.cs b/AddressOwnershipTool/Commands/Claim/ClaimInstruction.cs
@@ -23,6 +23,9 @@ public class ClaimInstruction : BaseInstruction
     [Option('r', "datafolder", Required = false, HelpText = "[Optional] Root folder for your node")]
     public string DataFolder { get; set; }
 
+    [Option('o', "outputFolder", Required = false, HelpText = "[Optional] Path for the folder where generated CSV will go")]
+    public string OutputFolder { get; set; }
+
     public ClaimCommand ToCommand()
     {
         return new ClaimCommand
@@ -33,7 +36,8 @@ public ClaimCommand ToCommand()
             Testnet = Testnet,
             UseCirrus = UseCirrus,
             Destination = Destination,
-            DataFolder = DataFolder
+            DataFolder = DataFolder,
+            OutputFolder = OutputFolder
         };
     }
 }
diff --git a/AddressOwnershipTool/Commands/Scan/ScanCommand.cs b/AddressOwnershipTool/Commands/Scan/ScanCommand.cs
@@ -9,4 +9,8 @@ public class ScanCommand : ICommand<Result>
     public bool Testnet { get; set; }
 
     public int StartBlock { get; set; }
+
+    public int EndBlock { get; set; }
+
+    public string OutputFolder { get; set; }
 }
diff --git a/AddressOwnershipTool/Commands/Scan/ScanCommandHandler.cs b/AddressOwnershipTool/Commands/Scan/ScanCommandHandler.cs
@@ -13,9 +13,9 @@ public ScanCommandHandler(ISwapExtractionServiceFactory swapExtractionServiceFac
 
     public async Task<Result> Handle(ScanCommand request, CancellationToken cancellationToken)
     {
-        var service = _swapExtractionServiceFactory.CreateSwapExtractionServiceFactory(request.Testnet, request.UseCirrus);
+        var service = _swapExtractionServiceFactory.CreateSwapExtractionServiceFactory(request.Testnet, request.UseCirrus, request.OutputFolder);
 
-        await service.RunAsync(request.StartBlock);
+        await service.RunAsync(request.StartBlock, request.EndBlock);
 
         return Result.Ok();
     }
diff --git a/AddressOwnershipTool/Commands/Scan/ScanCommandValidator.cs b/AddressOwnershipTool/Commands/Scan/ScanCommandValidator.cs
@@ -11,5 +11,22 @@ public ScanCommandValidator()
             .GreaterThanOrEqualTo(0)
             .WithMessage("Please specify a valid start block")
             .WithName("--start");
+
+        RuleFor(x => x.EndBlock)
+            .GreaterThanOrEqualTo(0)
+            .WithMessage("Please specify a valid end block")
+            .WithName("--end");
+
+        RuleFor(x => new { x.StartBlock, x.EndBlock })
+            .Must(x => x.StartBlock <= x.EndBlock)
+            .WithMessage("Start block cannot be higher than end block");
+
+        When(x => !string.IsNullOrEmpty(x.OutputFolder), () => {
+            RuleFor(x => x.OutputFolder)
+            .NotEmpty()
+            .Must(x => Path.IsPathFullyQualified(x))
+            .WithMessage("Please specify a valid output folder path")
+            .WithName("--outputFolder");
+        });
     }
 }
diff --git a/AddressOwnershipTool/Commands/Scan/ScanInstruction.cs b/AddressOwnershipTool/Commands/Scan/ScanInstruction.cs
@@ -11,13 +11,21 @@ public class ScanInstruction : BaseInstruction
     [Option('s', "start", Required = false, HelpText = "[Required] Start block to scan.")]
     public int StartBlock { get; set; }
 
+    [Option('e', "end", Required = false, HelpText = "[Optional] End block to scan.", Default = 2100000)]
+    public int EndBlock { get; set; }
+
+    [Option('o', "outputFolder", Required = false, HelpText = "[Optional] Path for the folder where generated CSV will go")]
+    public string OutputFolder { get; set; }
+
     public ScanCommand ToCommand()
     {
         return new ScanCommand
         {
             Testnet = Testnet,
             UseCirrus = UseCirrus,
-            StartBlock = StartBlock
+            StartBlock = StartBlock,
+            EndBlock = EndBlock,
+            OutputFolder = OutputFolder
         };
     }
 }
diff --git a/AddressOwnershipTool/Commands/Validate/ValidateCommand.cs b/AddressOwnershipTool/Commands/Validate/ValidateCommand.cs
@@ -9,4 +9,6 @@ public class ValidateCommand : ICommand<Result>
     public bool Testnet { get; set; }
 
     public bool UseCirrus { get; set; }
+
+    public string OutputFolder { get; set; }
 }
diff --git a/AddressOwnershipTool/Commands/Validate/ValidateCommandHandler.cs b/AddressOwnershipTool/Commands/Validate/ValidateCommandHandler.cs
@@ -18,7 +18,7 @@ public async Task<Result> Handle(ValidateCommand request, CancellationToken canc
             return Result.Fail($"Could not locate directory '{request.Signaturefolder}'!");
         }
 
-        var addressOwnershipService = _addressOwnershipServiceFactory.CreateAddressOwnershipService(request.Testnet, request.UseCirrus);
+        var addressOwnershipService = _addressOwnershipServiceFactory.CreateAddressOwnershipService(request.Testnet, request.UseCirrus, outputPath: request.OutputFolder);
 
         addressOwnershipService.Validate(request.Signaturefolder);
 
diff --git a/AddressOwnershipTool/Commands/Validate/ValidateCommandValidator.cs b/AddressOwnershipTool/Commands/Validate/ValidateCommandValidator.cs
@@ -7,5 +7,13 @@ public class ValidateCommandValidator : AbstractValidator<ValidateCommand>
     public ValidateCommandValidator()
     {
         RuleFor(x => x.Signaturefolder).NotEmpty().WithName("--sigfolder");
+
+        When(x => !string.IsNullOrEmpty(x.OutputFolder), () => {
+            RuleFor(x => x.OutputFolder)
+            .NotEmpty()
+            .Must(x => Path.IsPathFullyQualified(x))
+            .WithMessage("Please specify a valid output folder path")
+            .WithName("--outputFolder");
+        });
     }
 }
diff --git a/AddressOwnershipTool/Commands/Validate/ValidateInstruction.cs b/AddressOwnershipTool/Commands/Validate/ValidateInstruction.cs
@@ -11,13 +11,17 @@ public class ValidateInstruction : BaseInstruction
     [Option('c', "cirrus", Required = false, HelpText = "[Optional] Specify if you want to use CIRRUS, default is STRAX.")]
     public bool UseCirrus { get; set; }
 
+    [Option('o', "outputFolder", Required = false, HelpText = "[Optional] Path for the folder where generated CSV will go")]
+    public string OutputFolder { get; set; }
+
     public ValidateCommand ToCommand()
     {
         return new ValidateCommand
         {
             Signaturefolder = Signaturefolder,
             UseCirrus = UseCirrus,
-            Testnet = Testnet
+            Testnet = Testnet,
+            OutputFolder = OutputFolder
         };
     }
 }
diff --git a/AddressOwnershipTool/Common/AddressOwnershipService.cs b/AddressOwnershipTool/Common/AddressOwnershipService.cs
@@ -31,11 +31,12 @@ public class AddressOwnershipService : IAddressOwnershipService
     private readonly string ownershipFilePath;
     private readonly INodeApiClientFactory nodeApiClientFactory;
     private readonly IEthRpcClientFactory ethRpcClientFactory;
+    private readonly string outputPath;
     private List<SwappedTx> distributedTransactions;
     private List<OwnershipTransaction> ownershipTransactions;
     private int straxApiPort;
 
-    public AddressOwnershipService(INodeApiClientFactory nodeApiClientFactory, IEthRpcClientFactory ethRpcClientFactory, bool testnet, bool useCirrus = false, bool loadFiles = true)
+    public AddressOwnershipService(INodeApiClientFactory nodeApiClientFactory, IEthRpcClientFactory ethRpcClientFactory, bool testnet, bool useCirrus = false, bool loadFiles = true, string outputPath = null)
     {
         this.network = testnet 
             ? (useCirrus ? new CirrusTest() : new StraxTest())
@@ -45,7 +46,9 @@ public AddressOwnershipService(INodeApiClientFactory nodeApiClientFactory, IEthR
             ? (useCirrus ? 38223 : 27103)
             : (useCirrus ? 37223 : 17103);
 
-        this.ownershipFilePath = Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location);
+        this.ownershipFilePath = string.IsNullOrEmpty(outputPath)
+                ? Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location)
+                : outputPath;
 
         // Only needed for -validate and -distribute
         if (loadFiles)
@@ -56,6 +59,7 @@ public AddressOwnershipService(INodeApiClientFactory nodeApiClientFactory, IEthR
 
         this.nodeApiClientFactory = nodeApiClientFactory;
         this.ethRpcClientFactory = ethRpcClientFactory;
+        this.outputPath = outputPath;
     }
 
     private void LoadAlreadyDistributedTransactions()
@@ -326,7 +330,9 @@ public void OutputToFile(string address, string destinationAddress, string signa
 
         Console.WriteLine(export);
 
-        using (StreamWriter sw = File.AppendText(destinationAddress + ".csv"))
+        var destination = string.IsNullOrEmpty(this.outputPath) ? $"{destinationAddress}.csv" : Path.Combine(this.outputPath, $"{destinationAddress}.csv");
+
+        using (StreamWriter sw = File.AppendText(destination))
         {
             sw.WriteLine(export);
         }
diff --git a/AddressOwnershipTool/Common/AddressOwnershipServiceFactory.cs b/AddressOwnershipTool/Common/AddressOwnershipServiceFactory.cs
@@ -11,8 +11,8 @@ public AddressOwnershipServiceFactory(INodeApiClientFactory nodeApiClientFactory
         _ethRpcClientFactory = ethRpcClientFactory;
     }
 
-    public IAddressOwnershipService CreateAddressOwnershipService(bool testnet, bool useCirrus = false, bool loadFiles = true)
+    public IAddressOwnershipService CreateAddressOwnershipService(bool testnet, bool useCirrus = false, bool loadFiles = true, string outputPath = null)
     {
-        return new AddressOwnershipService(_nodeApiClientFactory, _ethRpcClientFactory, testnet, useCirrus, loadFiles);
+        return new AddressOwnershipService(_nodeApiClientFactory, _ethRpcClientFactory, testnet, useCirrus, loadFiles, outputPath);
     }
 }
diff --git a/AddressOwnershipTool/Common/IAddressOwnershipServiceFactory.cs b/AddressOwnershipTool/Common/IAddressOwnershipServiceFactory.cs
@@ -2,6 +2,6 @@
 {
     public interface IAddressOwnershipServiceFactory
     {
-        IAddressOwnershipService CreateAddressOwnershipService(bool testnet, bool useCirrus = false, bool loadFiles = true);
+        IAddressOwnershipService CreateAddressOwnershipService(bool testnet, bool useCirrus = false, bool loadFiles = true, string outputPath = null);
     }
 }
diff --git a/AddressOwnershipTool/Common/ISwapExtractionService.cs b/AddressOwnershipTool/Common/ISwapExtractionService.cs
@@ -3,6 +3,6 @@ namespace AddressOwnershipTool.Common
 {
     public interface ISwapExtractionService
     {
-        Task RunAsync(int startBlock);
+        Task RunAsync(int startBlock, int endBlock);
     }
 }
diff --git a/AddressOwnershipTool/Common/ISwapExtractionServiceFactory.cs b/AddressOwnershipTool/Common/ISwapExtractionServiceFactory.cs
@@ -2,6 +2,6 @@
 {
     public interface ISwapExtractionServiceFactory
     {
-        ISwapExtractionService CreateSwapExtractionServiceFactory(bool testnet, bool useCirrus = false);
+        ISwapExtractionService CreateSwapExtractionServiceFactory(bool testnet, bool useCirrus = false, string outputPath = null);
     }
 }
diff --git a/AddressOwnershipTool/Common/SwapExtractionService.cs b/AddressOwnershipTool/Common/SwapExtractionService.cs
@@ -15,14 +15,15 @@ public sealed class SwapExtractionService : ExtractionBase, ISwapExtractionServi
 {
     private List<SwapTransaction> swapTransactions;
     private readonly INodeApiClientFactory nodeApiClientFactory;
+    private readonly string outputPath;
     private readonly Network network;
     private readonly int straxApiPort;
 
-    public SwapExtractionService(INodeApiClientFactory nodeApiClientFactory, bool testnet, bool useCirrus)
+    public SwapExtractionService(INodeApiClientFactory nodeApiClientFactory, bool testnet, bool useCirrus, string outputPath = null)
     {
         this.swapTransactions = new List<SwapTransaction>();
         this.nodeApiClientFactory = nodeApiClientFactory;
-
+        this.outputPath = string.IsNullOrEmpty(outputPath) ? "swaps.csv" : Path.Combine(outputPath, "swaps.csv");
         this.network = testnet
             ? (useCirrus ? new CirrusTest() : new StraxTest())
             : (useCirrus ? new CirrusMain() : new StraxMain());
@@ -32,22 +33,22 @@ public SwapExtractionService(INodeApiClientFactory nodeApiClientFactory, bool te
             : (useCirrus ? 37223 : 17103);
     }
 
-    public async Task RunAsync(int startBlock)
+    public async Task RunAsync(int startBlock, int endBlock)
     {
         await this.LoadSwapTransactionFileAsync();
 
-        await ScanForSwapTransactionsAsync(startBlock);
+        await ScanForSwapTransactionsAsync(startBlock, endBlock);
     }
 
     private async Task LoadSwapTransactionFileAsync()
     {
         Console.WriteLine($"Loading swap transaction file...");
 
         // First check if the swap file has been created.
-        if (File.Exists("swaps.csv"))
+        if (File.Exists(this.outputPath))
         {
             // If so populate the list from disk.
-            using (var reader = new StreamReader("swaps.csv"))
+            using (var reader = new StreamReader(this.outputPath))
             using (var csv = new CsvReader(reader, new CsvConfiguration(CultureInfo.InvariantCulture)))
             {
                 this.swapTransactions = await csv.GetRecordsAsync<SwapTransaction>().ToListAsync();
@@ -65,11 +66,11 @@ private async Task LoadSwapTransactionFileAsync()
         }
     }
 
-    private async Task ScanForSwapTransactionsAsync(int startBlock)
+    private async Task ScanForSwapTransactionsAsync(int startBlock, int endBlock)
     {
         Console.WriteLine($"Scanning for swap transactions...");
 
-        for (int height = startBlock; height < EndHeight; height++)
+        for (int height = startBlock; height < endBlock; height++)
         {
             var client = nodeApiClientFactory.CreateNodeApiClient($"http://localhost:{this.straxApiPort}/api");
             BlockTransactionDetailsModel block = await client.RetrieveBlockAtHeightAsync(height);
@@ -84,7 +85,7 @@ private async Task ScanForSwapTransactionsAsync(int startBlock)
         Console.WriteLine($"{this.swapTransactions.Count} swap transactions to process.");
         Console.WriteLine($"{Money.Satoshis(this.swapTransactions.Sum(s => s.SenderAmount)).ToUnit(MoneyUnit.BTC)} STRAX swapped.");
 
-        using (var writer = new StreamWriter("swaps.csv"))
+        using (var writer = new StreamWriter(this.outputPath))
         using (var csv = new CsvWriter(writer, CultureInfo.InvariantCulture))
         {
             csv.WriteRecords(this.swapTransactions);
diff --git a/AddressOwnershipTool/Common/SwapExtractionServiceFactory.cs b/AddressOwnershipTool/Common/SwapExtractionServiceFactory.cs
@@ -19,8 +19,8 @@ public SwapExtractionServiceFactory(INodeApiClientFactory nodeApiClientFactory)
         this.nodeApiClientFactory = nodeApiClientFactory;
     }
 
-    public ISwapExtractionService CreateSwapExtractionServiceFactory(bool testnet, bool useCirrus = false)
+    public ISwapExtractionService CreateSwapExtractionServiceFactory(bool testnet, bool useCirrus = false, string outputPath = null)
     {
-        return new SwapExtractionService(nodeApiClientFactory, testnet, useCirrus);
+        return new SwapExtractionService(nodeApiClientFactory, testnet, useCirrus, outputPath);
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -23,4 +23,6 @@ public class ClaimCommand : ICommand<Result>`
`23`	`23`	`public bool Testnet { get; set; }`
`24`	`24`
`25`	`25`	`public string DataFolder { get; set; }`
	`26`	`+`
	`27`	`+ public string OutputFolder { get; set; }`
`26`	`28`	`}`
Original file line number	Diff line number	Diff line change
`@@ -72,7 +72,7 @@ public async Task<Result> Handle(ClaimCommand request, CancellationToken cancell`
`72`	`72`	`}`
`73`	`73`	`else`
`74`	`74`	`{`
`75`		`- var addressOwnershipService = _addressOwnershipServiceFactory.CreateAddressOwnershipService(request.Testnet, request.UseCirrus, false);`
	`75`	`+ var addressOwnershipService = _addressOwnershipServiceFactory.CreateAddressOwnershipService(request.Testnet, request.UseCirrus, false, outputPath: request.OutputFolder);`
`76`	`76`	`addressOwnershipService.SbfnExport(request.WalletName, request.WalletPassword, request.Destination, request.Deep, request.DataFolder);`
`77`	`77`	`}`
`78`	`78`
Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,9 @@ public class ClaimInstruction : BaseInstruction`
`23`	`23`	`[Option('r', "datafolder", Required = false, HelpText = "[Optional] Root folder for your node")]`
`24`	`24`	`public string DataFolder { get; set; }`
`25`	`25`
	`26`	`+ [Option('o', "outputFolder", Required = false, HelpText = "[Optional] Path for the folder where generated CSV will go")]`
	`27`	`+ public string OutputFolder { get; set; }`
	`28`	`+`
`26`	`29`	`public ClaimCommand ToCommand()`
`27`	`30`	`{`
`28`	`31`	`return new ClaimCommand`
`@@ -33,7 +36,8 @@ public ClaimCommand ToCommand()`
`33`	`36`	`Testnet = Testnet,`
`34`	`37`	`UseCirrus = UseCirrus,`
`35`	`38`	`Destination = Destination,`
`36`		`- DataFolder = DataFolder`
	`39`	`+ DataFolder = DataFolder,`
	`40`	`+ OutputFolder = OutputFolder`
`37`	`41`	`};`
`38`	`42`	`}`
`39`	`43`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,4 +9,8 @@ public class ScanCommand : ICommand<Result>`
`9`	`9`	`public bool Testnet { get; set; }`
`10`	`10`
`11`	`11`	`public int StartBlock { get; set; }`
	`12`	`+`
	`13`	`+ public int EndBlock { get; set; }`
	`14`	`+`
	`15`	`+ public string OutputFolder { get; set; }`
`12`	`16`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,9 +13,9 @@ public ScanCommandHandler(ISwapExtractionServiceFactory swapExtractionServiceFac`
`13`	`13`
`14`	`14`	`public async Task<Result> Handle(ScanCommand request, CancellationToken cancellationToken)`
`15`	`15`	`{`
`16`		`- var service = _swapExtractionServiceFactory.CreateSwapExtractionServiceFactory(request.Testnet, request.UseCirrus);`
	`16`	`+ var service = _swapExtractionServiceFactory.CreateSwapExtractionServiceFactory(request.Testnet, request.UseCirrus, request.OutputFolder);`
`17`	`17`
`18`		`- await service.RunAsync(request.StartBlock);`
	`18`	`+ await service.RunAsync(request.StartBlock, request.EndBlock);`
`19`	`19`
`20`	`20`	`return Result.Ok();`
`21`	`21`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,13 +11,21 @@ public class ScanInstruction : BaseInstruction`
`11`	`11`	`[Option('s', "start", Required = false, HelpText = "[Required] Start block to scan.")]`
`12`	`12`	`public int StartBlock { get; set; }`
`13`	`13`
	`14`	`+ [Option('e', "end", Required = false, HelpText = "[Optional] End block to scan.", Default = 2100000)]`
	`15`	`+ public int EndBlock { get; set; }`
	`16`	`+`
	`17`	`+ [Option('o', "outputFolder", Required = false, HelpText = "[Optional] Path for the folder where generated CSV will go")]`
	`18`	`+ public string OutputFolder { get; set; }`
	`19`	`+`
`14`	`20`	`public ScanCommand ToCommand()`
`15`	`21`	`{`
`16`	`22`	`return new ScanCommand`
`17`	`23`	`{`
`18`	`24`	`Testnet = Testnet,`
`19`	`25`	`UseCirrus = UseCirrus,`
`20`		`- StartBlock = StartBlock`
	`26`	`+ StartBlock = StartBlock,`
	`27`	`+ EndBlock = EndBlock,`
	`28`	`+ OutputFolder = OutputFolder`
`21`	`29`	`};`
`22`	`30`	`}`
`23`	`31`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,4 +9,6 @@ public class ValidateCommand : ICommand<Result>`
`9`	`9`	`public bool Testnet { get; set; }`
`10`	`10`
`11`	`11`	`public bool UseCirrus { get; set; }`
	`12`	`+`
	`13`	`+ public string OutputFolder { get; set; }`
`12`	`14`	`}`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ public async Task<Result> Handle(ValidateCommand request, CancellationToken canc`
`18`	`18`	`return Result.Fail($"Could not locate directory '{request.Signaturefolder}'!");`
`19`	`19`	`}`
`20`	`20`
`21`		`- var addressOwnershipService = _addressOwnershipServiceFactory.CreateAddressOwnershipService(request.Testnet, request.UseCirrus);`
	`21`	`+ var addressOwnershipService = _addressOwnershipServiceFactory.CreateAddressOwnershipService(request.Testnet, request.UseCirrus, outputPath: request.OutputFolder);`
`22`	`22`
`23`	`23`	`addressOwnershipService.Validate(request.Signaturefolder);`
`24`	`24`