mirror of
https://github.com/fluencelabs/js-peer-id
synced 2025-07-04 23:11:50 +00:00
Compare commits
5 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 3ef704ba32 | |||
| 1be7d888d6 | |||
| 0d3d9f835b | |||
| c1ed9751e3 | |||
| 01957fa095 |
21
.gitignore
vendored
21
.gitignore
vendored
@ -1,15 +1,7 @@
|
|||||||
docs
|
|
||||||
**/node_modules/
|
|
||||||
**/*.log
|
|
||||||
test/repo-tests*
|
|
||||||
**/bundle.js
|
|
||||||
|
|
||||||
# Logs
|
# Logs
|
||||||
logs
|
logs
|
||||||
*.log
|
*.log
|
||||||
|
|
||||||
coverage
|
|
||||||
|
|
||||||
# Runtime data
|
# Runtime data
|
||||||
pids
|
pids
|
||||||
*.pid
|
*.pid
|
||||||
@ -27,19 +19,12 @@ coverage
|
|||||||
# node-waf configuration
|
# node-waf configuration
|
||||||
.lock-wscript
|
.lock-wscript
|
||||||
|
|
||||||
build
|
# Compiled binary addons (http://nodejs.org/api/addons.html)
|
||||||
|
build/Release
|
||||||
|
|
||||||
# Dependency directory
|
# Dependency directory
|
||||||
# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
|
# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
|
||||||
node_modules
|
node_modules
|
||||||
|
|
||||||
docs
|
|
||||||
lib
|
|
||||||
dist
|
dist
|
||||||
test/test-data/go-ipfs-repo/LOCK
|
docs
|
||||||
test/test-data/go-ipfs-repo/LOG
|
|
||||||
test/test-data/go-ipfs-repo/LOG.old
|
|
||||||
|
|
||||||
# while testing npm5
|
|
||||||
package-lock.json
|
|
||||||
yarn.lock
|
|
||||||
28
.npmignore
Normal file
28
.npmignore
Normal file
@ -0,0 +1,28 @@
|
|||||||
|
# Logs
|
||||||
|
logs
|
||||||
|
*.log
|
||||||
|
|
||||||
|
# Runtime data
|
||||||
|
pids
|
||||||
|
*.pid
|
||||||
|
*.seed
|
||||||
|
|
||||||
|
# Directory for instrumented libs generated by jscoverage/JSCover
|
||||||
|
lib-cov
|
||||||
|
|
||||||
|
# Coverage directory used by tools like istanbul
|
||||||
|
coverage
|
||||||
|
|
||||||
|
# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
|
||||||
|
.grunt
|
||||||
|
|
||||||
|
# Compiled binary addons (http://nodejs.org/api/addons.html)
|
||||||
|
build/Release
|
||||||
|
|
||||||
|
# Optional npm cache directory
|
||||||
|
.npm
|
||||||
|
|
||||||
|
# Optional REPL history
|
||||||
|
.node_repl_history
|
||||||
|
|
||||||
|
test
|
||||||
69
.travis.yml
69
.travis.yml
@ -1,46 +1,37 @@
|
|||||||
|
sudo: false
|
||||||
language: node_js
|
language: node_js
|
||||||
cache: npm
|
|
||||||
stages:
|
|
||||||
- check
|
|
||||||
- test
|
|
||||||
- cov
|
|
||||||
|
|
||||||
node_js:
|
matrix:
|
||||||
- '10'
|
|
||||||
|
|
||||||
os:
|
|
||||||
- linux
|
|
||||||
- osx
|
|
||||||
|
|
||||||
script: npx nyc -s npm run test:node -- --bail
|
|
||||||
after_success: npx nyc report --reporter=text-lcov > coverage.lcov && npx codecov
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
include:
|
include:
|
||||||
- os: windows
|
- node_js: 4
|
||||||
cache: false
|
env: CXX=g++-4.8
|
||||||
|
- node_js: 6
|
||||||
|
env:
|
||||||
|
- SAUCE=true
|
||||||
|
- CXX=g++-4.8
|
||||||
|
- node_js: stable
|
||||||
|
env: CXX=g++-4.8
|
||||||
|
|
||||||
- stage: check
|
# Make sure we have new NPM.
|
||||||
script:
|
before_install:
|
||||||
- npx aegir commitlint --travis
|
- npm install -g npm
|
||||||
- npx aegir dep-check
|
|
||||||
- npm run lint
|
|
||||||
|
|
||||||
- stage: test
|
script:
|
||||||
name: chrome
|
- npm run lint
|
||||||
addons:
|
- npm test
|
||||||
chrome: stable
|
- npm run coverage
|
||||||
script:
|
|
||||||
- npx aegir test -t browser
|
|
||||||
- npx aegir test -t webworker
|
|
||||||
|
|
||||||
- stage: test
|
before_script:
|
||||||
name: firefox
|
- export DISPLAY=:99.0
|
||||||
addons:
|
- sh -e /etc/init.d/xvfb start
|
||||||
firefox: latest
|
|
||||||
script:
|
|
||||||
- npx aegir test -t browser -- --browsers FirefoxHeadless
|
|
||||||
- npx aegir test -t webworker -- --browsers FirefoxHeadless
|
|
||||||
|
|
||||||
notifications:
|
after_success:
|
||||||
email: false
|
- npm run coverage-publish
|
||||||
|
|
||||||
|
addons:
|
||||||
|
firefox: latest
|
||||||
|
apt:
|
||||||
|
sources:
|
||||||
|
- ubuntu-toolchain-r-test
|
||||||
|
packages:
|
||||||
|
- g++-4.8
|
||||||
|
|||||||
296
CHANGELOG.md
296
CHANGELOG.md
@ -1,296 +0,0 @@
|
|||||||
<a name="0.13.0"></a>
|
|
||||||
# [0.13.0](https://github.com/libp2p/js-peer-id/compare/v0.12.2...v0.13.0) (2019-07-11)
|
|
||||||
|
|
||||||
|
|
||||||
### Features
|
|
||||||
|
|
||||||
* async await ([#87](https://github.com/libp2p/js-peer-id/issues/87)) ([c3463c7](https://github.com/libp2p/js-peer-id/commit/c3463c7))
|
|
||||||
|
|
||||||
|
|
||||||
### BREAKING CHANGES
|
|
||||||
|
|
||||||
* API refactored to use async/await
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="0.12.2"></a>
|
|
||||||
## [0.12.2](https://github.com/libp2p/js-peer-id/compare/v0.12.1...v0.12.2) (2019-01-09)
|
|
||||||
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
* clean repo and bundle size reduction ([cd20993](https://github.com/libp2p/js-peer-id/commit/cd20993))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="0.12.1"></a>
|
|
||||||
## [0.12.1](https://github.com/libp2p/js-peer-id/compare/v0.12.0...v0.12.1) (2019-01-03)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="0.12.0"></a>
|
|
||||||
# [0.12.0](https://github.com/libp2p/js-peer-id/compare/v0.11.0...v0.12.0) (2018-10-18)
|
|
||||||
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
* add peerIdWithIs to the API functions using the instance ([2e5e666](https://github.com/libp2p/js-peer-id/commit/2e5e666))
|
|
||||||
|
|
||||||
|
|
||||||
### Features
|
|
||||||
|
|
||||||
* add class-is module ([6513a02](https://github.com/libp2p/js-peer-id/commit/6513a02))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="0.11.0"></a>
|
|
||||||
# [0.11.0](https://github.com/libp2p/js-peer-id/compare/v0.10.7...v0.11.0) (2018-07-02)
|
|
||||||
|
|
||||||
|
|
||||||
### Features
|
|
||||||
|
|
||||||
* change toPrint output to match go implementation ([e8ab1b9](https://github.com/libp2p/js-peer-id/commit/e8ab1b9))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="0.10.7"></a>
|
|
||||||
## [0.10.7](https://github.com/libp2p/js-peer-id/compare/v0.10.6...v0.10.7) (2018-04-05)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="0.10.6"></a>
|
|
||||||
## [0.10.6](https://github.com/libp2p/js-peer-id/compare/v0.10.5...v0.10.6) (2018-02-12)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="0.10.5"></a>
|
|
||||||
## [0.10.5](https://github.com/libp2p/js-peer-id/compare/v0.10.4...v0.10.5) (2018-01-28)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="0.10.4"></a>
|
|
||||||
## [0.10.4](https://github.com/libp2p/js-peer-id/compare/v0.10.3...v0.10.4) (2017-12-20)
|
|
||||||
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
* update dependencies ([#73](https://github.com/libp2p/js-peer-id/issues/73)) ([8b9a134](https://github.com/libp2p/js-peer-id/commit/8b9a134))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="0.10.3"></a>
|
|
||||||
## [0.10.3](https://github.com/libp2p/js-peer-id/compare/v0.10.2...v0.10.3) (2017-12-01)
|
|
||||||
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
* catch error when unmarshaling instead of crashing ([#72](https://github.com/libp2p/js-peer-id/issues/72)) ([156911e](https://github.com/libp2p/js-peer-id/commit/156911e))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="0.10.2"></a>
|
|
||||||
## [0.10.2](https://github.com/libp2p/js-peer-id/compare/v0.10.1...v0.10.2) (2017-10-12)
|
|
||||||
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
* Always add public key to constructor if possible, Fix for undefined pubKey in remote peers ([#68](https://github.com/libp2p/js-peer-id/issues/68)) ([3abdcda](https://github.com/libp2p/js-peer-id/commit/3abdcda))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="0.10.1"></a>
|
|
||||||
## [0.10.1](https://github.com/libp2p/js-peer-id/compare/v0.10.0...v0.10.1) (2017-09-07)
|
|
||||||
|
|
||||||
|
|
||||||
### Features
|
|
||||||
|
|
||||||
* **deps:** update aegir and libp2p-crypto ([#67](https://github.com/libp2p/js-peer-id/issues/67)) ([d7088d6](https://github.com/libp2p/js-peer-id/commit/d7088d6))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="0.10.0"></a>
|
|
||||||
# [0.10.0](https://github.com/libp2p/js-peer-id/compare/v0.9.0...v0.10.0) (2017-09-03)
|
|
||||||
|
|
||||||
|
|
||||||
### Features
|
|
||||||
|
|
||||||
* p2p addrs situation ([#66](https://github.com/libp2p/js-peer-id/issues/66)) ([63428fa](https://github.com/libp2p/js-peer-id/commit/63428fa))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="0.9.0"></a>
|
|
||||||
# [0.9.0](https://github.com/libp2p/js-peer-id/compare/v0.8.8...v0.9.0) (2017-07-22)
|
|
||||||
|
|
||||||
|
|
||||||
### Features
|
|
||||||
|
|
||||||
* use next libp2p-crypto ([#64](https://github.com/libp2p/js-peer-id/issues/64)) ([442df13](https://github.com/libp2p/js-peer-id/commit/442df13))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="0.8.8"></a>
|
|
||||||
## [0.8.8](https://github.com/libp2p/js-peer-id/compare/v0.8.7...v0.8.8) (2017-07-21)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="0.8.7"></a>
|
|
||||||
## [0.8.7](https://github.com/libp2p/js-peer-id/compare/v0.8.6...v0.8.7) (2017-04-03)
|
|
||||||
|
|
||||||
|
|
||||||
### Features
|
|
||||||
|
|
||||||
* set privKey pubKey ([ac27907](https://github.com/libp2p/js-peer-id/commit/ac27907))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="0.8.6"></a>
|
|
||||||
## [0.8.6](https://github.com/libp2p/js-peer-id/compare/v0.8.5...v0.8.6) (2017-03-30)
|
|
||||||
|
|
||||||
|
|
||||||
### Features
|
|
||||||
|
|
||||||
* isEqual ([3f4f670](https://github.com/libp2p/js-peer-id/commit/3f4f670))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="0.8.5"></a>
|
|
||||||
## [0.8.5](https://github.com/libp2p/js-peer-id/compare/v0.8.4...v0.8.5) (2017-03-27)
|
|
||||||
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
* avoid using constructor.name ([a3fe1a2](https://github.com/libp2p/js-peer-id/commit/a3fe1a2))
|
|
||||||
|
|
||||||
|
|
||||||
### Features
|
|
||||||
|
|
||||||
* isPeerId ([0acc572](https://github.com/libp2p/js-peer-id/commit/0acc572))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="0.8.4"></a>
|
|
||||||
## [0.8.4](https://github.com/libp2p/js-peer-id/compare/v0.8.2...v0.8.4) (2017-03-16)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="0.8.2"></a>
|
|
||||||
## [0.8.2](https://github.com/libp2p/js-peer-id/compare/v0.8.1...v0.8.2) (2017-02-09)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="0.8.1"></a>
|
|
||||||
## [0.8.1](https://github.com/libp2p/js-peer-id/compare/v0.8.0...v0.8.1) (2016-12-18)
|
|
||||||
|
|
||||||
|
|
||||||
### Features
|
|
||||||
|
|
||||||
* cache b58 id ([bebb0a7](https://github.com/libp2p/js-peer-id/commit/bebb0a7))
|
|
||||||
* create b58 string on creation and throw on id mutation ([78d96d0](https://github.com/libp2p/js-peer-id/commit/78d96d0))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="0.8.0"></a>
|
|
||||||
# [0.8.0](https://github.com/libp2p/js-peer-id/compare/v0.7.0...v0.8.0) (2016-11-03)
|
|
||||||
|
|
||||||
|
|
||||||
* Async Crypto Endeavour (#33) ([31701e2](https://github.com/libp2p/js-peer-id/commit/31701e2))
|
|
||||||
|
|
||||||
|
|
||||||
### BREAKING CHANGES
|
|
||||||
|
|
||||||
* This changes the interface of .create, .createFromPrivKey,
|
|
||||||
.createFromPubKey, .createFromJSON
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="0.7.0"></a>
|
|
||||||
# [0.7.0](https://github.com/libp2p/js-peer-id/compare/v0.6.7...v0.7.0) (2016-05-26)
|
|
||||||
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
* code review and docs and go interop ([58f1933](https://github.com/libp2p/js-peer-id/commit/58f1933))
|
|
||||||
* use new version of libp2p-crypto ([ab55046](https://github.com/libp2p/js-peer-id/commit/ab55046))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="0.6.7"></a>
|
|
||||||
## [0.6.7](https://github.com/libp2p/js-peer-id/compare/v0.6.6...v0.6.7) (2016-05-23)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="0.6.6"></a>
|
|
||||||
## [0.6.6](https://github.com/libp2p/js-peer-id/compare/v0.6.5...v0.6.6) (2016-04-12)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="0.6.5"></a>
|
|
||||||
## [0.6.5](https://github.com/libp2p/js-peer-id/compare/v0.6.1...v0.6.5) (2016-04-12)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="0.6.1"></a>
|
|
||||||
## [0.6.1](https://github.com/libp2p/js-peer-id/compare/v0.6.0...v0.6.1) (2016-03-15)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="0.6.0"></a>
|
|
||||||
# [0.6.0](https://github.com/libp2p/js-peer-id/compare/v0.5.3...v0.6.0) (2016-03-10)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="0.5.3"></a>
|
|
||||||
## [0.5.3](https://github.com/libp2p/js-peer-id/compare/v0.5.1...v0.5.3) (2016-03-05)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="0.5.1"></a>
|
|
||||||
## [0.5.1](https://github.com/libp2p/js-peer-id/compare/v0.5.0...v0.5.1) (2016-03-03)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="0.5.0"></a>
|
|
||||||
# [0.5.0](https://github.com/libp2p/js-peer-id/compare/v0.4.0...v0.5.0) (2016-02-14)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="0.4.0"></a>
|
|
||||||
# [0.4.0](https://github.com/libp2p/js-peer-id/compare/v0.3.4...v0.4.0) (2015-11-05)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="0.3.4"></a>
|
|
||||||
## [0.3.4](https://github.com/libp2p/js-peer-id/compare/v0.3.3...v0.3.4) (2015-10-28)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="0.3.3"></a>
|
|
||||||
## [0.3.3](https://github.com/libp2p/js-peer-id/compare/v0.3.2...v0.3.3) (2015-09-15)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="0.3.2"></a>
|
|
||||||
## [0.3.2](https://github.com/libp2p/js-peer-id/compare/v0.3.1...v0.3.2) (2015-09-14)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="0.3.1"></a>
|
|
||||||
## [0.3.1](https://github.com/libp2p/js-peer-id/compare/v0.3.0...v0.3.1) (2015-08-25)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="0.3.0"></a>
|
|
||||||
# [0.3.0](https://github.com/libp2p/js-peer-id/compare/v0.2.0...v0.3.0) (2015-07-19)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="0.2.0"></a>
|
|
||||||
# [0.2.0](https://github.com/libp2p/js-peer-id/compare/v0.1.0...v0.2.0) (2015-07-17)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="0.1.0"></a>
|
|
||||||
# 0.1.0 (2015-07-08)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
168
README.md
168
README.md
@ -1,22 +1,18 @@
|
|||||||
# peer-id
|
# peer-id
|
||||||
|
|
||||||
[](http://protocol.ai)
|
[](http://ipn.io)
|
||||||
[](http://libp2p.io/)
|
[](http://webchat.freenode.net/?channels=%23ipfs)
|
||||||
[](http://webchat.freenode.net/?channels=%23libp2p)
|
[](https://travis-ci.org/libp2p/js-peer-id)
|
||||||
[](https://discuss.libp2p.io)
|
[](https://coveralls.io/github/libp2p/js-peer-id?branch=master)
|
||||||
[](https://codecov.io/gh/libp2p/js-peer-id)
|
|
||||||
[](https://travis-ci.com/libp2p/js-peer-id)
|
|
||||||
[](https://david-dm.org/libp2p/js-peer-id)
|
[](https://david-dm.org/libp2p/js-peer-id)
|
||||||
[](https://github.com/feross/standard)
|
[](https://github.com/feross/standard)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
[](https://saucelabs.com/u/ipfs-js-peer-id)
|
||||||
|
|
||||||
> [IPFS](https://github.com/ipfs/ipfs) Peer ID implementation in JavaScript.
|
> [IPFS](https://github.com/ipfs/ipfs) Peer ID implementation in JavaScript.
|
||||||
|
|
||||||
## Lead Maintainer
|
|
||||||
|
|
||||||
[Pedro Teixeira](https://github.com/pgte)
|
|
||||||
|
|
||||||
## Table of Contents
|
|
||||||
|
|
||||||
- [Description](#description)
|
- [Description](#description)
|
||||||
- [Example](#example)
|
- [Example](#example)
|
||||||
- [Installation](#installation)
|
- [Installation](#installation)
|
||||||
@ -26,42 +22,30 @@
|
|||||||
- [Browser: Browserify, Webpack, other bundlers](#browser-browserify-webpack-other-bundlers)
|
- [Browser: Browserify, Webpack, other bundlers](#browser-browserify-webpack-other-bundlers)
|
||||||
- [Browser: `<script>` Tag](#browser-script-tag)
|
- [Browser: `<script>` Tag](#browser-script-tag)
|
||||||
- [API](#api)
|
- [API](#api)
|
||||||
- [Create](#create)
|
|
||||||
- [`new PeerId(id[, privKey, pubKey])`](#new-peeridid-privkey-pubkey)
|
|
||||||
- [`create([opts])`](#createopts)
|
|
||||||
- [Import](#import)
|
|
||||||
- [`createFromHexString(str)`](#createfromhexstringstr)
|
|
||||||
- [`createFromBytes(buf)`](#createfrombytesbuf)
|
|
||||||
- [`createFromB58String(str)`](#createfromb58stringstr)
|
|
||||||
- [`createFromPubKey(pubKey)`](#createfrompubkeypubkey)
|
|
||||||
- [`createFromPrivKey(privKey)`](#createfromprivkeyprivkey)
|
|
||||||
- [`createFromJSON(obj)`](#createfromjsonobj)
|
|
||||||
- [Export](#export)
|
|
||||||
- [`toHexString()`](#tohexstring)
|
|
||||||
- [`toBytes()`](#tobytes)
|
|
||||||
- [`toB58String()`](#tob58string)
|
|
||||||
- [`toJSON()`](#tojson)
|
|
||||||
- [`toPrint()`](#toprint)
|
|
||||||
- [License](#license)
|
- [License](#license)
|
||||||
|
|
||||||
# Description
|
# Description
|
||||||
|
|
||||||
Generate, import, and export PeerIDs, for use with [IPFS](https://github.com/ipfs/ipfs).
|
Generate, import, and export PeerIDs, for use with [IPFS](https://github.com/ipfs/ipfs).
|
||||||
|
|
||||||
A Peer ID is the SHA-256 [multihash](https://github.com/multiformats/multihash) of a public key.
|
*A Peer ID is the SHA-256 [multihash](https://github.com/multiformats/multihash) of a
|
||||||
|
public key.*
|
||||||
|
|
||||||
The public key is a base64 encoded string of a protobuf containing an RSA DER buffer. This uses a node buffer to pass the base64 encoded public key protobuf to the multihash for ID generation.
|
*The public key is a base64 encoded string of a protobuf containing an RSA DER
|
||||||
|
buffer. This uses a node buffer to pass the base64 encoded public key protobuf
|
||||||
|
to the multihash for ID generation.*
|
||||||
|
|
||||||
# Example
|
# Example
|
||||||
|
|
||||||
```JavaScript
|
```js
|
||||||
const PeerId = require('peer-id')
|
var PeerId = require('peer-id')
|
||||||
|
|
||||||
const id = await PeerId.create({ bits: 1024 })
|
PeerId.create({ bits: 1024 }, (err, id) => {
|
||||||
console.log(JSON.stringify(id.toJSON(), null, 2))
|
console.log(JSON.stringify(id.toJSON(), null, 2)
|
||||||
|
})
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash
|
```
|
||||||
{
|
{
|
||||||
"id": "Qma9T5YraSnpRDZqRR4krcSJabThc8nwZuJV3LercPHufi",
|
"id": "Qma9T5YraSnpRDZqRR4krcSJabThc8nwZuJV3LercPHufi",
|
||||||
"privKey": "CAAS4AQwggJcAgEAAoGBAMBgbIqyOL26oV3nGPBYrdpbv..",
|
"privKey": "CAAS4AQwggJcAgEAAoGBAMBgbIqyOL26oV3nGPBYrdpbv..",
|
||||||
@ -82,7 +66,7 @@ console.log(JSON.stringify(id.toJSON(), null, 2))
|
|||||||
## Node.js
|
## Node.js
|
||||||
|
|
||||||
```js
|
```js
|
||||||
const PeerId = require('peer-id')
|
var PeerId = require('peer-id')
|
||||||
```
|
```
|
||||||
|
|
||||||
## Browser: Browserify, Webpack, other bundlers
|
## Browser: Browserify, Webpack, other bundlers
|
||||||
@ -93,7 +77,7 @@ it and use with your favourite bundler without having to adjust asset management
|
|||||||
process.
|
process.
|
||||||
|
|
||||||
```js
|
```js
|
||||||
const PeerId = require('peer-id')
|
var PeerId = require('peer-id')
|
||||||
```
|
```
|
||||||
|
|
||||||
## Browser: `<script>` Tag
|
## Browser: `<script>` Tag
|
||||||
@ -109,116 +93,6 @@ the global namespace.
|
|||||||
|
|
||||||
# API
|
# API
|
||||||
|
|
||||||
```js
|
|
||||||
const PeerId = require('peer-id')
|
|
||||||
```
|
|
||||||
|
|
||||||
## Create
|
|
||||||
|
|
||||||
### `new PeerId(id[, privKey, pubKey])`
|
|
||||||
|
|
||||||
- `id: Buffer` - The multihash of the publick key as `Buffer`
|
|
||||||
- `privKey: RsaPrivateKey` - The private key
|
|
||||||
- `pubKey: RsaPublicKey` - The public key
|
|
||||||
|
|
||||||
The key format is detailed in [libp2p-crypto](https://github.com/libp2p/js-libp2p-crypto).
|
|
||||||
|
|
||||||
### `create([opts])`
|
|
||||||
|
|
||||||
Generates a new Peer ID, complete with public/private keypair.
|
|
||||||
|
|
||||||
- `opts: Object`: Default: `{bits: 2048}`
|
|
||||||
|
|
||||||
Returns `Promise<PeerId>`.
|
|
||||||
|
|
||||||
## Import
|
|
||||||
|
|
||||||
### `createFromHexString(str)`
|
|
||||||
|
|
||||||
Creates a Peer ID from hex string representing the key's multihash.
|
|
||||||
|
|
||||||
Returns `PeerId.
|
|
||||||
|
|
||||||
### `createFromBytes(buf)`
|
|
||||||
|
|
||||||
Creates a Peer ID from a buffer representing the key's multihash.
|
|
||||||
|
|
||||||
Returns `PeerId`.
|
|
||||||
|
|
||||||
### `createFromB58String(str)`
|
|
||||||
|
|
||||||
Creates a Peer ID from a Base58 string representing the key's multihash.
|
|
||||||
|
|
||||||
Returns `PeerId`.
|
|
||||||
|
|
||||||
### `createFromPubKey(pubKey)`
|
|
||||||
|
|
||||||
- `publicKey: Buffer`
|
|
||||||
|
|
||||||
Creates a Peer ID from a buffer containing a public key.
|
|
||||||
|
|
||||||
Returns `Promise<PeerId>`.
|
|
||||||
|
|
||||||
### `createFromPrivKey(privKey)`
|
|
||||||
|
|
||||||
- `privKey: Buffer`
|
|
||||||
|
|
||||||
Creates a Peer ID from a buffer containing a private key.
|
|
||||||
|
|
||||||
Returns `Promise<PeerId>`.
|
|
||||||
|
|
||||||
### `createFromJSON(obj)`
|
|
||||||
|
|
||||||
- `obj.id: String` - The multihash encoded in `base58`
|
|
||||||
- `obj.pubKey: String` - The public key in protobuf format, encoded in `base64`
|
|
||||||
- `obj.privKey: String` - The private key in protobuf format, encoded in `base64`
|
|
||||||
|
|
||||||
Returns `Promise<PeerId>`.
|
|
||||||
|
|
||||||
## Export
|
|
||||||
|
|
||||||
### `toHexString()`
|
|
||||||
|
|
||||||
Returns the Peer ID's `id` as a hex string.
|
|
||||||
|
|
||||||
```
|
|
||||||
1220d6243998f2fc56343ad7ed0342ab7886a4eb18d736f1b67d44b37fcc81e0f39f
|
|
||||||
```
|
|
||||||
|
|
||||||
### `toBytes()`
|
|
||||||
|
|
||||||
Returns the Peer ID's `id` as a buffer.
|
|
||||||
|
|
||||||
```
|
|
||||||
<Buffer 12 20 d6 24 39 98 f2 fc 56 34 3a d7 ed 03 42 ab 78 86 a4 eb 18 d7 36 f1 b6 7d 44 b3 7f cc 81 e0 f3 9f>
|
|
||||||
```
|
|
||||||
|
|
||||||
### `toB58String()`
|
|
||||||
|
|
||||||
Returns the Peer ID's `id` as a base58 string.
|
|
||||||
|
|
||||||
```
|
|
||||||
QmckZzdVd72h9QUFuJJpQqhsZqGLwjhh81qSvZ9BhB2FQi
|
|
||||||
```
|
|
||||||
|
|
||||||
### `toJSON()`
|
|
||||||
|
|
||||||
Returns an `obj` of the form
|
|
||||||
|
|
||||||
- `obj.id: String` - The multihash encoded in `base58`
|
|
||||||
- `obj.pubKey: String` - The public key in protobuf format, encoded in 'base64'
|
|
||||||
- `obj.privKey: String` - The private key in protobuf format, encoded in 'base 64'
|
|
||||||
|
|
||||||
### `toPrint()`
|
|
||||||
|
|
||||||
Returns the Peer ID as a printable string without the `Qm` prefix.
|
|
||||||
|
|
||||||
Example: `<peer.ID xxxxxx>`
|
|
||||||
|
|
||||||
### `isEqual(id)`
|
|
||||||
|
|
||||||
- `id` can be a PeerId or a Buffer containing the id
|
|
||||||
|
|
||||||
# License
|
# License
|
||||||
|
|
||||||
MIT
|
MIT
|
||||||
|
|||||||
12
circle.yml
Normal file
12
circle.yml
Normal file
@ -0,0 +1,12 @@
|
|||||||
|
machine:
|
||||||
|
node:
|
||||||
|
version: stable
|
||||||
|
|
||||||
|
dependencies:
|
||||||
|
pre:
|
||||||
|
- google-chrome --version
|
||||||
|
- wget -q -O - https://dl-ssl.google.com/linux/linux_signing_key.pub | sudo apt-key add -
|
||||||
|
- sudo sh -c 'echo "deb [arch=amd64] http://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google.list'
|
||||||
|
- sudo apt-get update
|
||||||
|
- sudo apt-get --only-upgrade install google-chrome-stable
|
||||||
|
- google-chrome --version
|
||||||
5
documentation.yml
Normal file
5
documentation.yml
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
toc:
|
||||||
|
- name: Introduction
|
||||||
|
file: intro.md
|
||||||
|
- PeerId
|
||||||
|
- PeerIdJson
|
||||||
61
intro.md
Normal file
61
intro.md
Normal file
@ -0,0 +1,61 @@
|
|||||||
|
Generate, import, and export PeerIDs, for use with [IPFS](https://github.com/ipfs/ipfs).
|
||||||
|
|
||||||
|
> A Peer ID is the SHA-256 [multihash](https://github.com/multiformats/multihash) of a public key.
|
||||||
|
>
|
||||||
|
> The public key is a base64 encoded string of a protobuf containing an RSA DER buffer. This uses a node buffer to pass the base64 encoded public key protobuf to the multihash for ID generation.
|
||||||
|
|
||||||
|
## Example
|
||||||
|
|
||||||
|
```js
|
||||||
|
var PeerId = require('peer-id')
|
||||||
|
|
||||||
|
PeerId.create({ bits: 1024 }, (err, id) => {
|
||||||
|
console.log(JSON.stringify(id.toJSON(), null, 2)
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"id": "Qma9T5YraSnpRDZqRR4krcSJabThc8nwZuJV3LercPHufi",
|
||||||
|
"privKey": "CAAS4AQwggJcAgEAAoGBAMBgbIqyOL26oV3nGPBYrdpbv..",
|
||||||
|
"pubKey": "CAASogEwgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMBgbIqyOL26oV3nGPBYrdpbvzCY..."
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
### npm
|
||||||
|
|
||||||
|
```sh
|
||||||
|
> npm i peer-id
|
||||||
|
```
|
||||||
|
|
||||||
|
## Setup
|
||||||
|
|
||||||
|
### Node.js
|
||||||
|
|
||||||
|
```js
|
||||||
|
var PeerId = require('peer-id')
|
||||||
|
```
|
||||||
|
|
||||||
|
### Browser: Browserify, Webpack, other bundlers
|
||||||
|
|
||||||
|
The code published to npm that gets loaded on require is in fact a ES5
|
||||||
|
transpiled version with the right shims added. This means that you can require
|
||||||
|
it and use with your favourite bundler without having to adjust asset management
|
||||||
|
process.
|
||||||
|
|
||||||
|
```js
|
||||||
|
var PeerId = require('peer-id')
|
||||||
|
```
|
||||||
|
|
||||||
|
### Browser: `<script>` Tag
|
||||||
|
|
||||||
|
Loading this module through a script tag will make the `PeerId` obj available in
|
||||||
|
the global namespace.
|
||||||
|
|
||||||
|
```html
|
||||||
|
<script src="https://unpkg.com/peer-id/dist/index.min.js"></script>
|
||||||
|
<!-- OR -->
|
||||||
|
<script src="https://unpkg.com/peer-id/dist/index.js"></script>
|
||||||
|
```
|
||||||
62
package.json
62
package.json
@ -1,48 +1,47 @@
|
|||||||
{
|
{
|
||||||
"name": "peer-id",
|
"name": "peer-id",
|
||||||
"version": "0.13.0",
|
"version": "0.8.0",
|
||||||
"description": "IPFS Peer Id implementation in Node.js",
|
"description": "IPFS Peer Id implementation in Node.js",
|
||||||
"leadMaintainer": "Pedro Teixeira <i@pgte.me>",
|
|
||||||
"main": "src/index.js",
|
"main": "src/index.js",
|
||||||
"bin": "src/bin.js",
|
"bin": "src/bin.js",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"lint": "aegir lint",
|
"lint": "aegir-lint",
|
||||||
"build": "aegir build",
|
"build": "aegir-build",
|
||||||
"test": "aegir test",
|
"test": "aegir-test",
|
||||||
"test:node": "aegir test -t node",
|
"test:node": "aegir-test node",
|
||||||
"test:browser": "aegir test -t browser -t webworker",
|
"test:browser": "aegir-test browser",
|
||||||
"release": "aegir release",
|
"release": "aegir-release",
|
||||||
"release-minor": "aegir release --type minor",
|
"release-minor": "aegir-release --type minor",
|
||||||
"release-major": "aegir release --type major",
|
"release-major": "aegir-release --type major",
|
||||||
"coverage": "aegir coverage",
|
"coverage": "aegir-coverage",
|
||||||
"size": "bundlesize -f dist/index.min.js -s 140kB"
|
"coverage-publish": "aegir-coverage publish",
|
||||||
|
"docs": "aegir-docs"
|
||||||
},
|
},
|
||||||
"files": [
|
|
||||||
"src",
|
|
||||||
"dist"
|
|
||||||
],
|
|
||||||
"keywords": [
|
"keywords": [
|
||||||
"IPFS"
|
"IPFS"
|
||||||
],
|
],
|
||||||
|
"author": "David Dias <daviddias@ipfs.io>",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
|
"pre-commit": [
|
||||||
|
"lint",
|
||||||
|
"test"
|
||||||
|
],
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": ">=10.0.0",
|
"node": ">=4.0.0"
|
||||||
"npm": ">=6.0.0"
|
|
||||||
},
|
},
|
||||||
"bugs": {
|
"bugs": {
|
||||||
"url": "https://github.com/libp2p/js-peer-id/issues"
|
"url": "https://github.com/libp2p/js-peer-id/issues"
|
||||||
},
|
},
|
||||||
"homepage": "https://github.com/libp2p/js-peer-id",
|
"homepage": "https://github.com/libp2p/js-peer-id",
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"aegir": "^19.0.5",
|
"aegir": "^9.1.2",
|
||||||
"bundlesize": "~0.18.0",
|
"chai": "^3.5.0",
|
||||||
"chai": "^4.2.0",
|
"pre-commit": "^1.1.3"
|
||||||
"dirty-chai": "^2.0.1"
|
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"class-is": "^1.1.0",
|
"async": "^2.0.1",
|
||||||
"libp2p-crypto": "~0.17.0",
|
"libp2p-crypto": "^0.7.0",
|
||||||
"multihashes": "~0.4.14"
|
"multihashes": "^0.3.0"
|
||||||
},
|
},
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
@ -52,21 +51,10 @@
|
|||||||
"David Dias <daviddias.p@gmail.com>",
|
"David Dias <daviddias.p@gmail.com>",
|
||||||
"David Dias <mail@daviddias.me>",
|
"David Dias <mail@daviddias.me>",
|
||||||
"Friedel Ziegelmayer <dignifiedquire@gmail.com>",
|
"Friedel Ziegelmayer <dignifiedquire@gmail.com>",
|
||||||
"Henrique Dias <hacdias@gmail.com>",
|
|
||||||
"Hugo Dias <hugomrdias@gmail.com>",
|
|
||||||
"Maciej Krüger <mkg20001@gmail.com>",
|
|
||||||
"Michael Garvin <gar+gh@danger.computer>",
|
|
||||||
"Pedro Teixeira <i@pgte.me>",
|
|
||||||
"Prashanth Chandra <coolshanth94@gmail.com>",
|
|
||||||
"Richard Littauer <richard.littauer@gmail.com>",
|
"Richard Littauer <richard.littauer@gmail.com>",
|
||||||
"Richard Schneider <makaretu@gmail.com>",
|
|
||||||
"Stephen Whitmore <stephen.whitmore@gmail.com>",
|
"Stephen Whitmore <stephen.whitmore@gmail.com>",
|
||||||
"Vasco Santos <vasco.santos@ua.pt>",
|
|
||||||
"Vasco Santos <vasco.santos@moxy.studio>",
|
|
||||||
"Yahya <ya7yaz@gmail.com>",
|
|
||||||
"greenkeeperio-bot <support@greenkeeper.io>",
|
"greenkeeperio-bot <support@greenkeeper.io>",
|
||||||
"nginnever <ginneversource@gmail.com>",
|
"nginnever <ginneversource@gmail.com>",
|
||||||
"npmcdn-to-unpkg-bot <npmcdn-to-unpkg-bot@users.noreply.github.com>",
|
"npmcdn-to-unpkg-bot <npmcdn-to-unpkg-bot@users.noreply.github.com>"
|
||||||
"ᴠɪᴄᴛᴏʀ ʙᴊᴇʟᴋʜᴏʟᴍ <victorbjelkholm@gmail.com>"
|
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|||||||
11
src/bin.js
11
src/bin.js
@ -4,9 +4,10 @@
|
|||||||
|
|
||||||
const PeerId = require('./index.js')
|
const PeerId = require('./index.js')
|
||||||
|
|
||||||
async function main () {
|
PeerId.create((err, id) => {
|
||||||
const id = await PeerId.create()
|
if (err) {
|
||||||
console.log(JSON.stringify(id.toJSON(), null, 2)) // eslint-disable-line no-console
|
throw err
|
||||||
}
|
}
|
||||||
|
|
||||||
main()
|
console.log(JSON.stringify(id.toJSON(), null, 2))
|
||||||
|
})
|
||||||
|
|||||||
434
src/index.js
434
src/index.js
@ -1,15 +1,32 @@
|
|||||||
/*
|
|
||||||
* Id is an object representation of a peer Id. a peer Id is a multihash
|
|
||||||
*/
|
|
||||||
|
|
||||||
'use strict'
|
'use strict'
|
||||||
|
|
||||||
const mh = require('multihashes')
|
const mh = require('multihashes')
|
||||||
const cryptoKeys = require('libp2p-crypto/src/keys')
|
const crypto = require('libp2p-crypto')
|
||||||
const assert = require('assert')
|
const assert = require('assert')
|
||||||
const withIs = require('class-is')
|
const waterfall = require('async/waterfall')
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @name PeerIdJson
|
||||||
|
* @type {Object}
|
||||||
|
* @typedef {Object} PeerIdJson
|
||||||
|
* @param {string} id - `Base58` encoded peer id
|
||||||
|
* @param {string=} privKey - The RSA private key in protobuf format, encoded in `base64`.
|
||||||
|
* @param {string=} pubKey - The RSA public key in protobuf format, encoded in `base64`.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A Peer ID is the SHA-256
|
||||||
|
* [multihash](https://github.com/multiformats/multihash) of a
|
||||||
|
* public key.
|
||||||
|
* @class PeerId
|
||||||
|
* @see [libp2p-crypto](htttps://github.com/libp2p/js-libp2p-crypto)
|
||||||
|
*/
|
||||||
class PeerId {
|
class PeerId {
|
||||||
|
/**
|
||||||
|
* @param {Buffer} id
|
||||||
|
* @param {RSAPrivateKey=} privKey
|
||||||
|
* @param {RSAPublickKey=} pubKey
|
||||||
|
*/
|
||||||
constructor (id, privKey, pubKey) {
|
constructor (id, privKey, pubKey) {
|
||||||
assert(Buffer.isBuffer(id), 'invalid id provided')
|
assert(Buffer.isBuffer(id), 'invalid id provided')
|
||||||
|
|
||||||
@ -17,219 +34,306 @@ class PeerId {
|
|||||||
assert(privKey.public.bytes.equals(pubKey.bytes), 'inconsistent arguments')
|
assert(privKey.public.bytes.equals(pubKey.bytes), 'inconsistent arguments')
|
||||||
}
|
}
|
||||||
|
|
||||||
this._id = id
|
/**
|
||||||
this._idB58String = mh.toB58String(this.id)
|
* @type {Buffer}
|
||||||
|
*/
|
||||||
|
this.id = id
|
||||||
this._privKey = privKey
|
this._privKey = privKey
|
||||||
this._pubKey = pubKey
|
this._pubKey = pubKey
|
||||||
}
|
}
|
||||||
|
|
||||||
get id () {
|
/**
|
||||||
return this._id
|
* The private key of this id, if it exists.
|
||||||
}
|
*
|
||||||
|
* @type {RSAPrivateKey|undefined}
|
||||||
set id (val) {
|
*/
|
||||||
throw new Error('Id is immutable')
|
|
||||||
}
|
|
||||||
|
|
||||||
get privKey () {
|
get privKey () {
|
||||||
return this._privKey
|
return this._privKey
|
||||||
}
|
}
|
||||||
|
|
||||||
set privKey (privKey) {
|
/**
|
||||||
this._privKey = privKey
|
* The public key of this id, if it exists.
|
||||||
}
|
*
|
||||||
|
* @type {(RSAPublicKey|undefined)}
|
||||||
|
*/
|
||||||
get pubKey () {
|
get pubKey () {
|
||||||
if (this._pubKey) {
|
if (this._pubKey) {
|
||||||
return this._pubKey
|
return this._pubKey
|
||||||
}
|
}
|
||||||
|
|
||||||
if (this._privKey) {
|
if (this.privKey) {
|
||||||
return this._privKey.public
|
return this.privKey.public
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
set pubKey (pubKey) {
|
/** Create the protobuf version of the public key,
|
||||||
this._pubKey = pubKey
|
* matching go-ipfs formatting.
|
||||||
}
|
*
|
||||||
|
* @returns {Buffer} - The marshalled public key
|
||||||
// Return the protobuf version of the public key, matching go ipfs formatting
|
*/
|
||||||
marshalPubKey () {
|
marshalPubKey () {
|
||||||
if (this.pubKey) {
|
if (this.pubKey) {
|
||||||
return cryptoKeys.marshalPublicKey(this.pubKey)
|
return crypto.marshalPublicKey(this.pubKey)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Return the protobuf version of the private key, matching go ipfs formatting
|
/** Create the protobuf version of the private key,
|
||||||
|
* matching go-ipfs formatting.
|
||||||
|
*
|
||||||
|
* @returns {Buffer}
|
||||||
|
*/
|
||||||
marshalPrivKey () {
|
marshalPrivKey () {
|
||||||
if (this.privKey) {
|
if (this.privKey) {
|
||||||
return cryptoKeys.marshalPrivateKey(this.privKey)
|
return crypto.marshalPrivateKey(this.privKey)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Alias for `toJSON`.
|
||||||
|
*
|
||||||
|
* @returns {PeerIdJson}
|
||||||
|
*/
|
||||||
toPrint () {
|
toPrint () {
|
||||||
let pid = this.toB58String()
|
return this.toJSON()
|
||||||
// All sha256 nodes start with Qm
|
|
||||||
// We can skip the Qm to make the peer.ID more useful
|
|
||||||
if (pid.startsWith('Qm')) {
|
|
||||||
pid = pid.slice(2)
|
|
||||||
}
|
|
||||||
let maxRunes = 6
|
|
||||||
if (pid.length < maxRunes) {
|
|
||||||
maxRunes = pid.length
|
|
||||||
}
|
|
||||||
|
|
||||||
return '<peer.ID ' + pid.substr(0, maxRunes) + '>'
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// return the jsonified version of the key, matching the formatting
|
/**
|
||||||
// of go-ipfs for its config file
|
* Return the jsonified version of the key, matching the formatting
|
||||||
|
* of go-ipfs for its config file.
|
||||||
|
*
|
||||||
|
* @returns {PeerIdJson}
|
||||||
|
*/
|
||||||
toJSON () {
|
toJSON () {
|
||||||
return {
|
return {
|
||||||
id: this.toB58String(),
|
id: mh.toB58String(this.id),
|
||||||
privKey: toB64Opt(this.marshalPrivKey()),
|
privKey: toB64Opt(this.marshalPrivKey()),
|
||||||
pubKey: toB64Opt(this.marshalPubKey())
|
pubKey: toB64Opt(this.marshalPubKey())
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// encode/decode functions
|
/**
|
||||||
|
* Returns the Peer ID's `id` as a hex string.
|
||||||
|
*
|
||||||
|
* @returns {String}
|
||||||
|
*/
|
||||||
toHexString () {
|
toHexString () {
|
||||||
return mh.toHexString(this.id)
|
return mh.toHexString(this.id)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the Peer ID's `id` as a buffer.
|
||||||
|
*
|
||||||
|
* @returns {Buffer}
|
||||||
|
*/
|
||||||
toBytes () {
|
toBytes () {
|
||||||
return this.id
|
return this.id
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the Peer ID's `id` as a base58 string.
|
||||||
|
*
|
||||||
|
* @returns {String}
|
||||||
|
*/
|
||||||
toB58String () {
|
toB58String () {
|
||||||
return this._idB58String
|
return mh.toB58String(this.id)
|
||||||
}
|
}
|
||||||
|
|
||||||
isEqual (id) {
|
/**
|
||||||
if (Buffer.isBuffer(id)) {
|
* Create a new `PeerId` by generating a new public/private keypair.
|
||||||
return this.id.equals(id)
|
*
|
||||||
} else if (id.id) {
|
* @param {Object=} opts - Configuration object.
|
||||||
return this.id.equals(id.id)
|
* @param {number} [opts.bits=2048] - How many bits to use for the RSA key generation.
|
||||||
|
* @param {function(Error, PeerId)} callback - Node.js style callback.
|
||||||
|
* @returns {undefined}
|
||||||
|
*
|
||||||
|
* @example
|
||||||
|
* const PeerId = require('peer-id')
|
||||||
|
*
|
||||||
|
* PeerId.create((err, id) => {
|
||||||
|
* if (err) {
|
||||||
|
* throw err
|
||||||
|
* }
|
||||||
|
* console.log('id', JSON.stringify(id))
|
||||||
|
* })
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
static create (opts, callback) {
|
||||||
|
if (typeof opts === 'function') {
|
||||||
|
callback = opts
|
||||||
|
opts = {}
|
||||||
|
}
|
||||||
|
opts = opts || {}
|
||||||
|
opts.bits = opts.bits || 2048
|
||||||
|
|
||||||
|
waterfall([
|
||||||
|
(cb) => crypto.generateKeyPair('RSA', opts.bits, cb),
|
||||||
|
(privKey, cb) => privKey.public.hash((err, digest) => {
|
||||||
|
cb(err, digest, privKey)
|
||||||
|
})
|
||||||
|
], (err, digest, privKey) => {
|
||||||
|
if (err) {
|
||||||
|
return callback(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
callback(null, new PeerId(digest, privKey))
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates a Peer ID from hex string representing the key's multihash.
|
||||||
|
*
|
||||||
|
* @param {string} str - Hex encoded id
|
||||||
|
* @returns {PeerId}
|
||||||
|
*/
|
||||||
|
static createFromHexString (str) {
|
||||||
|
return new PeerId(mh.fromHexString(str))
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates a Peer ID from a buffer representing the key's multihash.
|
||||||
|
*
|
||||||
|
* @param {Buffer} buf
|
||||||
|
* @returns {PeerId}
|
||||||
|
*/
|
||||||
|
static createFromBytes (buf) {
|
||||||
|
return new PeerId(buf)
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates a Peer ID from a `base58` string representing the
|
||||||
|
* key's multihash.
|
||||||
|
*
|
||||||
|
* @param {string} str - `base58` encoded id
|
||||||
|
* @returns {PeerId}
|
||||||
|
*/
|
||||||
|
static createFromB58String (str) {
|
||||||
|
return new PeerId(mh.fromB58String(str))
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates a Peer ID from a buffer containing a public key.
|
||||||
|
*
|
||||||
|
* @param {string|Buffer} key
|
||||||
|
* @param {function(Error, PeerId)} callback
|
||||||
|
* @returns {undefined}
|
||||||
|
*/
|
||||||
|
static createFromPubKey (key, callback) {
|
||||||
|
let buf = key
|
||||||
|
if (typeof buf === 'string') {
|
||||||
|
buf = new Buffer(key, 'base64')
|
||||||
|
}
|
||||||
|
|
||||||
|
if (typeof callback !== 'function') {
|
||||||
|
throw new Error('callback is required')
|
||||||
|
}
|
||||||
|
|
||||||
|
const pubKey = crypto.unmarshalPublicKey(buf)
|
||||||
|
pubKey.hash((err, digest) => {
|
||||||
|
if (err) {
|
||||||
|
return callback(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
callback(null, new PeerId(digest, null, pubKey))
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates a Peer ID from a buffer containing a private key.
|
||||||
|
*
|
||||||
|
* @param {string|Buffer} key - The private key, if passed as
|
||||||
|
* string `base64` encoding is assumed.
|
||||||
|
* @param {function(Error, PeerId)} callback
|
||||||
|
* @returns {undefined}
|
||||||
|
*/
|
||||||
|
static createFromPrivKey (key, callback) {
|
||||||
|
let buf = key
|
||||||
|
if (typeof buf === 'string') {
|
||||||
|
buf = new Buffer(key, 'base64')
|
||||||
|
}
|
||||||
|
|
||||||
|
if (typeof callback !== 'function') {
|
||||||
|
throw new Error('callback is required')
|
||||||
|
}
|
||||||
|
|
||||||
|
waterfall([
|
||||||
|
(cb) => crypto.unmarshalPrivateKey(buf, cb),
|
||||||
|
(privKey, cb) => privKey.public.hash((err, digest) => {
|
||||||
|
cb(err, digest, privKey)
|
||||||
|
})
|
||||||
|
], (err, digest, privKey) => {
|
||||||
|
if (err) {
|
||||||
|
return callback(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
callback(null, new PeerId(digest, privKey))
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Import a `PeerId` from a serialized JSON object.
|
||||||
|
*
|
||||||
|
* @param {PeerIdJson} obj
|
||||||
|
* @param {function(Error, PeerId)} callback
|
||||||
|
* @returns {undefined}
|
||||||
|
*/
|
||||||
|
static createFromJSON (obj, callback) {
|
||||||
|
if (typeof callback !== 'function') {
|
||||||
|
throw new Error('callback is required')
|
||||||
|
}
|
||||||
|
|
||||||
|
const id = mh.fromB58String(obj.id)
|
||||||
|
const rawPrivKey = obj.privKey && new Buffer(obj.privKey, 'base64')
|
||||||
|
const rawPubKey = obj.pubKey && new Buffer(obj.pubKey, 'base64')
|
||||||
|
const pub = rawPubKey && crypto.unmarshalPublicKey(rawPubKey)
|
||||||
|
|
||||||
|
if (rawPrivKey) {
|
||||||
|
waterfall([
|
||||||
|
(cb) => crypto.unmarshalPrivateKey(rawPrivKey, cb),
|
||||||
|
(priv, cb) => priv.public.hash((err, digest) => {
|
||||||
|
cb(err, digest, priv)
|
||||||
|
}),
|
||||||
|
(privDigest, priv, cb) => {
|
||||||
|
if (pub) {
|
||||||
|
pub.hash((err, pubDigest) => {
|
||||||
|
cb(err, privDigest, priv, pubDigest)
|
||||||
|
})
|
||||||
|
} else {
|
||||||
|
cb(null, privDigest, priv)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
], (err, privDigest, priv, pubDigest) => {
|
||||||
|
if (err) {
|
||||||
|
return callback(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if (pub && !privDigest.equals(pubDigest)) {
|
||||||
|
return callback(new Error('Public and private key do not match'))
|
||||||
|
}
|
||||||
|
|
||||||
|
if (id && !privDigest.equals(id)) {
|
||||||
|
return callback(new Error('Id and private key do not match'))
|
||||||
|
}
|
||||||
|
|
||||||
|
callback(null, new PeerId(id, priv, pub))
|
||||||
|
})
|
||||||
} else {
|
} else {
|
||||||
throw new Error('not valid Id')
|
callback(null, new PeerId(id, null, pub))
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/*
|
|
||||||
* Check if this PeerId instance is valid (privKey -> pubKey -> Id)
|
|
||||||
*/
|
|
||||||
isValid () {
|
|
||||||
// TODO: needs better checking
|
|
||||||
return Boolean(this.privKey &&
|
|
||||||
this.privKey.public &&
|
|
||||||
this.privKey.public.bytes &&
|
|
||||||
Buffer.isBuffer(this.pubKey.bytes) &&
|
|
||||||
this.privKey.public.bytes.equals(this.pubKey.bytes))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
const PeerIdWithIs = withIs(PeerId, {
|
|
||||||
className: 'PeerId',
|
|
||||||
symbolName: '@libp2p/js-peer-id/PeerId'
|
|
||||||
})
|
|
||||||
|
|
||||||
exports = module.exports = PeerIdWithIs
|
|
||||||
|
|
||||||
// generation
|
|
||||||
exports.create = async (opts) => {
|
|
||||||
opts = opts || {}
|
|
||||||
opts.bits = opts.bits || 2048
|
|
||||||
|
|
||||||
const key = await cryptoKeys.generateKeyPair('RSA', opts.bits)
|
|
||||||
const digest = await key.public.hash()
|
|
||||||
|
|
||||||
return new PeerIdWithIs(digest, key)
|
|
||||||
}
|
|
||||||
|
|
||||||
exports.createFromHexString = (str) => {
|
|
||||||
return new PeerIdWithIs(mh.fromHexString(str))
|
|
||||||
}
|
|
||||||
|
|
||||||
exports.createFromBytes = (buf) => {
|
|
||||||
return new PeerIdWithIs(buf)
|
|
||||||
}
|
|
||||||
|
|
||||||
exports.createFromB58String = (str) => {
|
|
||||||
return new PeerIdWithIs(mh.fromB58String(str))
|
|
||||||
}
|
|
||||||
|
|
||||||
// Public Key input will be a buffer
|
|
||||||
exports.createFromPubKey = async (key) => {
|
|
||||||
let buf = key
|
|
||||||
|
|
||||||
if (typeof buf === 'string') {
|
|
||||||
buf = Buffer.from(key, 'base64')
|
|
||||||
}
|
|
||||||
|
|
||||||
if (!Buffer.isBuffer(buf)) {
|
|
||||||
throw new Error('Supplied key is neither a base64 string nor a buffer')
|
|
||||||
}
|
|
||||||
|
|
||||||
const pubKey = await cryptoKeys.unmarshalPublicKey(buf)
|
|
||||||
const digest = await pubKey.hash()
|
|
||||||
return new PeerIdWithIs(digest, null, pubKey)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Private key input will be a string
|
|
||||||
exports.createFromPrivKey = async (key) => {
|
|
||||||
let buf = key
|
|
||||||
|
|
||||||
if (typeof buf === 'string') {
|
|
||||||
buf = Buffer.from(key, 'base64')
|
|
||||||
}
|
|
||||||
|
|
||||||
if (!Buffer.isBuffer(buf)) {
|
|
||||||
throw new Error('Supplied key is neither a base64 string nor a buffer')
|
|
||||||
}
|
|
||||||
|
|
||||||
const privKey = await cryptoKeys.unmarshalPrivateKey(buf)
|
|
||||||
const digest = await privKey.public.hash()
|
|
||||||
|
|
||||||
return new PeerIdWithIs(digest, privKey, privKey.public)
|
|
||||||
}
|
|
||||||
|
|
||||||
exports.createFromJSON = async (obj) => {
|
|
||||||
let id = mh.fromB58String(obj.id)
|
|
||||||
let rawPrivKey = obj.privKey && Buffer.from(obj.privKey, 'base64')
|
|
||||||
let rawPubKey = obj.pubKey && Buffer.from(obj.pubKey, 'base64')
|
|
||||||
let pub = rawPubKey && await cryptoKeys.unmarshalPublicKey(rawPubKey)
|
|
||||||
|
|
||||||
if (!rawPrivKey) {
|
|
||||||
return new PeerIdWithIs(id, null, pub)
|
|
||||||
}
|
|
||||||
|
|
||||||
const privKey = await cryptoKeys.unmarshalPrivateKey(rawPrivKey)
|
|
||||||
const privDigest = await privKey.public.hash()
|
|
||||||
let pubDigest
|
|
||||||
|
|
||||||
if (pub) {
|
|
||||||
pubDigest = await pub.hash()
|
|
||||||
}
|
|
||||||
|
|
||||||
if (pub && !privDigest.equals(pubDigest)) {
|
|
||||||
throw new Error('Public and private key do not match')
|
|
||||||
}
|
|
||||||
|
|
||||||
if (id && !privDigest.equals(id)) {
|
|
||||||
throw new Error('Id and private key do not match')
|
|
||||||
}
|
|
||||||
|
|
||||||
return new PeerIdWithIs(id, privKey, pub)
|
|
||||||
}
|
|
||||||
|
|
||||||
exports.isPeerId = (peerId) => {
|
|
||||||
return Boolean(typeof peerId === 'object' &&
|
|
||||||
peerId._id &&
|
|
||||||
peerId._idB58String)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Convert a given `Buffer` to a `base64` encoded string.
|
||||||
|
* If no `val` is given it just returns `undefined`.
|
||||||
|
*
|
||||||
|
* @private
|
||||||
|
* @param {Buffer=} val
|
||||||
|
* @returns {string|undefined}
|
||||||
|
*/
|
||||||
function toB64Opt (val) {
|
function toB64Opt (val) {
|
||||||
if (val) {
|
if (val) {
|
||||||
return val.toString('base64')
|
return val.toString('base64')
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
exports = module.exports = PeerId
|
||||||
|
|||||||
225
test/index.spec.js
Normal file
225
test/index.spec.js
Normal file
@ -0,0 +1,225 @@
|
|||||||
|
/* eslint max-nested-callbacks: ["error", 8] */
|
||||||
|
/* eslint-env mocha */
|
||||||
|
'use strict'
|
||||||
|
|
||||||
|
const expect = require('chai').expect
|
||||||
|
const crypto = require('libp2p-crypto')
|
||||||
|
const mh = require('multihashes')
|
||||||
|
const parallel = require('async/parallel')
|
||||||
|
|
||||||
|
const PeerId = require('../src')
|
||||||
|
|
||||||
|
const testId = require('./fixtures/sample-id')
|
||||||
|
const testIdHex = testId.id
|
||||||
|
const testIdBytes = mh.fromHexString(testId.id)
|
||||||
|
const testIdB58String = mh.toB58String(testIdBytes)
|
||||||
|
|
||||||
|
const goId = require('./fixtures/go-private-key')
|
||||||
|
|
||||||
|
describe('PeerId', () => {
|
||||||
|
it('create an id without \'new\'', () => {
|
||||||
|
expect(PeerId).to.throw(Error)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('create a new id', (done) => {
|
||||||
|
PeerId.create((err, id) => {
|
||||||
|
expect(err).to.not.exist
|
||||||
|
expect(id.toB58String().length).to.equal(46)
|
||||||
|
done()
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
it('recreate an Id from Hex string', () => {
|
||||||
|
const id = PeerId.createFromHexString(testIdHex)
|
||||||
|
expect(testIdBytes).to.deep.equal(id.id)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('Recreate an Id from a Buffer', () => {
|
||||||
|
const id = PeerId.createFromBytes(testIdBytes)
|
||||||
|
expect(testId.id).to.equal(id.toHexString())
|
||||||
|
})
|
||||||
|
|
||||||
|
it('Recreate a B58 String', () => {
|
||||||
|
const id = PeerId.createFromB58String(testIdB58String)
|
||||||
|
expect(testIdB58String).to.equal(id.toB58String())
|
||||||
|
})
|
||||||
|
|
||||||
|
it('Recreate from a Public Key', (done) => {
|
||||||
|
PeerId.createFromPubKey(testId.pubKey, (err, id) => {
|
||||||
|
expect(err).to.not.exist
|
||||||
|
expect(testIdB58String).to.equal(id.toB58String())
|
||||||
|
done()
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
it('Recreate from a Private Key', (done) => {
|
||||||
|
PeerId.createFromPrivKey(testId.privKey, (err, id) => {
|
||||||
|
expect(err).to.not.exist
|
||||||
|
expect(testIdB58String).to.equal(id.toB58String())
|
||||||
|
|
||||||
|
const encoded = new Buffer(testId.privKey, 'base64')
|
||||||
|
PeerId.createFromPrivKey(encoded, (err, id2) => {
|
||||||
|
expect(err).to.not.exist
|
||||||
|
expect(testIdB58String).to.equal(id2.toB58String())
|
||||||
|
done()
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
it('Compare generated ID with one created from PubKey', (done) => {
|
||||||
|
PeerId.create((err, id1) => {
|
||||||
|
expect(err).to.not.exist
|
||||||
|
|
||||||
|
PeerId.createFromPubKey(id1.marshalPubKey(), (err, id2) => {
|
||||||
|
expect(err).to.not.exist
|
||||||
|
expect(id1.id).to.be.eql(id2.id)
|
||||||
|
done()
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
it('Non-default # of bits', (done) => {
|
||||||
|
PeerId.create({ bits: 1024 }, (err, shortId) => {
|
||||||
|
expect(err).to.not.exist
|
||||||
|
PeerId.create({ bits: 4096 }, (err, longId) => {
|
||||||
|
expect(err).to.not.exist
|
||||||
|
expect(shortId.privKey.bytes.length).is.below(longId.privKey.bytes.length)
|
||||||
|
done()
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
it('Pretty printing', (done) => {
|
||||||
|
PeerId.create((err, id1) => {
|
||||||
|
expect(err).to.not.exist
|
||||||
|
PeerId.createFromPrivKey(id1.toPrint().privKey, (err, id2) => {
|
||||||
|
expect(err).to.not.exist
|
||||||
|
expect(id1.toPrint()).to.be.eql(id2.toPrint())
|
||||||
|
done()
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
it('toBytes', () => {
|
||||||
|
const id = PeerId.createFromHexString(testIdHex)
|
||||||
|
expect(id.toBytes().toString('hex')).to.equal(testIdBytes.toString('hex'))
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('fromJSON', () => {
|
||||||
|
it('full node', (done) => {
|
||||||
|
PeerId.create({bits: 1024}, (err, id) => {
|
||||||
|
expect(err).to.not.exist
|
||||||
|
|
||||||
|
PeerId.createFromJSON(id.toJSON(), (err, other) => {
|
||||||
|
expect(err).to.not.exist
|
||||||
|
expect(
|
||||||
|
id.toB58String()
|
||||||
|
).to.equal(
|
||||||
|
other.toB58String()
|
||||||
|
)
|
||||||
|
expect(
|
||||||
|
id.privKey.bytes
|
||||||
|
).to.deep.equal(
|
||||||
|
other.privKey.bytes
|
||||||
|
)
|
||||||
|
expect(
|
||||||
|
id.pubKey.bytes
|
||||||
|
).to.deep.equal(
|
||||||
|
other.pubKey.bytes
|
||||||
|
)
|
||||||
|
done()
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
it('only id', (done) => {
|
||||||
|
crypto.generateKeyPair('RSA', 1024, (err, key) => {
|
||||||
|
expect(err).to.not.exist
|
||||||
|
key.public.hash((err, digest) => {
|
||||||
|
expect(err).to.not.exist
|
||||||
|
|
||||||
|
const id = PeerId.createFromBytes(digest)
|
||||||
|
expect(id.privKey).to.not.exist
|
||||||
|
expect(id.pubKey).to.not.exist
|
||||||
|
|
||||||
|
PeerId.createFromJSON(id.toJSON(), (err, other) => {
|
||||||
|
expect(err).to.not.exist
|
||||||
|
expect(
|
||||||
|
id.toB58String()
|
||||||
|
).to.equal(
|
||||||
|
other.toB58String()
|
||||||
|
)
|
||||||
|
done()
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
it('go interop', (done) => {
|
||||||
|
PeerId.createFromJSON(goId, (err, id) => {
|
||||||
|
expect(err).to.not.exist
|
||||||
|
id.privKey.public.hash((err, digest) => {
|
||||||
|
expect(err).to.not.exist
|
||||||
|
expect(
|
||||||
|
mh.toB58String(digest)
|
||||||
|
).to.be.eql(
|
||||||
|
goId.id
|
||||||
|
)
|
||||||
|
done()
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('throws on inconsistent data', () => {
|
||||||
|
let k1, k2, k3
|
||||||
|
before((done) => {
|
||||||
|
parallel([
|
||||||
|
(cb) => crypto.generateKeyPair('RSA', 1024, cb),
|
||||||
|
(cb) => crypto.generateKeyPair('RSA', 1024, cb),
|
||||||
|
(cb) => crypto.generateKeyPair('RSA', 1024, cb)
|
||||||
|
], (err, keys) => {
|
||||||
|
if (err) {
|
||||||
|
return done(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
k1 = keys[0]
|
||||||
|
k2 = keys[1]
|
||||||
|
k3 = keys[2]
|
||||||
|
done()
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
it('missmatch private - public key', (done) => {
|
||||||
|
k1.public.hash((err, digest) => {
|
||||||
|
expect(err).to.not.exist
|
||||||
|
expect(
|
||||||
|
() => new PeerId(digest, k1, k2.public)
|
||||||
|
).to.throw(
|
||||||
|
/inconsistent arguments/
|
||||||
|
)
|
||||||
|
done()
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
it('missmatch id - private - public key', (done) => {
|
||||||
|
k1.public.hash((err, digest) => {
|
||||||
|
expect(err).to.not.exist
|
||||||
|
expect(
|
||||||
|
() => new PeerId(digest, k1, k3.public)
|
||||||
|
).to.throw(
|
||||||
|
/inconsistent arguments/
|
||||||
|
)
|
||||||
|
done()
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
it('invalid id', () => {
|
||||||
|
expect(
|
||||||
|
() => new PeerId('hello world')
|
||||||
|
).to.throw(
|
||||||
|
/invalid id/
|
||||||
|
)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
@ -1,233 +0,0 @@
|
|||||||
/* eslint max-nested-callbacks: ["error", 8] */
|
|
||||||
/* eslint-env mocha */
|
|
||||||
'use strict'
|
|
||||||
|
|
||||||
const chai = require('chai')
|
|
||||||
const dirtyChai = require('dirty-chai')
|
|
||||||
chai.use(dirtyChai)
|
|
||||||
const expect = chai.expect
|
|
||||||
const crypto = require('libp2p-crypto')
|
|
||||||
const mh = require('multihashes')
|
|
||||||
|
|
||||||
const PeerId = require('../src')
|
|
||||||
|
|
||||||
const util = require('util')
|
|
||||||
|
|
||||||
const testId = require('./fixtures/sample-id')
|
|
||||||
const testIdHex = testId.id
|
|
||||||
const testIdBytes = mh.fromHexString(testId.id)
|
|
||||||
const testIdB58String = mh.toB58String(testIdBytes)
|
|
||||||
|
|
||||||
const goId = require('./fixtures/go-private-key')
|
|
||||||
|
|
||||||
// Test options for making PeerId.create faster
|
|
||||||
// INSECURE, only use when testing
|
|
||||||
const testOpts = {
|
|
||||||
bits: 512
|
|
||||||
}
|
|
||||||
|
|
||||||
describe('PeerId', () => {
|
|
||||||
it('create an id without \'new\'', () => {
|
|
||||||
expect(PeerId).to.throw(Error)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('create a new id', async () => {
|
|
||||||
const id = await PeerId.create(testOpts)
|
|
||||||
expect(id.toB58String().length).to.equal(46)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('isPeerId', async () => {
|
|
||||||
const id = await PeerId.create(testOpts)
|
|
||||||
expect(PeerId.isPeerId(id)).to.equal(true)
|
|
||||||
expect(PeerId.isPeerId('aaa')).to.equal(false)
|
|
||||||
expect(PeerId.isPeerId(Buffer.from('batatas'))).to.equal(false)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('throws on changing the id', async () => {
|
|
||||||
const id = await PeerId.create(testOpts)
|
|
||||||
expect(id.toB58String().length).to.equal(46)
|
|
||||||
expect(() => {
|
|
||||||
id.id = Buffer.from('hello')
|
|
||||||
}).to.throw(/immutable/)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('recreate an Id from Hex string', () => {
|
|
||||||
const id = PeerId.createFromHexString(testIdHex)
|
|
||||||
expect(testIdBytes).to.deep.equal(id.id)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('Recreate an Id from a Buffer', () => {
|
|
||||||
const id = PeerId.createFromBytes(testIdBytes)
|
|
||||||
expect(testId.id).to.equal(id.toHexString())
|
|
||||||
})
|
|
||||||
|
|
||||||
it('Recreate a B58 String', () => {
|
|
||||||
const id = PeerId.createFromB58String(testIdB58String)
|
|
||||||
expect(testIdB58String).to.equal(id.toB58String())
|
|
||||||
})
|
|
||||||
|
|
||||||
it('Recreate from a Public Key', async () => {
|
|
||||||
const id = await PeerId.createFromPubKey(testId.pubKey)
|
|
||||||
expect(testIdB58String).to.equal(id.toB58String())
|
|
||||||
})
|
|
||||||
|
|
||||||
it('Recreate from a Private Key', async () => {
|
|
||||||
const id = await PeerId.createFromPrivKey(testId.privKey)
|
|
||||||
expect(testIdB58String).to.equal(id.toB58String())
|
|
||||||
const encoded = Buffer.from(testId.privKey, 'base64')
|
|
||||||
const id2 = await PeerId.createFromPrivKey(encoded)
|
|
||||||
expect(testIdB58String).to.equal(id2.toB58String())
|
|
||||||
expect(id.marshalPubKey()).to.deep.equal(id2.marshalPubKey())
|
|
||||||
})
|
|
||||||
|
|
||||||
it('Compare generated ID with one created from PubKey', async () => {
|
|
||||||
const id1 = await PeerId.create(testOpts)
|
|
||||||
const id2 = await PeerId.createFromPubKey(id1.marshalPubKey())
|
|
||||||
expect(id1.id).to.be.eql(id2.id)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('Works with default options', async function () {
|
|
||||||
this.timeout(10000)
|
|
||||||
const id = await PeerId.create()
|
|
||||||
expect(id.toB58String().length).to.equal(46)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('Non-default # of bits', async function () {
|
|
||||||
this.timeout(1000 * 60)
|
|
||||||
const shortId = await PeerId.create(testOpts)
|
|
||||||
const longId = await PeerId.create({ bits: 1024 })
|
|
||||||
expect(shortId.privKey.bytes.length).is.below(longId.privKey.bytes.length)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('Pretty printing', async () => {
|
|
||||||
const id1 = await PeerId.create(testOpts)
|
|
||||||
const id2 = await PeerId.createFromPrivKey((id1.toJSON()).privKey)
|
|
||||||
expect(id1.toPrint()).to.be.eql(id2.toPrint())
|
|
||||||
expect(id1.toPrint()).to.equal('<peer.ID ' + id1.toB58String().substr(2, 6) + '>')
|
|
||||||
})
|
|
||||||
|
|
||||||
it('toBytes', () => {
|
|
||||||
const id = PeerId.createFromHexString(testIdHex)
|
|
||||||
expect(id.toBytes().toString('hex')).to.equal(testIdBytes.toString('hex'))
|
|
||||||
})
|
|
||||||
|
|
||||||
it('isEqual', async () => {
|
|
||||||
const ids = await Promise.all([
|
|
||||||
PeerId.create(testOpts),
|
|
||||||
PeerId.create(testOpts)
|
|
||||||
])
|
|
||||||
|
|
||||||
expect(ids[0].isEqual(ids[0])).to.equal(true)
|
|
||||||
expect(ids[0].isEqual(ids[1])).to.equal(false)
|
|
||||||
expect(ids[0].isEqual(ids[0].id)).to.equal(true)
|
|
||||||
expect(ids[0].isEqual(ids[1].id)).to.equal(false)
|
|
||||||
})
|
|
||||||
|
|
||||||
describe('fromJSON', () => {
|
|
||||||
it('full node', async () => {
|
|
||||||
const id = await PeerId.create(testOpts)
|
|
||||||
const other = await PeerId.createFromJSON(id.toJSON())
|
|
||||||
expect(id.toB58String()).to.equal(other.toB58String())
|
|
||||||
expect(id.privKey.bytes).to.eql(other.privKey.bytes)
|
|
||||||
expect(id.pubKey.bytes).to.eql(other.pubKey.bytes)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('only id', async () => {
|
|
||||||
const key = await crypto.keys.generateKeyPair('RSA', 1024)
|
|
||||||
const digest = await key.public.hash()
|
|
||||||
const id = PeerId.createFromBytes(digest)
|
|
||||||
expect(id.privKey).to.not.exist()
|
|
||||||
expect(id.pubKey).to.not.exist()
|
|
||||||
const other = await PeerId.createFromJSON(id.toJSON())
|
|
||||||
expect(id.toB58String()).to.equal(other.toB58String())
|
|
||||||
})
|
|
||||||
|
|
||||||
it('go interop', async () => {
|
|
||||||
const id = await PeerId.createFromJSON(goId)
|
|
||||||
const digest = await id.privKey.public.hash()
|
|
||||||
expect(mh.toB58String(digest)).to.eql(goId.id)
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
it('set privKey (valid)', async () => {
|
|
||||||
const peerId = await PeerId.create(testOpts)
|
|
||||||
peerId.privKey = peerId._privKey
|
|
||||||
expect(peerId.isValid()).to.equal(true)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('set pubKey (valid)', async () => {
|
|
||||||
const peerId = await PeerId.create(testOpts)
|
|
||||||
peerId.pubKey = peerId._pubKey
|
|
||||||
expect(peerId.isValid()).to.equal(true)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('set privKey (invalid)', async () => {
|
|
||||||
const peerId = await PeerId.create(testOpts)
|
|
||||||
peerId.privKey = Buffer.from('bufff')
|
|
||||||
expect(peerId.isValid()).to.equal(false)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('set pubKey (invalid)', async () => {
|
|
||||||
const peerId = await PeerId.create(testOpts)
|
|
||||||
peerId.pubKey = Buffer.from('bufff')
|
|
||||||
expect(peerId.isValid()).to.equal(false)
|
|
||||||
})
|
|
||||||
|
|
||||||
describe('returns error via cb instead of crashing', () => {
|
|
||||||
const garbage = [
|
|
||||||
Buffer.from('00010203040506070809', 'hex'),
|
|
||||||
{}, null, false, undefined, true, 1, 0,
|
|
||||||
Buffer.from(''), 'aGVsbG93b3JsZA==', 'helloworld', ''
|
|
||||||
]
|
|
||||||
|
|
||||||
const fncs = ['createFromPubKey', 'createFromPrivKey', 'createFromJSON']
|
|
||||||
|
|
||||||
for (const gb of garbage) {
|
|
||||||
for (const fn of fncs) {
|
|
||||||
it(`${fn} (${util.inspect(gb)})`, async () => {
|
|
||||||
try {
|
|
||||||
await PeerId[fn](gb)
|
|
||||||
} catch (err) {
|
|
||||||
expect(err).to.exist()
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
describe('throws on inconsistent data', () => {
|
|
||||||
let k1
|
|
||||||
let k2
|
|
||||||
let k3
|
|
||||||
|
|
||||||
before(async () => {
|
|
||||||
const keys = await Promise.all([
|
|
||||||
crypto.keys.generateKeyPair('RSA', 512),
|
|
||||||
crypto.keys.generateKeyPair('RSA', 512),
|
|
||||||
crypto.keys.generateKeyPair('RSA', 512)
|
|
||||||
])
|
|
||||||
|
|
||||||
k1 = keys[0]
|
|
||||||
k2 = keys[1]
|
|
||||||
k3 = keys[2]
|
|
||||||
})
|
|
||||||
|
|
||||||
it('missmatch private - public key', async () => {
|
|
||||||
const digest = await k1.public.hash()
|
|
||||||
expect(() => {
|
|
||||||
new PeerId(digest, k1, k2.public) // eslint-disable-line no-new
|
|
||||||
}).to.throw(/inconsistent arguments/)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('missmatch id - private - public key', async () => {
|
|
||||||
const digest = await k1.public.hash()
|
|
||||||
expect(() => {
|
|
||||||
new PeerId(digest, k1, k3.public) // eslint-disable-line no-new
|
|
||||||
}).to.throw(/inconsistent arguments/)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('invalid id', () => {
|
|
||||||
expect(() => new PeerId('hello world')).to.throw(/invalid id/)
|
|
||||||
})
|
|
||||||
})
|
|
||||||
})
|
|
||||||
Reference in New Issue
Block a user