@libp2p/interface 1.7.0-3c8dd5bbf → 1.7.0-5214dec4a

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

@@ -1,4 +1,4 @@
-import type { Connection, MultiaddrConnection } from '../connection/index.js';
+import type { Connection, ConnectionLimits, MultiaddrConnection } from '../connection/index.js';
 import type { TypedEventTarget } from '../event-target.js';
 import type { AbortOptions } from '../index.js';
 import type { StreamMuxerFactory } from '../stream-muxer/index.js';
@@ -85,15 +85,11 @@ export declare enum FaultTolerance {
      */
     NO_FATAL = 1
 }
-export interface UpgraderOptions<ConnectionUpgradeEvents extends ProgressEvent = ProgressEvent> extends ProgressOptions<ConnectionUpgradeEvents> {
+export interface UpgraderOptions<ConnectionUpgradeEvents extends ProgressEvent = ProgressEvent> extends ProgressOptions<ConnectionUpgradeEvents>, AbortOptions {
     skipEncryption?: boolean;
     skipProtection?: boolean;
     muxerFactory?: StreamMuxerFactory;
-    /**
-     * The passed MultiaddrConnection has limits place on duration and/or data
-     * transfer amounts so is not expected to be open for very long.
-     */
-    transient?: boolean;
+    limits?: ConnectionLimits;
 }
 export type InboundConnectionUpgradeEvents = ProgressEvent<'upgrader:encrypt-inbound-connection'> | ProgressEvent<'upgrader:multiplex-inbound-connection'>;
 export type OutboundConnectionUpgradeEvents = ProgressEvent<'upgrader:encrypt-outbound-connection'> | ProgressEvent<'upgrader:multiplex-outbound-connection'>;

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/transport/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAA;AAC7E,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AAC1D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAC/C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAA;AAClE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACxD,OAAO,KAAK,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAErE,MAAM,WAAW,cAAc;IAC7B,YAAY,EAAE,WAAW,CAAC,UAAU,CAAC,CAAA;IACrC,WAAW,EAAE,WAAW,CAAA;IACxB,OAAO,EAAE,WAAW,CAAC,KAAK,CAAC,CAAA;IAC3B,OAAO,EAAE,WAAW,CAAA;CACrB;AAED,MAAM,WAAW,QAAS,SAAQ,gBAAgB,CAAC,cAAc,CAAC;IAChE;;OAEG;IACH,MAAM,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAC3C;;OAEG;IACH,QAAQ,IAAI,SAAS,EAAE,CAAA;IACvB;;;;OAIG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;CACvB;AAED,eAAO,MAAM,eAAe,eAAkC,CAAA;AAE9D,MAAM,WAAW,iBAAiB;IAAG,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI,CAAA;CAAE;AAErE,MAAM,WAAW,eAAe;IAAG,CAAC,UAAU,EAAE,SAAS,EAAE,GAAG,SAAS,EAAE,CAAA;CAAE;AAE3E,MAAM,WAAW,qBAAqB;IACpC,OAAO,CAAC,EAAE,iBAAiB,CAAA;IAC3B,QAAQ,EAAE,QAAQ,CAAA;CACnB;AAED,MAAM,WAAW,oBAAoB,CAAC,UAAU,SAAS,aAAa,GAAG,aAAa,CAAE,SAAQ,YAAY,EAAE,eAAe,CAAC,UAAU,CAAC;IACvI,QAAQ,EAAE,QAAQ,CAAA;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,SAAS,CAAC,UAAU,SAAS,aAAa,GAAG,aAAa;IACzE;;OAEG;IACH,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,MAAM,CAAA;IAE5B;;OAEG;IACH,CAAC,eAAe,CAAC,EAAE,IAAI,CAAA;IAEvB;;OAEG;IACH,IAAI,CAAC,EAAE,EAAE,SAAS,EAAE,OAAO,EAAE,oBAAoB,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAEnF;;OAEG;IACH,cAAc,CAAC,OAAO,EAAE,qBAAqB,GAAG,QAAQ,CAAA;IAExD;;;OAGG;IACH,YAAY,EAAE,eAAe,CAAA;IAE7B;;;OAGG;IACH,UAAU,EAAE,eAAe,CAAA;CAC5B;AAED,wBAAgB,WAAW,CAAE,KAAK,EAAE,GAAG,GAAG,KAAK,IAAI,SAAS,CAE3D;AAED;;GAEG;AACH,oBAAY,cAAc;IACxB;;OAEG;IACH,SAAS,IAAI;IAEb;;OAEG;IACH,QAAQ,IAAA;CACT;AAED,MAAM,WAAW,eAAe,CAAC,uBAAuB,SAAS,aAAa,GAAG,aAAa,CAAE,SAAQ,eAAe,CAAC,uBAAuB,CAAC;IAC9I,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,YAAY,CAAC,EAAE,kBAAkB,CAAA;IAEjC;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB;AAED,MAAM,MAAM,8BAA8B,GAC1C,aAAa,CAAC,qCAAqC,CAAC,GACpD,aAAa,CAAC,uCAAuC,CAAC,CAAA;AAEtD,MAAM,MAAM,+BAA+B,GAC3C,aAAa,CAAC,sCAAsC,CAAC,GACrD,aAAa,CAAC,wCAAwC,CAAC,CAAA;AAEvD,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,eAAe,CAAC,MAAM,EAAE,mBAAmB,EAAE,IAAI,CAAC,EAAE,eAAe,CAAC,+BAA+B,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAE1H;;OAEG;IACH,cAAc,CAAC,MAAM,EAAE,mBAAmB,EAAE,IAAI,CAAC,EAAE,eAAe,CAAC,8BAA8B,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;CACzH"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/transport/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAA;AAC/F,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AAC1D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAC/C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAA;AAClE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACxD,OAAO,KAAK,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAErE,MAAM,WAAW,cAAc;IAC7B,YAAY,EAAE,WAAW,CAAC,UAAU,CAAC,CAAA;IACrC,WAAW,EAAE,WAAW,CAAA;IACxB,OAAO,EAAE,WAAW,CAAC,KAAK,CAAC,CAAA;IAC3B,OAAO,EAAE,WAAW,CAAA;CACrB;AAED,MAAM,WAAW,QAAS,SAAQ,gBAAgB,CAAC,cAAc,CAAC;IAChE;;OAEG;IACH,MAAM,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAC3C;;OAEG;IACH,QAAQ,IAAI,SAAS,EAAE,CAAA;IACvB;;;;OAIG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;CACvB;AAED,eAAO,MAAM,eAAe,eAAkC,CAAA;AAE9D,MAAM,WAAW,iBAAiB;IAAG,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI,CAAA;CAAE;AAErE,MAAM,WAAW,eAAe;IAAG,CAAC,UAAU,EAAE,SAAS,EAAE,GAAG,SAAS,EAAE,CAAA;CAAE;AAE3E,MAAM,WAAW,qBAAqB;IACpC,OAAO,CAAC,EAAE,iBAAiB,CAAA;IAC3B,QAAQ,EAAE,QAAQ,CAAA;CACnB;AAED,MAAM,WAAW,oBAAoB,CAAC,UAAU,SAAS,aAAa,GAAG,aAAa,CAAE,SAAQ,YAAY,EAAE,eAAe,CAAC,UAAU,CAAC;IACvI,QAAQ,EAAE,QAAQ,CAAA;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,SAAS,CAAC,UAAU,SAAS,aAAa,GAAG,aAAa;IACzE;;OAEG;IACH,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,MAAM,CAAA;IAE5B;;OAEG;IACH,CAAC,eAAe,CAAC,EAAE,IAAI,CAAA;IAEvB;;OAEG;IACH,IAAI,CAAC,EAAE,EAAE,SAAS,EAAE,OAAO,EAAE,oBAAoB,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAEnF;;OAEG;IACH,cAAc,CAAC,OAAO,EAAE,qBAAqB,GAAG,QAAQ,CAAA;IAExD;;;OAGG;IACH,YAAY,EAAE,eAAe,CAAA;IAE7B;;;OAGG;IACH,UAAU,EAAE,eAAe,CAAA;CAC5B;AAED,wBAAgB,WAAW,CAAE,KAAK,EAAE,GAAG,GAAG,KAAK,IAAI,SAAS,CAE3D;AAED;;GAEG;AACH,oBAAY,cAAc;IACxB;;OAEG;IACH,SAAS,IAAI;IAEb;;OAEG;IACH,QAAQ,IAAA;CACT;AAED,MAAM,WAAW,eAAe,CAAC,uBAAuB,SAAS,aAAa,GAAG,aAAa,CAAE,SAAQ,eAAe,CAAC,uBAAuB,CAAC,EAAE,YAAY;IAC5J,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,YAAY,CAAC,EAAE,kBAAkB,CAAA;IACjC,MAAM,CAAC,EAAE,gBAAgB,CAAA;CAC1B;AAED,MAAM,MAAM,8BAA8B,GAC1C,aAAa,CAAC,qCAAqC,CAAC,GACpD,aAAa,CAAC,uCAAuC,CAAC,CAAA;AAEtD,MAAM,MAAM,+BAA+B,GAC3C,aAAa,CAAC,sCAAsC,CAAC,GACrD,aAAa,CAAC,wCAAwC,CAAC,CAAA;AAEvD,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,eAAe,CAAC,MAAM,EAAE,mBAAmB,EAAE,IAAI,CAAC,EAAE,eAAe,CAAC,+BAA+B,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAE1H;;OAEG;IACH,cAAc,CAAC,MAAM,EAAE,mBAAmB,EAAE,IAAI,CAAC,EAAE,eAAe,CAAC,8BAA8B,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;CACzH"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@libp2p/interface",
-  "version": "1.7.0-3c8dd5bbf",
+  "version": "1.7.0-5214dec4a",
   "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/connection/index.ts

@@ -185,12 +185,16 @@ export interface NewStreamOptions extends AbortOptions {
   maxOutboundStreams?: number
 
   /**
-   * Opt-in to running over a transient connection - one that has time/data limits
-   * placed on it.
+   * Opt-in to running over a limited connection - one that has restrictions
+   * on the amount of data that may be transferred or how long it may be open for.
+   *
+   * These limits are typically enforced by a relay server, if the protocol
+   * will be transferring a lot of data or the stream will be open for a long time
+   * consider upgrading to a direct connection before opening the stream.
    *
    * @default false
    */
-  runOnTransientConnection?: boolean
+  runOnLimitedConnection?: boolean
 
   /**
    * By default when negotiating a protocol the dialer writes then protocol name
@@ -222,6 +226,29 @@ export interface NewStreamOptions extends AbortOptions {
 
 export type ConnectionStatus = 'open' | 'closing' | 'closed'
 
+/**
+ * Connection limits are present on connections that are only allowed to
+ * transfer a certain amount of bytes or be open for a certain number
+ * of seconds.
+ *
+ * These limits are applied by Circuit Relay v2 servers, for example and
+ * the connection will normally be closed abruptly if the limits are
+ * exceeded.
+ */
+export interface ConnectionLimits {
+  /**
+   * If present this is the number of bytes remaining that may be
+   * transferred over this connection
+   */
+  bytes?: bigint
+
+  /**
+   * If present this is the number of seconds that this connection will
+   * remain open for
+   */
+  seconds?: number
+}
+
 /**
  * A Connection is a high-level representation of a connection
  * to a remote peer that may have been secured by encryption and
@@ -280,12 +307,11 @@ export interface Connection {
   status: ConnectionStatus
 
   /**
-   * A transient connection is one that is not expected to be open for very long
-   * or one that cannot transfer very much data, such as one being used as a
-   * circuit relay connection. Protocols need to explicitly opt-in to being run
-   * over transient connections.
+   * If present, this connection has limits applied to it, perhaps by an
+   * intermediate relay. Once the limits have been reached the connection will
+   * be closed by the relay.
    */
-  transient: boolean
+  limits?: ConnectionLimits
 
   /**
    * The time in milliseconds it takes to make a round trip to the remote peer.

package/src/connection-encrypter/index.ts

@@ -1,8 +1,18 @@
 import type { MultiaddrConnection } from '../connection/index.js'
+import type { AbortOptions } from '../index.js'
 import type { PeerId } from '../peer-id/index.js'
 import type { Duplex } from 'it-stream-types'
 import type { Uint8ArrayList } from 'uint8arraylist'
 
+/**
+ * If the remote PeerId is known and passed as an option, the securing operation
+ * will throw if the remote peer cannot prove it has the private key that
+ * corresponds to the public key the remote PeerId is derived from.
+ */
+export interface SecureConnectionOptions extends AbortOptions {
+  remotePeer?: PeerId
+}
+
 /**
  * A libp2p connection encrypter module must be compliant to this interface
  * to ensure all exchanged data between two peers is encrypted.
@@ -15,14 +25,14 @@ export interface ConnectionEncrypter<Extension = unknown> {
    * pass it for extra verification, otherwise it will be determined during
    * the handshake.
    */
-  secureOutbound <Stream extends Duplex<AsyncGenerator<Uint8Array | Uint8ArrayList>> = MultiaddrConnection> (localPeer: PeerId, connection: Stream, remotePeer?: PeerId): Promise<SecuredConnection<Stream, Extension>>
+  secureOutbound <Stream extends Duplex<AsyncGenerator<Uint8Array | Uint8ArrayList>> = MultiaddrConnection> (connection: Stream, options?: SecureConnectionOptions): Promise<SecuredConnection<Stream, Extension>>
 
   /**
    * Decrypt incoming data. If the remote PeerId is known,
    * pass it for extra verification, otherwise it will be determined during
    * the handshake
    */
-  secureInbound <Stream extends Duplex<AsyncGenerator<Uint8Array | Uint8ArrayList>> = MultiaddrConnection> (localPeer: PeerId, connection: Stream, remotePeer?: PeerId): Promise<SecuredConnection<Stream, Extension>>
+  secureInbound <Stream extends Duplex<AsyncGenerator<Uint8Array | Uint8ArrayList>> = MultiaddrConnection> (connection: Stream, options?: SecureConnectionOptions): Promise<SecuredConnection<Stream, Extension>>
 }
 
 export interface SecuredConnection<Stream = any, Extension = unknown> {

package/src/errors.ts

@@ -4,21 +4,15 @@
  * AbortSignal.
  */
 export class AbortError extends Error {
-  public readonly code: string
-  public readonly type: string
-
   constructor (message: string = 'The operation was aborted') {
     super(message)
     this.name = 'AbortError'
-    this.code = AbortError.code
-    this.type = AbortError.type
   }
-
-  static readonly code = 'ABORT_ERR'
-
-  static readonly type = 'aborted'
 }
 
+/**
+ * @deprecated
+ */
 export class CodeError<T extends Record<string, any> = Record<string, never>> extends Error {
   public readonly props: T
 
@@ -34,6 +28,9 @@ export class CodeError<T extends Record<string, any> = Record<string, never>> ex
   }
 }
 
+/**
+ * @deprecated
+ */
 export class AggregateCodeError<T extends Record<string, any> = Record<string, never>> extends AggregateError {
   public readonly props: T
 
@@ -51,44 +48,203 @@ export class AggregateCodeError<T extends Record<string, any> = Record<string, n
 }
 
 export class UnexpectedPeerError extends Error {
-  public code: string
-
   constructor (message = 'Unexpected Peer') {
     super(message)
     this.name = 'UnexpectedPeerError'
-    this.code = UnexpectedPeerError.code
   }
-
-  static readonly code = 'ERR_UNEXPECTED_PEER'
 }
 
 export class InvalidCryptoExchangeError extends Error {
-  public code: string
-
   constructor (message = 'Invalid crypto exchange') {
     super(message)
     this.name = 'InvalidCryptoExchangeError'
-    this.code = InvalidCryptoExchangeError.code
   }
+}
+
+export class InvalidParametersError extends Error {
+  constructor (message = 'Invalid parameters') {
+    super(message)
+    this.name = 'InvalidParametersError'
+  }
+}
 
-  static readonly code = 'ERR_INVALID_CRYPTO_EXCHANGE'
+export class InvalidPublicKeyError extends Error {
+  constructor (message = 'Invalid public key') {
+    super(message)
+    this.name = 'InvalidPublicKeyError'
+  }
 }
 
-export class InvalidCryptoTransmissionError extends Error {
-  public code: string
+export class InvalidPrivateKeyError extends Error {
+  constructor (message = 'Invalid private key') {
+    super(message)
+    this.name = 'InvalidPrivateKeyError'
+  }
+}
 
-  constructor (message = 'Invalid crypto transmission') {
+export class UnsupportedOperationError extends Error {
+  constructor (message = 'Unsupported operation') {
     super(message)
-    this.name = 'InvalidCryptoTransmissionError'
-    this.code = InvalidCryptoTransmissionError.code
+    this.name = 'UnsupportedOperationError'
   }
+}
 
-  static readonly code = 'ERR_INVALID_CRYPTO_TRANSMISSION'
+export class ConnectionClosingError extends Error {
+  constructor (message = 'The connection is closing') {
+    super(message)
+    this.name = 'ConnectionClosingError'
+  }
 }
 
-// Error codes
+export class ConnectionClosedError extends Error {
+  constructor (message = 'The connection is closed') {
+    super(message)
+    this.name = 'ConnectionClosedError'
+  }
+}
 
-export const ERR_TIMEOUT = 'ERR_TIMEOUT'
-export const ERR_INVALID_PARAMETERS = 'ERR_INVALID_PARAMETERS'
-export const ERR_NOT_FOUND = 'ERR_NOT_FOUND'
-export const ERR_INVALID_MESSAGE = 'ERR_INVALID_MESSAGE'
+export class ConnectionFailedError extends Error {
+  constructor (message = 'Connection failed') {
+    super(message)
+    this.name = 'ConnectionFailedError'
+  }
+}
+
+export class StreamResetError extends Error {
+  constructor (message = 'The stream has been reset') {
+    super(message)
+    this.name = 'StreamResetError'
+  }
+}
+
+export class StreamStateError extends Error {
+  constructor (message = 'The stream is in an invalid state') {
+    super(message)
+    this.name = 'StreamStateError'
+  }
+}
+
+export class NotFoundError extends Error {
+  constructor (message = 'Not found') {
+    super(message)
+    this.name = 'NotFoundError'
+  }
+}
+
+export class InvalidPeerIdError extends Error {
+  constructor (message = 'Invalid PeerID') {
+    super(message)
+    this.name = 'InvalidPeerIdError'
+  }
+}
+
+export class InvalidMultiaddrError extends Error {
+  constructor (message = 'Invalid multiaddr') {
+    super(message)
+    this.name = 'InvalidMultiaddrError'
+  }
+}
+
+export class InvalidCIDError extends Error {
+  constructor (message = 'Invalid CID') {
+    super(message)
+    this.name = 'InvalidCIDError'
+  }
+}
+
+export class InvalidMultihashError extends Error {
+  constructor (message = 'Invalid Multihash') {
+    super(message)
+    this.name = 'InvalidMultihashError'
+  }
+}
+
+export class UnsupportedProtocolError extends Error {
+  constructor (message = 'Unsupported protocol error') {
+    super(message)
+    this.name = 'UnsupportedProtocolError'
+  }
+}
+
+/**
+ * An invalid or malformed message was encountered during a protocol exchange
+ */
+export class InvalidMessageError extends Error {
+  constructor (message = 'Invalid message') {
+    super(message)
+    this.name = 'InvalidMessageError'
+  }
+}
+
+export class ProtocolError extends Error {
+  constructor (message = 'Protocol error') {
+    super(message)
+    this.name = 'ProtocolError'
+  }
+}
+
+export class TimeoutError extends Error {
+  constructor (message = 'Timed out') {
+    super(message)
+    this.name = 'TimeoutError'
+  }
+}
+
+export class NotStartedError extends Error {
+  constructor (message = 'Not started') {
+    super(message)
+    this.name = 'NotStartedError'
+  }
+}
+
+export class AlreadyStartedError extends Error {
+  constructor (message = 'Already started') {
+    super(message)
+    this.name = 'AlreadyStartedError'
+  }
+}
+
+export class DialError extends Error {
+  constructor (message = 'Dial error') {
+    super(message)
+    this.name = 'DialError'
+  }
+}
+
+export class ListenError extends Error {
+  constructor (message = 'Listen error') {
+    super(message)
+    this.name = 'ListenError'
+  }
+}
+
+export class LimitedConnectionError extends Error {
+  constructor (message = 'Limited connection') {
+    super(message)
+    this.name = 'LimitedConnectionError'
+  }
+}
+
+export class TooManyInboundProtocolStreamsError extends Error {
+  constructor (message = 'Too many inbound protocol streams') {
+    super(message)
+    this.name = 'TooManyInboundProtocolStreamsError'
+  }
+}
+
+export class TooManyOutboundProtocolStreamsError extends Error {
+  constructor (message = 'Too many outbound protocol streams') {
+    super(message)
+    this.name = 'TooManyOutboundProtocolStreamsError'
+  }
+}
+
+/**
+ * Thrown when and attempt to operate on an unsupported key was made
+ */
+export class UnsupportedKeyTypeError extends Error {
+  constructor (message = 'Unsupported key type') {
+    super(message)
+    this.name = 'UnsupportedKeyTypeError'
+  }
+}

package/src/event-target.ts

@@ -104,5 +104,3 @@ export class TypedEventEmitter<EventMap extends Record<string, any>> extends Eve
     return this.dispatchEvent(new CustomEvent<Detail>(type as string, detail))
   }
 }
-
-export const CustomEvent = globalThis.CustomEvent

package/src/index.ts

@@ -17,8 +17,9 @@
 import type { Connection, NewStreamOptions, Stream } from './connection/index.js'
 import type { ContentRouting } from './content-routing/index.js'
 import type { TypedEventTarget } from './event-target.js'
+import type { Ed25519PublicKey, PublicKey, RSAPublicKey, Secp256k1PublicKey } from './keys/index.js'
 import type { Metrics } from './metrics/index.js'
-import type { PeerId } from './peer-id/index.js'
+import type { Ed25519PeerId, PeerId, RSAPeerId, Secp256k1PeerId, URLPeerId } from './peer-id/index.js'
 import type { PeerInfo } from './peer-info/index.js'
 import type { PeerRouting } from './peer-routing/index.js'
 import type { Address, Peer, PeerStore } from './peer-store/index.js'
@@ -331,7 +332,7 @@ export interface IsDialableOptions extends AbortOptions {
    * because that protocol would not be allowed to run over a data/time limited
    * connection.
    */
-  runOnTransientConnection?: boolean
+  runOnLimitedConnection?: boolean
 }
 
 export type TransportManagerDialProgressEvents =
@@ -347,7 +348,10 @@ export type OpenConnectionProgressEvents =
   OutboundConnectionUpgradeEvents
 
 export interface DialOptions extends AbortOptions, ProgressOptions {
-
+  /**
+   * If true, open a new connection to the remote even if one already exists
+   */
+  force?: boolean
 }
 
 export interface DialProtocolOptions extends NewStreamOptions {
@@ -642,7 +646,11 @@ export interface Libp2p<T extends ServiceMap = ServiceMap> extends Startable, Ty
    * type this may mean searching the routing if the peer's key is not present
    * in the peer store.
    */
-  getPublicKey(peer: PeerId, options?: AbortOptions): Promise<Uint8Array>
+  getPublicKey(peer: Ed25519PeerId, options?: AbortOptions): Promise<Ed25519PublicKey>
+  getPublicKey(peer: Secp256k1PeerId, options?: AbortOptions): Promise<Secp256k1PublicKey>
+  getPublicKey(peer: RSAPeerId, options?: AbortOptions): Promise<RSAPublicKey>
+  getPublicKey(peer: URLPeerId, options?: AbortOptions): Promise<never>
+  getPublicKey(peer: PeerId, options?: AbortOptions): Promise<PublicKey>
 
   /**
    * Given the current node configuration, returns a promise of `true` or

package/src/keys/index.ts

@@ -1,39 +1,94 @@
+import type { CID } from 'multiformats/cid'
+import type { MultihashDigest } from 'multiformats/hashes/interface'
 import type { Uint8ArrayList } from 'uint8arraylist'
 
-export interface PublicKey<Type extends KeyType = 'Ed25519'> {
-  readonly bytes: Uint8Array
+export type KeyType = 'RSA' | 'Ed25519' | 'secp256k1'
+
+interface PublicKeyBase<KeyType extends string, DigestCode extends number = number> {
+  /**
+   * The type of this key
+   */
+  readonly type: KeyType
+
+  /**
+   * The raw public key bytes (for Ed25519 and secp256k1 keys) or PKIX in ASN1
+   * DER format (for RSA keys)
+   */
+  readonly raw: Uint8Array
+
+  /**
+   * Returns `true` if the passed object matches this key
+   */
+  equals(key?: any): boolean
+
+  /**
+   * Returns this public key as a Multihash digest.
+   *
+   * It contains either an identity hash containing the protobuf version of the
+   * public key (for Ed25519 and secp256k1 keys) or a sha256 hash of the
+   * protobuf version of the public key (RSA keys).
+   */
+  toMultihash(): MultihashDigest<DigestCode>
+
+  /**
+   * Return this public key as a CID encoded with the `libp2p-key` codec
+   *
+   * The digest contains either an identity hash containing the protobuf version
+   * of the public key (for Ed25519 and secp256k1 keys) or a sha256 hash of the
+   * protobuf version of the public key (RSA keys).
+   */
+  toCID(): CID<unknown, 0x72, DigestCode, 1>
+
+  /**
+   * Verify the passed data was signed by the private key corresponding to this
+   * public key
+   */
   verify(data: Uint8Array | Uint8ArrayList, sig: Uint8Array): boolean | Promise<boolean>
-  marshal(): Uint8Array
-  equals(key: PublicKey<Type>): boolean
-  hash(): Uint8Array | Promise<Uint8Array>
+
+  /**
+   * Returns this key as a multihash with base58btc encoding
+   */
+  toString(): string
 }
 
+export interface RSAPublicKey extends PublicKeyBase<'RSA', 0x12> {}
+export interface Ed25519PublicKey extends PublicKeyBase<'Ed25519', 0x0> {}
+export interface Secp256k1PublicKey extends PublicKeyBase<'secp256k1', 0x0> {}
+export type PublicKey = RSAPublicKey | Ed25519PublicKey | Secp256k1PublicKey
+
 /**
  * Generic private key interface
  */
-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<Type>): boolean
-  hash(): Uint8Array | Promise<Uint8Array>
+interface PrivateKeyBase<KeyType extends string, PublicKeyType extends PublicKeyBase<KeyType>> {
   /**
-   * Gets the ID of the key.
-   *
-   * The key id is the base58 encoding of the SHA-256 multihash of its public key.
-   * The public key is a protobuf encoding containing a type and the DER encoding
-   * of the PKCS SubjectPublicKeyInfo.
+   * The type of this key
    */
-  id(): Promise<string>
+  readonly type: KeyType
+
   /**
-   * Exports the password protected key in the format specified.
+   * The public key that corresponds to this private key
    */
-  export(password: string, format?: 'pkcs-8' | string): Promise<string>
-}
+  readonly publicKey: PublicKeyType
 
