@blockstack/connect v2.12.7

@blockstack/connect

A library for building excellent user experiences with Blockstack.

Installation

yarn add @blockstack/connect

API Methods

authenticate

import { authenticate } from '@blockstack/connect';

authenticate({
  redirectTo,
  manifestPath,
  finished,
  vaultUrl,
  sendToSignIn,
});

Call this method to redirect the user to authentication. It will first check for whether the user has the Blockstack extension installed. If not, it'll send them to the hosted version. The authentication flow opens a popup in the center of the screen.

• redirectTo: The path in your app where users go after sign in.
• manifestPath: The path in your app where your manifest.json file can be found
• finished: An optional callback that can be invoked after authentication. This prevents having to do a whole page refresh in a new tab. One argument is passed to this callback, which is an object with userSession included. If included, then the redirectTo path is ignored, and the user will be logged in automatically.
• vaultUrl: The URL you'd like to use for authentication. Only necessary when developing the authentication app.
• sendToSignIn: defaults to false. Whether the user should go straight to the 'sign in' flow.
• appDetails: an optional object which includes appName: string and appIcon: string. This will speed up the process of loading your app's information during onboarding.
• userSession: Optionally, pass a UserSession instance to use for authentication. If it's not passed, @blockstack/connect will create one for you.

Local Development

There is a test app located in /test-app. cd test-app && yarn && yarn start to run a local react app with fast-refresh.