Merge pull request #54 from KristiforMilchev/development

Code refactoring, adding comments to methods.

Author: KristiforMilchev

Data/AuthenicationHandler.cs

@@ -20,18 +20,7 @@ public AuthenicationHandler()
         HardwareService = ServiceHelper.GetService<IHardwareService>();
     }
 
-    public string CreateAccountInitial()
-	{
-        //WIP
-        return string.Empty;
-    }
-
-    public async Task<string> DeployContract()
-    {
-        //WIP
-        return string.Empty;
-    }
-
+ 
     public string GetDefault()
     {
         //WIP
@@ -132,16 +121,6 @@ public async Task<List<Token>> GetSupportedTokens(int networkId)
          return await ContractService.GetNetworkTokens(networkId);
 
     }
-
-    string IAuthenicationService.ToHex(byte[] value, bool prefix)
-    {
-        return System.Text.Encoding.UTF8.GetString(value);
-    }
-
-    byte IAuthenicationService.ConvertBinaryToText(string seq)
-    {
-        return Convert.ToByte(seq, 2);
-    }
 }   
 
 

Data/ContractService.cs

@@ -24,19 +24,19 @@ internal class HardwareService : IHardwareService
 
         public string DeviceConnected()
         {
+            //Get an array of com ports on the system
             string[] portNames = SerialPortStream.GetPortNames();
 
-         //   string[] ports = SerialPort.GetPortNames();
-
-            Debug.WriteLine("The following serial ports were found:");
             var current = string.Empty;
             // Display each port name to the console.
+            //Always assigns the last com port to the system, doesn't work with two devices.
             foreach (string port in portNames)
             {
                 Debug.WriteLine(port);
                 MauiProgram.ComPort = port;
                 current = port;
             }
+
             return current;
         }
 
@@ -49,27 +49,28 @@ public bool CreateNewDevice(string port)
         {
             string userName = Environment.UserName;
 
-           
-            if (!File.Exists(@$"{Utilities.GetOsSavePath()}\wallet.ino.standard.hex"))
+            //If file exists, delete it, we want the latest version of the file.
+            if (File.Exists(@$"{Utilities.GetOsSavePath()}\wallet.ino.standard.hex"))
+                File.Delete(@$"{Utilities.GetOsSavePath()}\wallet.ino.standard.hex");
+
+
+            //Download the latest version of the file.
+            using (WebClient wc = new WebClient())
             {
-                using (WebClient wc = new WebClient())
-                {
 
-                        wc.DownloadFile(
-                        // Param1 = Link of file
-                        new System.Uri("https://raw.githubusercontent.com/KristiforMilchev/LInksync-Cold-Storage-Wallet/main/HardwareCode/ColdStorage/wallet.ino.standard.hex"),
-                        // Param2 = Path to save
-                        @$"{Utilities.GetOsSavePath()}\wallet.ino.standard.hex"
-                    );
-                }
+                wc.DownloadFile(
+                // Param1 = Link of file
+                new System.Uri("https://raw.githubusercontent.com/KristiforMilchev/LInksync-Cold-Storage-Wallet/main/HardwareCode/ColdStorage/wallet.ino.standard.hex"),
+                // Param2 = Path to save
+                @$"{Utilities.GetOsSavePath()}\wallet.ino.standard.hex");
             }
 
 
+            //Uploads the firmware to device.
             ConfigureHardware(MauiProgram.DeviceType, @$"{Utilities.GetOsSavePath()}\wallet.ino.standard.hex", port);
 
             Debug.WriteLine("Device Updated");
             return true;
-
         }
 
         public void ConfigureHardware(ArduinoModel device,string path, string port)
@@ -92,6 +93,7 @@ public CryptoWallet ImportAccount(List<Word> words)
             var Pk = string.Empty;
             var i = 0;
 
