blockstack.ts

JavaScript / TypeScript library for interacting with Blockstack

Contribute · Examples · Documentation · Quick start

develop

master

About

blockstack.ts is a library for interacting with Blockstack (i.e. identity, authentication and storage).

It's a fork of Blockstack's official blockstack.js library but got ported to TypeScript. Since TypeScript compiles to JavaScript, you can use this library in both languages without limitations.

Installation

Simply install it with yarn install blockstack.ts into your project.

Please note that the version on NPM is just a placeholder and doesn't contain any useful code.

Quick start

Identity

@todo

Authentication

@todo

Storage

@todo

For more examples see examples/.

Documentation

The code documentation lives in docs/code/. You can find a live version at https://ntzwrk.github.io/blockstack.ts/code/.

Please note that this code reference represents the state of the last release. Also if you're a developer using this library, you probably want to take a look at the quick start section and the documentation linked there.

Contributing

See CONTRIBUTING.md for a guide on how to contribute to this library.

Maintaining

See MAINTAINING.md for a guide on how to maintain this library.

License

This code is published under the MIT License.