### blockstack

`18.1.0`
Need help reading this?

## Authentication

Blockstack Authentication provides single sign on and authentication without third parties or remote servers. Blockstack Authentication is a bearer token-based authentication system. From an app user's perspective, it functions similar to legacy third-party authentication techniques that they're familiar with. For an app developer, the flow is a bit different from the typical client-server flow of centralized sign in services (e.g., OAuth). Rather, with Blockstack, the authentication flow happens entirely client-side.

## Quickstart

1) Install `blockstack.js`:

    npm install blockstack --save

2) Import Blockstack into your project

    import * as blockstack from 'blockstack'

3) Wire up a sign in button

    document.getElementById('signin-button').addEventListener('click', function() {
      blockstack.redirectToSignIn()
    })

4) Wire up a sign out button

    document.getElementById('signout-button').addEventListener('click', function() {
      blockstack.signUserOut(window.location.origin)
    })

5) Include the logic to (a) load user data (b) handle the auth response

    function showProfile(profile) {
      var person = new blockstack.Person(profile)
      document.getElementById('heading-name').innerHTML = person.name()
      document.getElementById('avatar-image').setAttribute('src', person.avatarUrl())
      document.getElementById('section-1').style.display = 'none'
      document.getElementById('section-2').style.display = 'block'
    }

    if (blockstack.isUserSignedIn()) {
      const userData = blockstack.loadUserData()
      showProfile(userData.profile)
    } else if (blockstack.isSignInPending()) {
      blockstack.handlePendingSignIn()
      .then(userData => {
        showProfile(userData.profile)
      })
    }

6) Create a `manifest.json` file

    {
      "name": "Hello, Blockstack",
      "start_url": "localhost:5000",
      "description": "A simple demo of Blockstack Auth",
      "icons": [{
        "src": "https://helloblockstack.com/icon-192x192.png",
        "sizes": "192x192",
        "type": "image/png"
      }]
    }

Make sure your `manifest.json` file has appropriate CORS headers so that it can be fetched via an http `GET` from any origin.

7) Serve your application

## User flow

What follows is a walk through of the experience of a user, Alice, signing in to your app with Blockstack.

First, Alice clicks the "Sign in with Blockstack" button on your app. She is redirected to her copy of the Blockstack Browser. The Blockstack Browser shows Alice an approval dialog with information about your app including:

- The origin your app was served from
- Your app's name
- Your app's logo
- The types of permissions and data your app is requesting

Alice can choose to authenticate as one of her Blockstack IDs by selecting the ID and clicking the Approve button.

When she clicks approve, she's redirected back to your app. Your app gets cryptographic proof that she is who she claims to be, access to a dedicated bucket in her Gaia storage hub for your app to read and write its own data along with public information she's stored in her profile.

## Manifest file

Blockstack apps have a manifest file based on the W3C web app manifest specification. The Blockstack Browser retrieves the manifest file from the app during the authentication process and displays some of the information in it such as the app name and icon to the user. The location of the app manifest file is specific in the authentication request token and MUST be on the same origin as the app requesting authentication.

Below is an example of a manifest file:

    {
      "name": "Todo App",
      "start_url": "http://blockstack-todos.appartisan.com",
      "description": "A simple todo app build on blockstack",
      "icons": [{
        "src": "http://blockstack-todos.appartisan.com/logo.png",
        "sizes": "400x400",
        "type": "image/png"
      }]
    }

The manifest file MUST have Cross-origin resource sharing (CORS) headers that allow the manifest file to be fetched from any arbitrary source. This usually means returning:

    Access-Control-Allow-Origin: *

## Key pairs

Blockstack Authentication makes extensive use of public key cryptography. As mentioned above, we use ECDSA with the secp256k1 curve. What follows is a description of the various public-private key pairs used in the authentication process including how they're generated, where they're used and to whom the private key is disclosed.

### Transit private key

