feat: add types (#74)

src/crypto/errors.d.ts

@@ -1,15 +0,0 @@
-export class UnexpectedPeerError extends Error {
-    static get code(): string;
-    constructor(message?: string);
-    code: string;
-}
-export class InvalidCryptoExchangeError extends Error {
-    static get code(): string;
-    constructor(message?: string);
-    code: string;
-}
-export class InvalidCryptoTransmissionError extends Error {
-    static get code(): string;
-    constructor(message?: string);
-    code: string;
-}

src/crypto/tests/index.js

@@ -6,7 +6,7 @@ const expect = chai.expect
 chai.use(require('dirty-chai'))
 
 const duplexPair = require('it-pair/duplex')
-const pipe = require('it-pipe')
+const { pipe } = require('it-pipe')
 const PeerId = require('peer-id')
 const { collect } = require('streaming-iterables')
 const uint8arrayFromString = require('uint8arrays/from-string')

src/crypto/types.ts

@@ -0,0 +1,24 @@
+import PeerId from 'peer-id'
+import { MultiaddrConnection } from '../transport/types'
+
+/**
+ * A libp2p crypto module must be compliant to this interface
+ * to ensure all exchanged data between two peers is encrypted.
+ */
+export interface Crypto {
+  protocol: string;
+  /**
+   * Encrypt outgoing data to the remote party.
+   */
+  secureOutbound(localPeer: PeerId, connection: MultiaddrConnection, remotePeer: PeerId): Promise<SecureOutbound>;
+  /**
+   * Decrypt incoming data.
+   */
+  secureInbound(localPeer: PeerId, connection: MultiaddrConnection, remotePeer?: PeerId): Promise<SecureOutbound>;
+}
+
+export type SecureOutbound = {
+  conn: MultiaddrConnection;
+  remoteEarlyData: Buffer;
+  remotePeer: PeerId;
+}