Implement IBAN under Web3.Utils.Iban

Author: Alex Vlasov

README.md

@@ -72,7 +72,7 @@ You can try it by yourself by running the example project:
 
 ### Requirements
 
-Web3swift requires Swift 4.1 and iOS 9.0 or macOS 10.13 although we recommend to use the latest iOS and MacOS versions for your own safety. Don't forget to set iOS version i na Podfile, otherwise you get an error if deployment target is less than the latest SDK.
+Web3swift requires Swift 4.1 and iOS 9.0 or macOS 10.13 although we recommend to use the latest iOS and MacOS versions for your own safety. Don't forget to set iOS version in a Podfile, otherwise you get an error if deployment target is less than the latest SDK.
 
 ### Installation
 
@@ -113,7 +113,7 @@ Changes from this branch will be merged into the [master](https://github.com/BAN
 
 ## Appreciation
 
-When using this pod references to this repo, [Bankex](http://bankex.com) and [Bankex Foundation](http://bankexfoundation.org) are appreciated.
+When using this pod references to this repo, [BANKEX](http://bankex.com) and [BANKEX Foundation](http://bankexfoundation.org) are appreciated.
 
 ## Authors
 

web3swift.xcodeproj/project.pbxproj

@@ -94,6 +94,8 @@
 		815630002007B48800A0EC2F /* BIP32KeystoreJSONStructure.swift in Sources */ = {isa = PBXBuildFile; fileRef = 81562FFF2007B48800A0EC2F /* BIP32KeystoreJSONStructure.swift */; };
 		815630022007B53C00A0EC2F /* BIP32Keystore.swift in Sources */ = {isa = PBXBuildFile; fileRef = 815630012007B53C00A0EC2F /* BIP32Keystore.swift */; };
 		815630042007BC8F00A0EC2F /* BIP39+WordLists.swift in Sources */ = {isa = PBXBuildFile; fileRef = 815630032007BC8F00A0EC2F /* BIP39+WordLists.swift */; };
+		8160E5CE20B8245A0070070B /* IBAN.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8160E5CD20B8245A0070070B /* IBAN.swift */; };
+		8160E5CF20B8245A0070070B /* IBAN.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8160E5CD20B8245A0070070B /* IBAN.swift */; };
 		817EBB102004FE2800E02EAA /* EthereumAddress.swift in Sources */ = {isa = PBXBuildFile; fileRef = 817EBB0F2004FE2800E02EAA /* EthereumAddress.swift */; };
 		817EBB122004FE2F00E02EAA /* BIP32HDNode.swift in Sources */ = {isa = PBXBuildFile; fileRef = 817EBB112004FE2F00E02EAA /* BIP32HDNode.swift */; };
 		817EBB162004FE4200E02EAA /* Web3+HttpProvider.swift in Sources */ = {isa = PBXBuildFile; fileRef = 817EBB142004FE4200E02EAA /* Web3+HttpProvider.swift */; };
@@ -247,6 +249,7 @@
 		815630012007B53C00A0EC2F /* BIP32Keystore.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BIP32Keystore.swift; sourceTree = "<group>"; };
 		815630032007BC8F00A0EC2F /* BIP39+WordLists.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "BIP39+WordLists.swift"; sourceTree = "<group>"; };
 		815630052008A64C00A0EC2F /* Security.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = Security.framework; path = System/Library/Frameworks/Security.framework; sourceTree = SDKROOT; };
+		8160E5CD20B8245A0070070B /* IBAN.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = IBAN.swift; sourceTree = "<group>"; };
 		817EBB0F2004FE2800E02EAA /* EthereumAddress.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = EthereumAddress.swift; sourceTree = "<group>"; };
 		817EBB112004FE2F00E02EAA /* BIP32HDNode.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = BIP32HDNode.swift; sourceTree = "<group>"; };
 		817EBB142004FE4200E02EAA /* Web3+HttpProvider.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = "Web3+HttpProvider.swift"; sourceTree = "<group>"; };
@@ -491,6 +494,7 @@
 				81531A9F1FE7C07A002192CC /* EthereumKeystoreV3.swift */,
 				817EBB26200673D100E02EAA /* KeystoreV3JSONStructure.swift */,
 				8103BBCB2077B84400499769 /* PlainKeystore.swift */,
+				8160E5CD20B8245A0070070B /* IBAN.swift */,
 			);
 			path = Classes;
 			sourceTree = "<group>";
