re-align torus-utils-swift

Re-align the current implementation of torus-utils-swift to that of the web implementation of torus.js. This will reduce the overhead of differences a developer would need to remember between the two and provide an overall better experience. This will also provide better long term maintainability and make feature parity simpler to implement between the two. The are also numerous bug fixes implemented in this PR as well, one of which allowed the package AnyCodable as a dependency to be removed. Should be feature-complete up until tag v12.3.5 on torus.js
torusresearch · Jun 12, 2024 · af687db · af687db
1 parent 5375aa0
commit af687db
Show file tree

Hide file tree

Showing 90 changed files with 3,854 additions and 4,694 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -25,8 +25,8 @@ jobs:
         platform:
           - iOS
     steps:
-      - uses: actions/checkout@v2.3.4
-      - uses: mxcl/xcodebuild@v1
+      - uses: actions/checkout@v4
+      - uses: mxcl/xcodebuild@v3.0.0
         with:
           platform: ${{ matrix.platform }}
           action: test

diff --git a/.gitignore b/.gitignore
@@ -49,7 +49,6 @@ playground.xcworkspace
 #
 # Xcode automatically generates this directory with a .xcworkspacedata file and xcuserdata
 # hence it is not needed unless you have added a package configuration file to your project
-.swiftpm/
 
 .build/
 

