Decrypts data encrypted with encryptContent
with the
transit private key.
encrypted content.
the hex string of the ECDSA private key to use for decryption. If not provided, will use user's appPrivateKey.
decrypted content.
Deletes the specified file from the app's data store. Currently not implemented.
the path to the file to delete
that resolves when the file has been removed or rejects with an error
Encrypts the data provided with the app public key.
data to encrypt
the hex string of the ECDSA public key to use for encryption. If not provided, will use user's appPrivateKey.
Stringified ciphertext object
Generates a ECDSA keypair to use as the ephemeral app transit private key and store in the session
the hex encoded private key
Retrieve the authentication token from the URL query
the authentication token if it exists otherwise null
Retrieves the specified file from the app's data store.
the path to the file to read
that resolves to the raw data in the file or rejects with an error
Get the URL for reading a file from an app's data store.
the path to the file to read
the app to lookup for multi-player storage - defaults to current origin
the Blockstack ID to lookup for multi-player storage
that resolves to the URL or rejects with an error
Try to process any pending sign in request by returning a Promise
that resolves
to the user data object if the sign in succeeds.
the signed authentication response token
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.
Check if there is a authentication request that hasn't been handled.
true
if there is a pending sign in, otherwise false
Check if a user is currently signed in.
true
if the user is signed in, false
if not.
List the set of files in this application's Gaia storage bucket.
a callback to invoke on each named file that
returns true
to continue the listing operation or false
to end it
that resolves to the number of files listed
Retrieves the user data object. The user's profile is stored in the key profile
.
User data object.
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.
hex-encoded transit key
the time at which this request is no longer valid
Any extra parameters you'd like to pass to the authenticator. Use this to pass options that aren't part of the Blockstack auth spec, but might be supported by special authenticators.
the authentication request
Stores the data provided in the app's data store to to the file specified.
the path to store the data in
the data to store in the file
that resolves if the operation succeed and rejects if it failed
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 generateAndStoreTransitKey
, makeAuthRequest
,
and redirectToSignInWithAuthRequest
to build your own sign in process.
Redirects the user to the Blockstack browser to approve the sign in request given.
The user is redirected to the authenticator URL specified in the AppConfig
if the blockstack:
protocol handler is not detected.
Please note that the protocol handler detection
does not work on all browsers.
the authentication request generated by makeAuthRequest
These two functions are app-specific connections to gaia hub, they read the user data object for information on setting up a hub connection, and store the hub config to localstorage
that resolves to the new gaia hub connection
Sign the user out and optionally redirect to given location.
Location to redirect user to after sign out.
Only used in environments with window
available
Generated using TypeDoc
Represents an instance of a signed in user for a particular app.
A signed in user has access to two major pieces of information about the user, the user's private key for that app and the location of the user's gaia storage bucket for the app.
A user can be signed in either directly through the interactive sign in process or by directly providing the app private key.