@@ -1057,6 +1061,7 @@
 				81C5DA282072E18200424CD6 /* NativeTypesEncoding+Extensions.swift in Sources */,
 				8123E1C7200CBAC200B6D3AB /* Dictionary+Extension.swift in Sources */,
 				81D7D97820A61E3800A193EC /* EventFiltering.swift in Sources */,
+				8160E5CE20B8245A0070070B /* IBAN.swift in Sources */,
 				8103BBC920779E2200499769 /* Web3+TransactionAndBlockDetailsOperations.swift in Sources */,
 				81FB21F12078142D007F9A83 /* Web3+Deprecated.swift in Sources */,
 				810B0F9C1FEC520500CF0DA2 /* Web3+Methods.swift in Sources */,
@@ -1147,6 +1152,7 @@
 				41948130203630530065A83B /* BIP32Keystore.swift in Sources */,
 				8103BBCA20779E2200499769 /* Web3+TransactionAndBlockDetailsOperations.swift in Sources */,
 				81D7D97920A61E3800A193EC /* EventFiltering.swift in Sources */,
+				8160E5CF20B8245A0070070B /* IBAN.swift in Sources */,
 				81FB21F22078142D007F9A83 /* Web3+Deprecated.swift in Sources */,
 				41948131203630530065A83B /* BIP32KeystoreJSONStructure.swift in Sources */,
 				41948132203630530065A83B /* BIP32HDNode.swift in Sources */,

web3swift/Convenience/Classes/String+Extension.swift

@@ -46,6 +46,12 @@ extension String {
         return String(self[start..<end])
     }
 
