@libp2p/interface-internal 2.1.1 → 2.2.0

package/dist/src/address-manager/index.d.ts

@@ -1,4 +1,49 @@
 import type { Multiaddr } from '@multiformats/multiaddr';
+/**
+ * The type of address:
+ *
+ * - 'transport' a listen address supplied by a transport
+ * - 'announce' a pre-configured announce address
+ * - 'observed' a peer reported this as a public address
+ * - 'dns-mapping' a DNS address dynamically mapped to one or more public addresses
+ * - 'ip-mapping' an external IP address dynamically mapped to a LAN address
+ */
+export type AddressType = 'transport' | 'announce' | 'observed' | 'dns-mapping' | 'ip-mapping';
+/**
+ * An address that has been configured or detected
+ */
+export interface NodeAddress {
+    /**
+     * The multiaddr that represents the address
+     */
+    multiaddr: Multiaddr;
+    /**
+     * Dynamically configured addresses such as observed or IP/DNS mapped ones
+     * must be verified as valid by AutoNAT or some other means before the current
+     * node will add them to it's peer record and share them with peers.
+     *
+     * When this value is true, it's safe to share the address.
+     */
+    verified: boolean;
+    /**
+     * The timestamp at which the address was last verified
+     */
+    lastVerified?: number;
+    /**
+     * A millisecond timestamp after which this address should be reverified
+     */
+    expires: number;
+    /**
+     * The source of this address
+     */
+    type: AddressType;
+}
+export interface ConfirmAddressOptions {
+    /**
+     * Override the TTL of the observed address verification
+     */
+    ttl?: number;
+}
 export interface AddressManager {
     /**
      * Get peer listen multiaddrs
@@ -17,7 +62,7 @@ export interface AddressManager {
      * Signal that we have confidence an observed multiaddr is publicly dialable -
      * this will make it appear in the output of getAddresses()
      */
-    confirmObservedAddr(addr: Multiaddr): void;
+    confirmObservedAddr(addr: Multiaddr, options?: ConfirmAddressOptions): void;
     /**
      * Signal that we do not have confidence an observed multiaddr is publicly dialable -
      * this will remove it from the output of getObservedAddrs()
@@ -33,6 +78,10 @@ export interface AddressManager {
      * Get the current node's addresses
      */
     getAddresses(): Multiaddr[];
+    /**
+     * Return all known addresses with metadata
+     */
+    getAddressesWithMetadata(): NodeAddress[];
     /**
      * Adds a mapping between one or more IP addresses and a domain name - when
      * `getAddresses` is invoked, where the IP addresses are present in a
@@ -44,5 +93,20 @@ export interface AddressManager {
      * Remove a mapping previously added with `addDNSMapping`.
      */
     removeDNSMapping(domain: string): void;
+    /**
+     * Add a publicly routable address/port/protocol tuple that this node is
+     * reachable on. Where this node listens on a link-local (e.g. LAN) address
+     * with the same protocol for any transport, an additional listen address will
+     * be added with the IP and port replaced with this IP and port.
+     *
+     * It's possible to add a IPv6 address here and have it added to the address
+     * list, this is for the case when a router has an external IPv6 address with
+     * port forwarding configured, but it does IPv6 -> IPv4 NAT.
+     */
+    addPublicAddressMapping(internalIp: string, internalPort: number, externalIp: string, externalPort?: number, protocol?: 'tcp' | 'udp'): void;
+    /**
+     * Remove a publicly routable address that this node is no longer reachable on
+     */
+    removePublicAddressMapping(internalIp: string, internalPort: number, externalIp: string, externalPort?: number, protocol?: 'tcp' | 'udp'): void;
 }
 //# sourceMappingURL=index.d.ts.map