The transit private is an ephemeral key that is used to encrypt secrets that need to be passed from the Blockstack Browser to the app during the authentication process. It is randomly generated by the app at the beginning of the authentication response. The public key that corresponds to the transit private key is stored in a single element array in the `public_keys` key of the authentication request token. The Blockstack Browser encrypts secret data such as the app private key using this public key and sends it back to the app when the user signs in to the app. The transit private key signs the app authentication request.

### Blockstack ID Identity address private key

The identity address private key is derived from the user's keychain phrase and is the private key of the Blockstack ID that the user chooses to use to sign in to the app. It is a secret owned by the user and never leaves the user's instance of the Blockstack browser. This private key signs the authentication response token for an app to indicate that the user approves sign in to that app.

### App private key

The app private key is an app-specific private key that is generated from the user's identity address private key using the `domain_name` as input. It is deterministic in that for a given Blockstack ID and `domain_name`, the same private key will be generated each time. The app private key is securely shared with the app on each authentication, encrypted by the Blockstack browser with the transit public key.

The app private key serves three functions.

- It is used to create the credentials that give an app access to the gaia hub storage bucket for that specific app.
- It is used in the end-to-end encryption of files stored for the app on the user's gaia hub.
- It serves as a cryptographic secret that apps can use to perform other cryptographic functions.

## Scopes

Scopes define the information and permissions an app requests from the user during authentication. Requested scopes may be any of the following:

- `store_write` - read and write data to the user's Gaia hub in an app-specific storage bucket

- `publish_data` - publish data so that other users of the app can discover and interact with the user

- `email` - requests the user's email if available

  If no `scopes` array is provided to the `redirectToSignIn` or `makeAuthRequest` functions, the default is to request `['store_write']`.

## Authentication tokens

The app and the Blockstack Browser communicate during the authentication flow by passing back and forth two tokens:

The requesting application sends the Blockstack Browser an authRequest token. Once a user approves a sign in, the Blockstack Browser responds to the application with an authResponse token.

These tokens are JSON Web Tokens, and they are passed via URL query strings.

### JSON Web Token signatures

Blockstack's authentication tokens are based on the RFC 7519 OAuth JSON Web Token (JWT) with additional support for the secp256k1 curve used by bitcoin and many other cryptocurrencies.

This signature algorithm is indicated by specifying `ES256K` in the token's `alg` key, specifying that the JWT signature uses ECDSA with the secp256k1 curve. We provide both JavaScript and Ruby JWT libraries with support for this signing algorithm.

### Authentication request payload schema

    const requestPayload = {
        jti, // UUID
        iat, // JWT creation time in seconds
        exp, // JWT expiration time in seconds
        iss, // legacy decentralized identifier generated from transit key
        public_keys, // single entry array with public key of transit key
        domain_name, // app origin
        manifest_uri, // url to manifest file - must be hosted on app origin
        redirect_uri, // url to which browser redirects user on auth approval - must be hosted on app origin
        version, // version tuple
        do_not_include_profile, // a boolean flag asking browser to send profile url instead of profile object
        supports_hub_url, // a boolean flag indicating gaia hub support
        scopes // an array of string values indicating scopes requested by the app
      }

### Authentication response payload schema

        const responsePayload = {
        jti, // UUID
        iat, // JWT creation time in seconds
        exp, // JWT expiration time in seconds
        iss, // legacy decentralized identifier (string prefix + identity address) - this uniquely identifies the user
        private_key, // encrypted private key payload
        public_keys, // single entry array with public key
        profile, // profile object or null if passed by profile_url
        username, // blockstack id username (if any)
        core_token, // encrypted core token payload
        email, // email if email scope is requested & email available
        profile_url, // url to signed profile token
        hubUrl, // url pointing to user's gaia hub
        version // version tuple
      }

## `blockstack:` custom protocol handler

The `blockstack:` custom protocol handler is how Blockstack apps send their authentication requests to the Blockstack Browser. When the Blockstack Browser is installed on a user's computer, it registers itself as the handler for the `blockstack:` customer protocol.

