Compare commits

...

5 Commits

Author SHA1 Message Date
5468ee0877 chore: release version v0.14.3 2021-01-26 09:22:15 +01:00
f895151451 chore: update contributors 2021-01-26 09:22:15 +01:00
e7d0eaa796 chore: update deps (#137) 2021-01-26 09:10:46 +01:00
41ab96c47d docs: correct case for RSA keyType (#136)
* docs: correct case for RSA keyType

correct case of rsa keytype in docs/examples to match keyType exported from libp2p-crypto

Co-authored-by: Vasco Santos <vasco.santos@ua.pt>
2021-01-06 15:13:25 +01:00
4178e53db8 docs: add documentation for isPeerId(id) (#134) (#135) 2020-12-01 17:33:15 +01:00
4 changed files with 30 additions and 12 deletions

View File

@ -1,3 +1,7 @@
## [0.14.3](https://github.com/libp2p/js-peer-id/compare/v0.14.2...v0.14.3) (2021-01-26)
<a name="0.14.2"></a> <a name="0.14.2"></a>
## [0.14.2](https://github.com/libp2p/js-peer-id/compare/v0.14.1...v0.14.2) (2020-09-23) ## [0.14.2](https://github.com/libp2p/js-peer-id/compare/v0.14.1...v0.14.2) (2020-09-23)

View File

@ -53,6 +53,8 @@
- [`toPrint()`](#toprint) - [`toPrint()`](#toprint)
- [`equals(id)`](#equalsid) - [`equals(id)`](#equalsid)
- [`isEqual(id)`](#isequalid) - [`isEqual(id)`](#isequalid)
- [Others](#others)
- [`isPeerId(id)`](#ispeeridid)
- [License](#license) - [License](#license)
# Description # Description
@ -68,7 +70,7 @@ The public key is a base64 encoded string of a protobuf containing an RSA DER bu
```JavaScript ```JavaScript
const PeerId = require('peer-id') const PeerId = require('peer-id')
const id = await PeerId.create({ bits: 1024, keyType: 'rsa' }) const id = await PeerId.create({ bits: 1024, keyType: 'RSA' })
console.log(JSON.stringify(id.toJSON(), null, 2)) console.log(JSON.stringify(id.toJSON(), null, 2))
``` ```
@ -147,7 +149,7 @@ The key format is detailed in [libp2p-crypto](https://github.com/libp2p/js-libp2
Generates a new Peer ID, complete with public/private keypair. Generates a new Peer ID, complete with public/private keypair.
- `opts.bits: number` - The size of the key. Default: `2048` - `opts.bits: number` - The size of the key. Default: `2048`
- `opts.keyType: string` - The key type, one of: `['rsa', 'ed25519', 'secp256k1']`. Default: `rsa` - `opts.keyType: string` - The key type, one of: `['RSA', 'Ed25519', 'secp256k1']`. Default: `RSA`
Returns `Promise<PeerId>`. Returns `Promise<PeerId>`.
@ -285,6 +287,14 @@ Returns `true` if the given PeerId is equal to the current instance.
- `id` can be a PeerId or a Buffer containing the id - `id` can be a PeerId or a Buffer containing the id
## Others
### `isPeerId(id)`
Returns `true` if the given id is an instance of PeerId
- `id` should be an instance of PeerId
# License # License
MIT MIT

View File

@ -1,6 +1,6 @@
{ {
"name": "peer-id", "name": "peer-id",
"version": "0.14.2", "version": "0.14.3",
"description": "IPFS Peer Id implementation in Node.js", "description": "IPFS Peer Id implementation in Node.js",
"leadMaintainer": "Vasco Santos <santos.vasco10@gmail.com>", "leadMaintainer": "Vasco Santos <santos.vasco10@gmail.com>",
"main": "src/index.js", "main": "src/index.js",
@ -8,7 +8,7 @@
"bin": "src/bin.js", "bin": "src/bin.js",
"scripts": { "scripts": {
"lint": "aegir lint", "lint": "aegir lint",
"build": "aegir build", "build": "aegir build --no-types",
"test": "aegir test", "test": "aegir test",
"test:node": "aegir test -t node", "test:node": "aegir test -t node",
"test:browser": "aegir test -t browser -t webworker", "test:browser": "aegir test -t browser -t webworker",
@ -36,19 +36,19 @@
}, },
"homepage": "https://github.com/libp2p/js-peer-id", "homepage": "https://github.com/libp2p/js-peer-id",
"devDependencies": { "devDependencies": {
"@types/chai": "^4.2.7", "@types/chai": "^4.2.14",
"@types/dirty-chai": "^2.0.2", "@types/dirty-chai": "^2.0.2",
"@types/mocha": "^8.0.1", "@types/mocha": "^8.2.0",
"aegir": "^25.0.0" "aegir": "^30.3.0"
}, },
"dependencies": { "dependencies": {
"cids": "^1.0.0", "cids": "^1.1.5",
"class-is": "^1.1.0", "class-is": "^1.1.0",
"libp2p-crypto": "^0.18.0", "libp2p-crypto": "^0.19.0",
"minimist": "^1.2.5", "minimist": "^1.2.5",
"multihashes": "^3.0.1", "multihashes": "^3.1.1",
"protons": "^2.0.0", "protons": "^2.0.0",
"uint8arrays": "^1.1.0" "uint8arrays": "^2.0.5"
}, },
"repository": { "repository": {
"type": "git", "type": "git",
@ -67,6 +67,7 @@
"Alex Potsides <alex@achingbrain.net>", "Alex Potsides <alex@achingbrain.net>",
"Nate Foss <npfoss@gmail.com>", "Nate Foss <npfoss@gmail.com>",
"Robert Kiel <robert.kiel@validitylabs.org>", "Robert Kiel <robert.kiel@validitylabs.org>",
"Adam Uhlíř <adam@uhlir.dev>",
"ᴠɪᴄᴛᴏʀ ʙᴊᴇʟᴋʜᴏʟᴍ <victorbjelkholm@gmail.com>", "ᴠɪᴄᴛᴏʀ ʙᴊᴇʟᴋʜᴏʟᴍ <victorbjelkholm@gmail.com>",
"Arve Knudsen <arve.knudsen@gmail.com>", "Arve Knudsen <arve.knudsen@gmail.com>",
"Carson Farmer <carson.farmer@gmail.com>", "Carson Farmer <carson.farmer@gmail.com>",
@ -80,6 +81,6 @@
"Topper Bowers <topper@quorumcontrol.com>", "Topper Bowers <topper@quorumcontrol.com>",
"Vojtech Simetka <vojtech@simetka.cz>", "Vojtech Simetka <vojtech@simetka.cz>",
"Yahya <ya7yaz@gmail.com>", "Yahya <ya7yaz@gmail.com>",
"Adam Uhlíř <adam@uhlir.dev>" "a1300 <matthias-knopp@gmx.net>"
] ]
} }

View File

@ -144,6 +144,7 @@ class PeerId {
/** /**
* Checks the equality of `this` peer against a given PeerId. * Checks the equality of `this` peer against a given PeerId.
*
* @param {Uint8Array|PeerId} id * @param {Uint8Array|PeerId} id
* @returns {boolean} * @returns {boolean}
*/ */
@ -159,6 +160,7 @@ class PeerId {
/** /**
* Checks the equality of `this` peer against a given PeerId. * Checks the equality of `this` peer against a given PeerId.
*
* @deprecated Use `.equals` * @deprecated Use `.equals`
* @param {Uint8Array|PeerId} id * @param {Uint8Array|PeerId} id
* @returns {boolean} * @returns {boolean}
@ -181,6 +183,7 @@ class PeerId {
/** /**
* Check if the PeerId has an inline public key. * Check if the PeerId has an inline public key.
*
* @returns {boolean} * @returns {boolean}
*/ */
hasInlinePublicKey () { hasInlinePublicKey () {