DinosaurDad / base58-js

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

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

For Deno, import the files with deep imports.

import base58_to_binary from "https://deno.land/x/base58/base58_to_binary.mjs";
import binary_to_base_58 from "https://deno.land/x/base58/binary_to_base58.mjs";

console.log(binary_to_base_58(base58_to_binary("denoisabase58")));

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);

Logged output will be 6MRy.

Ways to require in Common JS

Note

As base58 v2.0.0 is an ESM module if you need to require it in a Common JS package, then you can require like this:

(async function () {
  const { base58_to_binary, binary_to_base58 } = await import("base58-js");
  console.log(
    binary_to_base58(base58_to_binary("Thequickbrownfoxjumpedoverthea1zydog"))
  );
})();

The logged output was Thequickbrownfoxjumpedoverthea1zydog.

Exports

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

• index.mjs
• create_base58_map.mjs.mjs
• binary_to_base58.mjs.mjs
• base58_to_binary.mjs.mjs
• base58_chars.mjs.mjs.mjs

IntelliSense via TypeScript JSDoc.