+            //Loop over the words and reconstruct the key
             words.ForEach(x =>
             {
                 Pk += x.Name;
@@ -136,36 +138,17 @@ public List<Word> GenerateWords(List<string> chunks)
             List<Word> words = new List<Word>();
             chunks.ToList().ForEach(x =>
             {
-                string yourByteString = x;
- 
-
- 
                 words.Add(new Word
                 {
-                    Name = yourByteString,
+                    Name = x,
                     Index = i,
                 });
                 i++; 
 
             });
             return words;
         }
-
-        public string GeneratePrivateKey(List<string> data)
-        {
-            byte[] bytes = new byte[data.Count+1];
-            var i = 0;
-            data.ForEach(x =>
-            {
-                var cByte = Convert.ToByte(x, 2);
-                bytes[i] = cByte;
-                i++;
-            });
-
-            var pk = bytes.ToHex();
-            return pk;
-        }
-
+ 
         public string Encrypt(string data, string password)
         {
             try

Data/HardwareService.cs

@@ -23,6 +23,8 @@ internal class PaymentService : IPaymentService
         IContractService ContractService { get; set; }
         IUtilities Utilities { get; set; }
         IAuthenicationService AuthenicationService { get; set; }
+
+        //Init the constructor and inherit all dependencies.
         public PaymentService()
         {
             ContractService = ServiceHelper.GetService<IContractService>();
@@ -32,30 +34,25 @@ public PaymentService()
 
         public async Task<TransactionResult> BeginTransaction()
         {
-
-            MauiProgram.HideTokenList = "none";
-            MauiProgram.HideTokenSend = "none";
-            MauiProgram.ShowPinPanel = "none";
-         
-
-            var wallet = AuthenicationService.UnlockWallet(MauiProgram.Pass);
+            var wallet = AuthenicationService.UnlockWallet(MauiProgram.Pass); //One of decrypt the PK encoded on the device and open the wallet.
 
+            //If wallet doesn't exist return null
             if(wallet == null)
                 return null; 
 
+            //Check if a contract exists (Native currencies don't have a contract) if false, send native chain token.
             if (string.IsNullOrEmpty(MauiProgram.SelectedContract.ContractAddress))
                 await ContractService.ExecuteNative(MauiProgram.ReceiverAddress, MauiProgram.Amount, wallet, MauiProgram.ActiveNetwork.Endpoint, MauiProgram.ActiveNetwork.Chainid);
             else
                 await ContractService.ExecutePayments(MauiProgram.ReceiverAddress, MauiProgram.SelectedContract, MauiProgram.Amount, wallet, MauiProgram.ActiveNetwork.Endpoint, MauiProgram.ActiveNetwork.Chainid);
 
-            //Clear PK, password etc.
-
-          
-
-            var dateTime = DateTime.UtcNow.AddSeconds(30);
+            //Defer next check, it will be validated after the next block regardless.
+            var dateTime = DateTime.UtcNow.AddSeconds(30); 
 
+            //Loop and wait till the transaction was valid, important no recursion here due to that the transaction hash has already been created we are only checking the status.
             while(TransactionResult == null)
             {
+                //If time is over the check time validate if the transaction is validated
                 if(DateTime.UtcNow > dateTime)
                 {
                     await ValidateTransaction(MauiProgram.TxHash);
@@ -70,12 +67,22 @@ public async Task<TransactionResult> BeginTransaction()
 
         public async Task<bool> ValidateTransaction(string txHash)
         {
-
+            //We don't need a real wallet here, Pass is empty however due to how Nethereum operates we need to make the request from the object, so we can inherit the chain
+            //That's why we just instance a object to interact with the chain.
             var account = AuthenicationService.UnlockWallet(MauiProgram.Pass);
 
+            //If Hash is empty return false. Return an empty object to avoid recursion in the loop.
             if (string.IsNullOrEmpty(txHash))
+            {
+                TransactionResult = new TransactionResult
+                {
+                    TransactionHash = "-1"
+                };
+                MauiProgram.TxHash = string.Empty;
                 return false;
-
+            }    
+            
+            //If the transaction failed at creation, and there is no hash we return an error object.
             if(txHash == "-")
             {
                 TransactionResult = new TransactionResult
@@ -84,12 +91,14 @@ public async Task<bool> ValidateTransaction(string txHash)
                     From = "--",
                     To = "--",
                     Timestamp = DateTime.UtcNow,
-                    TransactionHash = "Transaction failed, internal error, inssuficient balance or gas!"
+                    TransactionHash = "Transaction failed, internal error, insuficient balance or gas!"
                 };
-                MauiProgram.TxHash = String.Empty;
+                MauiProgram.TxHash = string.Empty;
                 return false;
             }
 
+            //Create a new web3 instance, using the account object, for the chain data and the current selected network. 
+            //We send a request to the blockchain to check the receipt of the transaction.
             var web3 = new Web3(account, MauiProgram.ActiveNetwork.Endpoint);
             var transactionReceipt = await web3.Eth.Transactions.GetTransactionReceipt.SendRequestAsync(txHash);
             if (transactionReceipt == null) //Check if transaction is processed in case it fails sent it to quoue;
@@ -98,6 +107,8 @@ public async Task<bool> ValidateTransaction(string txHash)
                 return false;
             }
 
+            //Decode events in case it's a proxy contract, ETC ETH smart contract
+            //If transferEventOutput is 0, it's a native token transfer.
             var transferEventOutput = transactionReceipt.DecodeAllEvents<TransferEventDTO>();
             if (transferEventOutput.Count == 0)
             {
@@ -111,21 +122,28 @@ public async Task<bool> ValidateTransaction(string txHash)
                         Timestamp = DateTime.UtcNow,
                         TransactionHash = transactionReceipt.TransactionHash
                     };
-                    MauiProgram.TxHash = String.Empty;
+                    MauiProgram.TxHash = string.Empty;
                     return true;
                 }
                 else if (transactionReceipt.Failed())
                 {
-                    
-                    MauiProgram.TxHash = String.Empty;
+                    TransactionResult = new TransactionResult
+                    {
+                        Amount = 0,
+                        From = "--",
+                        To = "--",
+                        Timestamp = DateTime.UtcNow,
+                        TransactionHash = "Transaction failed, internal error, insuficient balance or gas!"
+                    };
+                    MauiProgram.TxHash = string.Empty;
                     return false;
                 }
             }
 
-
+            //Get the initial main trainsfer event.
             var transferEvent = transferEventOutput.FirstOrDefault().Event;
 
-
+            //We get the ETH contract actual tokens by substracting the decimals that are obsolete
             var actualTransfer = Utilities.ConvertToDex((decimal)transferEvent.Value, MauiProgram.SelectedContract.Decimals);
             if (transferEvent.From.ToUpper() != MauiProgram.PublicAddress.ToUpper() || actualTransfer < 0)
                 return false;
@@ -140,7 +158,7 @@ public async Task<bool> ValidateTransaction(string txHash)
                 Timestamp = DateTime.UtcNow,
                 TransactionHash = transactionReceipt.TransactionHash
             };
-            MauiProgram.TxHash = String.Empty;
+            MauiProgram.TxHash = string.Empty;
 
             return true;
         }

Data/PaymentService.cs

@@ -8,8 +8,7 @@ namespace SYNCWallet.Models
 {
     public class TransactionResult
     {
-        public string TransactionHash { get; set;
-        }
+        public string TransactionHash { get; set;}
         public string From { get; set; }
         public string To { get; set; }
         public decimal Amount { get; set; }

Models/TransactionResult.cs

@@ -10,17 +10,40 @@ namespace SYNCWallet.Services.Definitions
 {
     public interface IAuthenicationService
     {
-        public string CreateAccountInitial();
-        public Task<string> DeployContract();
+        /// <summary>
+        /// Gets the public key of the connected wallet.
+        /// </summary>
         public string GetDefault();
+        /// <summary>
+        /// Impoirts a custom EVM compatible blockchain network
+        /// Parameters:
+        /// <param name="networkName">Name of the network</param>            
+        /// <param name="networkSymbol">SYMBOL of the network</param>        
+        /// <param name="rpcUrl">rpc endpoint of the network</param>        
+        /// <param name="chainID">chain idof the network</param>        
+        /// <param name="blockExplorer">https block explorer</param>        
+        /// </summary>
         public bool SetupNetwork(string networkName, string networkSymbol, string rpcUrl, int chainID, string blockExplorer);
+        /// <summary>
+        /// Imports custom token not listed on the official list.
+        /// Parameters:
+        /// <param name="contractAddress">Address of the contract that we import </param>        
+        /// <param name="symbol">Token Symbol</param>        
+        /// <param name="delimiter">Decimal count of the token</param>        
+        /// <param name="network">Internal network id of the network under which we import the token</param>        
+        /// </summary>
         public bool ImportToken(string contractAddress, string symbol, int delimiter, int network);
+        /// <summary>
+        /// Attepmts to decrypt and unlock a web3 wallet using a password
+        /// Parameters:
+        /// <param name="pass">Password used to encrypt the wallet.</param>        
+        /// </summary>
         public Account UnlockWallet(string pass);
+        /// <summary>
+        /// Gets a list of supported tokens filtered by network id
+        /// Parameters:
+        /// <param name="networkId">Blockchain endpoint, RPC address of the Blockchain network </param>        
+        /// </summary>
         public Task<List<Token>> GetSupportedTokens(int networkId);
-        string ToHex(byte[] value, bool prefix = false);
-        byte ConvertBinaryToText(string seq);
-
-
-
     }
 }