When an application calls `redirectToSignIn` or `redirectToSignInWithAuthRequest`, blockstack.js checks if a blockstack: protocol handler is installed and, if so, redirects the user to `blockstack:<authRequestToken>`. This passes the authentication request token from the app to the Blockstack Browser, which will in turn validate the request and display an authentication dialog.

## Adding Blockstack Authentication to your app

The way you can add Blockstack Authentication to you app depends on whether your app is a modern decentralized Blockstack App where code runs client-side without trusted servers or a legacy client-server app where a server is trusted.

### Authentication in Client-side apps

This method is appropriate for decentralized client-side apps where the user's zone of trust - the parts of the app that the user is trusting - begins and ends with the code running on their own computer. In apps like these, any code the app interacts with that's not on their own computer such as external servers does not need to know who she is.

Blockstack.js provides API methods that help you to implement Blockstack Authentication in your client-side app.

#### Standard flow

The preferred way to implement authentication in these apps is to use the standard flow. This flow hides much of the process behind a few easy function calls and makes it very fast to get up and running.

In this process you'll use these four functions:

- `redirectToSignIn`
- `isSignInPending`
- `handlePendingSignIn`
- `loadUserData`

##### Starting the sign in process

When your app wants to start the sign in process, typically when the user clicks a "Sign in with Blockstack" button, your app will call the `redirectToSignIn` method of blockstack.js.

This creates an ephemeral transit key, stores it in the web browser's `localStorage`, uses it to create an authentication request token and finally redirects the user to the Blockstack browser to approve the sign in request.

##### Handling an authentication response

When a user approves a sign in request, the Blockstack Browser will return the signed authentication response token to the `redirectURI` specified in `redirectToSignIn`.

To check for the presence of this token, your app should call `isSignInPending`. If this returns `true`, the app should then call `handlePendingSignIn`. This decodes the token, returns the signed-in-user's data, and simultaneously storing it to `localStorage` so that it can be retrieved later with `loadUserData`.

    import * as blockstack from 'blockstack'

    if (blockstack.isSignInPending()) {
        blockstack.handlePendingSignIn()
        .then(userData => {
            const profile = userData.profile
        })
    }

#### Manual flow

Alternatively, you can manually generate your own transit private key and/or authentication request token. This gives you more control over the experience.

For example, you could use the following code to generate an authentication request on `https://alice.example.com` or `https://bob.example.com` for an app running on origin `https://example.com`.

    const transitPrivateKey = generateAndStoreTransitKey()
    const redirectURI = 'https://example.com/authLandingPage'
    const manifestURI = 'https://example.com/manifest.json'
    const scopes = ['scope_write', 'publish_data']
    const appDomain = 'https://example.com'

    const authRequest = makeAuthRequest(transitPrivateKey, redirectURI, manifestURI, scopes, appDomain)

    redirectToSignInWithAuthRequest(authRequest)

### Authentication in client-server apps

Note: Client-server authentication requires using a library written in the language of your server app. There are private methods in blockstack.js that can be accomplish this on node.js server apps, but they are not currently part of our public, supported API.

Using Blockstack Authentication in client-server apps is very similar to client-side apps. You generate the authentication request using the same code in the client as described above.

The main difference is that you need to verify the authentication response token on the server after the user approves sign in to your app.

For an example of how verification can be done server side, take a look at the blockstack-ruby library.

### redirectToSignIn

Generates an authentication request and redirects the user to the Blockstack browser to approve the sign in request.

Please note that this requires that the web browser properly handles the `blockstack:` URL protocol handler.

Most applications should use this method for sign in unless they require more fine grained control over how the authentication request is generated. If your app falls into this category, use `makeAuthRequest` and `redirectToSignInWithAuthRequest` to build your own sign in process.

redirectToSignIn(redirectURI: String, manifestURI: String, scopes: Array): void
Parameters
redirectURI `(String = ``${window.location.origin}/``)` The location to which the identity provider will redirect the user after the user approves sign in.
manifestURI `(String = ``${window.location.origin}/manifest.json``)` Location of the manifest file.
scopes `(Array = `DEFAULT_SCOPE`)` Defaults to requesting write access to this app's data store. An array of strings indicating which permissions this app is requesting.
Returns
`void`:

