argentlabs · dioKaratzas · Jun 2, 2022 · DarthMike · Jun 16, 2022 · DarthMike
diff --git a/Package.resolved b/Package.resolved
@@ -36,6 +36,42 @@
           "revision": "1a796f738bdcd84b41d05f92593188b23163e60b",
           "version": "0.7.0"
         }
+      },
+      {
+        "package": "swift-log",
+        "repositoryURL": "https://github.com/apple/swift-log.git",
+        "state": {
+          "branch": null,
+          "revision": "5d66f7ba25daf4f94100e7022febf3c75e37a6c7",
+          "version": "1.4.2"
+        }
+      },
+      {
+        "package": "swift-nio",
+        "repositoryURL": "https://github.com/apple/swift-nio.git",
+        "state": {
+          "branch": null,
+          "revision": "124119f0bb12384cef35aa041d7c3a686108722d",
+          "version": "2.40.0"
+        }
+      },
+      {
+        "package": "swift-nio-ssl",
+        "repositoryURL": "https://github.com/apple/swift-nio-ssl.git",
+        "state": {
+          "branch": null,
+          "revision": "1750873bce84b4129b5303655cce2c3d35b9ed3a",
+          "version": "2.19.0"
+        }
+      },
+      {
+        "package": "websocket-kit",
+        "repositoryURL": "https://github.com/vapor/websocket-kit.git",
+        "state": {
+          "branch": null,
+          "revision": "e32033ad3c68ebec1b761bc961be7bd56bad02f8",
+          "version": "2.3.1"
+        }
       }
     ]
   },

