chore: merge with develop

Author: JeneaVranceanu

Example/myWeb3Wallet/Podfile

@@ -1,5 +1,5 @@
 # Uncomment the next line to define a global platform for your project
-# platform :ios, '9.0'
+platform :ios, '15.0'
 
 target 'myWeb3Wallet' do
   # Comment the next line if you don't want to use dynamic frameworks
@@ -19,3 +19,12 @@ pod 'web3swift', :git => 'https://github.com/veerChauhan/web3swift.git', :branch
   end
 
 end
+
+# set iOS deployment target for every pod to avoid warnings
+post_install do |installer|
+  installer.pods_project.targets.each do |target|
+    target.build_configurations.each do |config|
+      config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] = '15.0'
+    end
+  end
+end

Example/myWeb3Wallet/myWeb3Wallet.xcodeproj/project.pbxproj

@@ -754,7 +754,7 @@
 			isa = XCBuildConfiguration;
 			baseConfigurationReference = D6018FABA256C0117F85A829 /* Pods-myWeb3Wallet-myWeb3WalletUITests.debug.xcconfig */;
 			buildSettings = {
-				ALWAYS_EMBED_SWIFT_STANDARD_LIBRARIES = YES;
+				ALWAYS_EMBED_SWIFT_STANDARD_LIBRARIES = "$(inherited)";
 				CODE_SIGN_STYLE = Automatic;
 				CURRENT_PROJECT_VERSION = 1;
 				DEVELOPMENT_TEAM = VPS9LBWQ55;
@@ -778,7 +778,7 @@
 			isa = XCBuildConfiguration;
 			baseConfigurationReference = 7574A738941D92CC94F93A9E /* Pods-myWeb3Wallet-myWeb3WalletUITests.release.xcconfig */;
 			buildSettings = {
-				ALWAYS_EMBED_SWIFT_STANDARD_LIBRARIES = YES;
+				ALWAYS_EMBED_SWIFT_STANDARD_LIBRARIES = "$(inherited)";
 				CODE_SIGN_STYLE = Automatic;
 				CURRENT_PROJECT_VERSION = 1;
 				DEVELOPMENT_TEAM = VPS9LBWQ55;

Sources/Web3Core/KeystoreManager/BIP44.swift

@@ -0,0 +1,126 @@
+//
+//  BIP44.swift
+//  Created by Alberto Penas Amor on 15/12/22.
+//
+
+import Foundation
+
+public protocol BIP44 {
+    /**
+    Derive an ``HDNode`` based on the provided path. The function will throw ``BIP44Error.warning`` if it was invoked with throwOnWarning equal to
+    `true` and the root key doesn't have a previous child with at least one transaction. If it is invoked with throwOnError equal to `false` the child node will be
+    derived directly using the derive function of ``HDNode``. This function needs to query the blockchain history when throwOnWarning is `true`, so it can throw
+    network errors.
+    - Parameter path: valid BIP44 path.
+    - Parameter throwOnWarning: `true` to use
+    [Account Discovery](https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki#account-discovery) standard,
+    otherwise it will dervive the key using the derive function of ``HDNode``.
+    - Throws: ``BIP44Error.warning`` if the child key shouldn't be used according to
+    [Account Discovery](https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki#account-discovery) standard.
+    - Returns: an ``HDNode`` child key for the provided `path` if it can be created, otherwise `nil`
+    */
+    func derive(path: String, throwOnWarning: Bool, transactionChecker: TransactionChecker) async throws -> HDNode?
+}
+
+public enum BIP44Error: LocalizedError, Equatable {
+    /// The selected path doesn't fulfill BIP44 standard, you can derive the root key anyway
+    case warning
+
+    public var errorDescription: String? {
+        switch self {
+        case .warning:
+            return "Couldn't derive key as it doesn't have a previous account with at least one transaction"
+        }
+    }
+}
+
+public protocol TransactionChecker {
+    /**
+    It verifies if the provided address has at least one transaction
+    - Parameter address: to be queried
+    - Throws: any error related to query the blockchain provider
+    - Returns: `true` if the address has at least one transaction, `false` otherwise
+    */
+    func hasTransactions(address: String) async throws -> Bool
+}
+
+extension HDNode: BIP44 {
+    public func derive(path: String, throwOnWarning: Bool = true, transactionChecker: TransactionChecker) async throws -> HDNode? {
+        guard throwOnWarning else {
+            return derive(path: path, derivePrivateKey: true)
+        }
+        guard let account = path.accountFromPath else {
+            return nil
+        }
+        if account == 0 {
+            return derive(path: path, derivePrivateKey: true)
+        } else {
+            for searchAccount in 0..<account {
+                let maxUnusedAddressIndexes = 20
+                var hasTransactions = false
+                for searchAddressIndex in 0..<maxUnusedAddressIndexes {
+                    if let searchPath = path.newPath(account: searchAccount, addressIndex: searchAddressIndex),
+                    let childNode = derive(path: searchPath, derivePrivateKey: true),
+                    let ethAddress = Utilities.publicToAddress(childNode.publicKey) {
+                        hasTransactions = try await transactionChecker.hasTransactions(address: ethAddress.address)
+                        if hasTransactions {
+                            break
+                        }
+                    }
+                }
+                if !hasTransactions {
+                    throw BIP44Error.warning
+                }
+            }
+            return derive(path: path, derivePrivateKey: true)
+        }
+    }
+}
+
+extension String {
+    /// Verifies if self matches BIP44 path
+    var isBip44Path: Bool {
+        do {
+            let pattern = "^m/44'/\\d+'/\\d+'/[0-1]/\\d+$"
+            let regex = try NSRegularExpression(pattern: pattern, options: [.caseInsensitive])
+            let matches = regex.numberOfMatches(in: self, range: NSRange(location: 0, length: utf16.count))
+            return matches == 1
+        } catch {
+            return false
+        }
+    }
+
+    /// Returns the account from the path if self contains a well formed BIP44 path
+    var accountFromPath: Int? {
+        guard isBip44Path else {
+            return nil
+        }
+        let components = components(separatedBy: "/")
+        let accountIndex = 3
+        let rawAccount = components[accountIndex].trimmingCharacters(in: CharacterSet(charactersIn: "'"))
+        guard let account = Int(rawAccount) else {
+            return nil
+        }
+        return account
+    }
+
+    /**
+    Transforms a bip44 path into a new one changing account & index. The resulting one will have the change value equal to `0` to represent the external chain. The format will be `m/44'/coin_type'/account'/change/address_index`
+    - Parameter account: the new account to use
+    - Parameter addressIndex: the new addressIndex to use
+    - Returns: a valid bip44 path with the provided account, addressIndex and external change or `nil` otherwise
+    */
+    func newPath(account: Int, addressIndex: Int) -> String? {
+        guard isBip44Path else {
+            return nil
+        }
+        var components = components(separatedBy: "/")
+        let accountPosition = 3
+        components[accountPosition] = "\(account)'"
+        let changePosition = 4
+        components[changePosition] = "0"
+        let addressIndexPosition = 5
+        components[addressIndexPosition] = "\(addressIndex)"
+        return components.joined(separator: "/")
+    }
+}

Sources/Web3Core/KeystoreManager/EtherscanTransactionChecker.swift

@@ -0,0 +1,62 @@
+//
+//  EtherscanTransactionChecker.swift
+//  Created by albertopeam on 28/12/22.
+//
+
+import Foundation
+
+public struct EtherscanTransactionChecker: TransactionChecker {
+    private let urlSession: URLSessionProxy
+    private let apiKey: String
+
+    public init(urlSession: URLSession, apiKey: String) {
+        self.urlSession = URLSessionProxyImplementation(urlSession: urlSession)
+        self.apiKey = apiKey
+    }
+
+    internal init(urlSession: URLSessionProxy, apiKey: String) {
+        self.urlSession = urlSession
+        self.apiKey = apiKey
+    }
+
+    public func hasTransactions(address: String) async throws -> Bool {
+        let urlString = "https://api.etherscan.io/api?module=account&action=txlist&address=\(address)&startblock=0&page=1&offset=1&sort=asc&apikey=\(apiKey)"
+        guard let url = URL(string: urlString) else {
+            throw EtherscanTransactionCheckerError.invalidUrl(url: urlString)
+        }
+        let request = URLRequest(url: url)
+        let result = try await urlSession.data(for: request)
+        let response = try JSONDecoder().decode(Response.self, from: result.0)
+        return !response.result.isEmpty
+    }
+}
+
+extension EtherscanTransactionChecker {
+    struct Response: Codable {
+        let result: [Transaction]
+    }
+    struct Transaction: Codable {}
+}
+
+public enum EtherscanTransactionCheckerError: LocalizedError, Equatable {
+    case invalidUrl(url: String)
+
+    public var errorDescription: String? {
+        switch self {
+        case let .invalidUrl(url):
+            return "Couldn't create URL(string: \(url))"
+        }
+    }
+}
+
+internal protocol URLSessionProxy {
+    func data(for request: URLRequest) async throws -> (Data, URLResponse)
+}
+
+internal struct URLSessionProxyImplementation: URLSessionProxy {
+    let urlSession: URLSession
+
+    func data(for request: URLRequest) async throws -> (Data, URLResponse) {
+        try await urlSession.data(for: request)
+    }
+}

Sources/Web3Core/Structure/Transaction/TransactionReceipt.swift

@@ -16,12 +16,13 @@ public struct TransactionReceipt {
     public var contractAddress: EthereumAddress?
     public var cumulativeGasUsed: BigUInt
     public var gasUsed: BigUInt
+    public var effectiveGasPrice: BigUInt
     public var logs: [EventLog]
     public var status: TXStatus
     public var logsBloom: EthereumBloomFilter?
 
     static func notProcessed(transactionHash: Data) -> TransactionReceipt {
-        TransactionReceipt(transactionHash: transactionHash, blockHash: Data(), blockNumber: BigUInt(0), transactionIndex: BigUInt(0), contractAddress: nil, cumulativeGasUsed: BigUInt(0), gasUsed: BigUInt(0), logs: [EventLog](), status: .notYetProcessed, logsBloom: nil)
+        TransactionReceipt(transactionHash: transactionHash, blockHash: Data(), blockNumber: 0, transactionIndex: 0, contractAddress: nil, cumulativeGasUsed: 0, gasUsed: 0, effectiveGasPrice: 0, logs: [], status: .notYetProcessed, logsBloom: nil)
     }
 }
 
@@ -45,6 +46,7 @@ extension TransactionReceipt: Decodable {
         case logs
         case logsBloom
         case status
+        case effectiveGasPrice
     }
 
     public init(from decoder: Decoder) throws {
@@ -64,6 +66,8 @@ extension TransactionReceipt: Decodable {
 
         self.gasUsed = try container.decodeHex(BigUInt.self, forKey: .gasUsed)
 
+        self.effectiveGasPrice = (try? container.decodeHex(BigUInt.self, forKey: .effectiveGasPrice)) ?? 0
+
         let status = try? container.decodeHex(BigUInt.self, forKey: .status)
         switch status {
         case nil: self.status = .notYetProcessed
@@ -72,6 +76,10 @@ extension TransactionReceipt: Decodable {
         }
 
         self.logs = try container.decode([EventLog].self, forKey: .logs)
+
+        if let hexBytes = try? container.decodeHex(Data.self, forKey: .logsBloom) {
+            self.logsBloom = EthereumBloomFilter(hexBytes)
+        }
     }
 }
 

Sources/web3swift/Utils/ENS/ENS.swift

@@ -74,8 +74,7 @@ public class ENS {
         self.reverseRegistrar = reverseRegistrar
     }
 
-    // FIXME: Rewrite this to CodableTransaction
-    lazy var defaultOptions: CodableTransaction = {
+    lazy var defaultTransaction: CodableTransaction = {
         return CodableTransaction.emptyTransaction
     }()
 
@@ -107,7 +106,7 @@ public class ENS {
         guard isAddrSupports else {
             throw Web3Error.processingError(desc: "Address isn't supported")
         }
-        var options = options ?? defaultOptions
+        var options = options ?? defaultTransaction
         options.to = resolver.resolverContractAddress
         guard let result = try? await resolver.setAddress(forNode: node, address: address, options: options, password: password) else {
             throw Web3Error.processingError(desc: "Can't get result")
@@ -142,7 +141,7 @@ public class ENS {
         guard isNameSupports else {
             throw Web3Error.processingError(desc: "Name isn't supported")
         }
-        var options = options ?? defaultOptions
+        var options = options ?? defaultTransaction
         options.to = resolver.resolverContractAddress
         guard let result = try? await resolver.setCanonicalName(forNode: node, name: name, options: options, password: password) else {
             throw Web3Error.processingError(desc: "Can't get result")
@@ -178,7 +177,7 @@ public class ENS {
         guard isContentSupports else {
             throw Web3Error.processingError(desc: "Content isn't supported")
         }
-        var options = options ?? defaultOptions
+        var options = options ?? defaultTransaction
         options.to = resolver.resolverContractAddress
         guard let result = try? await resolver.setContentHash(forNode: node, hash: hash, options: options, password: password) else {
             throw Web3Error.processingError(desc: "Can't get result")
@@ -213,7 +212,7 @@ public class ENS {
         guard isABISupports else {
             throw Web3Error.processingError(desc: "ABI isn't supported")
         }
-        var options = options ?? defaultOptions
+        var options = options ?? defaultTransaction
         options.to = resolver.resolverContractAddress
         guard let result = try? await resolver.setContractABI(forNode: node, contentType: contentType, data: data, options: options, password: password) else {
             throw Web3Error.processingError(desc: "Can't get result")
@@ -248,7 +247,7 @@ public class ENS {
         guard isPKSupports else {
             throw Web3Error.processingError(desc: "Public Key isn't supported")
         }
-        var options = options ?? defaultOptions
+        var options = options ?? defaultTransaction
         options.to = resolver.resolverContractAddress
         guard let result = try? await resolver.setPublicKey(forNode: node, publicKey: publicKey, options: options, password: password) else {
             throw Web3Error.processingError(desc: "Can't get result")
@@ -283,7 +282,7 @@ public class ENS {
         guard isTextSupports else {
             throw Web3Error.processingError(desc: "Text isn't supported")
         }
-        var options = options ?? defaultOptions
+        var options = options ?? defaultTransaction
         options.to = resolver.resolverContractAddress
         guard let result = try? await resolver.setTextData(forNode: node, key: key, value: value, options: options, password: password) else {
             throw Web3Error.processingError(desc: "Can't get result")