README.md

June 23, 2018 · View on GitHub

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

Zone files

import { NameZoneFile } from 'blockstack.ts';
const zoneFile = await NameZoneFile.lookupByName('vsund.id');
console.log(zoneFile.profileTokenUrl);

_{Full reference for NameZoneFile}

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

You're want to contribute something? Thanks for considering!

You're looking for something to contribute on? Please review the issues labeled with help-wanted.

You're wanting to contribute functionality? Have a look at the requested features. Though please open an issue before starting to write code; would be a pity to throw away carefully written code just because of misunderstandings.

You're not sure yet what to contribute but definitely want to help with something? Add this repository on Code Triage.

See CONTRIBUTING.md for a more complete 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.