base58-js

base58-js

A light weight (~560 byte) universal JavaScript base58 encoder and decoder.

Installation

For Node.js, to install base58-js run:

npm install base58-js

Requirements

Supported runtime environments:

• Node.js versions ^16 || >=17.0.0 .
• Browsers matching the Browserslist query > 0.5%, not OperaMini all, not dead.

Examples

Convert base58 to binary

import { base58_to_binary } from "base58-js";

const bin = base58_to_binary("6MRy");
console.log(bin);

Logged output will be Uint8Array(3) [15, 239, 64].

Convert binary to base58

import { binary_to_base58 } from "base58-js";

const str = binary_to_base58([15, 239, 64]);
console.log(str);

The logged output was Thequickbrownfoxjumpedoverthea1zydog.

Exports

Deep imports from the ECMAScript modules are exported via the package.json field exports:

• index.js
• create_base58_map.js
• binary_to_base58.js
• base58_to_binary.js
• base58_chars.js

IntelliSense via TypeScript JSDoc.

Changelog

3.0.2

• Added support for both named exports and explicit .js paths for binary_to_base58 and base58_to_binary modules.
• Consumers can now import modules either without the .js extension or with it directly:

Without .js:

import binaryToBase58 from "base58-js/binary_to_base58";

With .js:

import binaryToBase58 from "base58-js/binary_to_base58.js";