### isSignInPending

Check if there is a authentication request that hasn't been handled.

isSignInPending(): Boolean
Returns
`Boolean`: `true` if there is a pending sign in, otherwise `false`

### handlePendingSignIn

Try to process any pending sign in request by returning a `Promise` that resolves to the user data object if the sign in succeeds.

handlePendingSignIn(nameLookupURL: String, authResponseToken: String, transitKey: String): Promise
Parameters
nameLookupURL `(String = `''`)` the endpoint against which to verify public keys match claimed username
authResponseToken `(String = `getAuthResponseToken()`)` the signed authentication response token
transitKey `(String = `getTransitKey()`)` the transit private key that corresponds to the transit public key that was provided in the authentication request
Returns
`Promise`: that resolves to the user data object if successful and rejects if handling the sign in request fails or there was no pending sign in request.

### loadUserData

Retrieves the user data object. The user's profile is stored in the key `profile`.

loadUserData(): Object
Returns
`Object`: User data object.

### isUserSignedIn

Check if a user is currently signed in.

isUserSignedIn(): Boolean
Returns
`Boolean`: `true` if the user is signed in, `false` if not.

### signUserOut

Sign the user out and optionally redirect to given location.

signUserOut(redirectURL: String): void
Parameters
redirectURL `(String = `null`)` Location to redirect user to after sign out.
Returns
`void`:

### makeAuthRequest

Generates an authentication request that can be sent to the Blockstack browser for the user to approve sign in. This authentication request can then be used for sign in by passing it to the `redirectToSignInWithAuthRequest` method.

Note: This method should only be used if you want to roll your own authentication flow. Typically you'd use `redirectToSignIn` which takes care of this under the hood.

makeAuthRequest(transitPrivateKey: String, redirectURI: String, manifestURI: String, scopes: Array<String>, appDomain: String, expiresAt: Number): String
Parameters
transitPrivateKey `(String = `generateAndStoreTransitKey()`)` hex encoded transit private key
redirectURI `(String = ``${window.location.origin}/``)` location to redirect user to after sign in approval
manifestURI `(String = ``${window.location.origin}/manifest.json``)` location of this app's manifest file
scopes `(Array<String> = `DEFAULT_SCOPE`)` the permissions this app is requesting
appDomain `(String = `window.location.origin`)` the origin of this app
expiresAt `(Number = `nextHour().getTime()`)` the time at which this request is no longer valid
Returns
`String`: the authentication request

### generateAndStoreTransitKey

Generates a ECDSA keypair to use as the ephemeral app transit private key and stores the hex value of the private key in local storage.

generateAndStoreTransitKey(): String
Returns
`String`: the hex encoded private key

### redirectToSignInWithAuthRequest

Redirects the user to the Blockstack browser to approve the sign in request given.

The user is redirected to the `blockstackIDHost` if the `blockstack:` protocol handler is not detected. Please note that the protocol handler detection does not work on all browsers.

redirectToSignInWithAuthRequest(authRequest: String, blockstackIDHost: String): void
Parameters
authRequest `(String = `makeAuthRequest()`)` the authentication request generated by `makeAuthRequest`
blockstackIDHost `(String = `DEFAULT_BLOCKSTACK_HOST`)` the URL to redirect the user to if the blockstack protocol handler is not detected
Returns
`void`:

### getAuthResponseToken

Retrieve the authentication token from the URL query

getAuthResponseToken(): String
Returns
`String`: the authentication token if it exists otherwise `null`

## Profiles

Follow these steps to create and register a profile for a Blockchain ID:

1. Create a JSON profile object
2. Split up the profile into tokens, sign the tokens, and put them in a token file
3. Create a zone file that points to the web location of the profile token file

### Create a profile

    const profileOfNaval = {
      "@context": "http://schema.org/",
      "@type": "Person",
      "name": "Naval Ravikant",
      "description": "Co-founder of AngelList"
    }

