Merge branch 'develop' into feature/gas-prediction

yaroslavyaroslav · web-flow · commit d8463bcacbbb · 2022-04-07T18:34:21.000+03:00
diff --git a/CONTRIBUTION.md b/CONTRIBUTION.md
@@ -0,0 +1,65 @@
+# Contribution guide
+## Version convention
+We’re conforming [default versions convension](https://semver.org/).
+So in the `1.0.0` version each position means follow:
+- 1.\*.* — **major release**, includes API groundbreaking changes (ie: your old code will not work).
+- \*.1.* — **minor release**, we’ve added some new feature to the lib, but we didn’t break something in anyway (ie: everything will work as expected without any moves after update).
+- \*.*.1 — **patch release**, we’re haven’t add any breaking changes or even new features for the user, but we’ve fixed some bugs or rewrote something internal (ie: you should not event mention that anything were changed in the lib).
+
+This library yet living within **three weeks minor release** schedule. Also please keep in mind that in sake of avoiding complex merge conflicts, we’re currently taking only **one big feature** in release, so if you want to take some, please drop us a message somewhere to avoiding reworking it after it’ll be broken by some massive merge.
+
+Critical bug fixes are should be marked with appropriate label in PR and should be proceed **within one week** till patch ’ll be released (at least we’ll try our best to made that).
+
+## What task to choose
+Please take it from the [roadmap](https://hackmd.io/G5znP3xAQY-BVc1X8Y1jSg) or from the [opened issues](https://github.com/skywinder/web3swift/issues?q=is:issue+is:open+sort:updated-desc "").
+
+> If you want to make something completely new and purely magical, please drop us a message somewhere before, since it could ends up that this is what we planning to do a lot later or that we not planning at all.
+
+## Codestyle guideline
+- `swiftlint` check should goes with no warnings.
+- Here’s some more detailed and human readable code style [guidelines](https://hackmd.io/8bACoAnTSsKc55Os596yCg "") (you can add there some suggestion if you’d like to). 
+## Tests guideline
+
+
+## Hacks & tricks & magic
+### TestPlans
+In ci/cd we’re using Xcode testplans feature to spread tests to local and remote one. 
+### Swift package manager
+Please add any files unused due build process to `excludeFiles` array in `Package.swift`.
+### Carthage
+Please do not forget to add & remove all new or droped files and dependencies in carthage `.xcodeproj` file if you’re working with project anywhere but carthage project.
+### Cocoapods
+Please do not forget to add & remove all dependencies within `web3swift.podspec` file.
+### GitHub actions
+You’re able to use our github actions checks in your fork without needing to make PR to this repo. To get that just add your branch name to the branch list in file on path `.github/actions/ci.yml` to let the magic happening like follow:
+
+```yml
+on:
+  push:
+    branches:
+      - master
+      - develop
+      - hotfix
+      - #YOUR_REPO_NAME#
+```
+
+> Please remove your branch from this list before making PR.
+
+## Good PR checklist
+### Code
+- [ ] All new functionality covered by unit tests.
+- [ ] Ci/cd green.
+- [ ] No redundant files are added (build cache, Xcode breakpoints settings and so on).
+
+### Info
+- [ ] Relative and concrete PR title.
+- [ ] Issue or roadmap goal attached.
+- [ ] PR description filled with detail explanation of what it is and what’s its specific.
+
+### Codestyle
+- [ ] All public method have `///` styled comments.
+- [ ] All magic or nonintuitive internal code parts are clearly explained in inline comments.
+- [ ] `swiftlint` ran have no warnings.
+- [ ] No commented out code lefts in PR.
+
+
diff --git a/Sources/web3swift/EthereumABI/ABIElements.swift b/Sources/web3swift/EthereumABI/ABIElements.swift
@@ -44,6 +44,7 @@ public extension ABI {
         case fallback(Fallback)
         case event(Event)
         case receive(Receive)
+        case error(EthError)
 
         public enum StateMutability {
             case payable
@@ -152,6 +153,21 @@ public extension ABI {
                 self.payable = payable
             }
         }
+        /// Custom structured error type available since solidity 0.8.4
+        public struct EthError {
+            public let name: String
+            public let inputs: [Input]
+            
+            public struct Input {
+                public let name: String
+                public let type: ParameterType
+                
+                public init(name: String, type: ParameterType) {
+                    self.name = name
+                    self.type = type
+                }
+            }
+        }
     }
 }
 
@@ -173,6 +189,8 @@ extension ABI.Element {
             return signature + data
         case .receive(_):
             return nil
+        case .error(_):
+            return nil
         }
     }
 }
