Merge remote-tracking branch 'origin/develop'

argentlabs · Nov 30, 2022 · d65094c · d65094c
2 parents 02dae99 + c7a6282
commit d65094c
Show file tree

Hide file tree

Showing 36 changed files with 829 additions and 303 deletions.
diff --git a/Package.resolved b/Package.resolved
@@ -12,11 +12,11 @@
       },
       {
         "package": "GenericJSON",
-        "repositoryURL": "https://github.com/zoul/generic-json-swift",
+        "repositoryURL": "https://github.com/iwill/generic-json-swift",
         "state": {
           "branch": null,
-          "revision": "a137894b2a217abe489cdf1ea287e6f7819b1051",
-          "version": "2.0.1"
+          "revision": "0a06575f4038b504e78ac330913d920f1630f510",
+          "version": "2.0.2"
         }
       },
       {

diff --git a/Package.swift b/Package.swift
@@ -12,7 +12,7 @@ let package = Package(
     ],
     dependencies: [
         .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(name: "GenericJSON", url: "https://github.com/iwill/generic-json-swift", .upToNextMajor(from: "2.0.0")),
         .package(url: "https://github.com/GigaBitcoin/secp256k1.swift.git", .upToNextMajor(from: "0.6.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")
@@ -56,7 +56,9 @@ let package = Package(
             path: "web3sTests",
             resources: [
                 .copy("Resources/rlptests.json"),
-                .copy("Account/cryptofights_712.json")
+                .copy("Account/cryptofights_712.json"),
+                .copy("Account/ethermail_signTypedDataV4.json"),
+                .copy("Account/real_word_opensea_signTypedDataV4.json"),
             ]
         )
     ]

diff --git a/README.md b/README.md
@@ -28,14 +28,14 @@ $ pod install
 
 ### Getting Started
 
-Create an instance of `EthereumAccount`  with a `EthereumKeyStorage` provider. This provides a wrapper around your key for web3.swift to use. **NOTE** We recommend you implement your own KeyStorage provider, instead of relying on the provided `EthereumKeyLocalStorage` class. This is provided as an example for conformity to the `EthereumKeyStorageProtocol`.
+Create an instance of `EthereumAccount`  with a `EthereumKeyStorage` provider. This provides a wrapper around your key for web3.swift to use. **NOTE We recommend you implement your own KeyStorage provider, instead of relying on the provided `EthereumKeyLocalStorage` class. This is provided as an example for conformity to the `EthereumSingleKeyStorageProtocol`.**
 
 ```swift
 import web3
 
-
+// This is just an example. EthereumKeyLocalStorage should not be used in production code
 let keyStorage = EthereumKeyLocalStorage()
-let account = try? EthereumAccount.create(keyStorage: keyStorage, keystorePassword: "MY_PASSWORD")
+let account = try? EthereumAccount.create(replacing: keyStorage, keystorePassword: "MY_PASSWORD")
 ```
 
 Create an instance of `EthereumHttpClient` or `EthereumWebSocketClient`. This will then provide you access to a set of functions for interacting with the Blockchain.
@@ -50,7 +50,7 @@ OR
 
 `EthereumWebSocketClient`
 ```swift
-guard let clientUrl = URL(string: "wss://ropsten.infura.io/ws/v3//123") else { return }
+guard let clientUrl = URL(string: "wss://goerli.infura.io/ws/v3//123") else { return }
 let client = EthereumWebSocketClient(url: clientUrl)
 ```
 
@@ -159,7 +159,7 @@ We support querying ERC721 token data via the `ERC721` struct. Including:
 
 ### Running Tests
 
-The tests will all pass when running against Ropsten. You will need to provide a URL for the blockchain proxy (e.g. on Infura), and a key-pair in `TestConfig.swift`. Some of the account signing tests will fail, given the signature assertions are against a specific (unprovided) key.
+The tests will all pass when running against Goerli. You will need to provide a URL for the blockchain proxy (e.g. on Infura), and a key-pair in `TestConfig.swift`. Some of the account signing tests will fail, given the signature assertions are against a specific (unprovided) key.
 
 ## Dependencies
 

diff --git a/web3.swift.podspec b/web3.swift.podspec
@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name = 'web3.swift'
-  s.version = '1.3.0'
+  s.version = '1.4.0'
   s.license = 'MIT'
   s.summary = 'Ethereum API for Swift'
   s.homepage = 'https://github.com/argentlabs/web3.swift'

diff --git a/web3sTests/Account/EthereumAccount+SignTypedTests.swift b/web3sTests/Account/EthereumAccount+SignTypedTests.swift
@@ -231,6 +231,18 @@ class EthereumAccount_SignTypedTests: XCTestCase {
         let typedData = try! decoder.decode(TypedData.self, from: data)
         XCTAssertEqual(try! typedData.signableHash().web3.hexString, "0xdb12328a6d193965801548e1174936c3aa7adbe1b54b3535a3c905bd4966467c")
     }
+
+    func test_GivenCustomTypeArray_V4_ItHashesCorrectly() {
+        let simpleUrl = Bundle.module.url(forResource: "ethermail_signTypedDataV4", withExtension: "json")!
+        let simpleData = try! Data(contentsOf: simpleUrl)
+        let simpleTypedData = try! decoder.decode(TypedData.self, from: simpleData)
+        XCTAssertEqual(try! simpleTypedData.signableHash().web3.hexString, "0x8a2c45f690057d91a9738b313da3f65916327e1d5b9a1348b9fc1cff0dc4091e")
+
+        let realWorldUrl = Bundle.module.url(forResource: "real_word_opensea_signTypedDataV4", withExtension: "json")!
+        let realWorldData = try! Data(contentsOf: realWorldUrl)
+        let realWorldTypedData = try! decoder.decode(TypedData.self, from: realWorldData)
+        XCTAssertEqual(try! realWorldTypedData.signableHash().web3.hexString, "0x76a61293096587b582305a07a60785f92b99ae6c8647c4bcf46d6651db0bd778")
+    }
 
     func test_givenExampleWithDynamicData_ItHashesCorrectly() {
         let typedData = try! decoder.decode(TypedData.self, from: example4)

diff --git a/web3sTests/Account/EthereumAccountTests.swift b/web3sTests/Account/EthereumAccountTests.swift
@@ -27,41 +27,41 @@ class EthereumAccountTests: XCTestCase {
     }
 
     func testCreateAccount() {
-        let storage = EthereumKeyLocalStorage() as EthereumKeyStorageProtocol
-        let account = try? EthereumAccount.create(keyStorage: storage, keystorePassword: "PASSWORD")
+        let storage = EthereumKeyLocalStorage()
+        let account = try? EthereumAccount.create(replacing: storage, keystorePassword: "PASSWORD")
         XCTAssertNotNil(account, "Failed to create account. Ensure key is valid in TestConfig.swift")
     }
 
     func testCreateAccountMultiple() {
-        let storage = EthereumKeyLocalStorage() as EthereumMultipleKeyStorageProtocol
-        let account = try? EthereumAccount.create(keyStorage: storage, keystorePassword: "PASSWORD")
+        let storage = EthereumKeyLocalStorage()
+        let account = try? EthereumAccount.create(addingTo: storage, keystorePassword: "PASSWORD")
         XCTAssertNotNil(account, "Failed to create account. Ensure key is valid in TestConfig.swift")
     }
 
     func testImportAccount() {
-        let storage = EthereumKeyLocalStorage() as EthereumKeyStorageProtocol
-        let account = try! EthereumAccount.importAccount(keyStorage: storage, privateKey: "0x2639f727ded571d584643895d43d02a7a190f8249748a2c32200cfc12dde7173", keystorePassword: "PASSWORD")
+        let storage = EthereumKeyLocalStorage()
+        let account = try! EthereumAccount.importAccount(replacing: storage, privateKey: "0x2639f727ded571d584643895d43d02a7a190f8249748a2c32200cfc12dde7173", keystorePassword: "PASSWORD")
 
         XCTAssertEqual(account.address.value, "0x675f5810feb3b09528e5cd175061b4eb8de69075")
     }
 
     func testImportAccountMultiple() {
-        let storage = EthereumKeyLocalStorage() as EthereumMultipleKeyStorageProtocol
-        let account = try! EthereumAccount.importAccount(keyStorage: storage, privateKey: "0x2639f727ded571d584643895d43d02a7a190f8249748a2c32200cfc12dde7173", keystorePassword: "PASSWORD")
+        let storage = EthereumKeyLocalStorage()
+        let account = try! EthereumAccount.importAccount(addingTo: storage, privateKey: "0x2639f727ded571d584643895d43d02a7a190f8249748a2c32200cfc12dde7173", keystorePassword: "PASSWORD")
 
         XCTAssertEqual(account.address.value, "0x675f5810feb3b09528e5cd175061b4eb8de69075")
     }
 
     func testFetchAccounts() {
-        let storage = EthereumKeyLocalStorage() as EthereumMultipleKeyStorageProtocol
-        let account = try! EthereumAccount.importAccount(keyStorage: storage, privateKey: "0x2639f727ded571d584643895d43d02a7a190f8249748a2c32200cfc12dde7173", keystorePassword: "PASSWORD")
+        let storage = EthereumKeyLocalStorage()
+        let account = try! EthereumAccount.importAccount(addingTo: storage, privateKey: "0x2639f727ded571d584643895d43d02a7a190f8249748a2c32200cfc12dde7173", keystorePassword: "PASSWORD")
         let accounts = try! storage.fetchAccounts()
         XCTAssertTrue(accounts.contains(account.address))
     }
 
     func testDeleteAccount() {
-        let storage = EthereumKeyLocalStorage() as EthereumMultipleKeyStorageProtocol
-        let account = try! EthereumAccount.importAccount(keyStorage: storage, privateKey: "0x2639f727ded571d584643895d43d02a7a190f8249748a2c32200cfc12dde7173", keystorePassword: "PASSWORD")
+        let storage = EthereumKeyLocalStorage()
+        let account = try! EthereumAccount.importAccount(addingTo: storage, privateKey: "0x2639f727ded571d584643895d43d02a7a190f8249748a2c32200cfc12dde7173", keystorePassword: "PASSWORD")
         let ethereumAddress = EthereumAddress("0x675f5810feb3b09528e5cd175061b4eb8de69075")
         try! storage.deletePrivateKey(for: ethereumAddress)
         let accounts = try! storage.fetchAccounts()

diff --git a/web3sTests/Account/EthereumKeyStorageTests.swift b/web3sTests/Account/EthereumKeyStorageTests.swift
@@ -43,7 +43,7 @@ class EthereumKeyStorageTests: XCTestCase {
 
     func testEncryptAndStorePrivateKey() {
         let randomData = Data.randomOfLength(256)!
-        let keyStorage = EthereumKeyLocalStorage() as EthereumKeyStorageProtocol
+        let keyStorage = EthereumKeyLocalStorage() as EthereumSingleKeyStorageProtocol
         let password = "myP4ssw0rD"
 
         do {
@@ -73,11 +73,11 @@ class EthereumKeyStorageTests: XCTestCase {
     }
 
     func testDeleteAllPrivateKeys() {
-        let keyStorage = EthereumKeyLocalStorage() as EthereumMultipleKeyStorageProtocol
+        let keyStorage = EthereumKeyLocalStorage()
         do {
-            _ = try EthereumAccount.create(keyStorage: keyStorage, keystorePassword: "PASSWORD")
-            _ = try EthereumAccount.create(keyStorage: keyStorage, keystorePassword: "PASSWORD")
-            _ = try EthereumAccount.create(keyStorage: keyStorage, keystorePassword: "PASSWORD")
+            _ = try EthereumAccount.create(addingTo: keyStorage, keystorePassword: "PASSWORD")
+            _ = try EthereumAccount.create(addingTo: keyStorage, keystorePassword: "PASSWORD")
+            _ = try EthereumAccount.create(addingTo: keyStorage, keystorePassword: "PASSWORD")
             try keyStorage.deleteAllKeys()
             let countAfterDeleting = try keyStorage.fetchAccounts()
             XCTAssertEqual(countAfterDeleting.count, 0)

diff --git a/web3sTests/Account/ethermail_signTypedDataV4.json b/web3sTests/Account/ethermail_signTypedDataV4.json
@@ -0,0 +1,70 @@
+{
+  "domain": {
+    "chainId": "137",
+    "name": "Etaher Mail",
+    "verifyingContract": "0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC",
+    "version": "1"
+  },
+  "message": {
+    "contents": "Hello, Bob!",
+    "from": {
+      "name": "Cow",
+      "wallets": [
+        "0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826",
+        "0xDeaDbeefdEAdbeefdEadbEEFdeadbeEFdEaDbeeF"
+      ]
+    },
+    "to": [{
+      "name": "Cow",
+      "wallets": [
+        "0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826",
+        "0xDeaDbeefdEAdbeefdEadbEEFdeadbeEFdEaDbeeF"
+      ]
+    }]
+  },
+  "primaryType": "Mail",
+  "types": {
+    "EIP712Domain": [
+      {
+        "name": "name",
+        "type": "string"
+      },
+      {
+        "name": "version",
+        "type": "string"
+      },
+      {
+        "name": "chainId",
+        "type": "uint256"
+      },
+      {
+        "name": "verifyingContract",
+        "type": "address"
+      }
+    ],
+    "Mail": [
+      {
+        "name": "from",
+        "type": "Person"
+      },
+      {
+        "name": "to",
+        "type": "Person[]"
+      },
+      {
+        "name": "contents",
+        "type": "string"
+      }
+    ],
+    "Person": [
+      {
+        "name": "name",
+        "type": "string"
+      },
+      {
+        "name": "wallets",
+        "type": "address[]"
+      }
+    ]
+  }
+}