mirror of
https://github.com/fluencelabs/js-peer-id
synced 2025-07-04 19:21:46 +00:00
Compare commits
23 Commits
Author | SHA1 | Date | |
---|---|---|---|
ecc1e5be6d | |||
153bc8ea38 | |||
d40d588776 | |||
224b30cb65 | |||
6d571ae196 | |||
ff4bd96467 | |||
427b46c86e | |||
d16ce9c2ac | |||
cd99cb2c7d | |||
c295329300 | |||
bb32b12395 | |||
6fd5ca2a12 | |||
020b963711 | |||
e3da29a440 | |||
8cd9dfb137 | |||
3598a433dc | |||
5ec88281e2 | |||
a80c481146 | |||
efc96106a4 | |||
16e1c74e9a | |||
c305c36b26 | |||
7e985b127f | |||
40d68cb512 |
7
.aegir.js
Normal file
7
.aegir.js
Normal file
@ -0,0 +1,7 @@
|
||||
'use strict'
|
||||
|
||||
module.exports = {
|
||||
bundlesize: {
|
||||
maxSize: '140kB'
|
||||
}
|
||||
}
|
67
CHANGELOG.md
67
CHANGELOG.md
@ -1,3 +1,70 @@
|
||||
<a name="0.14.1"></a>
|
||||
## [0.14.1](https://github.com/libp2p/js-peer-id/compare/v0.13.13...v0.14.1) (2020-09-03)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* privKey possible undefined ([#129](https://github.com/libp2p/js-peer-id/issues/129)) ([224b30c](https://github.com/libp2p/js-peer-id/commit/224b30c))
|
||||
* replace node buffers with uint8arrays ([#127](https://github.com/libp2p/js-peer-id/issues/127)) ([d16ce9c](https://github.com/libp2p/js-peer-id/commit/d16ce9c))
|
||||
* ts constructor types ([#130](https://github.com/libp2p/js-peer-id/issues/130)) ([d40d588](https://github.com/libp2p/js-peer-id/commit/d40d588))
|
||||
* typo in readme ([#128](https://github.com/libp2p/js-peer-id/issues/128)) ([6d571ae](https://github.com/libp2p/js-peer-id/commit/6d571ae))
|
||||
|
||||
|
||||
### BREAKING CHANGES
|
||||
|
||||
* - Where node Buffers were returned, now Uint8Arrays are
|
||||
|
||||
* chore: remove gh dep
|
||||
|
||||
|
||||
|
||||
<a name="0.14.0"></a>
|
||||
# [0.14.0](https://github.com/libp2p/js-peer-id/compare/v0.13.13...v0.14.0) (2020-08-07)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* replace node buffers with uint8arrays ([#127](https://github.com/libp2p/js-peer-id/issues/127)) ([d16ce9c](https://github.com/libp2p/js-peer-id/commit/d16ce9c))
|
||||
|
||||
|
||||
### BREAKING CHANGES
|
||||
|
||||
* - Where node Buffers were returned, now Uint8Arrays are
|
||||
|
||||
* chore: remove gh dep
|
||||
|
||||
|
||||
|
||||
<a name="0.13.13"></a>
|
||||
## [0.13.13](https://github.com/libp2p/js-peer-id/compare/v0.13.12...v0.13.13) (2020-06-23)
|
||||
|
||||
|
||||
|
||||
<a name="0.13.12"></a>
|
||||
## [0.13.12](https://github.com/libp2p/js-peer-id/compare/v0.13.11...v0.13.12) (2020-04-22)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* **cli:** add support for specifying type and size ([#122](https://github.com/libp2p/js-peer-id/issues/122)) ([8cd9dfb](https://github.com/libp2p/js-peer-id/commit/8cd9dfb))
|
||||
|
||||
|
||||
|
||||
<a name="0.13.11"></a>
|
||||
## [0.13.11](https://github.com/libp2p/js-peer-id/compare/v0.13.10...v0.13.11) (2020-03-26)
|
||||
|
||||
|
||||
|
||||
<a name="0.13.10"></a>
|
||||
## [0.13.10](https://github.com/libp2p/js-peer-id/compare/v0.13.9...v0.13.10) (2020-03-18)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* add buffer ([#120](https://github.com/libp2p/js-peer-id/issues/120)) ([c305c36](https://github.com/libp2p/js-peer-id/commit/c305c36))
|
||||
|
||||
|
||||
|
||||
<a name="0.13.9"></a>
|
||||
## [0.13.9](https://github.com/libp2p/js-peer-id/compare/v0.13.8...v0.13.9) (2020-02-19)
|
||||
|
||||
|
14
README.md
14
README.md
@ -28,6 +28,7 @@
|
||||
- [Node.js](#nodejs)
|
||||
- [Browser: Browserify, Webpack, other bundlers](#browser-browserify-webpack-other-bundlers)
|
||||
- [Browser: `<script>` Tag](#browser-script-tag)
|
||||
- [CLI](#cli)
|
||||
- [API](#api)
|
||||
- [Create](#create)
|
||||
- [`new PeerId(id[, privKey, pubKey])`](#new-peeridid-privkey-pubkey)
|
||||
@ -117,6 +118,14 @@ the global namespace.
|
||||
<script src="https://unpkg.com/peer-id/dist/index.js"></script>
|
||||
```
|
||||
|
||||
# CLI
|
||||
|
||||
After installing `peer-id`, `npm install peer-id`, you can leverage the cli to generate keys exported as JSON. You can specify the type for the key and size, as detailed in [`create([opts])`](#createopts). The defaults are shown here.
|
||||
|
||||
```sh
|
||||
> peer-id --type rsa --bits 2048
|
||||
```
|
||||
|
||||
# API
|
||||
|
||||
```js
|
||||
@ -137,7 +146,8 @@ The key format is detailed in [libp2p-crypto](https://github.com/libp2p/js-libp2
|
||||
|
||||
Generates a new Peer ID, complete with public/private keypair.
|
||||
|
||||
- `opts: Object`: Default: `{bits: 2048, keyType: 'rsa'}`
|
||||
- `opts.bits: number` - The size of the key. Default: `2048`
|
||||
- `opts.keyType: string` - The key type, one of: `['rsa', 'ed25519', 'secp256k1']`. Default: `rsa`
|
||||
|
||||
Returns `Promise<PeerId>`.
|
||||
|
||||
@ -147,7 +157,7 @@ Returns `Promise<PeerId>`.
|
||||
|
||||
Creates a Peer ID from hex string representing the key's multihash.
|
||||
|
||||
Returns `PeerId.
|
||||
Returns `PeerId`.
|
||||
|
||||
### `createFromBytes(buf)`
|
||||
|
||||
|
51
package.json
51
package.json
@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "peer-id",
|
||||
"version": "0.13.9",
|
||||
"version": "0.14.1",
|
||||
"description": "IPFS Peer Id implementation in Node.js",
|
||||
"leadMaintainer": "Vasco Santos <santos.vasco10@gmail.com>",
|
||||
"main": "src/index.js",
|
||||
@ -17,7 +17,7 @@
|
||||
"release-minor": "aegir release --type minor",
|
||||
"release-major": "aegir release --type major",
|
||||
"coverage": "aegir coverage",
|
||||
"size": "bundlesize -f dist/index.min.js -s 140kB"
|
||||
"size": "aegir build -b"
|
||||
},
|
||||
"files": [
|
||||
"src",
|
||||
@ -38,51 +38,48 @@
|
||||
"devDependencies": {
|
||||
"@types/chai": "^4.2.7",
|
||||
"@types/dirty-chai": "^2.0.2",
|
||||
"@types/mocha": "^5.2.7",
|
||||
"aegir": "^20.0.0",
|
||||
"bundlesize": "~0.18.0",
|
||||
"chai": "^4.2.0",
|
||||
"dirty-chai": "^2.0.1"
|
||||
"@types/mocha": "^8.0.1",
|
||||
"aegir": "^25.0.0"
|
||||
},
|
||||
"dependencies": {
|
||||
"cids": "^0.7.3",
|
||||
"cids": "^1.0.0",
|
||||
"class-is": "^1.1.0",
|
||||
"libp2p-crypto": "~0.17.2",
|
||||
"multihashes": "~0.4.15",
|
||||
"protons": "^1.0.1"
|
||||
"libp2p-crypto": "^0.18.0",
|
||||
"minimist": "^1.2.5",
|
||||
"multihashes": "^3.0.1",
|
||||
"protons": "^2.0.0",
|
||||
"uint8arrays": "^1.1.0"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/libp2p/js-peer-id.git"
|
||||
},
|
||||
"contributors": [
|
||||
"David Dias <daviddias.p@gmail.com>",
|
||||
"Vasco Santos <vasco.santos@moxy.studio>",
|
||||
"nginnever <ginneversource@gmail.com>",
|
||||
"dignifiedquire <dignifiedquire@gmail.com>",
|
||||
"Jacob Heun <jacobheun@gmail.com>",
|
||||
"Pedro Teixeira <i@pgte.me>",
|
||||
"Stephen Whitmore <stephen.whitmore@gmail.com>",
|
||||
"Hugo Dias <hugomrdias@gmail.com>",
|
||||
"Maciej Krüger <mkg20001@gmail.com>",
|
||||
"Alex Potsides <alex@achingbrain.net>",
|
||||
"Nate Foss <npfoss@gmail.com>",
|
||||
"Robert Kiel <robert.kiel@validitylabs.org>",
|
||||
"ᴠɪᴄᴛᴏʀ ʙᴊᴇʟᴋʜᴏʟᴍ <victorbjelkholm@gmail.com>",
|
||||
"Arve Knudsen <arve.knudsen@gmail.com>",
|
||||
"Carson Farmer <carson.farmer@gmail.com>",
|
||||
"Christian Paul <info@jaller.de>",
|
||||
"David Dias <daviddias.p@gmail.com>",
|
||||
"David Dias <mail@daviddias.me>",
|
||||
"Friedel Ziegelmayer <dignifiedquire@gmail.com>",
|
||||
"Henrique Dias <hacdias@gmail.com>",
|
||||
"Hugo Dias <hugomrdias@gmail.com>",
|
||||
"Jacob Heun <jacobheun@gmail.com>",
|
||||
"Maciej Krüger <mkg20001@gmail.com>",
|
||||
"Marcin Rataj <lidel@lidel.org>",
|
||||
"Michael Garvin <gar+gh@danger.computer>",
|
||||
"Nate Foss <npfoss@gmail.com>",
|
||||
"Pedro Teixeira <i@pgte.me>",
|
||||
"Prashanth Chandra <coolshanth94@gmail.com>",
|
||||
"Richard Littauer <richard.littauer@gmail.com>",
|
||||
"Richard Schneider <makaretu@gmail.com>",
|
||||
"Robert Kiel <robert.kiel@validitylabs.org>",
|
||||
"Stephen Whitmore <stephen.whitmore@gmail.com>",
|
||||
"Topper Bowers <topper@quorumcontrol.com>",
|
||||
"Vasco Santos <vasco.santos@moxy.studio>",
|
||||
"Vasco Santos <vasco.santos@ua.pt>",
|
||||
"Vojtech Simetka <vojtech@simetka.cz>",
|
||||
"Yahya <ya7yaz@gmail.com>",
|
||||
"greenkeeperio-bot <support@greenkeeper.io>",
|
||||
"nginnever <ginneversource@gmail.com>",
|
||||
"npmcdn-to-unpkg-bot <npmcdn-to-unpkg-bot@users.noreply.github.com>",
|
||||
"ᴠɪᴄᴛᴏʀ ʙᴊᴇʟᴋʜᴏʟᴍ <victorbjelkholm@gmail.com>"
|
||||
"Adam Uhlíř <adam@uhlir.dev>"
|
||||
]
|
||||
}
|
||||
|
@ -3,9 +3,13 @@
|
||||
'use strict'
|
||||
|
||||
const PeerId = require('./index.js')
|
||||
const argv = require('minimist')(process.argv.slice(2))
|
||||
|
||||
async function main () {
|
||||
const id = await PeerId.create()
|
||||
const id = await PeerId.create({
|
||||
keyType: argv.type,
|
||||
bits: argv.bits
|
||||
})
|
||||
console.log(JSON.stringify(id.toJSON(), null, 2)) // eslint-disable-line no-console
|
||||
}
|
||||
|
||||
|
40
src/index.d.ts
vendored
40
src/index.d.ts
vendored
@ -1,4 +1,4 @@
|
||||
import crypto, { PrivateKey, PublicKey, KeyType } from "libp2p-crypto";
|
||||
import { PrivateKey, PublicKey, KeyType } from "libp2p-crypto";
|
||||
import CID from 'cids'
|
||||
|
||||
declare namespace PeerId {
|
||||
@ -31,7 +31,7 @@ declare namespace PeerId {
|
||||
/**
|
||||
* Private key.
|
||||
*/
|
||||
privKey: string;
|
||||
privKey?: string;
|
||||
};
|
||||
|
||||
/**
|
||||
@ -51,36 +51,36 @@ declare namespace PeerId {
|
||||
* @param str The input hex string.
|
||||
*/
|
||||
function createFromHexString(str: string): PeerId;
|
||||
|
||||
|
||||
/**
|
||||
* Create PeerId from raw bytes.
|
||||
* @param buf The raw bytes.
|
||||
*/
|
||||
function createFromBytes(buf: Buffer): PeerId;
|
||||
function createFromBytes(buf: Uint8Array): PeerId;
|
||||
|
||||
/**
|
||||
* Create PeerId from base58-encoded string.
|
||||
* @param str The base58-encoded string.
|
||||
*/
|
||||
function createFromB58String(str: string): PeerId;
|
||||
|
||||
|
||||
/**
|
||||
* Create PeerId from CID.
|
||||
* @param cid The CID.
|
||||
*/
|
||||
function createFromCID(cid: CID | Buffer | string | object): PeerId;
|
||||
function createFromCID(cid: CID | Uint8Array | string | object): PeerId;
|
||||
|
||||
/**
|
||||
* Create PeerId from public key.
|
||||
* @param key Public key, as Buffer or base64-encoded string.
|
||||
* @param key Public key, as Uint8Array or base64-encoded string.
|
||||
*/
|
||||
function createFromPubKey(key: Buffer | string): Promise<PeerId>;
|
||||
function createFromPubKey(key: Uint8Array | string): Promise<PeerId>;
|
||||
|
||||
/**
|
||||
* Create PeerId from private key.
|
||||
* @param key Private key, as Buffer or base64-encoded string.
|
||||
* @param key Private key, as Uint8Array or base64-encoded string.
|
||||
*/
|
||||
function createFromPrivKey(key: Buffer | string): Promise<PeerId>;
|
||||
function createFromPrivKey(key: Uint8Array | string): Promise<PeerId>;
|
||||
|
||||
/**
|
||||
* Create PeerId from PeerId JSON formatted object.
|
||||
@ -91,21 +91,21 @@ declare namespace PeerId {
|
||||
|
||||
/**
|
||||
* Create PeerId from Protobuf bytes.
|
||||
* @param buf Protobuf bytes, as Buffer or hex-encoded string.
|
||||
* @param buf Protobuf bytes, as Uint8Array or hex-encoded string.
|
||||
*/
|
||||
function createFromProtobuf(buf: Buffer | string): Promise<PeerId>;
|
||||
function createFromProtobuf(buf: Uint8Array | string): Promise<PeerId>;
|
||||
}
|
||||
|
||||
/**
|
||||
* PeerId is an object representation of a peer identifier.
|
||||
*/
|
||||
declare class PeerId {
|
||||
constructor(id: Buffer | string, privKey?: PrivateKey, pubKey?: PublicKey);
|
||||
constructor(id: Uint8Array, privKey?: PrivateKey, pubKey?: PublicKey);
|
||||
|
||||
/**
|
||||
* Raw id.
|
||||
*/
|
||||
readonly id: Buffer;
|
||||
readonly id: Uint8Array;
|
||||
|
||||
/**
|
||||
* Private key.
|
||||
@ -120,18 +120,18 @@ declare class PeerId {
|
||||
/**
|
||||
* Return the protobuf version of the public key, matching go ipfs formatting.
|
||||
*/
|
||||
marshalPubKey(): Buffer;
|
||||
marshalPubKey(): Uint8Array;
|
||||
|
||||
/**
|
||||
* Return the protobuf version of the private key, matching go ipfs formatting.
|
||||
*/
|
||||
marshalPrivKey(): Buffer;
|
||||
marshalPrivKey(): Uint8Array;
|
||||
|
||||
/**
|
||||
* Return the protobuf version of the peer-id.
|
||||
* @param excludePriv Whether to exclude the private key information from the output.
|
||||
*/
|
||||
marshal(excludePriv?: boolean): Buffer;
|
||||
marshal(excludePriv?: boolean): Uint8Array;
|
||||
|
||||
/**
|
||||
* String representation.
|
||||
@ -153,7 +153,7 @@ declare class PeerId {
|
||||
/**
|
||||
* Return raw id bytes.
|
||||
*/
|
||||
toBytes(): Buffer;
|
||||
toBytes(): Uint8Array;
|
||||
|
||||
/**
|
||||
* Encode to base58 string.
|
||||
@ -170,14 +170,14 @@ declare class PeerId {
|
||||
* Checks the equality of `this` peer against a given PeerId.
|
||||
* @param id The other PeerId.
|
||||
*/
|
||||
equals(id: PeerId | Buffer): boolean;
|
||||
equals(id: PeerId | Uint8Array): boolean;
|
||||
|
||||
/**
|
||||
* Checks the equality of `this` peer against a given PeerId.
|
||||
* @deprecated Use {.equals}
|
||||
* @param id The other PeerId.
|
||||
*/
|
||||
isEqual(id: PeerId | Buffer): boolean;
|
||||
isEqual(id: PeerId | Uint8Array): boolean;
|
||||
|
||||
/**
|
||||
* Check if this PeerId instance is valid (privKey -> pubKey -> Id)
|
||||
|
55
src/index.js
55
src/index.js
@ -9,14 +9,17 @@ const CID = require('cids')
|
||||
const cryptoKeys = require('libp2p-crypto/src/keys')
|
||||
const withIs = require('class-is')
|
||||
const { PeerIdProto } = require('./proto')
|
||||
const uint8ArrayEquals = require('uint8arrays/equals')
|
||||
const uint8ArrayFromString = require('uint8arrays/from-string')
|
||||
const uint8ArrayToString = require('uint8arrays/to-string')
|
||||
|
||||
class PeerId {
|
||||
constructor (id, privKey, pubKey) {
|
||||
if (!Buffer.isBuffer(id)) {
|
||||
if (!(id instanceof Uint8Array)) {
|
||||
throw new Error('invalid id provided')
|
||||
}
|
||||
|
||||
if (privKey && pubKey && !privKey.public.bytes.equals(pubKey.bytes)) {
|
||||
if (privKey && pubKey && !uint8ArrayEquals(privKey.public.bytes, pubKey.bytes)) {
|
||||
throw new Error('inconsistent arguments')
|
||||
}
|
||||
|
||||
@ -141,14 +144,14 @@ class PeerId {
|
||||
|
||||
/**
|
||||
* Checks the equality of `this` peer against a given PeerId.
|
||||
* @param {Buffer|PeerId} id
|
||||
* @param {Uint8Array|PeerId} id
|
||||
* @returns {boolean}
|
||||
*/
|
||||
equals (id) {
|
||||
if (Buffer.isBuffer(id)) {
|
||||
return this.id.equals(id)
|
||||
if (id instanceof Uint8Array) {
|
||||
return uint8ArrayEquals(this.id, id)
|
||||
} else if (id.id) {
|
||||
return this.id.equals(id.id)
|
||||
return uint8ArrayEquals(this.id, id.id)
|
||||
} else {
|
||||
throw new Error('not valid Id')
|
||||
}
|
||||
@ -157,7 +160,7 @@ class PeerId {
|
||||
/**
|
||||
* Checks the equality of `this` peer against a given PeerId.
|
||||
* @deprecated Use `.equals`
|
||||
* @param {Buffer|PeerId} id
|
||||
* @param {Uint8Array|PeerId} id
|
||||
* @returns {boolean}
|
||||
*/
|
||||
isEqual (id) {
|
||||
@ -172,8 +175,8 @@ class PeerId {
|
||||
return Boolean(this.privKey &&
|
||||
this.privKey.public &&
|
||||
this.privKey.public.bytes &&
|
||||
Buffer.isBuffer(this.pubKey.bytes) &&
|
||||
this.privKey.public.bytes.equals(this.pubKey.bytes))
|
||||
this.pubKey.bytes instanceof Uint8Array &&
|
||||
uint8ArrayEquals(this.privKey.public.bytes, this.pubKey.bytes))
|
||||
}
|
||||
}
|
||||
|
||||
@ -230,16 +233,16 @@ exports.createFromCID = (cid) => {
|
||||
return new PeerIdWithIs(cid.multihash)
|
||||
}
|
||||
|
||||
// Public Key input will be a buffer
|
||||
// Public Key input will be a Uint8Array
|
||||
exports.createFromPubKey = async (key) => {
|
||||
let buf = key
|
||||
|
||||
if (typeof buf === 'string') {
|
||||
buf = Buffer.from(key, 'base64')
|
||||
buf = uint8ArrayFromString(key, 'base64pad')
|
||||
}
|
||||
|
||||
if (!Buffer.isBuffer(buf)) {
|
||||
throw new Error('Supplied key is neither a base64 string nor a buffer')
|
||||
if (!(buf instanceof Uint8Array)) {
|
||||
throw new Error('Supplied key is neither a base64 string nor a Uint8Array')
|
||||
}
|
||||
|
||||
const pubKey = await cryptoKeys.unmarshalPublicKey(buf)
|
||||
@ -248,24 +251,22 @@ exports.createFromPubKey = async (key) => {
|
||||
|
||||
// Private key input will be a string
|
||||
exports.createFromPrivKey = async (key) => {
|
||||
let buf = key
|
||||
|
||||
if (typeof buf === 'string') {
|
||||
buf = Buffer.from(key, 'base64')
|
||||
if (typeof key === 'string') {
|
||||
key = uint8ArrayFromString(key, 'base64pad')
|
||||
}
|
||||
|
||||
if (!Buffer.isBuffer(buf)) {
|
||||
throw new Error('Supplied key is neither a base64 string nor a buffer')
|
||||
if (!(key instanceof Uint8Array)) {
|
||||
throw new Error('Supplied key is neither a base64 string nor a Uint8Array')
|
||||
}
|
||||
|
||||
const privKey = await cryptoKeys.unmarshalPrivateKey(buf)
|
||||
const privKey = await cryptoKeys.unmarshalPrivateKey(key)
|
||||
return computePeerId(privKey, privKey.public)
|
||||
}
|
||||
|
||||
exports.createFromJSON = async (obj) => {
|
||||
const id = mh.fromB58String(obj.id)
|
||||
const rawPrivKey = obj.privKey && Buffer.from(obj.privKey, 'base64')
|
||||
const rawPubKey = obj.pubKey && Buffer.from(obj.pubKey, 'base64')
|
||||
const rawPrivKey = obj.privKey && uint8ArrayFromString(obj.privKey, 'base64pad')
|
||||
const rawPubKey = obj.pubKey && uint8ArrayFromString(obj.pubKey, 'base64pad')
|
||||
const pub = rawPubKey && await cryptoKeys.unmarshalPublicKey(rawPubKey)
|
||||
|
||||
if (!rawPrivKey) {
|
||||
@ -281,11 +282,11 @@ exports.createFromJSON = async (obj) => {
|
||||
pubDigest = await computeDigest(pub)
|
||||
}
|
||||
|
||||
if (pub && !privDigest.equals(pubDigest)) {
|
||||
if (pub && !uint8ArrayEquals(privDigest, pubDigest)) {
|
||||
throw new Error('Public and private key do not match')
|
||||
}
|
||||
|
||||
if (id && !privDigest.equals(id)) {
|
||||
if (id && !uint8ArrayEquals(privDigest, id)) {
|
||||
throw new Error('Id and private key do not match')
|
||||
}
|
||||
|
||||
@ -294,7 +295,7 @@ exports.createFromJSON = async (obj) => {
|
||||
|
||||
exports.createFromProtobuf = async (buf) => {
|
||||
if (typeof buf === 'string') {
|
||||
buf = Buffer.from(buf, 'hex')
|
||||
buf = uint8ArrayFromString(buf, 'base16')
|
||||
}
|
||||
|
||||
let { id, privKey, pubKey } = PeerIdProto.decode(buf)
|
||||
@ -315,7 +316,7 @@ exports.createFromProtobuf = async (buf) => {
|
||||
|
||||
if (privKey) {
|
||||
if (pubKey) {
|
||||
if (!privDigest.equals(pubDigest)) {
|
||||
if (!uint8ArrayEquals(privDigest, pubDigest)) {
|
||||
throw new Error('Public and private key do not match')
|
||||
}
|
||||
}
|
||||
@ -343,6 +344,6 @@ exports.isPeerId = (peerId) => {
|
||||
|
||||
function toB64Opt (val) {
|
||||
if (val) {
|
||||
return val.toString('base64')
|
||||
return uint8ArrayToString(val, 'base64pad')
|
||||
}
|
||||
}
|
||||
|
@ -2,13 +2,12 @@
|
||||
/* eslint-env mocha */
|
||||
'use strict'
|
||||
|
||||
const chai = require('chai')
|
||||
const dirtyChai = require('dirty-chai')
|
||||
chai.use(dirtyChai)
|
||||
const expect = chai.expect
|
||||
const { expect } = require('aegir/utils/chai')
|
||||
const crypto = require('libp2p-crypto')
|
||||
const mh = require('multihashes')
|
||||
const CID = require('cids')
|
||||
const uint8ArrayFromString = require('uint8arrays/from-string')
|
||||
const uint8ArrayToString = require('uint8arrays/to-string')
|
||||
|
||||
const PeerId = require('../src')
|
||||
|
||||
@ -55,14 +54,15 @@ describe('PeerId', () => {
|
||||
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)
|
||||
expect(PeerId.isPeerId(uint8ArrayFromString('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')
|
||||
// @ts-ignore
|
||||
id.id = uint8ArrayFromString('hello')
|
||||
}).to.throw(/immutable/)
|
||||
})
|
||||
|
||||
@ -71,7 +71,7 @@ describe('PeerId', () => {
|
||||
expect(testIdBytes).to.deep.equal(id.toBytes())
|
||||
})
|
||||
|
||||
it('recreate from a Buffer', () => {
|
||||
it('recreate from a Uint8Array', () => {
|
||||
const id = PeerId.createFromBytes(testIdBytes)
|
||||
expect(testId.id).to.equal(id.toHexString())
|
||||
expect(testIdBytes).to.deep.equal(id.toBytes())
|
||||
@ -112,8 +112,8 @@ describe('PeerId', () => {
|
||||
expect(testIdBytes).to.deep.equal(id.toBytes())
|
||||
})
|
||||
|
||||
it('recreate from CID Buffer', () => {
|
||||
const id = PeerId.createFromCID(testIdCID.buffer)
|
||||
it('recreate from CID Uint8Array', () => {
|
||||
const id = PeerId.createFromCID(testIdCID.bytes)
|
||||
expect(testIdCIDString).to.equal(id.toString())
|
||||
expect(testIdBytes).to.deep.equal(id.toBytes())
|
||||
})
|
||||
@ -158,7 +158,7 @@ describe('PeerId', () => {
|
||||
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 encoded = uint8ArrayFromString(testId.privKey, 'base64pad')
|
||||
const id2 = await PeerId.createFromPrivKey(encoded)
|
||||
expect(testIdB58String).to.equal(id2.toB58String())
|
||||
expect(id.marshalPubKey()).to.deep.equal(id2.marshalPubKey())
|
||||
@ -167,11 +167,11 @@ describe('PeerId', () => {
|
||||
it('recreate from Protobuf', async () => {
|
||||
const id = await PeerId.createFromProtobuf(testId.marshaled)
|
||||
expect(testIdB58String).to.equal(id.toB58String())
|
||||
const encoded = Buffer.from(testId.privKey, 'base64')
|
||||
const encoded = uint8ArrayFromString(testId.privKey, 'base64pad')
|
||||
const id2 = await PeerId.createFromPrivKey(encoded)
|
||||
expect(testIdB58String).to.equal(id2.toB58String())
|
||||
expect(id.marshalPubKey()).to.deep.equal(id2.marshalPubKey())
|
||||
expect(id.marshal().toString('hex')).to.deep.equal(testId.marshaled)
|
||||
expect(uint8ArrayToString(id.marshal(), 'base16')).to.deep.equal(testId.marshaled)
|
||||
})
|
||||
|
||||
it('can be created from a Secp256k1 public key', async () => {
|
||||
@ -216,7 +216,7 @@ describe('PeerId', () => {
|
||||
|
||||
it('toBytes', () => {
|
||||
const id = PeerId.createFromHexString(testIdHex)
|
||||
expect(id.toBytes().toString('hex')).to.equal(testIdBytes.toString('hex'))
|
||||
expect(uint8ArrayToString(id.toBytes(), 'base16')).to.equal(uint8ArrayToString(testIdBytes, 'base16'))
|
||||
})
|
||||
|
||||
it('isEqual', async () => {
|
||||
@ -286,22 +286,22 @@ describe('PeerId', () => {
|
||||
it('set privKey (invalid)', async () => {
|
||||
const peerId = await PeerId.create(testOpts)
|
||||
// @ts-ignore
|
||||
peerId.privKey = Buffer.from('bufff')
|
||||
peerId.privKey = uint8ArrayFromString('bufff')
|
||||
expect(peerId.isValid()).to.equal(false)
|
||||
})
|
||||
|
||||
it('set pubKey (invalid)', async () => {
|
||||
const peerId = await PeerId.create(testOpts)
|
||||
// @ts-ignore
|
||||
peerId.pubKey = Buffer.from('bufff')
|
||||
peerId.pubKey = uint8ArrayFromString('bufff')
|
||||
expect(peerId.isValid()).to.equal(false)
|
||||
})
|
||||
|
||||
describe('returns error via cb instead of crashing', () => {
|
||||
const garbage = [
|
||||
Buffer.from('00010203040506070809', 'hex'),
|
||||
uint8ArrayFromString('00010203040506070809', 'base16'),
|
||||
{}, null, false, undefined, true, 1, 0,
|
||||
Buffer.from(''), 'aGVsbG93b3JsZA==', 'helloworld', ''
|
||||
uint8ArrayFromString(''), 'aGVsbG93b3JsZA==', 'helloworld', ''
|
||||
]
|
||||
|
||||
const fncs = ['createFromPubKey', 'createFromPrivKey', 'createFromJSON', 'createFromProtobuf']
|
||||
|
Reference in New Issue
Block a user