+    subscript (bounds: CountablePartialRangeFrom<Int>) -> String {
+        let start = index(self.startIndex, offsetBy: bounds.lowerBound)
+        let end = self.endIndex
+        return String(self[start..<end])
+    }
+    
     func leftPadding(toLength: Int, withPad character: Character) -> String {
         let stringLength = self.count
         if stringLength < toLength {
@@ -113,4 +119,20 @@ extension String {
             else { return nil }
         return from ..< to
     }
+    
+    var asciiValue: Int {
+        get {
+            let s = self.unicodeScalars
+            return Int(s[s.startIndex].value)
+        }
+    }
+}
+
+extension Character {
+    var asciiValue: Int {
+        get {
+            let s = String(self).unicodeScalars
+            return Int(s[s.startIndex].value)
+        }
+    }
 }

web3swift/KeystoreManager/Classes/EthereumAddress.swift

@@ -100,4 +100,13 @@ public struct EthereumAddress: Equatable {
     public static func contractDeploymentAddress() -> EthereumAddress {
         return EthereumAddress("0x", type: .contractDeployment)!
     }
+    
+//    public static func fromIBAN(_ iban: String) -> EthereumAddress {
+//
+//    }
+    
 }
+
+
+
+

web3swift/KeystoreManager/Classes/IBAN.swift

@@ -0,0 +1,139 @@
+//
+//  IBAN.swift
+//  web3swift
+//
+//  Created by Alexander Vlasov on 25.05.2018.
+//  Copyright © 2018 Bankex Foundation. All rights reserved.
+//
+
+import Foundation
+import BigInt
+
+public struct ICAP {
+    public var asset: String
+    public var institution: String
+    public var client: String
+}
+
+public struct IBAN {
+    public var iban: String
+    
+    public var isDirect: Bool {
+        return self.iban.count == 34 || self.iban.count == 35
+    }
+
+    public var isIndirect: Bool {
+        return self.iban.count == 20
+    }
+    
+    public var checksum: String {
+        return self.iban[2..<4];
+    }
+    
+    public var asset: String {
+        if (self.isIndirect) {
+            return self.iban[4..<7]
+        } else {
+            return ""
+        }
+    }
+    
+    public var institution : String {
+        if (self.isIndirect) {
+            return self.iban[7..<11]
+        } else {
+            return ""
+        }
+    }
+    
+    public var client : String {
+        if self.isIndirect {
+            return self.iban[11...]
+        } else {
+            return ""
+        }
+    }
+    
+    
+    public func toEthereumAddress() -> EthereumAddress? {
+        if self.isDirect {
+            let base36 = self.iban[4...];
+            guard let asBigNumber = BigUInt(base36, radix: 36) else {return  nil}
+            let addressString = String(asBigNumber, radix: 16).leftPadding(toLength: 40, withPad: "0")
+            return EthereumAddress(addressString.addHexPrefix())
+        } else {
+            return nil
+        }
+    }
+    
+    internal static func decodeToInts(_ iban: String) -> String {
+//        let codePointForA = "A".asciiValue
+//        let codePointForZ = "Z".asciiValue
+
+        let uppercasedIBAN = iban.replacingOccurrences(of: " ", with: "").uppercased()
+        let begining = String(uppercasedIBAN[0..<4])
+        let end = String(uppercasedIBAN[4...])
+        let IBAN = end + begining
+        var arrayOfInts = [Int]()
+        for ch in IBAN {
+            guard let dataPoint = String(ch).data(using: .ascii) else {return ""}
+            guard dataPoint.count == 1 else {return ""}
+            let code = Int(dataPoint[0])
+            if code >= 65 && code <= 90 {
+                arrayOfInts.append(code - 65 + 10)
+            } else {
+                arrayOfInts.append(code - 48)
+            }
+        }
+        let joinedString = arrayOfInts.map({ (intCh) -> String in
+            return String(intCh)
+        }).joined()
+        return joinedString
+    }
+    
+    internal static func calculateChecksumMod97(_ preparedString: String) -> Int {
+        var m = 0
+        for digit in preparedString.split(intoChunksOf: 1) {
+            m = m * 10
+            m = m + Int(digit)!
+            m = m % 97
+        }
+        return m
+    }
+    
+    public static func isValidIBANaddress(_ iban: String, noValidityCheck: Bool = false) -> Bool {
+        let regex = "^XE[0-9]{2}(ETH[0-9A-Z]{13}|[0-9A-Z]{30,31})$"
+        let matcher = try! NSRegularExpression(pattern: regex, options: NSRegularExpression.Options.dotMatchesLineSeparators)
+        let match = matcher.matches(in: iban, options: NSRegularExpression.MatchingOptions.anchored, range: iban.fullNSRange)
+        guard match.count == 1 else {
+            return false
+        }
+        if (iban.hasPrefix("XE") && !noValidityCheck) {
+            let remainder = calculateChecksumMod97(decodeToInts(iban))
+            return remainder == 1
+        } else {
+            return true
+        }
+    }
+    
+    public init?(_ ibanString: String) {
+        let matched = ibanString.replacingOccurrences(of: " ", with: "").uppercased()
+        guard IBAN.isValidIBANaddress(matched) else {return nil}
+        self.iban = matched
+    }
+    
+    public init?(_ address: EthereumAddress) {
+        let addressString = address.address.lowercased().stripHexPrefix()
+        guard let bigNumber = BigUInt(addressString, radix: 16) else {return nil}
+        let base36EncodedString = String(bigNumber, radix: 36);
+        guard base36EncodedString.count <= 30 else {return nil}
+        let padded = base36EncodedString.leftPadding(toLength: 30, withPad: "0")
+        let prefix = "XE"
+        let remainder = IBAN.calculateChecksumMod97(IBAN.decodeToInts(prefix + "00" + padded));
+        let checkDigits = "0" + String(98 - remainder)
+        let twoDigits = checkDigits[checkDigits.count-2..<checkDigits.count]
+        let fullIban = prefix + twoDigits + padded
+        self.iban = fullIban.uppercased()
+    }
+    
+}

web3swift/Web3/Classes/Web3+Utils.swift

@@ -14,6 +14,8 @@ public typealias Web3Utils = Web3.Utils
 
 extension Web3 {
     public struct Utils {
+        
+        typealias Iban = IBAN
     }
 }
 

web3swiftTests/web3swiftTests.swift

@@ -2339,6 +2339,20 @@ class web3swiftTests: XCTestCase {
         XCTAssert(formatted == "-1,1000")
     }
 
+    func testIBANcreation() {
+        let iban = "XE7338O073KYGTWWZN0F2WZ0R8PX5ZPPZS"
+        let native = Web3.Utils.Iban(iban)
+        XCTAssert(native != nil)
+        let expectedAddress = "0x00c5496aEe77C1bA1f0854206A26DdA82a81D6D8"
+        let createdAddress = native?.toEthereumAddress()?.address
+        XCTAssert(createdAddress == expectedAddress)
+        
+        let address = EthereumAddress("0x03c5496aee77c1ba1f0854206a26dda82a81d6d8")!
+        let fromAddress = Web3.Utils.Iban(address)
+        let ibn = fromAddress?.iban
+        XCTAssert(ibn == "XE83FUTTUNPK7WZJSGGCWVEBARQWQ8YML4")
+    }
+    
     func testPerformanceExample() {
         // This is an example of a performance test case.
         self.measure {