update packages

add some docs

Sources/Blockchain/Models/Block.swift

@@ -17,6 +17,19 @@ class Block {
     var nonce: Int
     var timestamp: Int
     
+    /**
+        Initialize a block with the provided parts and specifications.
+     
+        - parameters:
+            - hash: The hash of the block
+            - data: The data of the block
+            - previousHash: The hash of the previous block
+            - index: The index of the block
+            - nonce: The nonce of the block
+            - timestamp: The timestamp of the block
+     
+        - returns: A beautiful new block for the blockchain.
+     */
     init(hash: String = "", data: String = "", previousHash: String = "", index: Int = 0, nonce: Int = 0, timestamp: Int = 0) {
         self.data = data
         self.previousHash = previousHash
@@ -26,10 +39,20 @@ class Block {
         self.hash = hash
     }
     
+    /**
+        Generate the hash of the block.
+     
+        - returns: The hash of the block
+     */
     func generateHash() -> String {
         return data.sha256()
     }
     
+    /**
+        Generate the timestamp of the block
+     
+        - returns: The timestamp of the block
+     */
     func generateTimestamp() -> Int {
         return Int(Date().timeIntervalSince1970)
     }

Sources/Blockchain/Models/Blockchain.swift

@@ -11,6 +11,12 @@ import Foundation
 class Blockchain {
     var chain = [Block]()
     
+    /**
+        Initialize the first block of the blockchain.
+        
+        - Parameters:
+            - data: The datas of the block
+     */
     func createGenesisBlock(data: String) {
         let genesisBlock = Block()
         genesisBlock.data = data
@@ -20,19 +26,63 @@ class Blockchain {
         genesisBlock.timestamp = genesisBlock.generateTimestamp()
         genesisBlock.hash = genesisBlock.generateHash()
         chain.append(genesisBlock)
-        print("Genesis block created -- hash: \(genesisBlock.hash ?? "")")
+        print("Genesis block created -- hash: \(genesisBlock.hash)")
     }
     
+    /**
+        Initialize a new block of the blockchain.
+     
+        - Parameters:
+            - data: The datas of the block
+     */
     func createBlock(data: String) {
         let newBlock = Block()
         newBlock.data = data
-        newBlock.previousHash = chain[chain.count-1].hash
+        newBlock.previousHash = chain.last!.hash
         newBlock.index = chain.count
         newBlock.nonce = 0
         newBlock.timestamp = newBlock.generateTimestamp()
         newBlock.hash = newBlock.generateHash()
         chain.append(newBlock)
         
-        print("Block \(newBlock.index ?? 0) created -- hash: \(newBlock.hash ?? "") previous hash: \(newBlock.previousHash ?? "") data: \(newBlock.data ?? "")")
+        print("-- Block \(newBlock.index) created --\n hash: \(newBlock.hash)\n previous hash: \(newBlock.previousHash)\n data: \(newBlock.data)")
+    }
+    
+    /**
+        Insert a corrupted block in the blockhain.
+        (for testing purpose)
+     */
+    func insertCorruptedBlock() {
+        let newCorruptedBlock = Block()
+        newCorruptedBlock.data = "Corrupted block"
+        newCorruptedBlock.previousHash = "1234567890"
+        newCorruptedBlock.index = chain.count
+        newCorruptedBlock.nonce = 0
+        newCorruptedBlock.timestamp = newCorruptedBlock.generateTimestamp()
+        newCorruptedBlock.hash = newCorruptedBlock.generateHash()
+        chain.append(newCorruptedBlock)
+        
+        print("-- Corrupted block \(newCorruptedBlock.index) created --\n hash: \(newCorruptedBlock.hash)\n previous hash: \(newCorruptedBlock.previousHash)\n data: \(newCorruptedBlock.data)")
+    }
+    
+    /**
+        Check validity of the blockchain.
+     */
+    func chainValidity() {
+        var isChainValid = true
+        var corruptedBlock = Block()
+        
+        for i in 1...chain.count-1 {
+            if chain[i].previousHash != chain[i-1].hash {
+                isChainValid = false
+                corruptedBlock = chain[i]
+            }
+        }
+        
+        print("Chain is valid : \(isChainValid)")
+        
+        if !isChainValid {
+            print("Corrupted block is : \(corruptedBlock.index)")
+        }
     }
 }