feat: decoding ABI with solidity error types

JeneaVranceanu · JeneaVranceanu · commit 3e5da9f8ca3e · 2022-01-25T01:03:27.000+02:00
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
@@ -31,6 +31,7 @@ extension ABI {
         case fallback
         case event
         case receive
+        case error
     }
     
 }
@@ -62,6 +63,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)
     }
     
 }
@@ -142,6 +146,16 @@ fileprivate func parseReceive(abiRecord:ABI.Record) throws -> ABI.Element.Receiv
     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 != nil ? 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! : ""
@@ -172,12 +186,18 @@ extension ABI.Input {
         }
     }
     
-    func parseForEvent() throws -> ABI.Element.Event.Input{
+    func parseForEvent() throws -> ABI.Element.Event.Input {
         let name = self.name != nil ? 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 != nil ? self.name! : ""
+        let parameterType = try ABITypeParser.parseTypeString(self.type)
+        return ABI.Element.EthError.Input(name:name, type: parameterType)
+    }
 }
 
 extension ABI.Output {
diff --git a/Tests/web3swiftTests/local_tests/web3swift_decodeSolidityErrorType.swift b/Tests/web3swiftTests/local_tests/web3swift_decodeSolidityErrorType.swift
@@ -0,0 +1,22 @@
+//
+//  web3swift_decodeSolidityErrorType.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 web3swift_decodeSolidityErrorType: XCTestCase {
+
+    func test_structuredErrorTypeDecoding() 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/web3swift.xcodeproj/project.pbxproj b/web3swift.xcodeproj/project.pbxproj
@@ -191,6 +191,7 @@
 		5C03EADF274406410052C66D /* web3swift_AdvancedABIv2_Tests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 5C03EACD274406400052C66D /* web3swift_AdvancedABIv2_Tests.swift */; };
 		5C03EAE0274406410052C66D /* web3swift_transactions_Tests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 5C03EACE274406410052C66D /* web3swift_transactions_Tests.swift */; };
 		CB50A52827060BD600D7E39B /* web3swift_EIP712_Tests.swift in Sources */ = {isa = PBXBuildFile; fileRef = CB50A52727060BD600D7E39B /* web3swift_EIP712_Tests.swift */; };
+		D606A56B279F5D59003643ED /* web3swift_decodeSolidityErrorType.swift in Sources */ = {isa = PBXBuildFile; fileRef = D606A56A279F5D59003643ED /* web3swift_decodeSolidityErrorType.swift */; };
 		E22A911F241ED71A00EC1021 /* browser.min.js in Resources */ = {isa = PBXBuildFile; fileRef = E22A911E241ED71A00EC1021 /* browser.min.js */; };
 		E252E67F26B403F500717C16 /* web3swift_helpers.swift in Sources */ = {isa = PBXBuildFile; fileRef = E252E67E26B403F500717C16 /* web3swift_helpers.swift */; };
 		E2B76710241ED479007EBFE3 /* browser.js in Resources */ = {isa = PBXBuildFile; fileRef = E2B7670F241ED479007EBFE3 /* browser.js */; };
@@ -405,11 +406,12 @@
 		5C03EACC274406400052C66D /* web3swift_User_cases.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = web3swift_User_cases.swift; sourceTree = "<group>"; };
 		5C03EACD274406400052C66D /* web3swift_AdvancedABIv2_Tests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = web3swift_AdvancedABIv2_Tests.swift; sourceTree = "<group>"; };
 		5C03EACE274406410052C66D /* web3swift_transactions_Tests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = web3swift_transactions_Tests.swift; sourceTree = "<group>"; };
-		5CDEF972275A74590004A2F2 /* web3swift.xctestplan */ = {isa = PBXFileReference; lastKnownFileType = file; name = web3swift.xctestplan; path = Tests/web3swiftTests/web3swift.xctestplan; sourceTree = SOURCE_ROOT; };
+		5CDEF972275A74590004A2F2 /* web3swift.xctestplan */ = {isa = PBXFileReference; lastKnownFileType = text; name = web3swift.xctestplan; path = Tests/web3swiftTests/web3swift.xctestplan; sourceTree = SOURCE_ROOT; };
 		5CDEF973275A74670004A2F2 /* LocalTests.xctestplan */ = {isa = PBXFileReference; lastKnownFileType = text; path = LocalTests.xctestplan; sourceTree = "<group>"; };
 		5CDEF974275A747B0004A2F2 /* RemoteTests.xctestplan */ = {isa = PBXFileReference; lastKnownFileType = text; path = RemoteTests.xctestplan; sourceTree = "<group>"; };
 		CB50A52727060BD600D7E39B /* web3swift_EIP712_Tests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = web3swift_EIP712_Tests.swift; sourceTree = "<group>"; };
 		CB50A52927060C5300D7E39B /* EIP712.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = EIP712.swift; sourceTree = "<group>"; };
+		D606A56A279F5D59003643ED /* web3swift_decodeSolidityErrorType.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = web3swift_decodeSolidityErrorType.swift; sourceTree = "<group>"; };
 		E22A911E241ED71A00EC1021 /* browser.min.js */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.javascript; path = browser.min.js; sourceTree = "<group>"; };
 		E252E67E26B403F500717C16 /* web3swift_helpers.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = web3swift_helpers.swift; sourceTree = "<group>"; };
 		E2B7670F241ED479007EBFE3 /* browser.js */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.javascript; path = browser.js; sourceTree = "<group>"; };
