init
This commit is contained in:
+61
@@ -0,0 +1,61 @@
|
||||
4.0.0 / 2016-12-3
|
||||
------------------
|
||||
- `decode` now returns a `Buffer` again, to avoid potential cryptographic errors. [Daniel Cousens / #21](https://github.com/cryptocoinjs/bs58/pull/21)
|
||||
|
||||
3.0.0 / 2015-08-18
|
||||
------------------
|
||||
- refactored module into generic [`base-x`](https://github.com/cryptocoinjs/base-x).
|
||||
|
||||
2.0.1 / 2014-12-23
|
||||
------------------
|
||||
- performance boost in `encode()` [#10](https://github.com/cryptocoinjs/bs58/pull/10)
|
||||
|
||||
2.0.0 / 2014-10-03
|
||||
------------------
|
||||
- `decode` now returns an `Array` instead of `Buffer` to keep things simple. [Daniel Cousens / #9](https://github.com/cryptocoinjs/bs58/pull/9)
|
||||
|
||||
1.2.1 / 2014-07-24
|
||||
------------------
|
||||
* speed optimizations [Daniel Cousens / #8](https://github.com/cryptocoinjs/bs58/pull/8)
|
||||
|
||||
1.2.0 / 2014-06-29
|
||||
------------------
|
||||
* removed `bigi` dep, implemented direct byte conversion [Jared Deckard / #6](https://github.com/cryptocoinjs/bs58/pull/6)
|
||||
|
||||
1.1.0 / 2014-06-26
|
||||
------------------
|
||||
* user `Buffer` internally for calculations, providing cleaner code and a performance increase. [Daniel Cousens](https://github.com/cryptocoinjs/bs58/commit/129c71de8bc1e36f113bce06da0616066f41c5ca)
|
||||
|
||||
1.0.0 / 2014-05-27
|
||||
------------------
|
||||
* removed `binstring` dep, `Buffer` now only input to `encode()` and output of `decode()`
|
||||
* update `bigi` from `~0.3.0` to `^1.1.0`
|
||||
* added travis-ci support
|
||||
* added coveralls support
|
||||
* modified tests and library to handle fixture style testing (thanks to bitcoinjs-lib devs and [Daniel Cousens](https://github.com/dcousens))
|
||||
|
||||
|
||||
0.3.0 / 2014-02-24
|
||||
------------------
|
||||
* duck type input to `encode` and change output of `decode` to `Buffer`.
|
||||
|
||||
|
||||
0.2.1 / 2014-02-24
|
||||
------------------
|
||||
* removed bower and component support. Closes #1
|
||||
* convert from 4 spaces to 2
|
||||
|
||||
|
||||
0.2.0 / 2013-12-07
|
||||
------------------
|
||||
* renamed from `cryptocoin-base58` to `bs58`
|
||||
|
||||
|
||||
0.1.0 / 2013-11-20
|
||||
------------------
|
||||
* removed AMD support
|
||||
|
||||
|
||||
0.0.1 / 2013-11-04
|
||||
------------------
|
||||
* initial release
|
||||
+71
@@ -0,0 +1,71 @@
|
||||
bs58
|
||||
====
|
||||
|
||||
[](https://travis-ci.org/cryptocoinjs/bs58)
|
||||
|
||||
JavaScript component to compute base 58 encoding. This encoding is typically used for crypto currencies such as Bitcoin.
|
||||
|
||||
**Note:** If you're looking for **base 58 check** encoding, see: [https://github.com/bitcoinjs/bs58check](https://github.com/bitcoinjs/bs58check), which depends upon this library.
|
||||
|
||||
|
||||
Install
|
||||
-------
|
||||
|
||||
npm i --save bs58
|
||||
|
||||
|
||||
API
|
||||
---
|
||||
|
||||
### encode(input)
|
||||
|
||||
`input` must be a [Buffer](https://nodejs.org/api/buffer.html) or an `Array`. It returns a `string`.
|
||||
|
||||
**example**:
|
||||
|
||||
```js
|
||||
const bs58 = require('bs58')
|
||||
|
||||
const bytes = Buffer.from('003c176e659bea0f29a3e9bf7880c112b1b31b4dc826268187', 'hex')
|
||||
const address = bs58.encode(bytes)
|
||||
console.log(address)
|
||||
// => 16UjcYNBG9GTK4uq2f7yYEbuifqCzoLMGS
|
||||
```
|
||||
|
||||
|
||||
### decode(input)
|
||||
|
||||
`input` must be a base 58 encoded string. Returns a [Buffer](https://nodejs.org/api/buffer.html).
|
||||
|
||||
**example**:
|
||||
|
||||
```js
|
||||
const bs58 = require('bs58')
|
||||
|
||||
const address = '16UjcYNBG9GTK4uq2f7yYEbuifqCzoLMGS'
|
||||
const bytes = bs58.decode(address)
|
||||
console.log(out.toString('hex'))
|
||||
// => 003c176e659bea0f29a3e9bf7880c112b1b31b4dc826268187
|
||||
```
|
||||
|
||||
Hack / Test
|
||||
-----------
|
||||
|
||||
Uses JavaScript standard style. Read more:
|
||||
|
||||
[](https://github.com/feross/standard)
|
||||
|
||||
|
||||
Credits
|
||||
-------
|
||||
- [Mike Hearn](https://github.com/mikehearn) for original Java implementation
|
||||
- [Stefan Thomas](https://github.com/justmoon) for porting to JavaScript
|
||||
- [Stephan Pair](https://github.com/gasteve) for buffer improvements
|
||||
- [Daniel Cousens](https://github.com/dcousens) for cleanup and merging improvements from bitcoinjs-lib
|
||||
- [Jared Deckard](https://github.com/deckar01) for killing `bigi` as a dependency
|
||||
|
||||
|
||||
License
|
||||
-------
|
||||
|
||||
MIT
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
var basex = require('base-x')
|
||||
var ALPHABET = '123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz'
|
||||
|
||||
module.exports = basex(ALPHABET)
|
||||
+37
@@ -0,0 +1,37 @@
|
||||
{
|
||||
"name": "bs58",
|
||||
"version": "4.0.1",
|
||||
"description": "Base 58 encoding / decoding",
|
||||
"keywords": [
|
||||
"base58",
|
||||
"bitcoin",
|
||||
"crypto",
|
||||
"crytography",
|
||||
"decode",
|
||||
"decoding",
|
||||
"encode",
|
||||
"encoding",
|
||||
"litecoin"
|
||||
],
|
||||
"license": "MIT",
|
||||
"devDependencies": {
|
||||
"standard": "*",
|
||||
"tape": "^4.6.3"
|
||||
},
|
||||
"repository": {
|
||||
"url": "https://github.com/cryptocoinjs/bs58",
|
||||
"type": "git"
|
||||
},
|
||||
"files": [
|
||||
"./index.js"
|
||||
],
|
||||
"main": "./index.js",
|
||||
"scripts": {
|
||||
"standard": "standard",
|
||||
"test": "npm run standard && npm run unit",
|
||||
"unit": "tape test/index.js"
|
||||
},
|
||||
"dependencies": {
|
||||
"base-x": "^3.0.2"
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user