### Sign a profile as a single token

    import { makeECPrivateKey, wrapProfileToken, Person } from 'blockstack'

    const privateKey = makeECPrivateKey()

    const person = new Person(profileOfNaval)
    const token = person.toToken(privateKey)
    const tokenFile = [wrapProfileToken(token)]

### Verify an individual token

    import { verifyProfileToken } from 'blockstack'

    try {
      const decodedToken = verifyProfileToken(tokenFile[0].token, publicKey)
    } catch(e) {
      console.log(e)
    }

### Recover a profile from a token file

    const recoveredProfile = Person.fromToken(tokenFile, publicKey)

### Validate profile schema

    const validationResults = Person.validateSchema(recoveredProfile)

### Where profile data is stored

Profile data is stored using Gaia on the user's selected storage provider.

An example of a profile.json file URL using Blockstack provided storage: `https://gaia.blockstack.org/hub/1EeZtGNdFrVB2AgLFsZbyBCF7UTZcEWhHk/profile.json`

### Validate a proof

    import { validateProofs } from 'blockstack'

    const domainName = "naval.id"
    validateProofs(profile, domainName).then((proofs) => {
      console.log(proofs)
    })

### How proofs are validated

The `validateProofs` function checks each of the proofs listed in the profile by fetching the proof URL and verifying the proof message.

The proof message must be of the form:

    Verifying my Blockstack ID is secured with the address
    1EeZtGNdFrVB2AgLFsZbyBCF7UTZcEWhHk

The proof message also must appear in the required location on the proof page specific to each type of social media account.

The account from which the proof message is posted must match exactly the account identifier/username claimed in the user profile. The `validateProofs` function will check this in the body of the proof or in the proof URL depending on the service.

### Adding additional social account validation services

The `Service` class can be extended to provide proof validation service to additional social account types. You will need to override the `getProofStatement(searchText: string)` method which parses the proof body and returns the proof message text. Additionally, the identifier claimed should be verified in the proof URL or in the body by implementing `getProofIdentity(searchText: string)` and setting `shouldValidateIdentityInBody()` to return true.

The following snippet uses the meta tags in the proof page to retrieve the proof message.

    static getProofStatement(searchText: string) {
    	const $ = cheerio.load(searchText)
    	const statement = $('meta[property="og:description"]')
    	                    .attr('content')

    	if (statement !== undefined && statement.split(':').length > 1) {
    	  return statement.split(':')[1].trim().replace('“', '').replace('”', '')
    	} else {
    	  return ''
    	}
    }

### Currently supported proof validation services

- Facebook
- Twitter
- Instagram
- LinkedIn
- Hacker News
- GitHub

### Profile proof schema

Proofs are stored under the `account` key in the user's profile data

    "account": [
    	{
    	  "@type": "Account",
    	  "service": "twitter",
    	  "identifier": "naval",
    	  "proofType": "http",
    	  "proofUrl": "https://twitter.com/naval/status/12345678901234567890"
    	}
    ]

### extractProfile

Extracts a profile from an encoded token and optionally verifies it, if `publicKeyOrAddress` is provided.

extractProfile(token: String, publicKeyOrAddress: String): Object
Parameters
token `(String)` the token to be extracted
publicKeyOrAddress `(String = `null`)` the public key or address of the keypair that is thought to have signed the token
Returns
`Object`: the profile extracted from the encoded token
Throws

- Error: if the token isn't signed by the provided `publicKeyOrAddress`

### wrapProfileToken

Wraps a token for a profile token file

wrapProfileToken(token: String): Object
Parameters
token `(String)` the token to be wrapped
Returns
`Object`: including `token` and `decodedToken`

### signProfileToken

Signs a profile token

signProfileToken(profile: Object, privateKey: String, subject: Object, issuer: Object, signingAlgorithm: String, issuedAt: Date, expiresAt: Date): Object
Parameters
profile `(Object)` the JSON of the profile to be signed
privateKey `(String)` the signing private key
subject `(Object = `null`)` the entity that the information is about
issuer `(Object = `null`)` the entity that is issuing the token
signingAlgorithm `(String = `'ES256K'`)` the signing algorithm to use
issuedAt `(Date = `new Date()`)` the time of issuance of the token
expiresAt `(Date = `nextYear()`)` the time of expiration of the token
Returns
`Object`: the signed profile token