@@ -1005,6 +1007,7 @@
 				5C03EACC274406400052C66D /* web3swift_User_cases.swift */,
 				E252E67E26B403F500717C16 /* web3swift_helpers.swift */,
 				5CDEF973275A74670004A2F2 /* LocalTests.xctestplan */,
+				D606A56A279F5D59003643ED /* web3swift_decodeSolidityErrorType.swift */,
 			);
 			path = local_tests;
 			sourceTree = "<group>";
@@ -1384,6 +1387,7 @@
 				5C03EACF274406410052C66D /* web3swift_helpers.swift in Sources */,
 				5C03EAD4274406410052C66D /* web3swift_numberFormattingUtil_Tests.swift in Sources */,
 				CB50A52827060BD600D7E39B /* web3swift_EIP712_Tests.swift in Sources */,
+				D606A56B279F5D59003643ED /* web3swift_decodeSolidityErrorType.swift in Sources */,
 				5C03EAE0274406410052C66D /* web3swift_transactions_Tests.swift in Sources */,
 				5C03EAD9274406410052C66D /* web3swift_keystores_Tests.swift in Sources */,
 				5C03EAD8274406410052C66D /* web3swift_Eventloop_Tests.swift in Sources */,
diff --git a/web3swift.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist b/web3swift.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>IDEDidComputeMac32BitWarning</key>
+	<true/>
+</dict>
+</plist>

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,6 +31,7 @@ extension ABI {`
`31`	`31`	`case fallback`
`32`	`32`	`case event`
`33`	`33`	`case receive`
	`34`	`+ case error`
`34`	`35`	`}`
`35`	`36`
`36`	`37`	`}`
`@@ -62,6 +63,9 @@ fileprivate func parseToElement(from abiRecord: ABI.Record, type: ABI.ElementTyp`
`62`	`63`	`case .receive:`
`63`	`64`	`let receive = try parseReceive(abiRecord: abiRecord)`
`64`	`65`	`return ABI.Element.receive(receive)`
	`66`	`+ case .error:`
	`67`	`+ let error = try parseError(abiRecord: abiRecord)`
	`68`	`+ return ABI.Element.error(error)`
`65`	`69`	`}`
`66`	`70`
`67`	`71`	`}`
`@@ -142,6 +146,16 @@ fileprivate func parseReceive(abiRecord:ABI.Record) throws -> ABI.Element.Receiv`
`142`	`146`	`return functionElement`
`143`	`147`	`}`
`144`	`148`
	`149`	`+fileprivate func parseError(abiRecord:ABI.Record) throws -> ABI.Element.EthError {`
	`150`	`+ let inputs = try abiRecord.inputs?.map({ (input:ABI.Input) throws -> ABI.Element.EthError.Input in`
	`151`	`+ let nativeInput = try input.parseForError()`
	`152`	`+ return nativeInput`
	`153`	`+ })`
	`154`	`+ let abiInputs = inputs ?? []`
	`155`	`+ let name = abiRecord.name != nil ? abiRecord.name! : ""`
	`156`	`+ return ABI.Element.EthError(name: name, inputs: abiInputs)`
	`157`	`+}`
	`158`	`+`
`145`	`159`	`extension ABI.Input {`
`146`	`160`	`func parse() throws -> ABI.Element.InOut {`
`147`	`161`	`let name = self.name != nil ? self.name! : ""`
`@@ -172,12 +186,18 @@ extension ABI.Input {`
`172`	`186`	`}`
`173`	`187`	`}`
`174`	`188`
`175`		`- func parseForEvent() throws -> ABI.Element.Event.Input{`
	`189`	`+ func parseForEvent() throws -> ABI.Element.Event.Input {`
`176`	`190`	`let name = self.name != nil ? self.name! : ""`
`177`	`191`	`let parameterType = try ABITypeParser.parseTypeString(self.type)`
`178`	`192`	`let indexed = self.indexed == true`
`179`	`193`	`return ABI.Element.Event.Input(name:name, type: parameterType, indexed: indexed)`
`180`	`194`	`}`
	`195`	`+`
	`196`	`+ func parseForError() throws -> ABI.Element.EthError.Input {`
	`197`	`+ let name = self.name != nil ? self.name! : ""`
	`198`	`+ let parameterType = try ABITypeParser.parseTypeString(self.type)`
	`199`	`+ return ABI.Element.EthError.Input(name:name, type: parameterType)`
	`200`	`+ }`
`181`	`201`	`}`
`182`	`202`
`183`	`203`	`extension ABI.Output {`