Merge pull request #755 from JeneaVranceanu/feat/git-hooks

feat: git hooks implementation

Author: yaroslavyaroslav

.pre-commit-config.yaml

@@ -0,0 +1,25 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.2.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-yaml
+    -   id: check-added-large-files
+    -   id: check-case-conflict
+    -   id: check-json
+    -   id: mixed-line-ending
+    -   id: no-commit-to-branch
+        args: [--branch, staging, --branch, main, --branch, master, --branch, develop-4.0, --branch, develop-upstream]
+-   repo: https://github.com/codespell-project/codespell
+    rev: v2.2.2
+    hooks:
+    -   id: codespell
+        args: ["--count --ignore-words-list=ans,deriver,inout,packag --skip=\"*.js,*WordLists.swift,.git,Carthage,.build,build\""]
+# SwiftLint is commented out until we fix all SwiftLint warnings and errors.
+# https://github.com/web3swift-team/web3swift/pull/756
+#-   repo: https://github.com/realm/SwiftLint
+#    rev: 0.50.3
+#    hooks:
+#    -   id: swiftlint
+#        args: [--fix, Sources, Tests]

README.md

@@ -193,6 +193,10 @@ $ ganache
 This will create a local blockchain and also some test accounts that are used throughout our tests.
 Make sure that `ganache` is running on its default port `8546`. To change the port in test cases locate `LocalTestCase.swift` and modify the static `url` variable.
 
+### Before you commit
+
+We are using [pre-commit](https://pre-commit.com) to run validations locally before a commit is created. Please, install pre-commit and run `pre-commit install` from project's root directory. After that before every commit git hook will run and execute `codespell`, `swiftlint` and other checks.
+
 ## Contribute
 Want to improve? It's awesome:
 Then good news for you: **We are ready to pay for your contribution via [@gitcoin bot](https://gitcoin.co/grants/358/web3swift)!**

Tests/web3swiftTests/localTests/TransactionsTests.swift

@@ -195,7 +195,7 @@ class TransactionsTests: XCTestCase {
             // check that we recovered the address correctly
             XCTAssertEqual(jsonTxn.sender!.address, expectedAddress.address, "Recovered Address Mismatch")
         } catch {
-            
+
             return XCTFail(String(describing: error))
         }
     }
@@ -243,7 +243,7 @@ class TransactionsTests: XCTestCase {
             // check that we recovered the address correctly
             XCTAssertEqual(jsonTxn.sender!.address, expectedAddress.address, "Recovered Address Mismatch")
         } catch {
-            
+
             return XCTFail(String(describing: error))
         }
     }
@@ -264,7 +264,7 @@ class TransactionsTests: XCTestCase {
             // check that we recovered the address correctly
             XCTAssertEqual(jsonTxn.sender!.address, expectedAddress.address, "Recovered Address Mismatch")
         } catch {
-            
+
             return XCTFail(String(describing: error))
         }
     }
@@ -312,7 +312,7 @@ class TransactionsTests: XCTestCase {
             // check that we recovered the address correctly
             XCTAssertEqual(jsonTxn.sender!.address, expectedAddress.address, "Recovered Address Mismatch")
         } catch {
-            
+
             return XCTFail(String(describing: error))
         }
     }
@@ -333,7 +333,7 @@ class TransactionsTests: XCTestCase {
             // check that we recovered the address correctly
             XCTAssertEqual(jsonTxn.sender!.address, expectedAddress.address, "Recovered Address Mismatch")
         } catch {
-            
+
             return XCTFail(String(describing: error))
         }
     }
@@ -381,7 +381,7 @@ class TransactionsTests: XCTestCase {
             // check that we recovered the address correctly
             XCTAssertEqual(jsonTxn.sender!.address, expectedAddress.address, "Recovered Address Mismatch")
         } catch {
-            
+
             return XCTFail(String(describing: error))
         }
     }
@@ -402,7 +402,7 @@ class TransactionsTests: XCTestCase {
             // check that we recovered the address correctly
             XCTAssertEqual(jsonTxn.sender!.address, expectedAddress.address, "Recovered Address Mismatch")
         } catch {
-            
+
             return XCTFail(String(describing: error))
         }
     }
@@ -450,7 +450,7 @@ class TransactionsTests: XCTestCase {
             // check that we recovered the address correctly
             XCTAssertEqual(jsonTxn.sender!.address, expectedAddress.address, "Recovered Address Mismatch")
         } catch {
-            
+
             return XCTFail(String(describing: error))
         }
     }
@@ -518,7 +518,7 @@ class TransactionsTests: XCTestCase {
             // check that we recovered the address correctly
             XCTAssertEqual(jsonTxn.sender!.address, expectedAddress.address, "Recovered Address Mismatch")
         } catch {
-            
+
             return XCTFail(String(describing: error))
         }
     }
@@ -539,7 +539,7 @@ class TransactionsTests: XCTestCase {
             // check that we recovered the address correctly
             XCTAssertEqual(jsonTxn.sender!.address, expectedAddress.address, "Recovered Address Mismatch")
         } catch {
-            
+
             return XCTFail(String(describing: error))
         }
     }
@@ -587,7 +587,7 @@ class TransactionsTests: XCTestCase {
             // check that we recovered the address correctly
             XCTAssertEqual(jsonTxn.sender!.address, expectedAddress.address, "Recovered Address Mismatch")
         } catch {
-            
+
             return XCTFail(String(describing: error))
         }
     }
@@ -611,16 +611,16 @@ class TransactionsTests: XCTestCase {
             let publicKey = Utilities.privateToPublic(privateKeyData, compressed: false)
             let sender = Utilities.publicToAddress(publicKey!)
             transaction.chainID = 1
-            
+
             let hash = transaction.hashForSignature()
             let expectedHash = "0xdaf5a779ae972f972197303d7b574746c7ef83eadac0f2791ad23db92e4c8e53".stripHexPrefix()
             XCTAssertEqual(hash!.toHexString(), expectedHash, "Transaction signature failed")
             try transaction.sign(privateKey: privateKeyData, useExtraEntropy: false)
-            
+
             XCTAssertEqual(transaction.v, 37, "Transaction signature failed")
             XCTAssertEqual(sender, transaction.sender)
         } catch {
-            
+
             XCTFail()
         }
     }
@@ -639,12 +639,12 @@ class TransactionsTests: XCTestCase {
             let policies = Policies(gasLimitPolicy: .manual(78423))
             let result = try await writeTX.writeToChain(password: "", policies: policies, sendRaw: false)
             let txHash = Data.fromHex(result.hash.stripHexPrefix())!
-            
+
 
             Thread.sleep(forTimeInterval: 1.0)
 
             let receipt = try await web3.eth.transactionReceipt(txHash)
-            
+
             XCTAssert(receipt.status == .ok)
 
             switch receipt.status {
@@ -655,13 +655,13 @@ class TransactionsTests: XCTestCase {
             }
 
             let details = try await web3.eth.transactionDetails(txHash)
-            
+
             // FIXME: Re-enable this test.
 //            XCTAssertEqual(details.transaction.gasLimit, BigUInt(78423))
         } catch Web3Error.nodeError(let descr) {
             guard descr == "insufficient funds for gas * price + value" else {return XCTFail()}
         } catch {
-            
+
             XCTFail()
         }
     }