### verifyProfileToken

Verifies a profile token

verifyProfileToken(token: String, publicKeyOrAddress: String): Object
Parameters
token `(String)` the token to be verified
publicKeyOrAddress `(String)` the public key or address of the keypair that is thought to have signed the token
Returns
`Object`: the verified, decoded profile token
Throws

- Error: throws an error if token verification fails

### validateProofs

Validates the social proofs in a user's profile. Currently supports validation of Facebook, Twitter, GitHub, Instagram, LinkedIn and HackerNews accounts.

validateProofs(profile: Object, ownerAddress: string, name: string): Promise
Parameters
profile `(Object)` The JSON of the profile to be validated
ownerAddress `(string)` The owner bitcoin address to be validated
name `(string = `null`)` The Blockstack name to be validated
Returns
`Promise`: that resolves to an array of validated proof objects

### lookupProfile

Look up a user profile by blockstack ID

lookupProfile(username: string, zoneFileLookupURL: string): Promise
Parameters
username `(string)` The Blockstack ID of the profile to look up
zoneFileLookupURL `(string = `null`)` The URL to use for zonefile lookup. If falsey, lookupProfile will use the blockstack.js getNameInfo function.
Returns
`Promise`: that resolves to a profile object

## Storage

> Notes:

> 1) Blockstack Gaia Storage APIs and on-disk format will change in upcoming pre-releases breaking backward compatibility. File encryption is currently opt-in on a file by file basis.

> 2) Certain storage features such as and collections are not implemented in the current version. These features will be rolled out in future updates.

## Creating a file

     blockstack.putFile("/hello.txt", "hello world!")
     .then(() => {
        // /hello.txt exists now, and has the contents "hello world!".
     })

## Reading a file

     blockstack.getFile("/hello.txt")
     .then((fileContents) => {
        // get the contents of the file /hello.txt
        assert(fileContents === "hello world!")
     });

## Creating an encrypted file

     let options = {
       encrypt: true
     }

     blockstack.putFile("/message.txt", "Secret hello!", options)
     .then(() => {
        // message.txt exists now, and has the contents "hello world!".
     })

## Reading an encrypted file

     let options = {
       decrypt: true
     }

     blockstack.getFile("/message.txt", options)
     .then((fileContents) => {
        // get & decrypt the contents of the file /message.txt
        assert(fileContents === "Secret hello!")
     });

## Reading another user's unencrypted file

In order for files to be publicly readable, the app must request the `publish_data` scope during authentication.

     let options = {
       user: 'ryan.id', // the Blockstack ID of the user for which to lookup the file
       app: 'http://BlockstackApp.com' // origin of the app this file is stored for
     }

     blockstack.getFile("/message.txt", options)
     .then((fileContents) => {
        // get the contents of the file /message.txt
        assert(fileContents === "hello world!")
     });

## Deleting a file

Note: deleteFile is currently not implemented. For now, we recommend writing an empty file to wipe data

     blockstack.deleteFile("/hello.txt")
     .then(() => {
        // /hello.txt is now removed.
     })

### getFile

Retrieves the specified file from the app's data store.

getFile(path: String, options: Object): Promise
Parameters
path `(String)` the path to the file to read
options `(Object = `null`)` options object

Name | Description
--- | ---
options.decrypt `Boolean` (default `true`) | try to decrypt the data with the app private key
options.username `String` | the Blockstack ID to lookup for multi-player storage
options.verify `Boolean` | Whether the content should be verified, only to be used when `putFile` was set to `sign = true`
options.app `String` | the app to lookup for multi-player storage - defaults to current origin
options.zoneFileLookupURL `String` (default `null`) | The URL to use for zonefile lookup. If falsey, this will use the blockstack.js's getNameInfo function instead.

