@types/bs58

What is @types/bs58?

@types/bs58 provides TypeScript type definitions for the bs58 package, which is used for Base58 encoding and decoding. Base58 is commonly used in applications like Bitcoin and other cryptocurrencies to encode large numbers in a compact and human-readable format.

What are @types/bs58's main functionalities?

Base58 Encoding

This feature allows you to encode a buffer or byte array into a Base58 string. This is useful for creating compact and human-readable representations of binary data.

const bs58 = require('bs58');
const buffer = Buffer.from('hello world');
const encoded = bs58.encode(buffer);
console.log(encoded); // prints Base58 encoded string

Base58 Decoding

This feature allows you to decode a Base58 string back into a buffer or byte array. This is useful for retrieving the original binary data from its Base58 representation.

const bs58 = require('bs58');
const encoded = 'StV1DL6CwTryKyV';
const decoded = bs58.decode(encoded);
console.log(decoded.toString()); // prints the original string 'hello world'

Other packages similar to @types/bs58

base-x

The base-x package provides a generic base encoding/decoding for any base between 2 and 58. It is more flexible than bs58 as it allows you to define your own alphabet for encoding and decoding. This can be useful if you need to work with different base encodings beyond Base58.

bs58check

The bs58check package extends bs58 by adding a checksum to the encoded data. This is particularly useful in cryptocurrency applications where data integrity is crucial. It ensures that the encoded data has not been altered or corrupted.

README

Installation

npm install --save @types/bs58

Summary

This package contains type definitions for bs58 (https://github.com/cryptocoinjs/bs58).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/bs58/v3.

index.d.ts

// Type definitions for bs58 3.0
// Project: https://github.com/cryptocoinjs/bs58
// Definitions by: Ilya Mochalov <https://github.com/chrootsu>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

import * as BaseX from "base-x";

declare namespace base58 {}

declare let base58: BaseX.BaseConverter;

export = base58;

Additional Details

• Last updated: Fri, 15 Sep 2023 19:06:48 GMT
• Dependencies: @types/base-x
• Global values: none

Credits

These definitions were written by Ilya Mochalov.