# ipld-bitcoin

> JavaScript implementation of Bitcoin IPLD formats

Latest version **0.4.1** (published 2021-03-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install ipld-bitcoin
pnpm add ipld-bitcoin
yarn add ipld-bitcoin
bun add ipld-bitcoin
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.4.1 |
| Published | 2021-03-03 |
| First published | 2018-01-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 436.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 13 |
| Maintainers | vmx, daviddias |
| Keywords | IPFS |

## Links

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

## Dependencies (6)

- [cids](https://npm.io/package/cids.md) ^1.0.0
- [buffer](https://npm.io/package/buffer.md) ^6.0.3
- [multicodec](https://npm.io/package/multicodec.md) ^3.0.1
- [uint8arrays](https://npm.io/package/uint8arrays.md) ^2.1.3
- [bitcoinjs-lib](https://npm.io/package/bitcoinjs-lib.md) ^5.0.0
- [multihashing-async](https://npm.io/package/multihashing-async.md) ^2.0.0

## Recent versions

- 0.4.1 (latest) — 2021-03-03
- 0.4.0 — 2020-08-04
- 0.3.2 — 2020-07-23
- 0.3.1 — 2020-01-13
- 0.3.0 — 2019-05-10
- 0.2.0 — 2019-05-08
- 0.1.9 — 2018-12-03
- 0.1.8 — 2018-10-15
- 0.1.7 — 2018-07-19
- 0.1.6 — 2018-06-29
- 0.1.5 — 2018-02-14
- 0.1.4 — 2018-02-01
- 0.1.3 — 2018-01-22
- 0.1.2 — 2018-01-10

## README

# IPLD for Bitcoin

[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)
[![](https://img.shields.io/badge/project-IPLD-blue.svg?style=flat-square)](http://github.com/ipld/ipld)
[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
[![Travis CI](https://flat.badgen.net/travis/ipld/js-ipld-bitcoin)](https://travis-ci.com/ipld/js-ipld-bitcoin)
[![Coverage](https://coveralls.io/repos/github/ipld/js-ipld-bitcoin/badge.svg?branch=master)](https://coveralls.io/github/ipld/js-ipld-bitcoin?branch=master)
[![](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
[![](https://david-dm.org/ipld/js-ipld-bitcoin.svg?style=flat-square)](https://david-dm.org/ipld/js-ipld-bitcoin)
[![](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/feross/standard) [![Greenkeeper badge](https://badges.greenkeeper.io/ipld/js-ipld-bitcoin.svg)](https://greenkeeper.io/)
![](https://img.shields.io/badge/npm-%3E%3D3.0.0-orange.svg?style=flat-square)
![](https://img.shields.io/badge/Node.js-%3E%3D6.0.0-orange.svg?style=flat-square)

> JavaScript implementation of the [IPLD format spec](https://github.com/ipld/interface-ipld-format) for Bitcoin blocks.

## Lead Maintainer

[Volker Mische](https://github.com/vmx)

## Table of Contents

- [Install](#install)
  - [npm](#npm)
  - [Use in Node.js](#use-in-nodejs)
  - [Use in a browser with browserify, webpack or any other bundler](#use-in-a-browser-with-browserify-webpack-or-any-other-bundler)
  - [Use in a browser Using a script tag](#use-in-a-browser-using-a-script-tag)
- [Usage](#usage)
- [Contribute](#contribute)
- [License](#license)

## Install

### npm

```sh
> npm install ipld-bitcoin
```

### Use in Node.js

```JavaScript
const IpldBitcoin = require('ipld-bitcoin')
```

### Use in a browser with browserify, webpack or any other bundler

The code published to npm that gets loaded on require is in fact a ES5 transpiled version with the right shims added. This means that you can require it and use with your favourite bundler without having to adjust asset management process.

```JavaScript
var IpldBitcoin = require('ipld-bitcoin')
```

### Use in a browser Using a script tag

Loading this module through a script tag will make the `IpldBitcoint` obj available in the global namespace.

```html
<script src="https://unpkg.com/ipld-bitcoin/dist/index.min.js"></script>
<!-- OR -->
<script src="https://unpkg.com/ipld-bitcoin/dist/index.js"></script>
```

## Usage

As this is is an implementation of the [IPLD format spec](https://github.com/ipld/interface-ipld-format), it should be used through the [IPLD resolver](https://github.com/ipld/js-ipld-resolver). See the IPLD format spec for details about the API.

Though it can also be used as a standalone module:

```JavaScript
const IpldBitcoin = require('ipld-bitcoin')

// `bitcoinBlock` is some binary Bitcoin block
const dagNode = IpldBitcoin.util.deserialize(bitcoinBlock)
console.log(dagNode)
```

## Contribute

Feel free to join in. All welcome. Open an [issue](https://github.com/ipld/js-ipld-bitcoin/issues)!

For more information please check out the [contributing guidelines](CONTRIBUTING.md).

Small note: If editing the README, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.

## License

[MIT](LICENSE) © 2018 IPFS

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