No description, website, or topics provided.
Branch: master
Clone or download
Pull request Compare This branch is even with michalciurus:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.

Blockstack iOS SDK

Version License Platform


To run the example project, clone the repo, and run pod install from the Example directory first.


iOS 11.0+


Blockstack is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod 'Blockstack'


Step 1 - Choose a custom protocol handler

You'll need to choose a custom protocol handler that is unique to your app.

This is so that your app's web-based authentication redirect endpoint can redirect the user back to your iOS app.

In this example, we use myblockstackapp://.

Register your URL scheme in Xcode from the info tab of your project settings.

Step 2 - Create redirect endpoint on web app

Blockstack apps are identified by their domain names. You'll need to create an endpoint on the web version of your app that redirects users back to your mobile app.

The endpoint will receive a get request with the query parameter authResponse=XXXX and should redirect the browser to myblockstackapp://XXXX.

See the example in the example web app in this repository.

You can run the example webapp to test out redirects by running npm install && npm start from the webapp directory


Import the Blockstack framework.

import Blockstack

Sign in using Blockstack authentication

In this example, your web app would be located at http://localhost:8080

Blockstack.sharedInstance().signIn(redirectURI: "http://localhost:8080/redirect.html",
                                   appDomain: URL(string: "http://localhost:8080")!) { authResult in
    switch authResult {
        case .success(let userData):
            print("sign in success")
            self.handleSignInSuccess(userData: userData)
        case .cancelled:
            print("sign in cancelled")
        case .failed(let error):
            print("sign in failed")

Check if user is currently signed in

if (Blockstack.sharedInstance().isSignedIn()) {
    print("currently signed in")
} else {
    print("not signed in")

Sign out


Retrieve user profile data

let retrievedUserData = Blockstack.sharedInstance().loadUserData()
print(retrievedUserData?.profile?.name as Any)


Store data as json on Gaia

Blockstack.sharedInstance().putFile(path: "myFile.json", content: content) { (publicURL, error) in
    if (error != nil) {
        print("put file error")
    } else {
        print("put file success \(publicURL!)")

Read json data from Gaia

Blockstack.sharedInstance().getFile(path: "myFile.json", completion: { (response, error) in
    if (error != nil) {
        print("get file error")
    } else {
        print("get file success")
        print(response as Any)


Blockstack PBC