package/dist/src/address-manager/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/address-manager/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AAExD,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,cAAc,IAAI,SAAS,EAAE,CAAA;IAE7B;;OAEG;IACH,gBAAgB,IAAI,SAAS,EAAE,CAAA;IAE/B;;;OAGG;IACH,gBAAgB,IAAI,SAAS,EAAE,CAAA;IAE/B;;;OAGG;IACH,mBAAmB,CAAC,IAAI,EAAE,SAAS,GAAG,IAAI,CAAA;IAE1C;;;OAGG;IACH,kBAAkB,CAAC,IAAI,EAAE,SAAS,GAAG,IAAI,CAAA;IAEzC;;;;OAIG;IACH,eAAe,CAAC,IAAI,EAAE,SAAS,GAAG,IAAI,CAAA;IAEtC;;OAEG;IACH,YAAY,IAAI,SAAS,EAAE,CAAA;IAE3B;;;;;OAKG;IACH,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,GAAG,IAAI,CAAA;IAE1D;;OAEG;IACH,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;CACvC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/address-manager/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AAExD;;;;;;;;GAQG;AACH,MAAM,MAAM,WAAW,GAAG,WAAW,GAAG,UAAU,GAAG,UAAU,GAAG,aAAa,GAAG,YAAY,CAAA;AAE9F;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,SAAS,EAAE,SAAS,CAAA;IAEpB;;;;;;OAMG;IACH,QAAQ,EAAE,OAAO,CAAA;IAEjB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,IAAI,EAAE,WAAW,CAAA;CAClB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,cAAc,IAAI,SAAS,EAAE,CAAA;IAE7B;;OAEG;IACH,gBAAgB,IAAI,SAAS,EAAE,CAAA;IAE/B;;;OAGG;IACH,gBAAgB,IAAI,SAAS,EAAE,CAAA;IAE/B;;;OAGG;IACH,mBAAmB,CAAC,IAAI,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAAA;IAE3E;;;OAGG;IACH,kBAAkB,CAAC,IAAI,EAAE,SAAS,GAAG,IAAI,CAAA;IAEzC;;;;OAIG;IACH,eAAe,CAAC,IAAI,EAAE,SAAS,GAAG,IAAI,CAAA;IAEtC;;OAEG;IACH,YAAY,IAAI,SAAS,EAAE,CAAA;IAE3B;;OAEG;IACH,wBAAwB,IAAI,WAAW,EAAE,CAAA;IAEzC;;;;;OAKG;IACH,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,GAAG,IAAI,CAAA;IAE1D;;OAEG;IACH,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IAEtC;;;;;;;;;OASG;IACH,uBAAuB,CAAE,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,KAAK,GAAG,KAAK,GAAG,IAAI,CAAA;IAE7I;;OAEG;IACH,0BAA0B,CAAE,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,KAAK,GAAG,KAAK,GAAG,IAAI,CAAA;CACjJ"}

package/dist/src/connection-manager/index.d.ts