@@ -249,6 +267,8 @@ extension ABI.Element {
             return returnArray
         case .receive(_):
             return nil
+        case .error(_):
+            return nil
         }
     }
 
@@ -324,6 +344,8 @@ extension ABI.Element {
             return returnArray
         case .receive(_):
             return nil
+        case .error(_):
+            return nil
         }
     }
 }
diff --git a/Sources/web3swift/EthereumABI/ABIParsing.swift b/Sources/web3swift/EthereumABI/ABIParsing.swift
@@ -30,13 +30,14 @@ extension ABI {
         case fallback
         case event
         case receive
+        case error
     }
 
 }
 
 extension ABI.Record {
     public func parse() throws -> ABI.Element {
-        let typeString = self.type != nil ? self.type! : "function"
+        let typeString = self.type ?? "function"
         guard let type = ABI.ElementType(rawValue: typeString) else {
             throw ABI.ParsingError.elementTypeInvalid
         }
@@ -61,6 +62,9 @@ fileprivate func parseToElement(from abiRecord: ABI.Record, type: ABI.ElementTyp
     case .receive:
         let receive = try parseReceive(abiRecord: abiRecord)
         return ABI.Element.receive(receive)
+    case .error:
+        let error = try parseError(abiRecord: abiRecord)
+        return ABI.Element.error(error)
     }
 
 }
@@ -70,26 +74,22 @@ fileprivate func parseFunction(abiRecord: ABI.Record) throws -> ABI.Element.Func
         let nativeInput = try input.parse()
         return nativeInput
     })
-    let abiInputs = inputs != nil ? inputs! : [ABI.Element.InOut]()
-    let outputs = try abiRecord.outputs?.map({ (output: ABI.Output) throws -> ABI.Element.InOut in
+    let abiInputs = inputs ?? [ABI.Element.InOut]()
+    let outputs = try abiRecord.outputs?.map({ (output:ABI.Output) throws -> ABI.Element.InOut in
         let nativeOutput = try output.parse()
         return nativeOutput
     })
-    let abiOutputs = outputs != nil ? outputs! : [ABI.Element.InOut]()
-    let name = abiRecord.name != nil ? abiRecord.name! : ""
-    let payable = abiRecord.stateMutability != nil ?
-        (abiRecord.stateMutability == "payable" || abiRecord.payable ?? false) : false
-    let constant = (abiRecord.constant == true || abiRecord.stateMutability == "view" || abiRecord.stateMutability == "pure")
+    let abiOutputs = outputs ?? [ABI.Element.InOut]()
+    let name = abiRecord.name ?? ""
+    let payable = abiRecord.stateMutability == "payable" || abiRecord.payable == true
+    let constant = abiRecord.constant == true || abiRecord.stateMutability == "view" || abiRecord.stateMutability == "pure"
     let functionElement = ABI.Element.Function(name: name, inputs: abiInputs, outputs: abiOutputs, constant: constant, payable: payable)
     return functionElement
 }
 
 fileprivate func parseFallback(abiRecord: ABI.Record) throws -> ABI.Element.Fallback {
     let payable = (abiRecord.stateMutability == "payable" || abiRecord.payable == true)
-    var constant = abiRecord.constant == true
-    if (abiRecord.stateMutability == "view" || abiRecord.stateMutability == "pure") {
-        constant = true
-    }
+    let constant = abiRecord.constant == true || abiRecord.stateMutability == "view" || abiRecord.stateMutability == "pure"
     let functionElement = ABI.Element.Fallback(constant: constant, payable: payable)
     return functionElement
 }
@@ -99,16 +99,9 @@ fileprivate func parseConstructor(abiRecord: ABI.Record) throws -> ABI.Element.C
         let nativeInput = try input.parse()
         return nativeInput
     })
-    let abiInputs = inputs != nil ? inputs! : [ABI.Element.InOut]()
-    var payable = false
-    if (abiRecord.payable != nil) {
-        payable = abiRecord.payable!
-    }
-    if (abiRecord.stateMutability == "payable") {
-        payable = true
-    }
-    let constant = false
-    let functionElement = ABI.Element.Constructor(inputs: abiInputs, constant: constant, payable: payable)
+    let abiInputs = inputs ?? [ABI.Element.InOut]()
+    let payable = abiRecord.stateMutability == "payable" || abiRecord.payable == true
+    let functionElement = ABI.Element.Constructor(inputs: abiInputs, constant: false, payable: payable)
     return functionElement
 }
 
