Skip to content
The Blockstack JavaScript library for identity, auth and storage
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Changes for the new Typescript doc Apr 9, 2019
.vscode Fix Linkedin verification proof Mar 25, 2019
docs-theme Patching Apr 11, 2019
docs Update docs. Jun 3, 2019
mdincludes Update docs. Jun 3, 2019
src Merge branch 'develop' into feature/delete-file May 10, 2019
tests Merge branch 'develop' into feature/delete-file May 10, 2019
.codecov.yml Fix Linkedin verification proof Mar 25, 2019
.editorconfig Fix Linkedin verification proof Mar 25, 2019
.eslintignore Hide non-exported and private members via typedoc theme Apr 11, 2019
.eslintrc.js Fix Linkedin verification proof Mar 25, 2019
.gitignore * Add docs to gitignore (no longer commit them). Apr 12, 2019
.npmignore Add `src` dir to npm package #653 Apr 23, 2019
CHANGELOG.md Update changelog for v19.2.0 May 13, 2019
CONTRIBUTING.md Contributing doc updates. Feb 7, 2019
LICENSE combine docs and src folders for profiles and proofs Feb 19, 2017
README.md arghh Apr 24, 2019
babel.config.js Fix Linkedin verification proof Mar 25, 2019
bower.json add to bower May 4, 2017
docs-button.png update docs Mar 27, 2017
overview.md Generate dist script file usage with a cdn and the subresource integr… Apr 24, 2019
package-lock.json Update docs. Jun 3, 2019
package.json Bump to v19.2.1 Jun 3, 2019
tsconfig.browser.json Fix Linkedin verification proof Mar 25, 2019
tsconfig.json Fix Linkedin verification proof Mar 25, 2019
tsconfig.typedoc.json Updating with review comments Apr 24, 2019
webpack.config.js Generate dist script file usage with a cdn and the subresource integr… Apr 24, 2019

README.md

blockstack.js CircleCI npm npm npm Slack

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

Installation

$ npm install blockstack

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, add the mdincludes/script-dist-file.md script in your application.

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 document uses ES6 in its examples but it is compiled down to Javascript (ES5) and is perfectly compatible with it. If you're using the latter, just make a few adjustments to the examples below (e.g. use "let" instead of "var").

Documentation

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.

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

  • git flow release start <version>
  • Add section to CHANGELOG.md
  • Increment version in package.json and commit
  • npm publish
  • Commit built documentation and distribution
  • git flow release finish
You can’t perform that action at this time.