Swiftpack.co is a collection of thousands of indexed Swift packages. Search packages.
torusresearch/torus-direct-swift-sdk
Torus-direct-swift-sdk
Introduction
This repo allows iOS applications to retrieve keys stored on the Torus Network directly. The attestation layer for the Torus Network is generalizable, below is an example of how to access keys via the SDK via Google. You can read more about interactions with the Torus Network here.
Features
- All API's return Promises (mxcl/PromiseKit). You can import "yannickl/AwaitKit" to convert APIs to async/await format.
Usage
1. Installation
Swift package manager
In project settings, add the Github URL as a swift package dependency.
import PackageDescription
let package = Package(
name: "TorusSwiftDirectSDK",
dependencies: [
.package(name: "TorusSwiftDirectSDK", url: "https://github.com/torusresearch/torus-direct-swift-sdk", .upToNextMajor(from: "0.0.1"))
]
)
Cocoapods
pod 'Torus-directSDK', '~> 0.1.0'
Manual import or other packages
If you require a package manager other than SPM or Cocoapods, do reach out to hello@tor.us or alternatively clone the repo manually and import as a framework in your project
2. Initialization
Initalize the SDK depending on the login you require. The example below does so for a single google login.
import TorusSwiftDirectSDK
let sub = SubVerifierDetails(loginType: .installed, // default .web
loginProvider: .google,
clientId: "<your-client-id>",
verifierName: <verifier-name>,
redirectURL: "<your-redirect-url>")
let tdsdk = TorusSwiftDirectSDK(aggregateVerifierType: <type-of-verifier>, aggregateVerifierName: <verifier-name>, subVerifierDetails: [sub])
// controller is used to present a SFSafariViewController.
tdsdk.triggerLogin(controller: <UIViewController>?).done{ data in
print("private key rebuild", data)
}.catch{ err in
print(err)
}
Logins are dependent on verifier scripts/verifiers. There are other verifiers including single_id_verifier
, and_aggregate_verifier
, or_aggregate_verifier
and single_logins
of which you may need to use depending on your required logins. To get your application's verifier script setup, do reach out to hello@tor.us or to read more about verifiers do checkout the docs.
3. Handling the OAuth/Authentication URL redirects
You can setup the redirect in two ways; URL Schemes or Universal links. Typically we recommend users to use URL Schemes as Universal Links require an additional user interaction. The handle(url: URL)
class method implements a NSNotification to handle URL callbacks.
Setting up URL Schemes
In the info tab of your target, add your application name (ex. my-wallet-app). Add the redirect URL to the list of allowed redirect URLs in the OAuth providers settings page.
- For SwiftUI, implement the following in your SceneDelegate
func scene(_ scene: UIScene, openURLContexts URLContexts: Set<UIOpenURLContext>) {
guard let url = URLContexts.first?.url else {
return
}
TorusSwiftDirectSDK.handle(url: url)
}
- For Storyboard, implement the following in your app AppDelegate:
func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool {
if url.host == "my-wallet-app" {
TorusSwiftDirectSDK.handle(url: url)
}
return true
}
Universal Links
Universal Links allow your users to intelligently follow links to content inside your app or to your website. Checkout Documentation for implementation.
- For Swift UI,
func scene(_ scene: UIScene, continue userActivity: NSUserActivity) {
guard userActivity.activityType == NSUserActivityTypeBrowsingWeb, let urlToOpen = userActivity.webpageURL else {
return
}
TorusSwiftDirectSDK.handle(url: urlToOpen)
}
- For Storyboard,
func application(_ application: UIApplication, continue userActivity: UIUserActivity, restorationHandler: @escaping ([UIUserActivityRestoring]?) -> Void) -> Bool
{
// Get URL components from the incoming user activity
guard userActivity.activityType == NSUserActivityTypeBrowsingWeb,
let incomingURL = userActivity.webpageURL,
let components = NSURLComponents(url: incomingURL, resolvingAgainstBaseURL: true) else {
return false
}
TorusSwiftDirectSDK.handle(url: incomingURL)
}
After this you're good to go, reach out to hello@tor.us to get your verifier spun up on the testnet today!
Requirements
- Swift 5
Github
link |
Stars: 2 |
Last commit: 5 days ago |
You may find interesting
Dependencies
Releases
0.1.2 - 2021-02-19T03:51:28
- updated package.swift with new version of torus-swift-utils