-export const Ed25519 = 'Ed25519'
-export const RSA = 'RSA'
-export const secp256k1 = 'secp256k1'
+  /**
+   * The raw public key bytes (for Ed25519 and secp256k1 keys) or PKIX in ASN1
+   * DER format (for RSA keys)
+   */
+  readonly raw: Uint8Array
+
+  /**
+   * Returns `true` if the passed object matches this key
+   */
+  equals(key?: any): boolean
+
+  /**
+   * Sign the passed data with this private key and return the signature for
+   * later verification
+   */
+  sign(data: Uint8Array | Uint8ArrayList): Uint8Array | Promise<Uint8Array>
+}
 
-export type KeyType = typeof Ed25519 | typeof RSA | typeof secp256k1
+export interface RSAPrivateKey extends PrivateKeyBase<'RSA', RSAPublicKey> {}
+export interface Ed25519PrivateKey extends PrivateKeyBase<'Ed25519', Ed25519PublicKey> {}
+export interface Secp256k1PrivateKey extends PrivateKeyBase<'secp256k1', Secp256k1PublicKey> {}
+export type PrivateKey = RSAPrivateKey | Ed25519PrivateKey | Secp256k1PrivateKey

package/src/metrics/index.ts

@@ -76,23 +76,23 @@ export interface Metric {
  * A group of related metrics loosely based on the interfaces exposed by the
  * prom-client module
  */
-export interface MetricGroup {
+export interface MetricGroup<T extends string = any> {
   /**
    * Update the stored metric group to the passed value
    */
-  update(values: Record<string, number>): void
+  update(values: Partial<Record<T, number>>): void
 
   /**
    * Increment the metric group keys by the passed number or
-   * any non-numeric value to increment by 1
+   * `true` to increment by 1
    */
-  increment(values: Record<string, number | unknown>): void
+  increment(values: Partial<Record<T, number | true>>): void
 
   /**
    * Decrement the metric group keys by the passed number or
-   * any non-numeric value to decrement by 1
+   * `true` to decrement by 1
    */
-  decrement(values: Record<string, number | unknown>): void
+  decrement(values: Partial<Record<T, number | true>>): void
 
   /**
    * Reset the passed key in this metric group to its default value
@@ -128,12 +128,12 @@ export interface Counter {
  * exposed by the prom-client module - counters are metrics that only
  * go up
  */
-export interface CounterGroup {
+export interface CounterGroup<T extends string = any> {
   /**
    * Increment the metric group keys by the passed number or
    * any non-numeric value to increment by 1
    */
-  increment(values: Record<string, number | unknown>): void
+  increment(values: Partial<Record<T, number | true>>): void
 
   /**
    * Reset the passed key in this metric group to its default value