@@ -41,6 +41,11 @@ export interface ConnectionManager {
      * ```
      */
     getConnectionsMap(): PeerMap<Connection[]>;
+    /**
+     * Returns the configured maximum number of connections this connection
+     * manager will accept
+     */
+    getMaxConnections(): number;
     /**
      * Open a connection to a remote peer
      *

package/dist/src/connection-manager/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/connection-manager/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,WAAW,EAAE,UAAU,EAAE,mBAAmB,EAAE,MAAM,EAAE,iBAAiB,EAAE,4BAA4B,EAAE,MAAM,mBAAmB,CAAA;AAC5J,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,0BAA0B,CAAA;AACvD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACxD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAEtD,MAAM,WAAW,qBAAsB,SAAQ,YAAY,EAAE,eAAe,CAAC,4BAA4B,CAAC;IACxG;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,OAAO,CAAA;CAChB;AAED,MAAM,WAAW,iBAAiB;IAChC;;;;;;;;;OASG;IACH,cAAc,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,UAAU,EAAE,CAAA;IAE7C;;;;;;;;OAQG;IACH,iBAAiB,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC,CAAA;IAE1C;;;;;;;;OAQG;IACH,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS,EAAE,EAAE,OAAO,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAE5G;;OAEG;IACH,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAErE;;;;;OAKG;IACH,wBAAwB,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAEvE;;OAEG;IACH,mBAAmB,IAAI,IAAI,CAAA;IAE3B;;;;;;;;OAQG;IACH,YAAY,IAAI,WAAW,EAAE,CAAA;IAE7B;;;;;;;;OAQG;IACH,UAAU,CAAC,SAAS,EAAE,SAAS,GAAG,SAAS,EAAE,EAAE,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;CAC9F"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/connection-manager/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,WAAW,EAAE,UAAU,EAAE,mBAAmB,EAAE,MAAM,EAAE,iBAAiB,EAAE,4BAA4B,EAAE,MAAM,mBAAmB,CAAA;AAC5J,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,0BAA0B,CAAA;AACvD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACxD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAEtD,MAAM,WAAW,qBAAsB,SAAQ,YAAY,EAAE,eAAe,CAAC,4BAA4B,CAAC;IACxG;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,OAAO,CAAA;CAChB;AAED,MAAM,WAAW,iBAAiB;IAChC;;;;;;;;;OASG;IACH,cAAc,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,UAAU,EAAE,CAAA;IAE7C;;;;;;;;OAQG;IACH,iBAAiB,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC,CAAA;IAE1C;;;OAGG;IACH,iBAAiB,IAAI,MAAM,CAAA;IAE3B;;;;;;;;OAQG;IACH,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS,EAAE,EAAE,OAAO,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAE5G;;OAEG;IACH,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAErE;;;;;OAKG;IACH,wBAAwB,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAEvE;;OAEG;IACH,mBAAmB,IAAI,IAAI,CAAA;IAE3B;;;;;;;;OAQG;IACH,YAAY,IAAI,WAAW,EAAE,CAAA;IAE7B;;;;;;;;OAQG;IACH,UAAU,CAAC,SAAS,EAAE,SAAS,GAAG,SAAS,EAAE,EAAE,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;CAC9F"}

package/dist/typedoc-urls.json

@@ -1,8 +1,10 @@
 {
   "AddressManager": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface_internal.AddressManager.html",
+  "ConfirmAddressOptions": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface_internal.ConfirmAddressOptions.html",
   "ConnectionManager": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface_internal.ConnectionManager.html",
   "Envelope": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface_internal.Envelope.html",
   "IncomingStreamData": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface_internal.IncomingStreamData.html",
+  "NodeAddress": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface_internal.NodeAddress.html",
   "OpenConnectionOptions": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface_internal.OpenConnectionOptions.html",
   "RandomWalk": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface_internal.RandomWalk.html",
   "Record": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface_internal.Record.html",
@@ -11,5 +13,6 @@
   "StreamHandlerOptions": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface_internal.StreamHandlerOptions.html",
   "StreamHandlerRecord": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface_internal.StreamHandlerRecord.html",
   "TransportManager": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface_internal.TransportManager.html",
-  "TransportManagerDialOptions": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface_internal.TransportManagerDialOptions.html"
+  "TransportManagerDialOptions": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface_internal.TransportManagerDialOptions.html",
+  "AddressType": "https://libp2p.github.io/js-libp2p/types/_libp2p_interface_internal.AddressType.html"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@libp2p/interface-internal",
-  "version": "2.1.1",
+  "version": "2.2.0",
   "description": "Interfaces implemented by internal libp2p components",
   "license": "Apache-2.0 OR MIT",
   "homepage": "https://github.com/libp2p/js-libp2p/tree/main/packages/interface-internal#readme",
@@ -48,14 +48,14 @@
     "build": "aegir build"
   },
   "dependencies": {
-    "@libp2p/interface": "^2.2.1",
-    "@libp2p/peer-collections": "^6.0.12",
-    "@multiformats/multiaddr": "^12.2.3",
-    "progress-events": "^1.0.0",
+    "@libp2p/interface": "^2.3.0",
+    "@libp2p/peer-collections": "^6.0.13",
+    "@multiformats/multiaddr": "^12.3.3",
+    "progress-events": "^1.0.1",
     "uint8arraylist": "^2.4.8"
   },
   "devDependencies": {
-    "aegir": "^44.0.1"
+    "aegir": "^45.0.5"
   },
   "sideEffects": false
 }

package/src/address-manager/index.ts

@@ -1,5 +1,57 @@
 import type { Multiaddr } from '@multiformats/multiaddr'
 
+/**
+ * The type of address:
+ *
+ * - 'transport' a listen address supplied by a transport
+ * - 'announce' a pre-configured announce address
+ * - 'observed' a peer reported this as a public address
+ * - 'dns-mapping' a DNS address dynamically mapped to one or more public addresses
+ * - 'ip-mapping' an external IP address dynamically mapped to a LAN address
+ */
+export type AddressType = 'transport' | 'announce' | 'observed' | 'dns-mapping' | 'ip-mapping'
+
+/**
+ * An address that has been configured or detected
+ */
+export interface NodeAddress {
+  /**
+   * The multiaddr that represents the address
+   */
+  multiaddr: Multiaddr
+
+  /**
+   * Dynamically configured addresses such as observed or IP/DNS mapped ones
+   * must be verified as valid by AutoNAT or some other means before the current
+   * node will add them to it's peer record and share them with peers.
+   *
+   * When this value is true, it's safe to share the address.
+   */
+  verified: boolean
+
+  /**
+   * The timestamp at which the address was last verified
+   */
+  lastVerified?: number
+
+  /**
+   * A millisecond timestamp after which this address should be reverified
+   */
+  expires: number
+
+  /**
+   * The source of this address
+   */
+  type: AddressType
+}
+
+export interface ConfirmAddressOptions {
+  /**
+   * Override the TTL of the observed address verification
+   */
+  ttl?: number
+}
+
 export interface AddressManager {
   /**
    * Get peer listen multiaddrs
@@ -21,7 +73,7 @@ export interface AddressManager {
    * Signal that we have confidence an observed multiaddr is publicly dialable -
    * this will make it appear in the output of getAddresses()
    */
-  confirmObservedAddr(addr: Multiaddr): void
+  confirmObservedAddr(addr: Multiaddr, options?: ConfirmAddressOptions): void
 
   /**
    * Signal that we do not have confidence an observed multiaddr is publicly dialable -
@@ -41,6 +93,11 @@ export interface AddressManager {
    */
   getAddresses(): Multiaddr[]
 
+  /**
+   * Return all known addresses with metadata
+   */
+  getAddressesWithMetadata(): NodeAddress[]
+
   /**
    * Adds a mapping between one or more IP addresses and a domain name - when
    * `getAddresses` is invoked, where the IP addresses are present in a
@@ -53,4 +110,21 @@ export interface AddressManager {
    * Remove a mapping previously added with `addDNSMapping`.
    */
   removeDNSMapping(domain: string): void
+
+  /**
+   * Add a publicly routable address/port/protocol tuple that this node is
+   * reachable on. Where this node listens on a link-local (e.g. LAN) address
+   * with the same protocol for any transport, an additional listen address will
+   * be added with the IP and port replaced with this IP and port.
+   *
+   * It's possible to add a IPv6 address here and have it added to the address
+   * list, this is for the case when a router has an external IPv6 address with
+   * port forwarding configured, but it does IPv6 -> IPv4 NAT.
+   */
+  addPublicAddressMapping (internalIp: string, internalPort: number, externalIp: string, externalPort?: number, protocol?: 'tcp' | 'udp'): void
+
+  /**
+   * Remove a publicly routable address that this node is no longer reachable on
+   */
+  removePublicAddressMapping (internalIp: string, internalPort: number, externalIp: string, externalPort?: number, protocol?: 'tcp' | 'udp'): void
 }

package/src/connection-manager/index.ts

@@ -46,6 +46,12 @@ export interface ConnectionManager {
    */
   getConnectionsMap(): PeerMap<Connection[]>
 
+  /**
+   * Returns the configured maximum number of connections this connection
+   * manager will accept
+   */
+  getMaxConnections(): number
+
   /**
    * Open a connection to a remote peer
    *

package/LICENSE

@@ -1,4 +0,0 @@
-This project is dual licensed under MIT and Apache-2.0.
-
-MIT: https://www.opensource.org/licenses/mit
-Apache-2.0: https://www.apache.org/licenses/license-2.0