noble-base58check/README.md

Noble base58check. Typed, native, 0-dep port of bs58check module.

# noble-base58check ![Node CI](https://github.com/serh11p/noble-base58check/workflows/Node%20CI/badge.svg) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)

[Base58Check](https://en.bitcoin.it/wiki/Base58Check_encoding), a modified Base 58 binary-to-text encoding known as Base58Check is used for encoding Bitcoin addresses. More generically, Base58Check encoding is used for encoding byte arrays in Bitcoin into human-typable strings.

Port of [bs58check](https://www.npmjs.com/package/bs58check) module.

### This library belongs to _noble_ crypto

> **noble-crypto** — high-security, easily auditable set of contained cryptographic libraries and tools.

- No dependencies, one small file
- Easily auditable TypeScript/JS code
- Uses es2020 bigint. Supported in Chrome, Firefox, Safari, node 10+
- All releases are signed and trusted
- Check out all libraries:
  [secp256k1](https://github.com/paulmillr/noble-secp256k1),
  [ed25519](https://github.com/paulmillr/noble-ed25519),
  [bls12-381](https://github.com/paulmillr/noble-bls12-381),
  [ripemd160](https://github.com/paulmillr/noble-ripemd160)

## Usage

Node:

```
npm install noble-base58check
```

```js
import * as b58c from "noble-base58check";
import { strictEqual } from "assert";

const hash = "1AGNa15ZQXAZUgFiqJ2i7Z2DPU2J6hW62i";
(async () => {
  const bytes = await b58c.decode(hash);
  const sameHash = await b58c.encode(bytes);
  strictEqual(sameHash, hash);
})();
```

Deno:

```typescript
import * as b58c from "https://deno.land/x/base58check/mod.ts";
import { assertEquals } from "https://deno.land/x/testing/asserts.ts";

const hash = "1AGNa15ZQXAZUgFiqJ2i7Z2DPU2J6hW62i";
const bytes = await b58c.decode(hash);
const sameHash = await b58c.encode(bytes);
assertEquals(sameHash, hash);
```

Library: [https://deno.land/x/base58check](https://deno.land/x/base58check)

## API

- [`decode(string)`](#decodestring)
- [`encode(payload)`](#encodepayload)
- [`decodeUnsafe(string)`](#decodeunsafestring)
- [`encodePlain(payload)`](#encodeplainpayload)
- [`decodePlain(string)`](#decodeplainstring)
- [`decodePlainUnsafe(string)`](#decodeplainunsafestring)
- [`decodeRaw(buffer)`](#decoderawbuffer)
- [`getChecksum(buffer)`](#getchecksumbuffer)

##### `decode(string)`

```typescript
function decode(string: string): Promise<Uint8Array>;
```

- `string: string` - string to decode with Base58Check
- Returns `Promise<Uint8Array>`: decoded bytes

##### `encode(payload)`

```typescript
function encode(payload: Uint8Array): Promise<string>;
```

- `payload: Uint8Array` - payload to encode with Base58Check
- Returns `Promise<string>`: encoded string

##### `decodeUnsafe(string)`

```typescript
function decodeUnsafe(string: string): Promise<Uint8Array | undefined>;
```

- `string: string` - string to decode with Base58Check
- Returns `Promise<Uint8Array | undefined>`: `Promise<Uint8Array>` if success; otherwise `Promise<undefined>`

##### `decodePlain(string)`

```typescript
function decodePlain(string: string): Promise<Uint8Array>;
```

- `string: string` - string to decode with plain Base58 (without check)
- Returns `Promise<Uint8Array>`: decoded bytes

##### `encodePlain(payload)`

```typescript
function encodePlain(payload: Uint8Array): Promise<string>;
```

- `payload: Uint8Array` - payload to encode with plain Base58 (without check)
- Returns `Promise<string>`: encoded string

##### `decodePlainUnsafe(string)`

```typescript
function decodePlainUnsafe(string: string): Promise<Uint8Array | undefined>;
```

- `string: string` - string to decode with plain Base58 (without check)
- Returns `Promise<Uint8Array | undefined>`: `Promise<Uint8Array>` if success; otherwise `Promise<undefined>`

##### `decodeRaw(buffer)`

```typescript
function decodeRaw(buffer: Uint8Array): Promise<Uint8Array | undefined>;
```

- `buffer: Uint8Array` - payload to encode with plain Base58 (without check)
- Returns `Promise<Uint8Array | undefined>`: `Promise<Uint8Array>` payload without last 4 bytes if checksum valid; otherwise `Promise<undefined>`

##### `getChecksum(buffer)`

```typescript
function getChecksum(buffer: Uint8Array): Promise<Uint8Array>;
```

- `buffer: Uint8Array` - payload
- Returns `Promise<Uint8Array>`: checksum (double sha256)

## Inspiration

- [bs58check](https://github.com/bitcoinjs/bs58check)
- **noble-crypto** libraries by [Paul Miller](https://github.com/paulmillr):
  [secp256k1](https://github.com/paulmillr/noble-secp256k1),
  [ed25519](https://github.com/paulmillr/noble-ed25519),
  [bls12-381](https://github.com/paulmillr/noble-bls12-381),
  [ripemd160](https://github.com/paulmillr/noble-ripemd160)

## Contributing

1. Clone the repository.
2. `npm install` to install build dependencies like TypeScript
3. `npm run compile` to compile TypeScript code
4. `npm run test` to run jest on `test/index.ts`

## License

MIT (c) Serhii Pashchenko [(https://serh11p.com)](https://serh11p.com), see LICENSE file.