https://github.com/benyasin/bs58-rn

base58 for react native
https://github.com/benyasin/bs58-rn

Last synced: 3 days ago
JSON representation

base58 for react native

• Host: GitHub
• URL: https://github.com/benyasin/bs58-rn
• Owner: benyasin
• License: other
• Created: 2018-11-29T15:16:50.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2018-11-29T23:15:30.000Z (almost 6 years ago)
• Last Synced: 2024-10-11T12:52:59.653Z (27 days ago)
• Language: JavaScript
• Size: 5.86 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# bs58-rn

## Example

Base58

``` javascript

const ALPHABET = '123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz';

const basex = require('bs58-rn');

const base58 = basex(ALPHABET);

const decoded = bs58.decode('5Kd3NBUAdUnhyzenEwVLy9pBKxSwXvE9FMPyR4UKZvpe6E3AgLr')

console.log(decoded)

// => 

console.log(bs58.encode(decoded))

// => 5Kd3NBUAdUnhyzenEwVLy9pBKxSwXvE9FMPyR4UKZvpe6E3AgLr

```

### Alphabets

See below for a list of commonly recognized alphabets, and their respective base.

Base | Alphabet

------------- | -------------

2 | `01`

8 | `01234567`

11 | `0123456789a`

16 | `0123456789abcdef`

32 | `0123456789ABCDEFGHJKMNPQRSTVWXYZ`

36 | `0123456789abcdefghijklmnopqrstuvwxyz`

58 | `123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz`

62 | `0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ`

64 | `ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/`

66 | `ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-_.!~`

## How it works

It encodes octet arrays by doing long divisions on all significant digits in the

array, creating a representation of that number in the new base. Then for every

leading zero in the input (not significant as a number) it will encode as a

single leader character. This is the first in the alphabet and will decode as 8

bits. The other characters depend upon the base. For example, a base58 alphabet

packs roughly 5.858 bits per character.

This means the encoded string 000f (using a base16, 0-f alphabet) will actually decode

to 4 bytes unlike a canonical hex encoding which uniformly packs 4 bits into each

character.

While unusual, this does mean that no padding is required and it works for bases

like 43. **If you need standard hex encoding, or base64 encoding, this module is NOT

appropriate.**