blockstack

blockstack.js

Note: If you're looking for the Blockstack CLI repo it was merged with Blockstack Core.

• Installation
• About
• Documentation
• Compatibility
• Contributing
• Maintainer
• Testing
  • Testing in a browser
• Releasing

Installation

$ npm install blockstack

Using blockstack.js with a CDN

You can import blockstack.js as a script without using a package manager. To securely use the latest distribution of blockstack.js from a CDN, use the following script in your application:

<script src="https://unpkg.com/blockstack@21.1.1/dist/blockstack.js" integrity="sha384-QsRlJlLKvr/Vq4iv1MPwTqoMx5hd0StlnCBCTdwbb0ituqCGaTxjNIkdahGHlnwb" crossorigin="anonymous"></script>

Note: this is script is bundled as standalone (UMD) lib, targeting ES6 (ECMAScript 2015).

About

Blockstack JS is a library for profiles/identity, authentication, and storage.

The authentication portion of this library can be used to:

1. create an authentication request
2. create an authentication response

The profiles/identity portion of this library can be used to:

1. transform a JSON profile into cryptographically-signed tokens
2. recover a JSON profile from signed tokens
3. validate signed profile tokens

The storage portion of this library can be used to:

1. store and retrieve your app's data in storage that is controlled by the user

Note: this lib is written in Typescript and is compiled to ES6 (ECMAScript 2015) syntax and uses CommonJS modules. The NPM package works out of the box within the Node.js runtime, and within browsers when using a common bundler (e.g. Webpack, Browserify, Rollup, etc).

Documentation

Compatibility

Note: blockstack.js 0.14.0 and newer versions use a new on-disk format that is not backward compatible with prior versions.

Contributing

This repository uses the git flow branching mode.

The latest released code as deployed to npm is in master and the latest delivered development changes for the next release are in develop.

We use the git-flow-avh plugin.

Please send pull requests against develop. Pull requests should include tests, flow static type annotations and be lint free. Open your pull request using the template in PULL_REQUEST_TEMPLATE.md

Github issues marked help-wanted are great places to start. Please ask in a github issue or slack before embarking on larger issues that aren't labeled as help wanted or adding additional functionality so that we can make sure your contribution can be included!

Maintainer

This repository is maintained by yukan.id.

Testing

$ npm run test

We test on the "Active LTS" version of Node.

Testing in a browser

This test will only work with your browser's Cross-Origin Restrictions disabled.

Run npm run compile; npm run browserify before opening the file test.html in your browser.

Releasing

See release-checklist.md