Returns
`Promise`: that resolves to the raw data in the file or rejects with an error

### putFile

Stores the data provided in the app's data store to to the file specified.

putFile(path: String, content: (String | Buffer), options: Object): Promise
Parameters
path `(String)` the path to store the data in
content `((String | Buffer))` the data to store in the file
options `(Object = `null`)` options object

Name | Description
--- | ---
options.encrypt `(Boolean | String)` (default `true`) | encrypt the data with the app private key or the provided public key
options.sign `Boolean` (default `false`) | sign the data using ECDSA on SHA256 hashes with the app private key
options.contentType `String` (default `''`) | set a Content-Type header for unencrypted data

Returns
`Promise`: that resolves if the operation succeed and rejects if it failed

### encryptContent

Encrypts the data provided with the app public key.

encryptContent(content: (String | Buffer), options: Object): String
Parameters
content `((String | Buffer))` data to encrypt
options `(Object = `null`)` options object

Name | Description
--- | ---
options.publicKey `String` | the hex string of the ECDSA public key to use for encryption. If not provided, will use user's appPrivateKey.

Returns
`String`: Stringified ciphertext object

### decryptContent

Decrypts data encrypted with `encryptContent` with the transit private key.

decryptContent(content: (String | Buffer), options: Object): (String | Buffer)
Parameters
content `((String | Buffer))` encrypted content.
options `(Object = `null`)` options object

Name | Description
--- | ---
options.privateKey `String` | the hex string of the ECDSA private key to use for decryption. If not provided, will use user's appPrivateKey.

Returns
`(String | Buffer)`: decrypted content.

### getAppBucketUrl

Get the app storage bucket URL

getAppBucketUrl(gaiaHubUrl: String, appPrivateKey: String): Promise
Parameters
gaiaHubUrl `(String)` the gaia hub URL
appPrivateKey `(String)` the app private key used to generate the app address
Returns
`Promise`: That resolves to the URL of the app index file or rejects if it fails

### getUserAppFileUrl

Fetch the public read URL of a user file for the specified app.

getUserAppFileUrl(path: String, username: String, appOrigin: String, zoneFileLookupURL: String): Promise
Parameters
path `(String)` the path to the file to read
username `(String)` The Blockstack ID of the user to look up
appOrigin `(String)` The app origin
zoneFileLookupURL `(String = `null`)` The URL to use for zonefile lookup. If falsey, this will use the blockstack.js's getNameInfo function instead.
Returns
`Promise`: that resolves to the public read URL of the file or rejects with an error

### getNamePrice

Get the price of a name.

getNamePrice(fullyQualifiedName: String): Promise
Parameters
fullyQualifiedName `(String)` the name to query
Returns
`Promise`: a promise to an Object with { units: String, amount: BigInteger }, where .units encodes the cryptocurrency units to pay (e.g. BTC, STACKS), and .amount encodes the number of units, in the smallest denominiated amount (e.g. if .units is BTC, .amount will be satoshis; if .units is STACKS, .amount will be microStacks)

### getNamespacePrice

Get the price of a namespace

getNamespacePrice(namespaceID: String): Promise
Parameters
namespaceID `(String)` the namespace to query
Returns
`Promise`: a promise to an Object with { units: String, amount: BigInteger }, where .units encodes the cryptocurrency units to pay (e.g. BTC, STACKS), and .amount encodes the number of units, in the smallest denominiated amount (e.g. if .units is BTC, .amount will be satoshis; if .units is STACKS, .amount will be microStacks)

### getGracePeriod

How many blocks can pass between a name expiring and the name being able to be re-registered by a different owner?

getGracePeriod(): Promise
Returns
`Promise`: a promise to the number of blocks

### getNamesOwned

Get the names -- both on-chain and off-chain -- owned by an address.

getNamesOwned(address: String): Promise
Parameters
address `(String)` the blockchain address (the hash of the owner public key)
Returns
`Promise`: a promise that resolves to a list of names (Strings)

### getNamespaceBurnAddress

Get the blockchain address to which a name's registration fee must be sent (the address will depend on the namespace in which it is registered.)

