Merge branch 'develop' into fix/web3-wallet-example

Author: JeneaVranceanu

.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]

.swiftlint.yml

@@ -1,45 +1,47 @@
 excluded:
-  - Carthage
-  - Pods
   - .build
   - Build
+  - Carthage
   - DerivedData
+  - Pods
 
 disabled_rules:
-  - type_name
+  - function_parameter_count
   - identifier_name
   - line_length
   - multiple_closures_with_trailing_closure
+  - nesting
   - todo
+  - type_name
 
 opt_in_rules:
- - weak_delegate
- - unused_import
- - unneeded_parentheses_in_closure_argument
- - trailing_closure
- - static_operator
- - redundant_nil_coalescing
- - override_in_extension
- - legacy_objc_type
- - implicitly_unwrapped_optional
- - force_unwrapping
- - empty_string
- - closure_body_length
- - fallthrough
- - indentation_width
+  - closure_body_length
+  - empty_string
+  - fallthrough
+  - force_unwrapping
+  - implicitly_unwrapped_optional
+  - indentation_width
+  - legacy_objc_type
+  - override_in_extension
+  - redundant_nil_coalescing
+  - static_operator
+  - trailing_closure
+  - unneeded_parentheses_in_closure_argument
+  - unused_import
+  - weak_delegate
 
 # force warnings
 force_cast: error
 force_try: error 
 
 custom_rules:
   commented_out_code: 
-    included: ".*\\.swift" # regex that defines paths to include during linting. optional.
-    excluded: ".*Test(s)?\\.swift" # regex that defines paths to exclude during linting. optional
-    name: "Commented out code" # rule name. optional.
-    regex: "^\\/\\/\\s*(@|\\.?([a-z]|(\\})))" # matching pattern
+    included: .*\.swift # regex that defines paths to include during linting. optional.
+    excluded: .*Test(s)?\.swift # regex that defines paths to exclude during linting. optional
+    name: Commented out code # rule name. optional.
+    regex: ^\s*(\/\/(?!\s*swiftlint:).*|\/\*[\s\S]*?\*\/) # matching pattern
     capture_group: 0 # number of regex capture group to highlight the rule violation at. optional.
     match_kinds: # SyntaxKinds to match. optional.
       - comment
-    message: "No commented code in devel branch allowed." # violation message. optional.
+    message: No commented code in devel branch allowed. # violation message. optional.
     severity: warning # violation severity. optional.

Example/myWeb3Wallet/myWeb3Wallet/Appdelegate/AppDelegate.swift

@@ -10,8 +10,6 @@ import UIKit
 @main
 class AppDelegate: UIResponder, UIApplicationDelegate {
 
-
-
     func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
         // Override point for customization after application launch.
         return true
@@ -31,6 +29,4 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
         // Use this method to release any resources that were specific to the discarded scenes, as they will not return.
     }
 
-
 }
-

Example/myWeb3Wallet/myWeb3Wallet/Appdelegate/SceneDelegate.swift

@@ -11,7 +11,6 @@ class SceneDelegate: UIResponder, UIWindowSceneDelegate {
 
     var window: UIWindow?
 
-
     func scene(_ scene: UIScene, willConnectTo session: UISceneSession, options connectionOptions: UIScene.ConnectionOptions) {
         // Use this method to optionally configure and attach the UIWindow `window` to the provided UIWindowScene `scene`.
         // If using a storyboard, the `window` property will automatically be initialized and attached to the scene.
@@ -47,6 +46,4 @@ class SceneDelegate: UIResponder, UIWindowSceneDelegate {
         // to restore the scene back to its current state.
     }
 
-
 }
-

Example/myWeb3Wallet/myWeb3Wallet/ViewControllers/WalletController/DashboardViewController.swift

@@ -19,7 +19,6 @@ class DashboardViewController: UIViewController {
 
         }
     }
