@libp2p/identify 1.0.21-9d13a2f6a → 1.0.21

package/dist/src/index.d.ts

@@ -3,16 +3,7 @@
  *
  * Use the `identify` function to add support for the [Identify protocol](https://github.com/libp2p/specs/blob/master/identify/README.md) to libp2p.
  *
- * This protocol allows network peers to discover the multiaddrs the current node listens on, and the protocols it supports.
- *
- * A second function, `identifyPush` is also exported to add support for [identify/push](https://github.com/libp2p/specs/blob/master/identify/README.md#identifypush).
- *
- * This protocol will send updates to all connected peers when the multiaddrs or protocols of the current node change.
- *
- * > [!TIP]
- * > For maximum network compatibility you should configure both protocols
- *
- * @example Enabling identify
+ * @example
  *
  * ```typescript
  * import { createLibp2p } from 'libp2p'
@@ -25,28 +16,12 @@
  *   }
  * })
  * ```
- *
- * @example Enabling identify push
- *
- * ```typescript
- * import { createLibp2p } from 'libp2p'
- * import { identifyPush } from '@libp2p/identify'
- *
- * const node = await createLibp2p({
- *   // ...other options
- *   services: {
- *     identifyPush: identifyPush()
- *   }
- * })
- * ```
  */
 import type { AbortOptions, IdentifyResult, Libp2pEvents, ComponentLogger, NodeInfo, TypedEventTarget, PeerId, PeerStore, Connection } from '@libp2p/interface';
 import type { AddressManager, ConnectionManager, Registrar } from '@libp2p/interface-internal';
 export interface IdentifyInit {
     /**
-     * The prefix to use for the protocol
-     *
-     * @default 'ipfs'
+     * The prefix to use for the protocol (default: 'ipfs')
      */
     protocolPrefix?: string;
     /**
@@ -55,73 +30,43 @@ export interface IdentifyInit {
     agentVersion?: string;
     /**
      * How long we should wait for a remote peer to send their identify response
-     *
-     * @default 5000
      */
     timeout?: number;
     /**
-     * Identify responses larger than this in bytes will be rejected
-     *
-     * @default 8192
-     */
-    maxMessageSize?: number;
-    /**
-     * The maximum number of inbound streams that may be open on a single
-     * connection for this protocol
-     *
-     * @default 1
+     * Identify responses larger than this in bytes will be rejected (default: 8192)
      */
+    maxIdentifyMessageSize?: number;
     maxInboundStreams?: number;
-    /**
-     * The maximum number of outbound streams that may be open on a single
-     * connection for this protocol
-     *
-     * @default 1
-     */
     maxOutboundStreams?: number;
-    /**
-     * The maximum number of observed addresses to send in an Identify message
-     */
+    maxPushIncomingStreams?: number;
+    maxPushOutgoingStreams?: number;
     maxObservedAddresses?: number;
     /**
-     * Whether to run on connections with data or duration limits
-     *
-     * @default true
-     */
-    runOnTransientConnection?: boolean;
-    /**
-     * Whether to automatically run identify on newly opened connections
-     *
-     * @default true
+     * Whether to automatically dial identify on newly opened connections (default: true)
      */
     runOnConnectionOpen?: boolean;
-}
-export interface IdentifyPushInit extends Omit<IdentifyInit, 'runOnConnectionOpen'> {
     /**
-     * Whether to automatically dial identify-push on self updates
-     *
-     * @default true
+     * Whether to run on connections with data or duration limits (default: true)
      */
-    runOnSelfUpdate?: boolean;
-    /**
-     * Push to this many connections in parallel
-     *
-     * @default 32
-     */
-    concurrency?: number;
+    runOnTransientConnection?: boolean;
 }
 export interface IdentifyComponents {
     peerId: PeerId;
     peerStore: PeerStore;
+    connectionManager: ConnectionManager;
     registrar: Registrar;
     addressManager: AddressManager;
     events: TypedEventTarget<Libp2pEvents>;
     logger: ComponentLogger;
     nodeInfo: NodeInfo;
 }
-export interface IdentifyPushComponents extends IdentifyComponents {
-    connectionManager: ConnectionManager;
-}
+/**
+ * The protocols the Identify service supports
+ */
+export declare const multicodecs: {
+    IDENTIFY: string;
+    IDENTIFY_PUSH: string;
+};
 export interface Identify {
     /**
      * due to the default limits on inbound/outbound streams for this protocol,
@@ -131,10 +76,7 @@ export interface Identify {
      * you may be better off configuring a topology to be notified instead.
      */
     identify(connection: Connection, options?: AbortOptions): Promise<IdentifyResult>;
-}
-export interface IdentifyPush {
     push(): Promise<void>;
 }
 export declare function identify(init?: IdentifyInit): (components: IdentifyComponents) => Identify;
-export declare function identifyPush(init?: IdentifyPushInit): (components: IdentifyPushComponents) => IdentifyPush;
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AAIH,OAAO,KAAK,EAAE,YAAY,EAAE,cAAc,EAAE,YAAY,EAAE,eAAe,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAA;AAC/J,OAAO,KAAK,EAAE,cAAc,EAAE,iBAAiB,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAA;AAE9F,MAAM,WAAW,YAAY;IAC3B;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;IAEvB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;IAEvB;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAE1B;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAE3B;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAA;IAE7B;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAA;IAElC;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAA;CAC9B;AAED,MAAM,WAAW,gBAAiB,SAAQ,IAAI,CAAC,YAAY,EAAE,qBAAqB,CAAC;IACjF;;;;OAIG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;IAEzB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,SAAS,CAAA;IACpB,SAAS,EAAE,SAAS,CAAA;IACpB,cAAc,EAAE,cAAc,CAAA;IAC9B,MAAM,EAAE,gBAAgB,CAAC,YAAY,CAAC,CAAA;IACtC,MAAM,EAAE,eAAe,CAAA;IACvB,QAAQ,EAAE,QAAQ,CAAA;CACnB;AAED,MAAM,WAAW,sBAAuB,SAAQ,kBAAkB;IAChE,iBAAiB,EAAE,iBAAiB,CAAA;CACrC;AAED,MAAM,WAAW,QAAQ;IACvB;;;;;;OAMG;IACH,QAAQ,CAAC,UAAU,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,cAAc,CAAC,CAAA;CAClF;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;CACtB;AAED,wBAAgB,QAAQ,CAAE,IAAI,GAAE,YAAiB,GAAG,CAAC,UAAU,EAAE,kBAAkB,KAAK,QAAQ,CAE/F;AAED,wBAAgB,YAAY,CAAE,IAAI,GAAE,gBAAqB,GAAG,CAAC,UAAU,EAAE,sBAAsB,KAAK,YAAY,CAE/G"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAOH,OAAO,KAAK,EAAE,YAAY,EAAE,cAAc,EAAE,YAAY,EAAE,eAAe,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAA;AAC/J,OAAO,KAAK,EAAE,cAAc,EAAE,iBAAiB,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAA;AAE9F,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;IAEvB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAA;IAE/B,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAE3B,sBAAsB,CAAC,EAAE,MAAM,CAAA;IAC/B,sBAAsB,CAAC,EAAE,MAAM,CAAA;IAC/B,oBAAoB,CAAC,EAAE,MAAM,CAAA;IAE7B;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAE7B;;OAEG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAA;CACnC;AAED,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,SAAS,CAAA;IACpB,iBAAiB,EAAE,iBAAiB,CAAA;IACpC,SAAS,EAAE,SAAS,CAAA;IACpB,cAAc,EAAE,cAAc,CAAA;IAC9B,MAAM,EAAE,gBAAgB,CAAC,YAAY,CAAC,CAAA;IACtC,MAAM,EAAE,eAAe,CAAA;IACvB,QAAQ,EAAE,QAAQ,CAAA;CACnB;AAED;;GAEG;AACH,eAAO,MAAM,WAAW;;;CAGvB,CAAA;AAED,MAAM,WAAW,QAAQ;IACvB;;;;;;OAMG;IACH,QAAQ,CAAC,UAAU,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,cAAc,CAAC,CAAA;IAEjF,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;CACtB;AAED,wBAAgB,QAAQ,CAAE,IAAI,GAAE,YAAiB,GAAG,CAAC,UAAU,EAAE,kBAAkB,KAAK,QAAQ,CAE/F"}

package/dist/src/index.js

@@ -3,16 +3,7 @@
  *
  * Use the `identify` function to add support for the [Identify protocol](https://github.com/libp2p/specs/blob/master/identify/README.md) to libp2p.
  *
- * This protocol allows network peers to discover the multiaddrs the current node listens on, and the protocols it supports.
- *
- * A second function, `identifyPush` is also exported to add support for [identify/push](https://github.com/libp2p/specs/blob/master/identify/README.md#identifypush).
- *
- * This protocol will send updates to all connected peers when the multiaddrs or protocols of the current node change.
- *
- * > [!TIP]
- * > For maximum network compatibility you should configure both protocols
- *
- * @example Enabling identify
+ * @example
  *
  * ```typescript
  * import { createLibp2p } from 'libp2p'
@@ -25,27 +16,17 @@
  *   }
  * })
  * ```
- *
- * @example Enabling identify push
- *
- * ```typescript
- * import { createLibp2p } from 'libp2p'
- * import { identifyPush } from '@libp2p/identify'
- *
- * const node = await createLibp2p({
- *   // ...other options
- *   services: {
- *     identifyPush: identifyPush()
- *   }
- * })
- * ```
  */
-import { IdentifyPush as IdentifyPushClass } from './identify-push.js';
+import { MULTICODEC_IDENTIFY, MULTICODEC_IDENTIFY_PUSH } from './consts.js';
 import { Identify as IdentifyClass } from './identify.js';
+/**
+ * The protocols the Identify service supports
+ */
+export const multicodecs = {
+    IDENTIFY: MULTICODEC_IDENTIFY,
+    IDENTIFY_PUSH: MULTICODEC_IDENTIFY_PUSH
+};
 export function identify(init = {}) {
     return (components) => new IdentifyClass(components, init);
 }
-export function identifyPush(init = {}) {
-    return (components) => new IdentifyPushClass(components, init);
-}
 //# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AAEH,OAAO,EAAE,YAAY,IAAI,iBAAiB,EAAE,MAAM,oBAAoB,CAAA;AACtE,OAAO,EAAE,QAAQ,IAAI,aAAa,EAAE,MAAM,eAAe,CAAA;AAgHzD,MAAM,UAAU,QAAQ,CAAE,OAAqB,EAAE;IAC/C,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,IAAI,aAAa,CAAC,UAAU,EAAE,IAAI,CAAC,CAAA;AAC5D,CAAC;AAED,MAAM,UAAU,YAAY,CAAE,OAAyB,EAAE;IACvD,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,IAAI,iBAAiB,CAAC,UAAU,EAAE,IAAI,CAAC,CAAA;AAChE,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH,OAAO,EACL,mBAAmB,EACnB,wBAAwB,EACzB,MAAM,aAAa,CAAA;AACpB,OAAO,EAAE,QAAQ,IAAI,aAAa,EAAE,MAAM,eAAe,CAAA;AAsDzD;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,QAAQ,EAAE,mBAAmB;IAC7B,aAAa,EAAE,wBAAwB;CACxC,CAAA;AAeD,MAAM,UAAU,QAAQ,CAAE,OAAqB,EAAE;IAC/C,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,IAAI,aAAa,CAAC,UAAU,EAAE,IAAI,CAAC,CAAA;AAC5D,CAAC"}

package/dist/typedoc-urls.json

@@ -0,0 +1,12 @@
+{
+  "Identify": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_identify.Identify.html",
+  ".:Identify": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_identify.Identify.html",
+  "IdentifyComponents": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_identify.IdentifyComponents.html",
+  ".:IdentifyComponents": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_identify.IdentifyComponents.html",
+  "IdentifyInit": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_identify.IdentifyInit.html",
+  ".:IdentifyInit": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_identify.IdentifyInit.html",
+  "multicodecs": "https://libp2p.github.io/js-libp2p/variables/_libp2p_identify.multicodecs.html",
+  ".:multicodecs": "https://libp2p.github.io/js-libp2p/variables/_libp2p_identify.multicodecs.html",
+  "identify": "https://libp2p.github.io/js-libp2p/functions/_libp2p_identify.identify-1.html",
+  ".:identify": "https://libp2p.github.io/js-libp2p/functions/_libp2p_identify.identify-1.html"
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@libp2p/identify",
-  "version": "1.0.21-9d13a2f6a",
+  "version": "1.0.21",
   "description": "Implementation of the Identify Protocol",
   "license": "Apache-2.0 OR MIT",
   "homepage": "https://github.com/libp2p/js-libp2p/tree/main/packages/protocol-identify#readme",
@@ -52,14 +52,12 @@
     "doc-check": "aegir doc-check"
   },
   "dependencies": {
-    "@libp2p/interface": "1.3.1-9d13a2f6a",
-    "@libp2p/interface-internal": "1.2.0-9d13a2f6a",
-    "@libp2p/peer-id": "4.1.1-9d13a2f6a",
-    "@libp2p/peer-record": "7.0.16-9d13a2f6a",
+    "@libp2p/interface": "^1.3.1",
+    "@libp2p/interface-internal": "^1.2.0",
+    "@libp2p/peer-id": "^4.1.1",
+    "@libp2p/peer-record": "^7.0.16",
     "@multiformats/multiaddr": "^12.2.1",
     "@multiformats/multiaddr-matcher": "^1.2.0",
-    "it-drain": "^3.0.7",
-    "it-parallel": "^3.0.7",
     "it-protobuf-stream": "^1.1.2",
     "protons-runtime": "^5.4.0",
     "uint8arraylist": "^2.4.8",
@@ -67,11 +65,12 @@
     "wherearewe": "^2.0.1"
   },
   "devDependencies": {
-    "@libp2p/interface-compliance-tests": "5.4.3-9d13a2f6a",
-    "@libp2p/logger": "4.0.12-9d13a2f6a",
-    "@libp2p/peer-id-factory": "4.1.1-9d13a2f6a",
+    "@libp2p/interface-compliance-tests": "^5.4.3",
+    "@libp2p/logger": "^4.0.12",
+    "@libp2p/peer-id-factory": "^4.1.1",
     "aegir": "^42.2.5",
     "delay": "^6.0.0",
+    "it-drain": "^3.0.5",
     "it-length-prefixed": "^9.0.4",
     "it-pair": "^2.0.6",
     "it-pushable": "^3.2.3",

package/src/consts.ts

@@ -7,9 +7,3 @@ export const MULTICODEC_IDENTIFY_PROTOCOL_NAME = 'id'
 export const MULTICODEC_IDENTIFY_PUSH_PROTOCOL_NAME = 'id/push'
 export const MULTICODEC_IDENTIFY_PROTOCOL_VERSION = '1.0.0'
 export const MULTICODEC_IDENTIFY_PUSH_PROTOCOL_VERSION = '1.0.0'
-
-// https://github.com/libp2p/go-libp2p/blob/8d2e54e1637041d5cf4fac1e531287560bd1f4ac/p2p/protocol/identify/id.go#L52
-export const MAX_IDENTIFY_MESSAGE_SIZE = 1024 * 8
-
-// https://github.com/libp2p/go-libp2p/blob/0385ec924bad172f74a74db09939e97c079b1420/p2p/protocol/identify/id.go#L47C7-L47C25
-export const MAX_PUSH_CONCURRENCY = 32