# bs58check

> A straightforward implementation of base58-check encoding

Latest version **4.0.0** (published 2024-06-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install bs58check
pnpm add bs58check
yarn add bs58check
bun add bs58check
```

## Health

**Score 40/100 (D)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 4.0.0 |
| Published | 2024-06-25 |
| First published | 2014-07-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 8.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 103 |
| Author | Daniel Cousens |
| Keywords | base, base58, base58check, bitcoin, bs58, check, checksum, decode, decoding, encode, encoding, litecoin |

## Links

- npm: https://www.npmjs.com/package/bs58check
- Repository: https://github.com/bitcoinjs/bs58check
- Issues: https://github.com/bitcoinjs/bs58check/issues
- npm.io page: https://npm.io/package/bs58check

## Dependencies (2)

- [bs58](https://npm.io/package/bs58.md) ^6.0.0
- [@noble/hashes](https://npm.io/package/@noble/hashes.md) ^1.2.0

## Alternatives

- [flatbuffers](https://npm.io/package/flatbuffers.md) — 6.0M weekly downloads
- [jwt-simple](https://npm.io/package/jwt-simple.md) — 259.5K weekly downloads
- [@exodus/patch-broken-hermes-typed-arrays](https://npm.io/package/@exodus/patch-broken-hermes-typed-arrays.md) — 28.5K weekly downloads
- [@native-to-anchor/buffer-layout](https://npm.io/package/@native-to-anchor/buffer-layout.md) — 12.2K weekly downloads
- [binary-parser-encoder](https://npm.io/package/binary-parser-encoder.md) — 5.3K weekly downloads

## Recent versions

- 4.0.0 (latest) — 2024-06-25
- 3.0.1 — 2023-02-25
- 2.1.2 — 2018-07-26
- 2.1.1 — 2017-12-05
- 2.1.0 — 2017-11-13
- 2.0.2 — 2017-04-19
- 2.0.1 — 2016-12-21
- 1.3.4 — 2016-12-21
- 2.0.0 — 2016-12-21
- 1.3.1 — 2016-12-01
- 1.3.0 — 2016-11-27
- 1.1.1 — 2016-10-27
- 1.2.0 — 2016-10-27
- 1.1.0 — 2016-10-27
- 1.0.8 — 2016-01-24
- … 7 more at https://npm.io/package/bs58check/versions

## README

# bs58check

[![NPM Package](https://img.shields.io/npm/v/bs58check.svg?style=flat-square)](https://www.npmjs.org/package/bs58check)
[![Build Status](https://img.shields.io/travis/bitcoinjs/bs58check.svg?branch=master&style=flat-square)](https://travis-ci.org/bitcoinjs/bs58check)
[![Dependency status](https://img.shields.io/david/bitcoinjs/bs58check.svg?style=flat-square)](https://david-dm.org/bitcoinjs/bs58check#info=dependencies)

[![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)

A straight forward implementation of base58check extending upon bs58.


## Example

```javascript
import bs58check from 'bs58check'

var decoded = bs58check.decode('5Kd3NBUAdUnhyzenEwVLy9pBKxSwXvE9FMPyR4UKZvpe6E3AgLr')

console.log(decoded)
// => <Buffer 80 ed db dc 11 68 f1 da ea db d3 e4 4c 1e 3f 8f 5a 28 4c 20 29 f7 8a d2 6a f9 85 83 a4 99 de 5b 19>

console.log(bs58check.encode(decoded))
// => 5Kd3NBUAdUnhyzenEwVLy9pBKxSwXvE9FMPyR4UKZvpe6E3AgLr
```


## LICENSE [MIT](LICENSE)

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