@@ -117,9 +110,9 @@ fileprivate func parseEvent(abiRecord: ABI.Record) throws -> ABI.Element.Event {
         let nativeInput = try input.parseForEvent()
         return nativeInput
     })
-    let abiInputs = inputs != nil ? inputs! : [ABI.Element.Event.Input]()
-    let name = abiRecord.name != nil ? abiRecord.name! : ""
-    let anonymous = abiRecord.anonymous != nil ? abiRecord.anonymous! : false
+    let abiInputs = inputs ?? [ABI.Element.Event.Input]()
+    let name = abiRecord.name ?? ""
+    let anonymous = abiRecord.anonymous ?? false
     let functionElement = ABI.Element.Event(name: name, inputs: abiInputs, anonymous: anonymous)
     return functionElement
 }
@@ -129,21 +122,25 @@ fileprivate func parseReceive(abiRecord: ABI.Record) throws -> ABI.Element.Recei
         let nativeInput = try input.parse()
         return nativeInput
     })
-    let abiInputs = inputs != nil ? inputs! : [ABI.Element.InOut]()
-    var payable = false
-    if (abiRecord.payable != nil) {
-        payable = abiRecord.payable!
-    }
-    if (abiRecord.stateMutability == "payable") {
-        payable = true
-    }
+    let abiInputs = inputs ?? [ABI.Element.InOut]()
+    let payable = abiRecord.stateMutability == "payable" || abiRecord.payable == true
     let functionElement = ABI.Element.Receive(inputs: abiInputs, payable: payable)
     return functionElement
 }
 