getNamespaceBurnAddress(namespace: String): Promise
Parameters
namespace `(String)` the namespace ID
Returns
`Promise`: a promise that resolves to an address (String)

### getNameInfo

Get WHOIS-like information for a name, including the address that owns it, the block at which it expires, and the zone file anchored to it (if available).

getNameInfo(fullyQualifiedName: String): Promise
Parameters
fullyQualifiedName `(String)` the name to query. Can be on-chain of off-chain.
Returns
`Promise`: a promise that resolves to the WHOIS-like information

### getNamespaceInfo

Get the pricing parameters and creation history of a namespace.

getNamespaceInfo(namespaceID: String): Promise
Parameters
namespaceID `(String)` the namespace to query
Returns
`Promise`: a promise that resolves to the namespace information.

### getZonefile

Get a zone file, given its hash. Throws an exception if the zone file obtained does not match the hash.

getZonefile(zonefileHash: String): Promise
Parameters
zonefileHash `(String)` the ripemd160(sha256) hash of the zone file
Returns
`Promise`: a promise that resolves to the zone file's text

### getAccountStatus

Get the status of an account for a particular token holding. This includes its total number of expenditures and credits, lockup times, last txid, and so on.

getAccountStatus(address: String, tokenType: String): Promise
Parameters
address `(String)` the account
tokenType `(String)` the token type to query
Returns
`Promise`: a promise that resolves to an object representing the state of the account for this token

### getAccountHistoryPage

Get a page of an account's transaction history.

getAccountHistoryPage(address: String, page: number): Promise
Parameters
address `(String)` the account's address
page `(number)` the page number. Page 0 is the most recent transactions
Returns
`Promise`: a promise that resolves to an Array of Objects, where each Object encodes states of the account at various block heights (e.g. prior balances, txids, etc)

### getAccountAt

Get the state(s) of an account at a particular block height. This includes the state of the account beginning with this block's transactions, as well as all of the states the account passed through when this block was processed (if any).

getAccountAt(address: String, blockHeight: Integer): Promise
Parameters
address `(String)` the account's address
blockHeight `(Integer)` the block to query
Returns
`Promise`: a promise that resolves to an Array of Objects, where each Object encodes states of the account at this block.

### getAccountTokens

Get the set of token types that this account owns

getAccountTokens(address: String): Promise
Parameters
address `(String)` the account's address
Returns
`Promise`: a promise that resolves to an Array of Strings, where each item encodes the type of token this account holds (excluding the underlying blockchain's tokens)

### getAccountBalance

Get the number of tokens owned by an account. If the account does not exist or has no tokens of this type, then 0 will be returned.

getAccountBalance(address: String, tokenType: String): Promise
Parameters
address `(String)` the account's address
tokenType `(String)` the type of token to query.
Returns
`Promise`: a promise that resolves to a BigInteger that encodes the number of tokens held by this account.

### estimateTokenTransfer

Estimates the cost of a token-transfer transaction

estimateTokenTransfer(recipientAddress: String, tokenType: String, tokenAmount: Object, scratchArea: String, senderUtxos: Number, additionalOutputs: Number): Promise
Parameters
recipientAddress `(String)` the recipient of the tokens
tokenType `(String)` the type of token to spend
tokenAmount `(Object)` a 64-bit unsigned BigInteger encoding the number of tokens to spend
scratchArea `(String)` an arbitrary string to store with the transaction
senderUtxos `(Number = `1`)` the number of utxos we expect will be required from the importer address
additionalOutputs `(Number = `1`)` the number of outputs we expect to add beyond just the recipient output (default = 1, if the token owner is also the bitcoin funder)
Returns
`Promise`: a promise which resolves to the satoshi cost to fund this token-transfer transaction

### listFiles

List the set of files in this application's Gaia storage bucket.

listFiles(callback: function): Promise
Parameters
callback `(function)` a callback to invoke on each named file that returns `true` to continue the listing operation or `false` to end it
Returns
`Promise`: that resolves to the number of files listed