mirror of
https://github.com/fluencelabs/js-peer-id
synced 2025-07-04 19:11:36 +00:00
Compare commits
30 Commits
Author | SHA1 | Date | |
---|---|---|---|
1624b0f70a | |||
ce8a6ff77e | |||
41ce1d4671 | |||
231e553a22 | |||
cd2099305e | |||
8e030b24d4 | |||
9f69e1ba74 | |||
cbc8c5e2ba | |||
77000dbd8b | |||
eb062759c6 | |||
39e17c0c0b | |||
e03a4098df | |||
d7e633a90b | |||
2e5e666140 | |||
b388257b69 | |||
6ecd9a8cb0 | |||
6513a02e1e | |||
bd1dc9bda0 | |||
31cbb5d94c | |||
35556c3a37 | |||
e8ab1b9281 | |||
a786018528 | |||
417fd330b9 | |||
d74bdebcc8 | |||
ffed046595 | |||
1727a135aa | |||
466b3a030d | |||
464c92a53b | |||
8a608def32 | |||
19deeff432 |
28
.npmignore
28
.npmignore
@ -1,28 +0,0 @@
|
||||
# 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
|
32
.travis.yml
32
.travis.yml
@ -1,32 +0,0 @@
|
||||
# Warning: This file is automatically synced from https://github.com/ipfs/ci-sync so if you want to change it, please change it there and ask someone to sync all repositories.
|
||||
sudo: false
|
||||
language: node_js
|
||||
|
||||
matrix:
|
||||
include:
|
||||
- node_js: 6
|
||||
env: CXX=g++-4.8
|
||||
- node_js: 8
|
||||
env: CXX=g++-4.8
|
||||
# - node_js: stable
|
||||
# env: CXX=g++-4.8
|
||||
|
||||
script:
|
||||
- npm run lint
|
||||
- npm run test
|
||||
- npm run coverage
|
||||
|
||||
before_script:
|
||||
- export DISPLAY=:99.0
|
||||
- sh -e /etc/init.d/xvfb start
|
||||
|
||||
after_success:
|
||||
- npm run coverage-publish
|
||||
|
||||
addons:
|
||||
firefox: 'latest'
|
||||
apt:
|
||||
sources:
|
||||
- ubuntu-toolchain-r-test
|
||||
packages:
|
||||
- g++-4.8
|
50
CHANGELOG.md
50
CHANGELOG.md
@ -1,3 +1,53 @@
|
||||
<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)
|
||||
|
||||
|
16
README.md
16
README.md
@ -11,6 +11,12 @@
|
||||
|
||||
> [IPFS](https://github.com/ipfs/ipfs) Peer ID implementation in JavaScript.
|
||||
|
||||
## Lead Maintainer
|
||||
|
||||
[Pedro Teixeira](https://github.com/pgte)
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Description](#description)
|
||||
- [Example](#example)
|
||||
- [Installation](#installation)
|
||||
@ -138,6 +144,7 @@ Creates a Peer ID from hex string representing the key's multihash.
|
||||
Creates a Peer ID from a buffer representing the key's multihash.
|
||||
|
||||
### `createFromB58String(str)`
|
||||
|
||||
Creates a Peer ID from a Base58 string representing the key's multihash.
|
||||
|
||||
### `createFromPubKey(pubKey)`
|
||||
@ -155,8 +162,8 @@ Creates a Peer ID from a buffer containing a private key.
|
||||
### `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 'base 64'
|
||||
- `obj.pubKey: String` - The public key in protobuf format, encoded in `base64`
|
||||
- `obj.privKey: String` - The private key in protobuf format, encoded in `base64`
|
||||
|
||||
## Export
|
||||
|
||||
@ -192,10 +199,11 @@ Returns an `obj` of the form
|
||||
- `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()`
|
||||
|
||||
Alias for `.toJSON()`.
|
||||
Returns the Peer ID as a printable string without the `Qm` prefix.
|
||||
|
||||
Example: `<peer.ID xxxxxx>`
|
||||
|
||||
### `isEqual(id)`
|
||||
|
||||
|
29
appveyor.yml
29
appveyor.yml
@ -1,29 +0,0 @@
|
||||
# Warning: This file is automatically synced from https://github.com/ipfs/ci-sync so if you want to change it, please change it there and ask someone to sync all repositories.
|
||||
version: "{build}"
|
||||
|
||||
environment:
|
||||
matrix:
|
||||
- nodejs_version: "6"
|
||||
- nodejs_version: "8"
|
||||
|
||||
matrix:
|
||||
fast_finish: true
|
||||
|
||||
install:
|
||||
# Install Node.js
|
||||
- ps: Install-Product node $env:nodejs_version
|
||||
|
||||
# Upgrade npm
|
||||
- npm install -g npm
|
||||
|
||||
# Output our current versions for debugging
|
||||
- node --version
|
||||
- npm --version
|
||||
|
||||
# Install our package dependencies
|
||||
- npm install
|
||||
|
||||
test_script:
|
||||
- npm run test:node
|
||||
|
||||
build: off
|
15
circle.yml
15
circle.yml
@ -1,15 +0,0 @@
|
||||
# Warning: This file is automatically synced from https://github.com/ipfs/ci-sync so if you want to change it, please change it there and ask someone to sync all repositories.
|
||||
machine:
|
||||
node:
|
||||
version: stable
|
||||
|
||||
dependencies:
|
||||
pre:
|
||||
- google-chrome --version
|
||||
- curl -L -o google-chrome.deb https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb
|
||||
- sudo dpkg -i google-chrome.deb || true
|
||||
- sudo apt-get update
|
||||
- sudo apt-get install -f
|
||||
- sudo apt-get install --only-upgrade lsb-base
|
||||
- sudo dpkg -i google-chrome.deb
|
||||
- google-chrome --version
|
37
package.json
37
package.json
@ -1,7 +1,8 @@
|
||||
{
|
||||
"name": "peer-id",
|
||||
"version": "0.10.5",
|
||||
"version": "0.12.2",
|
||||
"description": "IPFS Peer Id implementation in Node.js",
|
||||
"leadMaintainer": "Pedro Teixeira <i@pgte.me>",
|
||||
"main": "src/index.js",
|
||||
"bin": "src/bin.js",
|
||||
"scripts": {
|
||||
@ -13,35 +14,35 @@
|
||||
"release": "aegir release",
|
||||
"release-minor": "aegir release --type minor",
|
||||
"release-major": "aegir release --type major",
|
||||
"coverage": "aegir coverage"
|
||||
"coverage": "aegir coverage",
|
||||
"size": "bundlesize -f dist/index.min.js -s 140kB"
|
||||
},
|
||||
"files": [
|
||||
"src",
|
||||
"dist"
|
||||
],
|
||||
"keywords": [
|
||||
"IPFS"
|
||||
],
|
||||
"author": "David Dias <daviddias@ipfs.io>",
|
||||
"license": "MIT",
|
||||
"pre-commit": [
|
||||
"lint",
|
||||
"test"
|
||||
],
|
||||
"engines": {
|
||||
"node": ">=6.0.0",
|
||||
"npm": ">=3.0.0"
|
||||
"node": ">=10.0.0",
|
||||
"npm": ">=6.0.0"
|
||||
},
|
||||
"bugs": {
|
||||
"url": "https://github.com/libp2p/js-peer-id/issues"
|
||||
},
|
||||
"homepage": "https://github.com/libp2p/js-peer-id",
|
||||
"devDependencies": {
|
||||
"aegir": "^12.4.0",
|
||||
"chai": "^4.1.2",
|
||||
"dirty-chai": "^2.0.1",
|
||||
"pre-commit": "^1.2.2"
|
||||
"aegir": "^18.0.2",
|
||||
"bundlesize": "~0.17.0",
|
||||
"chai": "^4.2.0",
|
||||
"dirty-chai": "^2.0.1"
|
||||
},
|
||||
"dependencies": {
|
||||
"async": "^2.6.0",
|
||||
"libp2p-crypto": "~0.12.0",
|
||||
"lodash": "^4.17.4",
|
||||
"async": "^2.6.1",
|
||||
"class-is": "^1.1.0",
|
||||
"libp2p-crypto": "~0.16.0",
|
||||
"multihashes": "~0.4.13"
|
||||
},
|
||||
"repository": {
|
||||
@ -52,11 +53,15 @@
|
||||
"David Dias <daviddias.p@gmail.com>",
|
||||
"David Dias <mail@daviddias.me>",
|
||||
"Friedel Ziegelmayer <dignifiedquire@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 Schneider <makaretu@gmail.com>",
|
||||
"Stephen Whitmore <stephen.whitmore@gmail.com>",
|
||||
"Vasco Santos <vasco.santos@moxy.studio>",
|
||||
"Yahya <ya7yaz@gmail.com>",
|
||||
"greenkeeperio-bot <support@greenkeeper.io>",
|
||||
"nginnever <ginneversource@gmail.com>",
|
||||
|
51
src/index.js
51
src/index.js
@ -5,9 +5,10 @@
|
||||
'use strict'
|
||||
|
||||
const mh = require('multihashes')
|
||||
const crypto = require('libp2p-crypto')
|
||||
const cryptoKeys = require('libp2p-crypto/src/keys')
|
||||
const assert = require('assert')
|
||||
const waterfall = require('async/waterfall')
|
||||
const withIs = require('class-is')
|
||||
|
||||
class PeerId {
|
||||
constructor (id, privKey, pubKey) {
|
||||
@ -56,20 +57,30 @@ class PeerId {
|
||||
// Return the protobuf version of the public key, matching go ipfs formatting
|
||||
marshalPubKey () {
|
||||
if (this.pubKey) {
|
||||
return crypto.keys.marshalPublicKey(this.pubKey)
|
||||
return cryptoKeys.marshalPublicKey(this.pubKey)
|
||||
}
|
||||
}
|
||||
|
||||
// Return the protobuf version of the private key, matching go ipfs formatting
|
||||
marshalPrivKey () {
|
||||
if (this.privKey) {
|
||||
return crypto.keys.marshalPrivateKey(this.privKey)
|
||||
return cryptoKeys.marshalPrivateKey(this.privKey)
|
||||
}
|
||||
}
|
||||
|
||||
// pretty print
|
||||
toPrint () {
|
||||
return this.toJSON()
|
||||
let pid = this.toB58String()
|
||||
// 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
|
||||
@ -122,7 +133,9 @@ class PeerId {
|
||||
}
|
||||
}
|
||||
|
||||
exports = module.exports = PeerId
|
||||
const PeerIdWithIs = withIs(PeerId, { className: 'PeerId', symbolName: '@libp2p/js-peer-id/PeerId' })
|
||||
|
||||
exports = module.exports = PeerIdWithIs
|
||||
|
||||
// generation
|
||||
exports.create = function (opts, callback) {
|
||||
@ -134,7 +147,7 @@ exports.create = function (opts, callback) {
|
||||
opts.bits = opts.bits || 2048
|
||||
|
||||
waterfall([
|
||||
(cb) => crypto.keys.generateKeyPair('RSA', opts.bits, cb),
|
||||
(cb) => cryptoKeys.generateKeyPair('RSA', opts.bits, cb),
|
||||
(privKey, cb) => privKey.public.hash((err, digest) => {
|
||||
cb(err, digest, privKey)
|
||||
})
|
||||
@ -143,20 +156,20 @@ exports.create = function (opts, callback) {
|
||||
return callback(err)
|
||||
}
|
||||
|
||||
callback(null, new PeerId(digest, privKey))
|
||||
callback(null, new PeerIdWithIs(digest, privKey))
|
||||
})
|
||||
}
|
||||
|
||||
exports.createFromHexString = function (str) {
|
||||
return new PeerId(mh.fromHexString(str))
|
||||
return new PeerIdWithIs(mh.fromHexString(str))
|
||||
}
|
||||
|
||||
exports.createFromBytes = function (buf) {
|
||||
return new PeerId(buf)
|
||||
return new PeerIdWithIs(buf)
|
||||
}
|
||||
|
||||
exports.createFromB58String = function (str) {
|
||||
return new PeerId(mh.fromB58String(str))
|
||||
return new PeerIdWithIs(mh.fromB58String(str))
|
||||
}
|
||||
|
||||
// Public Key input will be a buffer
|
||||
@ -175,7 +188,7 @@ exports.createFromPubKey = function (key, callback) {
|
||||
|
||||
if (!Buffer.isBuffer(buf)) throw new Error('Supplied key is neither a base64 string nor a buffer')
|
||||
|
||||
pubKey = crypto.keys.unmarshalPublicKey(buf)
|
||||
pubKey = cryptoKeys.unmarshalPublicKey(buf)
|
||||
} catch (err) {
|
||||
return callback(err)
|
||||
}
|
||||
@ -185,7 +198,7 @@ exports.createFromPubKey = function (key, callback) {
|
||||
return callback(err)
|
||||
}
|
||||
|
||||
callback(null, new PeerId(digest, null, pubKey))
|
||||
callback(null, new PeerIdWithIs(digest, null, pubKey))
|
||||
})
|
||||
}
|
||||
|
||||
@ -208,7 +221,7 @@ exports.createFromPrivKey = function (key, callback) {
|
||||
}
|
||||
|
||||
waterfall([
|
||||
(cb) => crypto.keys.unmarshalPrivateKey(buf, cb),
|
||||
(cb) => cryptoKeys.unmarshalPrivateKey(buf, cb),
|
||||
(privKey, cb) => privKey.public.hash((err, digest) => {
|
||||
cb(err, digest, privKey)
|
||||
})
|
||||
@ -217,7 +230,7 @@ exports.createFromPrivKey = function (key, callback) {
|
||||
return callback(err)
|
||||
}
|
||||
|
||||
callback(null, new PeerId(digest, privKey, privKey.public))
|
||||
callback(null, new PeerIdWithIs(digest, privKey, privKey.public))
|
||||
})
|
||||
}
|
||||
|
||||
@ -235,14 +248,14 @@ exports.createFromJSON = function (obj, callback) {
|
||||
id = mh.fromB58String(obj.id)
|
||||
rawPrivKey = obj.privKey && Buffer.from(obj.privKey, 'base64')
|
||||
rawPubKey = obj.pubKey && Buffer.from(obj.pubKey, 'base64')
|
||||
pub = rawPubKey && crypto.keys.unmarshalPublicKey(rawPubKey)
|
||||
pub = rawPubKey && cryptoKeys.unmarshalPublicKey(rawPubKey)
|
||||
} catch (err) {
|
||||
return callback(err)
|
||||
}
|
||||
|
||||
if (rawPrivKey) {
|
||||
waterfall([
|
||||
(cb) => crypto.keys.unmarshalPrivateKey(rawPrivKey, cb),
|
||||
(cb) => cryptoKeys.unmarshalPrivateKey(rawPrivKey, cb),
|
||||
(priv, cb) => priv.public.hash((err, digest) => {
|
||||
cb(err, digest, priv)
|
||||
}),
|
||||
@ -268,10 +281,10 @@ exports.createFromJSON = function (obj, callback) {
|
||||
return callback(new Error('Id and private key do not match'))
|
||||
}
|
||||
|
||||
callback(null, new PeerId(id, priv, pub))
|
||||
callback(null, new PeerIdWithIs(id, priv, pub))
|
||||
})
|
||||
} else {
|
||||
callback(null, new PeerId(id, null, pub))
|
||||
callback(null, new PeerIdWithIs(id, null, pub))
|
||||
}
|
||||
}
|
||||
|
||||
|
@ -136,9 +136,10 @@ describe('PeerId', () => {
|
||||
it('Pretty printing', (done) => {
|
||||
PeerId.create(testOpts, (err, id1) => {
|
||||
expect(err).to.not.exist()
|
||||
PeerId.createFromPrivKey(id1.toPrint().privKey, (err, id2) => {
|
||||
PeerId.createFromPrivKey(id1.toJSON().privKey, (err, id2) => {
|
||||
expect(err).to.not.exist()
|
||||
expect(id1.toPrint()).to.be.eql(id2.toPrint())
|
||||
expect(id1.toPrint()).to.equal('<peer.ID ' + id1.toB58String().substr(2, 6) + '>')
|
||||
done()
|
||||
})
|
||||
})
|
||||
|
Reference in New Issue
Block a user