# blockstack-proofs

> A library for verifying proofs (twitter, github, domains etc) linked to a Blockstack ID

Latest version **0.3.0** (published 2016-12-15) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install blockstack-proofs
pnpm add blockstack-proofs
yarn add blockstack-proofs
bun add blockstack-proofs
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.3.0 |
| Published | 2016-12-15 |
| First published | 2016-12-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Blockstack Inc. |
| Maintainers | larrysalibra, shea256 |

## Links

- npm: https://www.npmjs.com/package/blockstack-proofs
- Repository: https://github.com/blockstack/blockstack-proofs-js
- Homepage: https://github.com/blockstack/blockstack-proofs-js#readme
- Issues: https://github.com/blockstack/blockstack-proofs-js/issues
- npm.io page: https://npm.io/package/blockstack-proofs

## Dependencies (1)

- [isomorphic-fetch](https://npm.io/package/isomorphic-fetch.md) ^2.2.1

## Recent versions

- 0.3.0 (latest) — 2016-12-15
- 0.2.2 — 2016-12-06
- 0.2.1 — 2016-12-05
- 0.2.0 — 2016-12-05
- 0.1.0 — 2016-12-02

## README

# Blockstack Proofs

[![npm](https://img.shields.io/npm/l/blockstack-proofs.svg)](https://www.npmjs.com/package/blockstack-proofs)
[![npm](https://img.shields.io/npm/v/blockstack-proofs.svg)](https://www.npmjs.com/package/blockstack-proofs)
[![npm](https://img.shields.io/npm/dm/blockstack-proofs.svg)](https://www.npmjs.com/package/blockstack-proofs)
[![Slack](http://slack.blockstack.org/badge.svg)](http://slack.blockstack.org/)

### Contents

* [Installation](#installation)
* [Importing](#importing)
* [Proofs](#proof)

A library for verifying blockstack profile proofs.

*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").*

### Installation

```
$ npm install blockstack-proofs
```

### Importing

#### ES6

```es6
import {
  validateProofs
} from 'blockstack-proofs'
```

#### Node

```es6
var blockstackProofs = require('blockstack-proofs')
```

### Usage

```es6
let fqdn = "naval.id"
validateProofs(profile, fqdn).then((proofs) => {
  console.log(proofs)
})


[
  { "identifier": "naval",
    "proof_url": "https://twitter.com/naval/status/486609266212499456",
    "service": "twitter",
    "valid": true
  },
  {
      "identifier": "navalr",
      "proof_url": "https://facebook.com/navalr/posts/10152190734077261",
      "service": "facebook",
      "valid": true
  },
  {
    "identifier": "navalr",
    "proof_url": "https://gist.github.com/navalr/f31a74054f859ec0ac6a",
    "service": "github",
    "valid": true
  }
]

```

### Testing

Run `npm run test` to run the test suite.

#### 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.

---
_Source: https://npm.io/package/blockstack-proofs · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._