diff --git a/Package.swift b/Package.swift
@@ -14,7 +14,9 @@ let package = Package(
         .package(name: "BigInt", url: "https://github.com/attaswift/BigInt", from: "5.0.0"),
         .package(name: "GenericJSON", url: "https://github.com/zoul/generic-json-swift", from: "2.0.0"),
         .package(url: "https://github.com/GigaBitcoin/secp256k1.swift.git", .upToNextMajor(from: "0.6.0")),
-        .package(url: "https://github.com/OpenCombine/OpenCombine.git", from: "0.13.0")
+        .package(url: "https://github.com/OpenCombine/OpenCombine.git", from: "0.13.0"),
+        .package(url: "https://github.com/vapor/websocket-kit.git", from: "2.0.0"),
+        .package(url: "https://github.com/apple/swift-log.git", from: "1.0.0"),
     ],
     targets: [
         .target(
@@ -29,7 +31,9 @@ let package = Package(
                     .product(name: "BigInt", package: "BigInt"),
                     "OpenCombine",
                     .product(name: "OpenCombineFoundation", package: "OpenCombine"),
-                    .product(name: "secp256k1", package: "secp256k1.swift")
+                    .product(name: "secp256k1", package: "secp256k1.swift"),
+                    .product(name: "WebSocketKit", package: "websocket-kit"),
+                    .product(name: "Logging", package: "swift-log")
                 ],
             path: "web3swift/src"
         ),

diff --git a/web3sTests/Client/EthereumClientTests.swift b/web3sTests/Client/EthereumClientTests.swift
@@ -9,6 +9,7 @@
 import XCTest
 @testable import web3
 import BigInt
+import NIO
 
 struct TransferMatchingSignatureEvent: ABIEvent {
     public static let name = "Transfer"
@@ -31,9 +32,8 @@ struct TransferMatchingSignatureEvent: ABIEvent {
     }
 }
 
-
 class EthereumClientTests: XCTestCase {
-    var client: EthereumClient?
+    var client: EthereumClientProtocol?
     var account: EthereumAccount?
 
     override func setUp() {
@@ -110,7 +110,7 @@ class EthereumClientTests: XCTestCase {
 
     func testEthGetCode() async {
         do {
-            let code = try await client?.eth_getCode(address: EthereumAddress("0x112234455c3a32fd11230c42e7bccd4a84e02010"))
+            let code = try await client?.eth_getCode(address: EthereumAddress("0x112234455c3a32fd11230c42e7bccd4a84e02010"), block: .Latest)
             XCTAssertNotNil(code, "Contract code not available")
         } catch {
             XCTFail("Expected code but failed \(error).")
@@ -443,3 +443,154 @@ struct InvalidMethodB: ABIFunction {
     func encode(to encoder: ABIFunctionEncoder) throws {
     }
 }
+
+class EthereumWebSocketClientTests: EthereumClientTests {
+    var delegateExpectation: XCTestExpectation?
+
+    override func setUp() {
+        super.setUp()
+        self.client = EthereumWebSocketClient(url: TestConfig.wssUrl, configuration: TestConfig.webSocketConfig)
+
+    }
+#if os(Linux)
+// On Linux some tests are fail. Need investigation
+#else
+    func testWebSocketState() {
+        guard let client = client as? EthereumWebSocketClient else {
+            XCTFail("Expected client to be EthereumWebSocketClient")
+            return
+        }
+        XCTAssertEqual(client.currentState, EthereumWebSocketClient.State.open)
+
+        let clientClose = client.eventLoopGroup.next().makePromise(of: Void.self)
+        client.exposeWebSocket()?.onClose.cascade(to: clientClose)
+        client.disconnect()
+        XCTAssertNoThrow(try clientClose.futureResult.wait())
+        XCTAssertEqual(client.currentState, EthereumWebSocketClient.State.closed)
+
+        client.connect()
+        XCTAssertEqual(client.currentState, EthereumWebSocketClient.State.open)
+    }
+
+    func testWebSocketNoAutomaticOpen() {
+        self.client = EthereumWebSocketClient(url: TestConfig.wssUrl, configuration: .init(automaticOpen: false))
+
+        guard let client = client as? EthereumWebSocketClient else {
+            XCTFail("Expected client to be EthereumWebSocketClient")
+            return
+        }
+
+        XCTAssertEqual(client.currentState, EthereumWebSocketClient.State.closed)
+    }
+
+    func testWebSocketConnect() {
+        self.client = EthereumWebSocketClient(url: TestConfig.wssUrl, configuration: .init(automaticOpen: false))
+
+        guard let client = client as? EthereumWebSocketClient else {
+            XCTFail("Expected client to be EthereumWebSocketClient")
+            return
+        }
+
+        XCTAssertEqual(client.currentState, EthereumWebSocketClient.State.closed)
+
+        client.connect()
+
+        XCTAssertEqual(client.currentState, EthereumWebSocketClient.State.open)
+        XCTAssertTrue(!client.exposeWebSocket()!.isClosed)
+    }
+
+    func testWebSocketPendingTransactions() async {
+        do {
+            guard let client = client as? EthereumWebSocketClient else {
+                XCTFail("Expected client to be EthereumWebSocketClient")
+                return
+            }
+
+            var expectation: XCTestExpectation? = self.expectation(description: "Pending Transaction")
+            let subscription = try await client.pendingTransactions { txHash in
+                expectation?.fulfill()
+                expectation = nil
+            }
+
+            await waitForExpectations(timeout: 5, handler: nil)
+
+            XCTAssertNotEqual(subscription.id, "")
+            XCTAssertEqual(subscription.type, .pendingTransactions)
+        } catch {
+            XCTFail("Expected subscription but failed \(error).")
+        }
+    }
+
+    func testWebSocketNewBlockHeaders() async {
+        do {
+            guard let client = client as? EthereumWebSocketClient else {
+                XCTFail("Expected client to be EthereumWebSocketClient")
+                return
+            }
+
+            var expectation: XCTestExpectation? = self.expectation(description: "New Block Headers")
+            let subscription = try await client.newBlockHeaders { header in
+                expectation?.fulfill()
+                expectation = nil
+            }
+
+            // we need a high timeout as new block might take a while
+            await waitForExpectations(timeout: 2500, handler: nil)
+
+            XCTAssertNotEqual(subscription.id, "")
+            XCTAssertEqual(subscription.type, .newBlockHeaders)
+        } catch {
+            XCTFail("Expected subscription but failed \(error).")
+        }
+    }
+
+    func testWebSocketSubscribe() async {
+        do {
+            guard let client = client as? EthereumWebSocketClient else {
+                XCTFail("Expected client to be EthereumWebSocketClient")
+                return
+            }
+            client.delegate = self
+
+            delegateExpectation = expectation(description: "onNewPendingTransaction delegate call")
+            var subscription = try await client.subscribe(type: .pendingTransactions)
+            await waitForExpectations(timeout: 10)
+            _ = try await client.unsubscribe(subscription)
+
+            delegateExpectation = expectation(description: "onNewBlockHeader delegate call")
+            subscription = try await client.subscribe(type: .newBlockHeaders)
+            await waitForExpectations(timeout: 2500)
+            _ = try await client.unsubscribe(subscription)
+        } catch {
+            XCTFail("Expected subscription but failed \(error).")
+        }
+    }
+
+    func testWebSocketUnsubscribe() async {
+        do {
+            guard let client = client as? EthereumWebSocketClient else {
+                XCTFail("Expected client to be EthereumWebSocketClient")
+                return
+            }
+
+            let subscription = try await client.subscribe(type: .newBlockHeaders)
+            let result = try await client.unsubscribe(subscription)
+            XCTAssertTrue(result)
+        } catch {
+            XCTFail("Expected subscription but failed \(error).")
+        }
+    }
+#endif
+}
+
+extension EthereumWebSocketClientTests: EthereumWebSocketClientDelegate {
+    func onNewPendingTransaction(subscription: EthereumSubscription, txHash: String) {
+        delegateExpectation?.fulfill()
+        delegateExpectation = nil
+    }
+
+    func onNewBlockHeader(subscription: EthereumSubscription, header: EthereumHeader) {
+        delegateExpectation?.fulfill()
+        delegateExpectation = nil
+    }
+}
diff --git a/web3sTests/Contract/ABIEventTests.swift b/web3sTests/Contract/ABIEventTests.swift
@@ -11,9 +11,10 @@ import BigInt
 @testable import web3
 
 class ABIEventTests: XCTestCase {
-    var client: EthereumClient!
+    var client: EthereumClientProtocol!
 
     override func setUp() {
+        super.setUp()
         self.client = EthereumClient(url: URL(string: TestConfig.clientUrl)!)
     }
 
@@ -59,6 +60,13 @@ class ABIEventTests: XCTestCase {
     }
 }
 
+class ABIEventWebSocketTests: ABIEventTests {
+    override func setUp() {
+        super.setUp()
+        self.client = EthereumWebSocketClient(url: TestConfig.wssUrl, configuration: TestConfig.webSocketConfig)
+    }
+}
+
 struct EnabledStaticCall: ABIEvent {
     static let name = "EnabledStaticCall"
     static let types: [ABIType.Type] = [EthereumAddress.self,Data4.self]
@@ -95,3 +103,4 @@ struct UpgraderRegistered: ABIEvent {
         self.name = try data[0].decoded()
     }
 }
+
diff --git a/web3sTests/ENS/ENSOffchainTests.swift b/web3sTests/ENS/ENSOffchainTests.swift
@@ -11,7 +11,7 @@ import XCTest
 
 class ENSOffchainTests: XCTestCase {
     var account: EthereumAccount?
-    var client: EthereumClient!
+    var client: EthereumClientProtocol!
 
     override func setUp() {
         super.setUp()
@@ -149,3 +149,12 @@ class ENSOffchainTests: XCTestCase {
     }
 }
 
+// TODO: Disable till feature implementation
+/*
+class ENSOffchainWebSocketTests: ENSOffchainTests {
+    override func setUp() {
+        super.setUp()
+        self.client = EthereumWebSocketClient(url: TestConfig.wssUrl, configuration: TestConfig.webSocketConfig)
+    }
+}
+*/
diff --git a/web3sTests/ENS/ENSTests.swift b/web3sTests/ENS/ENSTests.swift
@@ -11,7 +11,7 @@ import XCTest
 
 class ENSTests: XCTestCase {
     var account: EthereumAccount?
-    var client: EthereumClient!
+    var client: EthereumClientProtocol!
 
     override func setUp() {
         super.setUp()
@@ -30,7 +30,7 @@ class ENSTests: XCTestCase {
 
             let tx = try function.transaction()
 
-            let dataStr = try await client?.eth_call(tx, block: .Latest)
+            let dataStr = try await client?.eth_call(tx, resolution: .noOffchain(failOnExecutionError: true), block: .Latest)
             guard let dataStr = dataStr else {
                 XCTFail()
                 return
@@ -208,3 +208,12 @@ class ENSTests: XCTestCase {
     }
 }
 
+// TODO: Disable till feature implementation
+/*
+class ENSWebSocketTests: ENSTests {
+    override func setUp() {
+        super.setUp()
+        self.client = EthereumWebSocketClient(url: TestConfig.wssUrl, configuration: TestConfig.webSocketConfig)
+    }
+}
+*/
diff --git a/web3sTests/ERC165/ERC165Tests.swift b/web3sTests/ERC165/ERC165Tests.swift
@@ -11,7 +11,7 @@ import BigInt
 @testable import web3
 
 class ERC165Tests: XCTestCase {
-    var client: EthereumClient!
+    var client: EthereumClientProtocol!
     var erc165: ERC165!
     let address = EthereumAddress(TestConfig.erc165Contract)
 
@@ -44,3 +44,9 @@ class ERC165Tests: XCTestCase {
     }
 }
 
+class ERC165WebSocketTests: ERC165Tests {
+    override func setUp() {
+        super.setUp()
+        self.client = EthereumWebSocketClient(url: TestConfig.wssUrl, configuration: TestConfig.webSocketConfig)
+    }
+}
diff --git a/web3sTests/ERC20/ERC20Tests.swift b/web3sTests/ERC20/ERC20Tests.swift
@@ -11,7 +11,7 @@ import BigInt
 @testable import web3
 
 class ERC20Tests: XCTestCase {
-    var client: EthereumClient?
+    var client: EthereumClientProtocol?
     var erc20: ERC20?
     let testContractAddress = EthereumAddress(TestConfig.erc20Contract)
 
@@ -115,3 +115,9 @@ class ERC20Tests: XCTestCase {
     }
 }
 
+class ERC20WebSocketTests: ERC20Tests {
+    override func setUp() {
+        super.setUp()
+        self.client = EthereumWebSocketClient(url: TestConfig.wssUrl, configuration: TestConfig.webSocketConfig)
+    }
+}