diff --git a/.periphery.yml b/.periphery.yml
@@ -0,0 +1,3 @@
+retain_public: true
+targets:
+- TorusUtils
diff --git a/.swiftpm/TorusUtils.xctestplan b/.swiftpm/TorusUtils.xctestplan
@@ -0,0 +1,24 @@
+{
+  "configurations" : [
+    {
+      "id" : "9F2D8848-AB66-4789-A38F-C7E010657904",
+      "name" : "Test Scheme Action",
+      "options" : {
+
+      }
+    }
+  ],
+  "defaultOptions" : {
+    "testRepetitionMode" : "retryOnFailure"
+  },
+  "testTargets" : [
+    {
+      "target" : {
+        "containerPath" : "container:",
+        "identifier" : "TorusUtilsTests",
+        "name" : "TorusUtilsTests"
+      }
+    }
+  ],
+  "version" : 1
+}
diff --git a/.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata b/.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata
diff --git a/.swiftpm/xcode/xcshareddata/xcschemes/TorusUtils.xcscheme b/.swiftpm/xcode/xcshareddata/xcschemes/TorusUtils.xcscheme
@@ -0,0 +1,84 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Scheme
+   LastUpgradeVersion = "1540"
+   version = "1.7">
+   <BuildAction
+      parallelizeBuildables = "YES"
+      buildImplicitDependencies = "YES"
+      buildArchitectures = "Automatic">
+      <BuildActionEntries>
+         <BuildActionEntry
+            buildForTesting = "YES"
+            buildForRunning = "YES"
+            buildForProfiling = "YES"
+            buildForArchiving = "YES"
+            buildForAnalyzing = "YES">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "TorusUtils"
+               BuildableName = "TorusUtils"
+               BlueprintName = "TorusUtils"
+               ReferencedContainer = "container:">
+            </BuildableReference>
+         </BuildActionEntry>
+      </BuildActionEntries>
+   </BuildAction>
+   <TestAction
+      buildConfiguration = "Debug"
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      shouldUseLaunchSchemeArgsEnv = "YES">
+      <TestPlans>
+         <TestPlanReference
+            reference = "container:.swiftpm/TorusUtils.xctestplan"
+            default = "YES">
+         </TestPlanReference>
+      </TestPlans>
+      <Testables>
+         <TestableReference
+            skipped = "NO">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "TorusUtilsTests"
+               BuildableName = "TorusUtilsTests"
+               BlueprintName = "TorusUtilsTests"
+               ReferencedContainer = "container:">
+            </BuildableReference>
+         </TestableReference>
+      </Testables>
+   </TestAction>
+   <LaunchAction
+      buildConfiguration = "Debug"
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      launchStyle = "0"
+      useCustomWorkingDirectory = "NO"
+      ignoresPersistentStateOnLaunch = "NO"
+      debugDocumentVersioning = "YES"
+      debugServiceExtension = "internal"
+      allowLocationSimulation = "YES">
+   </LaunchAction>
+   <ProfileAction
+      buildConfiguration = "Release"
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      savedToolIdentifier = ""
+      useCustomWorkingDirectory = "NO"
+      debugDocumentVersioning = "YES">
+      <MacroExpansion>
+         <BuildableReference
+            BuildableIdentifier = "primary"
+            BlueprintIdentifier = "TorusUtils"
+            BuildableName = "TorusUtils"
+            BlueprintName = "TorusUtils"
+            ReferencedContainer = "container:">
+         </BuildableReference>
+      </MacroExpansion>
+   </ProfileAction>
+   <AnalyzeAction
+      buildConfiguration = "Debug">
+   </AnalyzeAction>
+   <ArchiveAction
+      buildConfiguration = "Release"
+      revealArchiveInOrganizer = "YES">
+   </ArchiveAction>
+</Scheme>
diff --git a/Package.resolved b/Package.resolved
@@ -1,14 +1,5 @@
 {
   "pins" : [
-    {
-      "identity" : "anycodable",
-      "kind" : "remoteSourceControl",
-      "location" : "https://github.com/Flight-School/AnyCodable",
-      "state" : {
-        "revision" : "862808b2070cd908cb04f9aafe7de83d35f81b05",
-        "version" : "0.6.7"
-      }
-    },
     {
       "identity" : "bigint",
       "kind" : "remoteSourceControl",
@@ -32,8 +23,8 @@
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/torusresearch/fetch-node-details-swift.git",
       "state" : {
-        "revision" : "f085d3d85a4f36b57cfef8f0871ac8df1dd4f6f1",
-        "version" : "6.0.1"
+        "revision" : "22bfadf7491d77a0bc1953af002cadbd61383e7d",
+        "version" : "6.0.2"
       }
     },
     {

diff --git a/Package.swift b/Package.swift
@@ -12,17 +12,14 @@ let package = Package(
     ],
     dependencies: [
         .package(url: "https://github.com/tkey/curvelib.swift", from: "1.0.1"),
-        .package(url: "https://github.com/torusresearch/fetch-node-details-swift", from: "6.0.1"),
-        .package(url: "https://github.com/vapor/jwt-kit", from: "4.0.0"),
-        .package(
-            url: "https://github.com/Flight-School/AnyCodable",
-            from: "0.6.0"
-        ),
+        .package(url: "https://github.com/torusresearch/fetch-node-details-swift", from: "6.0.2"),
+        // NB: jwt-kit may only be a dependency in tests or it will break cocoapod support
+        .package(url: "https://github.com/vapor/jwt-kit.git", from: "4.0.0"),
     ],
     targets: [
         .target(
             name: "TorusUtils",
-            dependencies: ["AnyCodable",
+            dependencies: [
                 .product(name: "FetchNodeDetails", package: "fetch-node-details-swift"),
                 .product(name: "curveSecp256k1", package: "curvelib.swift"),
             ]),

diff --git a/README.md b/README.md
@@ -8,16 +8,16 @@ This utility library allows for early exits in optimistic scenarios, while handl
 The general approach is to evaluate predicates against a list of (potentially incomplete) results, and exit when the predicate passes.
 
 ## 🔗 Installation
-You can install the SingleFactorAuth Swift using Swift Package Manager.
+You can install the TorusUtils using Swift Package Manager:
 
 ```
 ...
 dependencies: [
     ...
-    .package(url: "https://github.com/torusresearch/torus-utils-swift", from: "8.1")
+    .package(url: "https://github.com/torusresearch/torus-utils-swift", from: "9.0.0")
 ],
 targets: [
-    .target( name: "",
+    .target( name: "<INSERT_TARGET_NAME>",
             dependencies: [
                 .product(name: "TorusUtils", package: "torus-utils-swift")
                 ]
@@ -26,15 +26,19 @@ targets: [
 ...
 ```
 
+Or CocoaPods:
+
+```
+...
+    pod 'Torus-utils', '~> 9.0.0'
+...
+```
+
 ## Getting Started
-Initialize the `TorusUtils` class by passing `TorusNetwork`, `enableOneKey`, and your `clientId`. `enableOneKey` if true, adds the nonce value to the key, to make it compaitible with v2 users. The package supports both legacy and sapphire networks.  
+Initialize the `TorusUtils` class by passing `TorusOptions` as params. Params includes `TorusNetwork`, `enableOneKey`, and your `clientId`. `enableOneKey` if true, adds the nonce value to the key, to make it compatible with v2 users. The package supports both legacy and sapphire networks.  
 
 ```swift
-  let torus = TorusUtils(
-        enableOneKey: true,
-        network: .sapphire(.SAPPHIRE_DEVNET),
-        clientId: "YOUR_CLIENT_ID"
-        )
+   let torusUtils = TorusUtils(params: TorusOptions(clientId: "YOUR_CLIENT_ID", network: .sapphire(.SAPPHIRE_MAINNET), enableOneKey: true))
 ```
 
 
@@ -46,39 +50,29 @@ Use the `getNodeDetails` function to retrive the node details for specific `veri
  do {
     let fnd = NodeDetailManager(network: .sapphire(.SAPPHIRE_DEVNET))
 
-    let nodeDetails = try await fnd.getNodeDetails(verifier: verifer, verifierID: veriferID)
+    let nodeDetails = try await fnd.getNodeDetails(verifier: verifier, verifierID: verifierID)
 
-    let publicAddressResponse = try await torus.getPublicAddress(
-        endpoints: nodeDetails.getTorusNodeEndpoints(),
-        torusNodePubs: nodeDetails.torusNodePub, 
-        verifier: TORUS_TEST_VERIFIER,
-        verifierId: TORUS_TEST_EMAIL
-        )
-
-    print(publicAddressResponse.oAuthKeyData!.evmAddress)
+    let publicDetails = try await torus.getPublicAddress(endpoints: nodeDetails.getTorusNodeEndpoints(), verifier: verifier, verifierId: verifierID)
+
+    print(publicDetails.oAuthKeyData!.evmAddress)
  } catch let error {
     // Handle error
  }   
 ```
 
-Use `retriveShares` function to login a user, and get the login data such as `sessionData`, `privKey`, `evmAddress`, `metaData` for user. Along with node detals, it also takes verifier, `verifierParams`, and `idToken`(JWT token).
+Use `retrieveShares` function to login a user, and get the login data such as `sessionData`, `privKey`, `evmAddress`, `metaData` for user. Along with node details, it also takes `verifier`, `verifierParams`, and `idToken`(JWT token).
 
 ```swift
 // verifier_id takes the value, for instance email, sub, or custom. 
 let verifierParams = VerifierParams(verifier_id: "verifier_id_value")
 
 do {
  // Use nodeDetails from above step
- let data = try await torus.retrieveShares(
-    endpoints: nodeDetails.getTorusNodeEndpoints(),
-    torusNodePubs: nodeDetails.getTorusNodePub(),
-    indexes: nodeDetails.getTorusIndexes(),
-    verifier: TORUS_TEST_VERIFIER,
-    verifierParams: verifierParams,
-    idToken: token
-    )
-
- let privateKey = data.finalKeyData!.privKey
+
+ let verifierParams = VerifierParams(verifier_id: verifierID)
+
+ let data = try await torus.retrieveShares(endpoints: nodeDetails.getTorusNodeSSSEndpoints(), indexes: nodeDetails.getTorusIndexes(), verifier: verifier, verifierParams: verifierParams, idToken: token)
+
  let evmAddress = data.finalKeyData!.evmAddress
 } catch let error {
     // Handle error

diff --git a/Sources/TorusUtils/AbstractTorusUtils.swift b/Sources/TorusUtils/AbstractTorusUtils.swift
diff --git a/Sources/TorusUtils/Constants.swift b/Sources/TorusUtils/Constants.swift
@@ -1,13 +1,8 @@
 enum JRPC_METHODS {
     static let GET_OR_SET_KEY = "GetPubKeyOrKeyAssign"
     static let COMMITMENT_REQUEST = "CommitmentRequest"
-    static let IMPORT_SHARE = "ImportShare"
+    static let IMPORT_SHARES = "ImportShares"
     static let GET_SHARE_OR_KEY_ASSIGN = "GetShareOrKeyAssign"
-    static let LEGACY_VERIFIER_LOOKUP_REQUEST = "VerifierLookupRequest"
-    static let LEGACY_KEY_ASSIGN = "KeyAssign"
-    static let LEGACY_SHARE_REQUEST = "ShareRequest"
 }
 
 let CURVE_N: String = "FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFEBAAEDCE6AF48A03BBFD25E8CD0364141"
-
-let LEGACY_METADATA_HOST = "https://metadata.tor.us"