Compare commits

...

4 Commits

Author SHA1 Message Date
763187beb1 chore: release version v0.1.2 2019-10-29 12:15:58 +01:00
44e08c9007 chore: update contributors 2019-10-29 12:15:57 +01:00
d2fe2d1b36 feat: crypto errors (#4)
* chore: ignore docs folder

* feat: add invalid crypto exchange error
2019-10-29 12:12:09 +01:00
bcb52ae709 docs: add crypto to readme (#5) 2019-10-29 11:24:28 +01:00
6 changed files with 30 additions and 4 deletions

1
.gitignore vendored
View File

@ -6,6 +6,7 @@
build
dist
docs
# Dependency directory
# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git

View File

@ -1,3 +1,13 @@
<a name="0.1.2"></a>
## [0.1.2](https://github.com/libp2p/js-interfaces/compare/v0.1.1...v0.1.2) (2019-10-29)
### Features
* crypto errors ([#4](https://github.com/libp2p/js-interfaces/issues/4)) ([d2fe2d1](https://github.com/libp2p/js-interfaces/commit/d2fe2d1))
<a name="0.1.1"></a>
## [0.1.1](https://github.com/libp2p/js-interfaces/compare/v0.1.0...v0.1.1) (2019-10-21)

View File

@ -15,6 +15,7 @@
- [Connection](./src/connection)
- [Content Routing](./src/content-routing)
- [Crypto](./src/crypto)
- [Peer Discovery](./src/peer-discovery)
- [Peer Routing](./src/peer-routing)
- [Stream Muxer](./src/stream-muxer)

View File

@ -1,6 +1,6 @@
{
"name": "libp2p-interfaces",
"version": "0.1.1",
"version": "0.1.2",
"description": "Interfaces for JS Libp2p",
"main": "src/index.js",
"files": [

View File

@ -84,6 +84,7 @@ Common crypto errors come with the interface, and can be imported directly. All
```js
const {
InvalidCryptoExchangeError,
UnexpectedPeerError
} = require('libp2p-interfaces/src/crypto/errors')
@ -93,4 +94,5 @@ console.log(error.code === UnexpectedPeerError.code) // true
### Error Types
- `UnexpectedPeerError` - Should be thrown when the expected peer id does not match the peer id determined via the crypto exchange
- `InvalidCryptoExchangeError` - Should be thrown when a peer provides data that is insufficient to finish the crypto exchange.
- `UnexpectedPeerError` - Should be thrown when the expected peer id does not match the peer id determined via the crypto exchange.

View File

@ -11,6 +11,18 @@ class UnexpectedPeerError extends Error {
}
}
module.exports = {
UnexpectedPeerError
class InvalidCryptoExchangeError extends Error {
constructor (message = 'Invalid crypto exchange') {
super(message)
this.code = InvalidCryptoExchangeError.code
}
static get code () {
return 'ERR_INVALID_CRYPTO_EXCHANGE'
}
}
module.exports = {
UnexpectedPeerError,
InvalidCryptoExchangeError
}