@libp2p/interface 1.2.0 → 1.3.0

package/README.md

@@ -50,8 +50,8 @@ $ npm i @libp2p/interface
 
 Licensed under either of
 
-- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
-- MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
+- Apache 2.0, ([LICENSE-APACHE](https://github.com/libp2p/js-libp2p/blob/main/packages/interface/LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
+- MIT ([LICENSE-MIT](https://github.com/libp2p/js-libp2p/blob/main/packages/interface/LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
 
 # Contribution
 

package/dist/src/keys/index.d.ts

@@ -1,20 +1,20 @@
 import type { Uint8ArrayList } from 'uint8arraylist';
-export interface PublicKey {
+export interface PublicKey<Type extends KeyType = 'Ed25519'> {
     readonly bytes: Uint8Array;
     verify(data: Uint8Array | Uint8ArrayList, sig: Uint8Array): boolean | Promise<boolean>;
     marshal(): Uint8Array;
-    equals(key: PublicKey): boolean;
+    equals(key: PublicKey<Type>): boolean;
     hash(): Uint8Array | Promise<Uint8Array>;
 }
 /**
  * Generic private key interface
  */
-export interface PrivateKey {
-    readonly public: PublicKey;
+export interface PrivateKey<Type extends KeyType = 'Ed25519'> {
+    readonly public: PublicKey<Type>;
     readonly bytes: Uint8Array;
     sign(data: Uint8Array | Uint8ArrayList): Uint8Array | Promise<Uint8Array>;
     marshal(): Uint8Array;
-    equals(key: PrivateKey): boolean;
+    equals(key: PrivateKey<Type>): boolean;
     hash(): Uint8Array | Promise<Uint8Array>;
     /**
      * Gets the ID of the key.

package/dist/src/keys/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/keys/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAEpD,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAA;IAC1B,MAAM,CAAC,IAAI,EAAE,UAAU,GAAG,cAAc,EAAE,GAAG,EAAE,UAAU,GAAG,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IACtF,OAAO,IAAI,UAAU,CAAA;IACrB,MAAM,CAAC,GAAG,EAAE,SAAS,GAAG,OAAO,CAAA;IAC/B,IAAI,IAAI,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;CACzC;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAA;IAC1B,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAA;IAC1B,IAAI,CAAC,IAAI,EAAE,UAAU,GAAG,cAAc,GAAG,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IACzE,OAAO,IAAI,UAAU,CAAA;IACrB,MAAM,CAAC,GAAG,EAAE,UAAU,GAAG,OAAO,CAAA;IAChC,IAAI,IAAI,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IACxC;;;;;;OAMG;IACH,EAAE,IAAI,OAAO,CAAC,MAAM,CAAC,CAAA;IACrB;;OAEG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,QAAQ,GAAG,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;CACtE;AAED,eAAO,MAAM,OAAO,YAAY,CAAA;AAChC,eAAO,MAAM,GAAG,QAAQ,CAAA;AACxB,eAAO,MAAM,SAAS,cAAc,CAAA;AAEpC,MAAM,MAAM,OAAO,GAAG,OAAO,OAAO,GAAG,OAAO,GAAG,GAAG,OAAO,SAAS,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/keys/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAEpD,MAAM,WAAW,SAAS,CAAC,IAAI,SAAS,OAAO,GAAG,SAAS;IACzD,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAA;IAC1B,MAAM,CAAC,IAAI,EAAE,UAAU,GAAG,cAAc,EAAE,GAAG,EAAE,UAAU,GAAG,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IACtF,OAAO,IAAI,UAAU,CAAA;IACrB,MAAM,CAAC,GAAG,EAAE,SAAS,CAAC,IAAI,CAAC,GAAG,OAAO,CAAA;IACrC,IAAI,IAAI,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;CACzC;AAED;;GAEG;AACH,MAAM,WAAW,UAAU,CAAC,IAAI,SAAS,OAAO,GAAG,SAAS;IAC1D,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAC,IAAI,CAAC,CAAA;IAChC,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAA;IAC1B,IAAI,CAAC,IAAI,EAAE,UAAU,GAAG,cAAc,GAAG,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IACzE,OAAO,IAAI,UAAU,CAAA;IACrB,MAAM,CAAC,GAAG,EAAE,UAAU,CAAC,IAAI,CAAC,GAAG,OAAO,CAAA;IACtC,IAAI,IAAI,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IACxC;;;;;;OAMG;IACH,EAAE,IAAI,OAAO,CAAC,MAAM,CAAC,CAAA;IACrB;;OAEG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,QAAQ,GAAG,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;CACtE;AAED,eAAO,MAAM,OAAO,YAAY,CAAA;AAChC,eAAO,MAAM,GAAG,QAAQ,CAAA;AACxB,eAAO,MAAM,SAAS,cAAc,CAAA;AAEpC,MAAM,MAAM,OAAO,GAAG,OAAO,OAAO,GAAG,OAAO,GAAG,GAAG,OAAO,SAAS,CAAA"}

package/dist/src/peer-id/index.d.ts

@@ -1,30 +1,29 @@
+import type { KeyType } from '../keys/index.js';
 import type { CID } from 'multiformats/cid';
 import type { MultihashDigest } from 'multiformats/hashes/interface';
-export type PeerIdType = 'RSA' | 'Ed25519' | 'secp256k1';
-interface BasePeerId {
-    readonly type: PeerIdType;
-    readonly multihash: MultihashDigest;
-    readonly privateKey?: Uint8Array;
-    readonly publicKey?: Uint8Array;
-    toString(): string;
-    toCID(): CID;
-    toBytes(): Uint8Array;
-    equals(other?: PeerId | Uint8Array | string): boolean;
-}
-export interface RSAPeerId extends BasePeerId {
+export type PeerIdType = KeyType | string;
+export interface RSAPeerId extends PeerId {
     readonly type: 'RSA';
     readonly publicKey?: Uint8Array;
 }
-export interface Ed25519PeerId extends BasePeerId {
+export interface Ed25519PeerId extends PeerId {
     readonly type: 'Ed25519';
     readonly publicKey: Uint8Array;
 }
-export interface Secp256k1PeerId extends BasePeerId {
+export interface Secp256k1PeerId extends PeerId {
     readonly type: 'secp256k1';
     readonly publicKey: Uint8Array;
 }
-export type PeerId = RSAPeerId | Ed25519PeerId | Secp256k1PeerId;
+export interface PeerId {
+    type: PeerIdType;
+    multihash: MultihashDigest;
+    privateKey?: Uint8Array;
+    publicKey?: Uint8Array;
+    toString(): string;
+    toCID(): CID;
+    toBytes(): Uint8Array;
+    equals(other?: PeerId | Uint8Array | string): boolean;
+}
 export declare const peerIdSymbol: unique symbol;
 export declare function isPeerId(other: any): other is PeerId;
-export {};
 //# sourceMappingURL=index.d.ts.map

package/dist/src/peer-id/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/peer-id/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAC3C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAA;AAEpE,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,SAAS,GAAG,WAAW,CAAA;AAExD,UAAU,UAAU;IAClB,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAA;IACzB,QAAQ,CAAC,SAAS,EAAE,eAAe,CAAA;IACnC,QAAQ,CAAC,UAAU,CAAC,EAAE,UAAU,CAAA;IAChC,QAAQ,CAAC,SAAS,CAAC,EAAE,UAAU,CAAA;IAE/B,QAAQ,IAAI,MAAM,CAAA;IAClB,KAAK,IAAI,GAAG,CAAA;IACZ,OAAO,IAAI,UAAU,CAAA;IACrB,MAAM,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,MAAM,GAAG,OAAO,CAAA;CACtD;AAED,MAAM,WAAW,SAAU,SAAQ,UAAU;IAC3C,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAA;IACpB,QAAQ,CAAC,SAAS,CAAC,EAAE,UAAU,CAAA;CAChC;AAED,MAAM,WAAW,aAAc,SAAQ,UAAU;IAC/C,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAA;IACxB,QAAQ,CAAC,SAAS,EAAE,UAAU,CAAA;CAC/B;AAED,MAAM,WAAW,eAAgB,SAAQ,UAAU;IACjD,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAA;IAC1B,QAAQ,CAAC,SAAS,EAAE,UAAU,CAAA;CAC/B;AAED,MAAM,MAAM,MAAM,GAAG,SAAS,GAAG,aAAa,GAAG,eAAe,CAAA;AAEhE,eAAO,MAAM,YAAY,eAAgC,CAAA;AAEzD,wBAAgB,QAAQ,CAAE,KAAK,EAAE,GAAG,GAAG,KAAK,IAAI,MAAM,CAErD"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/peer-id/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAA;AAC/C,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAC3C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAA;AAEpE,MAAM,MAAM,UAAU,GAAG,OAAO,GAAG,MAAM,CAAA;AAEzC,MAAM,WAAW,SAAU,SAAQ,MAAM;IACvC,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAA;IACpB,QAAQ,CAAC,SAAS,CAAC,EAAE,UAAU,CAAA;CAChC;AAED,MAAM,WAAW,aAAc,SAAQ,MAAM;IAC3C,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAA;IACxB,QAAQ,CAAC,SAAS,EAAE,UAAU,CAAA;CAC/B;AAED,MAAM,WAAW,eAAgB,SAAQ,MAAM;IAC7C,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAA;IAC1B,QAAQ,CAAC,SAAS,EAAE,UAAU,CAAA;CAC/B;AAED,MAAM,WAAW,MAAM;IACrB,IAAI,EAAE,UAAU,CAAA;IAChB,SAAS,EAAE,eAAe,CAAA;IAC1B,UAAU,CAAC,EAAE,UAAU,CAAA;IACvB,SAAS,CAAC,EAAE,UAAU,CAAA;IAEtB,QAAQ,IAAI,MAAM,CAAA;IAClB,KAAK,IAAI,GAAG,CAAA;IACZ,OAAO,IAAI,UAAU,CAAA;IACrB,MAAM,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,MAAM,GAAG,OAAO,CAAA;CACtD;AAED,eAAO,MAAM,YAAY,eAAgC,CAAA;AAEzD,wBAAgB,QAAQ,CAAE,KAAK,EAAE,GAAG,GAAG,KAAK,IAAI,MAAM,CAErD"}

package/dist/src/peer-id/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/peer-id/index.ts"],"names":[],"mappings":"AAkCA,MAAM,CAAC,MAAM,YAAY,GAAG,MAAM,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAA;AAEzD,MAAM,UAAU,QAAQ,CAAE,KAAU;IAClC,OAAO,KAAK,IAAI,IAAI,IAAI,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAA;AACtD,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/peer-id/index.ts"],"names":[],"mappings":"AAiCA,MAAM,CAAC,MAAM,YAAY,GAAG,MAAM,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAA;AAEzD,MAAM,UAAU,QAAQ,CAAE,KAAU;IAClC,OAAO,KAAK,IAAI,IAAI,IAAI,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAA;AACtD,CAAC"}

package/dist/typedoc-urls.json

@@ -1,4 +1,5 @@
 {
+  "KeyTypes": "https://libp2p.github.io/js-libp2p/types/_libp2p_crypto.keys.KeyTypes.html",
   "FaultTolerance": "https://libp2p.github.io/js-libp2p/enums/_libp2p_interface.FaultTolerance.html",
   "TopicValidatorResult": "https://libp2p.github.io/js-libp2p/enums/_libp2p_interface.TopicValidatorResult.html",
   "AbortError": "https://libp2p.github.io/js-libp2p/classes/_libp2p_interface.AbortError.html",
@@ -62,6 +63,7 @@
   "PeerDiscovery": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.PeerDiscovery.html",
   "PeerDiscoveryEvents": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.PeerDiscoveryEvents.html",
   "PeerDiscoveryProvider": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.PeerDiscoveryProvider.html",
+  "PeerId": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.PeerId.html",
   "PeerInfo": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.PeerInfo.html",
   "PeerQuery": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.PeerQuery.html",
   "PeerQueryFilter": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.PeerQueryFilter.html",
@@ -121,7 +123,6 @@
   "Libp2pStatus": "https://libp2p.github.io/js-libp2p/types/_libp2p_interface.Libp2pStatus.html",
   ".:Libp2pStatus": "https://libp2p.github.io/js-libp2p/types/_libp2p_interface.Libp2pStatus.html",
   "Message": "https://libp2p.github.io/js-libp2p/types/_libp2p_interface.Message.html",
-  "PeerId": "https://libp2p.github.io/js-libp2p/types/_libp2p_interface.PeerId.html",
   "PeerIdType": "https://libp2p.github.io/js-libp2p/types/_libp2p_interface.PeerIdType.html",
   "PendingDialStatus": "https://libp2p.github.io/js-libp2p/types/_libp2p_interface.PendingDialStatus.html",
   ".:PendingDialStatus": "https://libp2p.github.io/js-libp2p/types/_libp2p_interface.PendingDialStatus.html",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@libp2p/interface",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "The interface implemented by a libp2p node",
   "license": "Apache-2.0 OR MIT",
   "homepage": "https://github.com/libp2p/js-libp2p/tree/main/packages/interface#readme",

package/src/keys/index.ts

@@ -1,22 +1,22 @@
 import type { Uint8ArrayList } from 'uint8arraylist'
 
-export interface PublicKey {
+export interface PublicKey<Type extends KeyType = 'Ed25519'> {
   readonly bytes: Uint8Array
   verify(data: Uint8Array | Uint8ArrayList, sig: Uint8Array): boolean | Promise<boolean>
   marshal(): Uint8Array
-  equals(key: PublicKey): boolean
+  equals(key: PublicKey<Type>): boolean
   hash(): Uint8Array | Promise<Uint8Array>
 }
 
 /**
  * Generic private key interface
  */
-export interface PrivateKey {
-  readonly public: PublicKey
+export interface PrivateKey<Type extends KeyType = 'Ed25519'> {
+  readonly public: PublicKey<Type>
   readonly bytes: Uint8Array
   sign(data: Uint8Array | Uint8ArrayList): Uint8Array | Promise<Uint8Array>
   marshal(): Uint8Array
-  equals(key: PrivateKey): boolean
+  equals(key: PrivateKey<Type>): boolean
   hash(): Uint8Array | Promise<Uint8Array>
   /**
    * Gets the ID of the key.

package/src/peer-id/index.ts

@@ -1,36 +1,35 @@
+import type { KeyType } from '../keys/index.js'
 import type { CID } from 'multiformats/cid'
 import type { MultihashDigest } from 'multiformats/hashes/interface'
 
-export type PeerIdType = 'RSA' | 'Ed25519' | 'secp256k1'
+export type PeerIdType = KeyType | string
 
-interface BasePeerId {
-  readonly type: PeerIdType
-  readonly multihash: MultihashDigest
-  readonly privateKey?: Uint8Array
-  readonly publicKey?: Uint8Array
-
-  toString(): string
-  toCID(): CID
-  toBytes(): Uint8Array
-  equals(other?: PeerId | Uint8Array | string): boolean
-}
-
-export interface RSAPeerId extends BasePeerId {
+export interface RSAPeerId extends PeerId {
   readonly type: 'RSA'
   readonly publicKey?: Uint8Array
 }
 
-export interface Ed25519PeerId extends BasePeerId {
+export interface Ed25519PeerId extends PeerId {
   readonly type: 'Ed25519'
   readonly publicKey: Uint8Array
 }
 
-export interface Secp256k1PeerId extends BasePeerId {
+export interface Secp256k1PeerId extends PeerId {
   readonly type: 'secp256k1'
   readonly publicKey: Uint8Array
 }
 
-export type PeerId = RSAPeerId | Ed25519PeerId | Secp256k1PeerId
+export interface PeerId {
+  type: PeerIdType
+  multihash: MultihashDigest
+  privateKey?: Uint8Array
+  publicKey?: Uint8Array
+
+  toString(): string
+  toCID(): CID
+  toBytes(): Uint8Array
+  equals(other?: PeerId | Uint8Array | string): boolean
+}
 
 export const peerIdSymbol = Symbol.for('@libp2p/peer-id')