summaryrefslogtreecommitdiff
path: root/includes/external/signal/node_modules/bs58/README.md
diff options
context:
space:
mode:
authorRaindropsSys <raindrops@equestria.dev>2023-11-18 11:34:36 +0100
committerRaindropsSys <raindrops@equestria.dev>2023-11-18 11:34:36 +0100
commit9337aae8b1c87fad34884dacd5cd79d9591c60db (patch)
tree5340f9fa67cd6236e4c879f0057d51d0b1e21361 /includes/external/signal/node_modules/bs58/README.md
parent953ddd82e48dd206cef5ac94456549aed13b3ad5 (diff)
downloadpluralconnect-9337aae8b1c87fad34884dacd5cd79d9591c60db.tar.gz
pluralconnect-9337aae8b1c87fad34884dacd5cd79d9591c60db.tar.bz2
pluralconnect-9337aae8b1c87fad34884dacd5cd79d9591c60db.zip
Updated 39 files, added 86 files, deleted 40 files and renamed 2 files (automated)
Diffstat (limited to 'includes/external/signal/node_modules/bs58/README.md')
-rw-r--r--includes/external/signal/node_modules/bs58/README.md91
1 files changed, 91 insertions, 0 deletions
diff --git a/includes/external/signal/node_modules/bs58/README.md b/includes/external/signal/node_modules/bs58/README.md
new file mode 100644
index 0000000..ca0aa19
--- /dev/null
+++ b/includes/external/signal/node_modules/bs58/README.md
@@ -0,0 +1,91 @@
+bs58
+====
+
+[![build status](https://travis-ci.org/cryptocoinjs/bs58.svg)](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 `Uint8Array`, `Buffer`, or an `Array`. It returns a `string`.
+
+**example**:
+
+```js
+const bs58 = require('bs58')
+
+const bytes = Uint8Array.from([
+ 0, 60, 23, 110, 101, 155, 234,
+ 15, 41, 163, 233, 191, 120, 128,
+ 193, 18, 177, 179, 27, 77, 200,
+ 38, 38, 129, 135
+])
+const address = bs58.encode(bytes)
+console.log(address)
+// => 16UjcYNBG9GTK4uq2f7yYEbuifqCzoLMGS
+```
+
+
+### decode(input)
+
+`input` must be a base 58 encoded string. Returns a Uint8Array.
+
+**example**:
+
+```js
+const bs58 = require('bs58')
+
+const address = '16UjcYNBG9GTK4uq2f7yYEbuifqCzoLMGS'
+const bytes = bs58.decode(address)
+// See uint8array-tools package for helpful hex encoding/decoding/compare tools
+console.log(Buffer.from(bytes).toString('hex'))
+// => 003c176e659bea0f29a3e9bf7880c112b1b31b4dc826268187
+```
+
+Browser
+-----------
+You can use this module in the browser. Install Browserify:
+
+```bash
+npm install -g browserify
+```
+
+then run:
+
+```bash
+browserify node_modules/bs58/index.js -o bs58.bundle.js --standalone bs58
+```
+
+Hack / Test
+-----------
+
+Uses JavaScript standard style. Read more:
+
+[![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](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