-    
 
     /*
     // MARK: - Navigation

Example/myWeb3Wallet/myWeb3Wallet/ViewControllers/WalletController/SplashViewController.swift

@@ -10,20 +10,19 @@ import UIKit
 class SplashViewController: UIViewController {
 
     @IBOutlet weak var logoView: UIImageView!
-    
+
     override func viewDidLoad() {
         super.viewDidLoad()
         UIView.animate(withDuration: 0.9) {
             self.logoView.center.y = self.view.center.y
             Timer.scheduledTimer(timeInterval: 1, target: self, selector: #selector(self.moveToWalletView), userInfo: nil, repeats: false)
 
         }
-       
 
         // Do any additional setup after loading the view.
     }
-    @objc func moveToWalletView(){
-        
+    @objc func moveToWalletView() {
+
         guard let walletScreen = self.storyboard?.instantiateViewController(withIdentifier: "WalletViewController") as? WalletViewController else {
             #if DEBUG
             printContent("Unable to get Wallet controller")

Example/myWeb3Wallet/myWeb3Wallet/ViewControllers/WalletController/WalletViewController.swift

@@ -10,13 +10,13 @@ import web3swift
 import Web3Core
 
 class WalletViewController: UIViewController {
-    
+
     @IBOutlet weak var continueButton: UIButton!
     @IBOutlet weak var walletAddressLabel: UILabel!
     @IBOutlet weak var importWalletButton: UIButton!
     @IBOutlet weak var createWalletButton: UIButton!
     var _walletAddress: String {
-        set{
+        set {
             self.continueButton.isHidden = false
             self.walletAddressLabel.text = newValue
         }
@@ -29,23 +29,22 @@ class WalletViewController: UIViewController {
         super.viewDidLoad()
         self.createWalletButton.layer.cornerRadius = 5.0
         self.importWalletButton.layer.cornerRadius = 5.0
-        
+
         // Do any additional setup after loading the view.
     }
-    
-    
+
     @IBAction func onClickCreateWallet(_ sender: UIButton) {
 #if DEBUG
         print("Clicked on Create Wallet Option")
 #endif
         self.createMnemonics()
-        
+
     }
     @IBAction func onClickImportWalletButton(_ sender: UIButton) {
         print("Clicked on import Wallet Option")
         self.showImportALert()
     }
-    
+
     @IBAction func onClickContinueButton(_ sender: UIButton) {
         print("Clicked on COntinue button")
         guard let dashboardScreen = self.storyboard?.instantiateViewController(withIdentifier: "DashboardViewController") as? DashboardViewController else {
@@ -56,7 +55,7 @@ class WalletViewController: UIViewController {
         }
         self.navigationController?.pushViewController(dashboardScreen, animated: true)
     }
-    fileprivate func showImportALert(){
+    fileprivate func showImportALert() {
         let alert = UIAlertController(title: "MyWeb3Wallet", message: "", preferredStyle: .alert)
         alert.addTextField { textfied in
             textfied.placeholder = "Enter mnemonics/private Key"
@@ -71,15 +70,15 @@ class WalletViewController: UIViewController {
             guard let privateKey = alert.textFields?[0].text else { return }
             print(privateKey)
             self.importWalletWith(privateKey: privateKey)
-            
+
         }
         let cancelAction = UIAlertAction(title: "Cancel", style: .cancel)
         alert.addAction(mnemonicsAction)
         alert.addAction(privateKeyAction)
         alert.addAction(cancelAction)
         self.present(alert, animated: true, completion: nil)
     }
-    func importWalletWith(privateKey: String){
+    func importWalletWith(privateKey: String) {
         let formattedKey = privateKey.trimmingCharacters(in: .whitespacesAndNewlines)
         guard let dataKey = Data.fromHex(formattedKey) else {
             self.showAlertMessage(title: "Error", message: "Please enter a valid Private key ", actionName: "Ok")
@@ -96,7 +95,7 @@ class WalletViewController: UIViewController {
 #endif
                 let walletAddress = manager.addresses?.first?.address
                 self.walletAddressLabel.text = walletAddress ?? "0x"
-                
+
                 print(walletAddress)
             } else {
                 print("error")
@@ -111,9 +110,7 @@ class WalletViewController: UIViewController {
             alert.addAction(okAction)
             self.present(alert, animated: true)
         }
-        
-        
-        
+
     }
 
     func importWalletWith(mnemonics: String) {
@@ -123,19 +120,20 @@ class WalletViewController: UIViewController {
 }
 
 extension WalletViewController {
-    
-    fileprivate func createMnemonics(){
+
+    fileprivate func createMnemonics() {
         let userDir = NSSearchPathForDirectoriesInDomains(.documentDirectory, .userDomainMask, true)[0]
         let web3KeystoreManager = KeystoreManager.managerForPath(userDir + "/keystore")
         do {
-            if (web3KeystoreManager?.addresses?.count ?? 0 >= 0) {
+            if web3KeystoreManager?.addresses?.count ?? 0 >= 0 {
                 let tempMnemonics = try? BIP39.generateMnemonics(bitsOfEntropy: 256, language: .english)
                 guard let tMnemonics = tempMnemonics else {
                     self.showAlertMessage(title: "", message: "We are unable to create wallet", actionName: "Ok")
                     return
                 }
                 self._mnemonics = tMnemonics
                 print(_mnemonics)
+
                 let tempWalletAddress = try? BIP32Keystore(mnemonics: self._mnemonics, password: "", prefixPath: "m/44'/77777'/0'/0")
                 guard let walletAddress = tempWalletAddress?.addresses?.first else {
                     self.showAlertMessage(title: "", message: "Unable to create wallet", actionName: "Ok")
@@ -150,9 +148,9 @@ extension WalletViewController {
                 FileManager.default.createFile(atPath: userDir + "/keystore" + "/key.json", contents: keyData, attributes: nil)
             }
         } catch {
-            
+
         }
-        
+
     }
 }
 extension UIViewController {
@@ -162,5 +160,5 @@ extension UIViewController {
         alertController.addAction(action)
         self.present(alertController, animated: true)
     }
-    
+
 }

README.md

@@ -19,8 +19,8 @@
 
 - [Core features](#core-features)
 - [Installation](#installation)
-    - [CocoaPods](#cocoapods)
     - [Swift Package](#swift-package)
+    - [CocoaPods](#cocoapods)
 - [Example usage](#example-usage)
     - [Send Ether](#send-ether)
     - [Contract read method](#contract-read-method)
@@ -66,6 +66,27 @@
 
 ## Installation
 
+### Swift Package (Recommended)
+The [Swift Package Manager](https://swift.org/package-manager/ "") is a tool for automating the distribution of Swift code that is well integrated with Swift build system.
+
+Once you have your Swift package set up, adding `web3swift` as a dependency is as easy as adding it to the `dependencies` value of your `Package.swift`.
+```swift
+dependencies: [
+    .package(url: "https://github.com/web3swift-team/web3swift.git", .upToNextMajor(from: "3.0.0"))
+]
+```
+
+Or if your project is not a package follow these guidelines on [how to add a Swift Package to your Xcode project](https://developer.apple.com/documentation/xcode/adding-package-dependencies-to-your-app).
+
+
+## Example usage
+In the imports section:
+
+```swift
+import web3swift
+import Web3Core
+```
+
 ### CocoaPods
 
 [CocoaPods](http://cocoapods.org) is a dependency manager for Cocoa projects. You can install it with the following command:
@@ -91,23 +112,7 @@ Then, run the following command:
 $ pod install
 ```
 
-### Swift Package
-The [Swift Package Manager](https://swift.org/package-manager/ "") is a tool for automating the distribution of Swift code and is integrated into the swift compiler.
-
-Once you have your Swift package set up, adding Alamofire as a dependency is as easy as adding it to the `dependencies` value of your `Package.swift`.
-```swift
-dependencies: [
-    .package(url: "https://github.com/web3swift-team/web3swift.git", .upToNextMajor(from: "3.0.0"))
-]
-```
-
-## Example usage
-In the imports section:
-
-```swift
-import web3swift
-import Web3Core
-```
+> **WARNING**: CocoaPods is a powerful tool for managing dependencies in iOS development, but it also has some limitations that preventing us of providing first class support there. We highly recommend using SPM first as using CocoaPods will delay new updates and bug fixes being delivered to you.
 
 ### Send Ether
 ```swift
@@ -188,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)!**