+fileprivate func parseError(abiRecord:ABI.Record) throws -> ABI.Element.EthError {
+    let inputs = try abiRecord.inputs?.map({ (input:ABI.Input) throws -> ABI.Element.EthError.Input in
+        let nativeInput = try input.parseForError()
+        return nativeInput
+    })
+    let abiInputs = inputs ?? []
+    let name = abiRecord.name ?? ""
+    return ABI.Element.EthError(name: name, inputs: abiInputs)
+}
+
 extension ABI.Input {
     func parse() throws -> ABI.Element.InOut {
-        let name = self.name != nil ? self.name! : ""
+        let name = self.name ?? ""
         let parameterType = try ABITypeParser.parseTypeString(self.type)
         if case .tuple(types: _) = parameterType {
             let components = try self.components?.compactMap({ (inp: ABI.Input) throws -> ABI.Element.ParameterType in
@@ -171,12 +168,18 @@ extension ABI.Input {
         }
     }
 
-    func parseForEvent() throws -> ABI.Element.Event.Input{
-        let name = self.name != nil ? self.name! : ""
+    func parseForEvent() throws -> ABI.Element.Event.Input {
+        let name = self.name ?? ""
         let parameterType = try ABITypeParser.parseTypeString(self.type)
         let indexed = self.indexed == true
         return ABI.Element.Event.Input(name: name, type: parameterType, indexed: indexed)
     }
+    
+    func parseForError() throws -> ABI.Element.EthError.Input {
+        let name = self.name ?? ""
+        let parameterType = try ABITypeParser.parseTypeString(self.type)
+        return ABI.Element.EthError.Input(name:name, type: parameterType)
+    }
 }
 
 extension ABI.Output {
diff --git a/Sources/web3swift/Web3/Web3+InfuraProviders.swift b/Sources/web3swift/Web3/Web3+InfuraProviders.swift
@@ -31,7 +31,7 @@ public enum BlockNumber {
 public final class InfuraProvider: Web3HttpProvider {
     public init?(_ net: Networks, accessToken token: String? = nil, keystoreManager manager: KeystoreManager? = nil) {
         var requestURLstring = "https://" + net.name + Constants.infuraHttpScheme
-        requestURLstring += token != nil ? token! : Constants.infuraToken
+        requestURLstring += token ?? Constants.infuraToken
         let providerURL = URL(string: requestURLstring)
         super.init(providerURL!, network: net, keystoreManager: manager)
     }
diff --git a/Tests/web3swiftTests/localTests/web3swiftDecodeSolidityErrorType.swift b/Tests/web3swiftTests/localTests/web3swiftDecodeSolidityErrorType.swift
@@ -0,0 +1,22 @@
+//
+//  web3swiftDecodeSolidityErrorType.swift
+//  Tests
+//
+//  Created by JeneaVranceanu on 25/01/2022.
+//  Copyright © 2022 web3swift. All rights reserved.
+//
+
+import XCTest
+import web3swift
+
+/// Since solidity 0.8.4 a new type was introduced called `error`.
+/// Contracts' ABI with this type were not decodable.
+class web3swiftDecodeSolidityErrorType: XCTestCase {
+
+    func testStructuredErrorTypeDecoding() throws {
+        let contractAbiWithErrorTypes = "[{\"inputs\":[{\"internalType\":\"address\",\"name\":\"from\",\"type\":\"address\"},{\"internalType\":\"address\",\"name\":\"disallowedAddress\",\"type\":\"address\"}],\"name\":\"NotAllowedAddress\",\"type\":\"error\"},{\"inputs\":[{\"internalType\":\"address\",\"name\":\"from\",\"type\":\"address\"},{\"internalType\":\"bytes4\",\"name\":\"disallowedFunction\",\"type\":\"bytes4\"}],\"name\":\"NotAllowedFunction\",\"type\":\"error\"},{\"inputs\":[{\"internalType\":\"address\",\"name\":\"from\",\"type\":\"address\"},{\"internalType\":\"string\",\"name\":\"permission\",\"type\":\"string\"}],\"name\":\"NotAuthorised\",\"type\":\"error\"}]"
+        let web3Instance = try Web3.new(URL.init(string: "http://127.0.0.1:8545")!)
+        let contract = web3.web3contract(web3: web3Instance, abiString: contractAbiWithErrorTypes)
+        assert(contract != nil)
+    }
+}
diff --git a/Tests/web3swiftTests/remoteTests/RemoteTests.xctestplan b/Tests/web3swiftTests/remoteTests/RemoteTests.xctestplan
@@ -21,6 +21,7 @@
         "SoliditySha3Test",
         "web3swiftAdvancedABIv2Tests",
         "web3swiftBasicLocalNodeTests",
+        "web3swiftDecodeSolidityErrorType",
         "web3swiftEIP67Tests",
         "web3swiftEIP681Tests",
         "web3swiftERC20ClassTests",
diff --git a/web3swift.xcodeproj/project.pbxproj b/web3swift.xcodeproj/project.pbxproj
@@ -194,6 +194,7 @@
 		5CF7E8BC276B79380009900F /* web3swiftWebsocketTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 5CF7E8B7276B79380009900F /* web3swiftWebsocketTests.swift */; };
 		604FA4FF27ECBDC80021108F /* DataConversionTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 604FA4FE27ECBDC80021108F /* DataConversionTests.swift */; };
 		CB50A52827060BD600D7E39B /* EIP712Tests.swift in Sources */ = {isa = PBXBuildFile; fileRef = CB50A52727060BD600D7E39B /* EIP712Tests.swift */; };
+		D606A56B279F5D59003643ED /* web3swiftDecodeSolidityErrorType.swift in Sources */ = {isa = PBXBuildFile; fileRef = D606A56A279F5D59003643ED /* web3swiftDecodeSolidityErrorType.swift */; };
 		D6A3D9B827F1E785009E3BCF /* ABIEncoderSoliditySha3Test.swift in Sources */ = {isa = PBXBuildFile; fileRef = D6A3D9B727F1E785009E3BCF /* ABIEncoderSoliditySha3Test.swift */; };
 		E22A911F241ED71A00EC1021 /* browser.min.js in Resources */ = {isa = PBXBuildFile; fileRef = E22A911E241ED71A00EC1021 /* browser.min.js */; };
 		E2B76710241ED479007EBFE3 /* browser.js in Resources */ = {isa = PBXBuildFile; fileRef = E2B7670F241ED479007EBFE3 /* browser.js */; };
@@ -416,6 +417,7 @@
 		604FA4FE27ECBDC80021108F /* DataConversionTests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = DataConversionTests.swift; sourceTree = "<group>"; };
 		CB50A52727060BD600D7E39B /* EIP712Tests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = EIP712Tests.swift; sourceTree = "<group>"; };
 		CB50A52927060C5300D7E39B /* EIP712.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = EIP712.swift; sourceTree = "<group>"; };
+		D606A56A279F5D59003643ED /* web3swiftDecodeSolidityErrorType.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = web3swiftDecodeSolidityErrorType.swift; sourceTree = "<group>"; };
 		D6A3D9B727F1E785009E3BCF /* ABIEncoderSoliditySha3Test.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ABIEncoderSoliditySha3Test.swift; sourceTree = "<group>"; };
 		E22A911E241ED71A00EC1021 /* browser.min.js */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.javascript; path = browser.min.js; sourceTree = "<group>"; };
 		E2B7670F241ED479007EBFE3 /* browser.js */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.javascript; path = browser.js; sourceTree = "<group>"; };
@@ -1014,6 +1016,7 @@
 				CB50A52727060BD600D7E39B /* EIP712Tests.swift */,
 				D6A3D9B727F1E785009E3BCF /* ABIEncoderSoliditySha3Test.swift */,
 				5CDEF973275A74670004A2F2 /* LocalTests.xctestplan */,
+				D606A56A279F5D59003643ED /* web3swiftDecodeSolidityErrorType.swift */,
 			);
 			path = localTests;
 			sourceTree = "<group>";
@@ -1386,6 +1389,8 @@
 			isa = PBXSourcesBuildPhase;
 			buildActionMask = 2147483647;
 			files = (
+				CB50A52827060BD600D7E39B /* EIP712Tests.swift in Sources */,
+				D606A56B279F5D59003643ED /* web3swiftDecodeSolidityErrorType.swift in Sources */,
 				5CF7E8AB276B792A0009900F /* web3swiftTests.swift in Sources */,
 				5CF7E8A4276B792A0009900F /* web3swiftTransactionsTests.swift in Sources */,
 				5C26D8A027F3725500431EB0 /* EIP1559BlockTests.swift in Sources */,

Original file line number	Diff line number	Diff line change
`@@ -44,6 +44,7 @@ public extension ABI {`
`44`	`44`	`case fallback(Fallback)`
`45`	`45`	`case event(Event)`
`46`	`46`	`case receive(Receive)`
	`47`	`+ case error(EthError)`
`47`	`48`
`48`	`49`	`public enum StateMutability {`
`49`	`50`	`case payable`
`@@ -152,6 +153,21 @@ public extension ABI {`
`152`	`153`	`self.payable = payable`
`153`	`154`	`}`
`154`	`155`	`}`
	`156`	`+ /// Custom structured error type available since solidity 0.8.4`
	`157`	`+ public struct EthError {`
	`158`	`+ public let name: String`
	`159`	`+ public let inputs: [Input]`
	`160`	`+`
	`161`	`+ public struct Input {`
	`162`	`+ public let name: String`
	`163`	`+ public let type: ParameterType`
	`164`	`+`
	`165`	`+ public init(name: String, type: ParameterType) {`
	`166`	`+ self.name = name`
	`167`	`+ self.type = type`
	`168`	`+ }`
	`169`	`+ }`
	`170`	`+ }`
`155`	`171`	`}`
`156`	`172`	`}`
`157`	`173`
`@@ -173,6 +189,8 @@ extension ABI.Element {`
`173`	`189`	`return signature + data`
`174`	`190`	`case .receive(_):`
`175`	`191`	`return nil`
	`192`	`+ case .error(_):`
	`193`	`+ return nil`
`176`	`194`	`}`
`177`	`195`	`}`
`178`	`196`	`}`
`@@ -249,6 +267,8 @@ extension ABI.Element {`
`249`	`267`	`return returnArray`
`250`	`268`	`case .receive(_):`
`251`	`269`	`return nil`
	`270`	`+ case .error(_):`
	`271`	`+ return nil`
`252`	`272`	`}`
`253`	`273`	`}`
`254`	`274`
`@@ -324,6 +344,8 @@ extension ABI.Element {`
`324`	`344`	`return returnArray`
`325`	`345`	`case .receive(_):`
`326`	`346`	`return nil`
	`347`	`+ case .error(_):`
	`348`	`+ return nil`
`327`	`349`	`}`
`328`	`350`	`}`
`329`	`351`	`}`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ public enum BlockNumber {`
`31`	`31`	`public final class InfuraProvider: Web3HttpProvider {`
`32`	`32`	`public init?(_ net: Networks, accessToken token: String? = nil, keystoreManager manager: KeystoreManager? = nil) {`
`33`	`33`	`var requestURLstring = "https://" + net.name + Constants.infuraHttpScheme`
`34`		`- requestURLstring += token != nil ? token! : Constants.infuraToken`
	`34`	`+ requestURLstring += token ?? Constants.infuraToken`
`35`	`35`	`let providerURL = URL(string: requestURLstring)`
`36`	`36`	`super.init(providerURL!, network: net, keystoreManager: manager)`
`37`	`37`	`}`