chore: merge with develop branch

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,34 +1,34 @@
 excluded:
-  - Carthage
-  - Pods
   - .build
   - Build
+  - Carthage
   - DerivedData
+  - Pods
 
 disabled_rules:
-  - type_name
+  - function_parameter_count
   - identifier_name
   - line_length
   - multiple_closures_with_trailing_closure
-  - todo  
-  - function_parameter_count
   - 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

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)!**

Sources/Web3Core/EthereumABI/ABIElements.swift

@@ -262,7 +262,7 @@ extension ABI.Element {
 
 extension ABI.Element.Function {
     public func decodeInputData(_ rawData: Data) -> [String: Any]? {
-        return Web3Core.decodeInputData(rawData, methodEncoding: methodEncoding, inputs: inputs)
+        return ABIDecoder.decodeInputData(rawData, methodEncoding: methodEncoding, inputs: inputs)
     }
 
     /// Decodes data returned by a function call. Able to decode `revert(string)`, `revert CustomError(...)` and `require(expression, string)` calls.
@@ -432,61 +432,62 @@ extension ABI.Element.Function {
 
 extension ABI.Element.Constructor {
     public func decodeInputData(_ rawData: Data) -> [String: Any]? {
-        return Web3Core.decodeInputData(rawData, inputs: inputs)
+        return ABIDecoder.decodeInputData(rawData, inputs: inputs)
     }
 }
 
-/// Generic input decoding function.
-/// - Parameters:
-///   - rawData: data to decode. Must match the following criteria: `data.count == 0 || data.count % 32 == 4`.
-///   - methodEncoding: 4 bytes representing method signature like `0xFFffFFff`. Can be omitted to avoid checking method encoding.
-///   - inputs: expected input types. Order must be the same as in function declaration.
-/// - Returns: decoded dictionary of input arguments mapped to their indices and arguments' names if these are not empty.
-/// If decoding of at least one argument fails, `rawData` size is invalid or `methodEncoding` doesn't match - `nil` is returned.
-private func decodeInputData(_ rawData: Data,
-                                 methodEncoding: Data? = nil,
-                                 inputs: [ABI.Element.InOut]) -> [String: Any]? {
-    let data: Data
-    let sig: Data?
-
-    switch rawData.count % 32 {
-    case 0:
-        sig = nil
-        data = Data()
-        break
-    case 4:
-        sig = rawData[0 ..< 4]
-        data = Data(rawData[4 ..< rawData.count])
-    default:
-        return nil
-    }
-
-    if methodEncoding != nil && sig != nil && sig != methodEncoding {
-        return nil
-    }
-
-    var returnArray = [String: Any]()
+extension ABIDecoder {
+    /// Generic input decoding function.
+    /// - Parameters:
+    ///   - rawData: data to decode. Must match the following criteria: `data.count == 0 || data.count % 32 == 4`.
+    ///   - methodEncoding: 4 bytes representing method signature like `0xFFffFFff`. Can be omitted to avoid checking method encoding.
+    ///   - inputs: expected input types. Order must be the same as in function declaration.
+    /// - Returns: decoded dictionary of input arguments mapped to their indices and arguments' names if these are not empty.
+    /// If decoding of at least one argument fails, `rawData` size is invalid or `methodEncoding` doesn't match - `nil` is returned.
+    static func decodeInputData(_ rawData: Data,
+                                     methodEncoding: Data? = nil,
+                                     inputs: [ABI.Element.InOut]) -> [String: Any]? {
+        let data: Data
+        let sig: Data?
+
+        switch rawData.count % 32 {
+        case 0:
+            sig = nil
+            data = Data()
+            break
+        case 4:
+            sig = rawData[0 ..< 4]
+            data = Data(rawData[4 ..< rawData.count])
+        default:
+            return nil
+        }
 
-    if data.count == 0 && inputs.count == 1 {
-        let name = "0"
-        let value = inputs[0].type.emptyValue
-        returnArray[name] = value
-        if inputs[0].name != "" {
-            returnArray[inputs[0].name] = value
+        if methodEncoding != nil && sig != nil && sig != methodEncoding {
+            return nil
         }
-    } else {
-        guard inputs.count * 32 <= data.count else { return nil }
-
-        var i = 0
-        guard let values = ABIDecoder.decode(types: inputs, data: data) else { return nil }
-        for input in inputs {
-            let name = "\(i)"
-            returnArray[name] = values[i]
-            if input.name != "" {
-                returnArray[input.name] = values[i]
+
+        var returnArray = [String: Any]()
+        if data.count == 0 && inputs.count == 1 {
+            let name = "0"
+            let value = inputs[0].type.emptyValue
+            returnArray[name] = value
+            if inputs[0].name != "" {
+                returnArray[inputs[0].name] = value
+            }
+        } else {
+            guard inputs.count * 32 <= data.count else { return nil }
+
+            var i = 0
+            guard let values = ABIDecoder.decode(types: inputs, data: data) else { return nil }
+            for input in inputs {
+                let name = "\(i)"
+                returnArray[name] = values[i]
+                if input.name != "" {
+                    returnArray[input.name] = values[i]
+                }
+                i = i + 1
             }
-            i = i + 1
         }
+        return returnArray
     }
-    return returnArray
 }

Tests/web3swiftTests/localTests/TransactionsTests.swift

@@ -2,8 +2,7 @@ Pod::Spec.new do |spec|
     spec.compiler_flags = '-DCOCOAPODS'
 
     spec.name         = 'Web3Core'
-    spec.version      = '3.0.6'
-    spec.module_name  = 'Core'
+    spec.version      = '3.1.1'
     spec.ios.deployment_target = "13.0"
     spec.osx.deployment_target = "10.15"
     spec.license      = { :type => 'Apache License 2.0', :file => 'LICENSE.md' }
@@ -16,5 +15,5 @@ Pod::Spec.new do |spec|
     spec.dependency 'secp256k1.c', '~> 0.1'
     spec.dependency 'BigInt', '~> 5.2.0' # no newer version in pods.
     spec.dependency 'CryptoSwift', '~> 1.5.1'
-    spec.source_files = "Sources/Core/**/*.swift"
+    spec.source_files = "Sources/Web3Core/**/*.swift"
 end

Web3Core.podspec

@@ -1,4 +1,4 @@
-WEB3CORE_VERSION ||= '3.0.6'
+WEB3CORE_VERSION ||= '3.1.1'
 
 Pod::Spec.new do |spec|
     spec.name         = 'web3swift'