@libp2p/interface-connection-encrypter - npm Package Compare versions

Comparing version 2.0.1 to 2.0.2

dist/src/index.d.ts

@@ -10,7 +10,11 @@ import type { PeerId } from '@libp2p/interface-peer-id';
     /**
-     * Encrypt outgoing data to the remote party.
+     * Encrypt outgoing data to the remote party. If the remote PeerId is known,
+     * pass it for extra verification, otherwise it will be determined during
+     * the handshake.
      */
-    secureOutbound: (localPeer: PeerId, connection: Duplex<Uint8Array>, remotePeer: PeerId) => Promise<SecuredConnection>;
+    secureOutbound: (localPeer: PeerId, connection: Duplex<Uint8Array>, remotePeer?: PeerId) => Promise<SecuredConnection>;
     /**
-     * Decrypt incoming data.
+     * Decrypt incoming data. If the remote PeerId is known,
+     * pass it for extra verification, otherwise it will be determined during
+     * the handshake
      */
@@ -17,0 +21,0 @@ secureInbound: (localPeer: PeerId, connection: Duplex<Uint8Array>, remotePeer?: PeerId) => Promise<SecuredConnection>;

package.json

 {
   "name": "@libp2p/interface-connection-encrypter",
-  "version": "2.0.1",
+  "version": "2.0.2",
   "description": "Connection Encrypter interface for libp2p",
@@ -5,0 +5,0 @@ "license": "Apache-2.0 OR MIT",

src/index.ts

@@ -12,8 +12,12 @@ import type { PeerId } from '@libp2p/interface-peer-id'
   /**
-   * Encrypt outgoing data to the remote party.
+   * Encrypt outgoing data to the remote party. If the remote PeerId is known,
+   * pass it for extra verification, otherwise it will be determined during
+   * the handshake.
    */
-  secureOutbound: (localPeer: PeerId, connection: Duplex<Uint8Array>, remotePeer: PeerId) => Promise<SecuredConnection>
+  secureOutbound: (localPeer: PeerId, connection: Duplex<Uint8Array>, remotePeer?: PeerId) => Promise<SecuredConnection>
 
   /**
-   * Decrypt incoming data.
+   * Decrypt incoming data. If the remote PeerId is known,
+   * pass it for extra verification, otherwise it will be determined during
+   * the handshake
    */
@@ -20,0 +24,0 @@ secureInbound: (localPeer: PeerId, connection: Duplex<Uint8Array>, remotePeer?: PeerId) => Promise<SecuredConnection>

No alert changes

Improved metrics

Total package byte prevSize

14751

increased by3.69%

Lines of code

125

increased by6.84%

No dependency changes