libp2p - npm Package Compare versions

Comparing version 2.4.2 to 2.5.0-06fc82da8

dist/src/content-routing.d.ts

@@ -1,2 +0,2 @@
-import type { AbortOptions, ComponentLogger, ContentRouting, PeerInfo, PeerRouting, PeerStore, RoutingOptions, Startable } from '@libp2p/interface';
+import type { AbortOptions, ComponentLogger, ContentRouting, Metrics, PeerInfo, PeerRouting, PeerStore, RoutingOptions, Startable } from '@libp2p/interface';
 import type { CID } from 'multiformats/cid';
@@ -10,2 +10,3 @@ export interface CompoundContentRoutingInit {
     logger: ComponentLogger;
+    metrics?: Metrics;
 }
@@ -24,3 +25,3 @@ export declare class CompoundContentRouting implements ContentRouting, Startable {
      */
-    findProviders(key: CID, options?: RoutingOptions): AsyncIterable<PeerInfo>;
+    findProviders(key: CID, options?: RoutingOptions): AsyncGenerator<PeerInfo>;
     /**
@@ -27,0 +28,0 @@ * Iterates over all content routers in parallel to notify it is

dist/src/content-routing.js

 import { NotStartedError } from '@libp2p/interface';
 import { PeerSet } from '@libp2p/peer-collections';
 import merge from 'it-merge';
+import { toString as uint8ArrayToString } from 'uint8arrays/to-string';
 import { NoContentRoutersError } from './errors.js';
@@ -13,2 +14,51 @@ export class CompoundContentRouting {
         this.components = components;
+        this.findProviders = components.metrics?.traceFunction('libp2p.contentRouting.findProviders', this.findProviders.bind(this), {
+            optionsIndex: 1,
+            getAttributesFromArgs: ([cid], attrs) => {
+                return {
+                    ...attrs,
+                    cid: cid.toString()
+                };
+            },
+            getAttributesFromYieldedValue: (value, attrs) => {
+                return {
+                    ...attrs,
+                    providers: [...(Array.isArray(attrs.providers) ? attrs.providers : []), value.id.toString()]
+                };
+            }
+        }) ?? this.findProviders;
+        this.provide = components.metrics?.traceFunction('libp2p.contentRouting.provide', this.provide.bind(this), {
+            optionsIndex: 1,
+            getAttributesFromArgs: ([cid], attrs) => {
+                return {
+                    ...attrs,
+                    cid: cid.toString()
+                };
+            }
+        }) ?? this.provide;
+        this.cancelReprovide = components.metrics?.traceFunction('libp2p.contentRouting.cancelReprovide', this.cancelReprovide.bind(this), {
+            optionsIndex: 1,
+            getAttributesFromArgs: ([cid], attrs) => {
+                return {
+                    ...attrs,
+                    cid: cid.toString()
+                };
+            }
+        }) ?? this.cancelReprovide;
+        this.put = components.metrics?.traceFunction('libp2p.contentRouting.put', this.put.bind(this), {
+            optionsIndex: 2,
+            getAttributesFromArgs: ([key]) => {
+                return {
+                    key: uint8ArrayToString(key, 'base36')
+                };
+            }
+        }) ?? this.put;
+        this.get = components.metrics?.traceFunction('libp2p.contentRouting.get', this.get.bind(this), {
+            optionsIndex: 1,
+            getAttributesFromArgs: ([key]) => {
+                return {
+                    key: uint8ArrayToString(key, 'base36')
+                };
+            }
+        }) ?? this.get;
     }
@@ -15,0 +65,0 @@ [Symbol.toStringTag] = '@libp2p/content-routing';

dist/src/peer-routing.d.ts

@@ -1,2 +0,2 @@
-import type { PeerId, PeerInfo, PeerRouting, PeerStore, RoutingOptions } from '@libp2p/interface';
+import type { Metrics, PeerId, PeerInfo, PeerRouting, PeerStore, RoutingOptions } from '@libp2p/interface';
 import type { ComponentLogger } from '@libp2p/logger';
@@ -10,2 +10,3 @@ export interface PeerRoutingInit {
     logger: ComponentLogger;
+    metrics?: Metrics;
 }
@@ -26,4 +27,4 @@ export declare class DefaultPeerRouting implements PeerRouting {
      */
-    getClosestPeers(key: Uint8Array, options?: RoutingOptions): AsyncIterable<PeerInfo>;
+    getClosestPeers(key: Uint8Array, options?: RoutingOptions): AsyncGenerator<PeerInfo>;
 }
 //# sourceMappingURL=peer-routing.d.ts.map

dist/src/peer-routing.js

@@ -5,2 +5,3 @@ import { NotFoundError } from '@libp2p/interface';
 import parallel from 'it-parallel';
+import { toString as uint8ArrayToString } from 'uint8arrays/to-string';
 import { NoPeerRoutersError, QueriedForSelfError } from './errors.js';
@@ -17,2 +18,26 @@ export class DefaultPeerRouting {
         this.routers = init.routers ?? [];
+        this.findPeer = components.metrics?.traceFunction('libp2p.peerRouting.findPeer', this.findPeer.bind(this), {
+            optionsIndex: 1,
+            getAttributesFromArgs: ([peer], attrs) => {
+                return {
+                    ...attrs,
+                    peer: peer.toString()
+                };
+            }
+        }) ?? this.findPeer;
+        this.getClosestPeers = components.metrics?.traceFunction('libp2p.peerRouting.getClosestPeers', this.getClosestPeers.bind(this), {
+            optionsIndex: 1,
+            getAttributesFromArgs: ([key], attrs) => {
+                return {
+                    ...attrs,
+                    key: uint8ArrayToString(key, 'base36')
+                };
+            },
+            getAttributesFromYieldedValue: (value, attrs) => {
+                return {
+                    ...attrs,
+                    peers: [...(Array.isArray(attrs.peers) ? attrs.peers : []), value.id.toString()]
+                };
+            }
+        }) ?? this.getClosestPeers;
     }
@@ -19,0 +44,0 @@ [Symbol.toStringTag] = '@libp2p/peer-routing';

dist/src/version.d.ts

@@ -1,3 +0,3 @@
-export declare const version = "2.4.2";
+export declare const version = "2.5.0-06fc82da8";
 export declare const name = "js-libp2p";
 //# sourceMappingURL=version.d.ts.map

dist/src/version.js

@@ -1,3 +0,3 @@
-export const version = '2.4.2';
+export const version = '2.5.0-06fc82da8';
 export const name = 'js-libp2p';
 //# sourceMappingURL=version.js.map

package.json

 {
   "name": "libp2p",
-  "version": "2.4.2",
+  "version": "2.5.0-06fc82da8",
   "description": "JavaScript implementation of libp2p, a modular peer to peer network stack",
@@ -90,11 +90,11 @@ "license": "Apache-2.0 OR MIT",
     "@chainsafe/netmask": "^2.0.0",
-    "@libp2p/crypto": "^5.0.8",
-    "@libp2p/interface": "^2.3.0",
-    "@libp2p/interface-internal": "^2.2.1",
-    "@libp2p/logger": "^5.1.5",
-    "@libp2p/multistream-select": "^6.0.10",
-    "@libp2p/peer-collections": "^6.0.13",
-    "@libp2p/peer-id": "^5.0.9",
-    "@libp2p/peer-store": "^11.0.13",
-    "@libp2p/utils": "^6.3.0",
+    "@libp2p/crypto": "5.0.9-06fc82da8",
+    "@libp2p/interface": "2.4.0-06fc82da8",
+    "@libp2p/interface-internal": "2.2.2-06fc82da8",
+    "@libp2p/logger": "5.1.6-06fc82da8",
+    "@libp2p/multistream-select": "6.0.11-06fc82da8",
+    "@libp2p/peer-collections": "6.0.14-06fc82da8",
+    "@libp2p/peer-id": "5.0.10-06fc82da8",
+    "@libp2p/peer-store": "11.0.14-06fc82da8",
+    "@libp2p/utils": "6.3.1-06fc82da8",
     "@multiformats/dns": "^1.0.6",
@@ -101,0 +101,0 @@ "@multiformats/multiaddr": "^12.3.3",

README.md

@@ -11,6 +11,35 @@ <h1 align="center">
 [![Matrix](https://img.shields.io/badge/matrix-%23libp2p--implementers%3Aipfs.io-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23libp2p)
-[![Discord](https://img.shields.io/discord/806902334369824788?color=blueviolet\&label=discord\&style=flat-square)](https://discord.com/invite/Ae4TbahHaT)
+[![Discord](https://img.shields.io/discord/806902334369824788?color=blueviolet&label=discord&style=flat-square)](https://discord.com/invite/Ae4TbahHaT)
 [![codecov](https://img.shields.io/codecov/c/github/libp2p/js-libp2p.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p)
 [![CI](https://img.shields.io/github/actions/workflow/status/libp2p/js-libp2p/main.yml?branch=main\&style=flat-square)](https://github.com/libp2p/js-libp2p/actions/workflows/main.yml?query=branch%3Amain)
 
+# About
+
+<!--
+
+!IMPORTANT!
+
+Everything in this README between "# About" and "# Install" is automatically
+generated and will be overwritten the next time the doc generator is run.
+
+To make changes to this section, please update the @packageDocumentation section
+of src/index.js or src/index.ts
+
+To experiment with formatting, please run "npm run docs" from the root of this
+repo and examine the changes made.
+
+-->
+
+Use the `createLibp2p` function to create a libp2p node.
+
+## Example
+
+```typescript
+import { createLibp2p } from 'libp2p'
+
+const node = await createLibp2p({
+  // ...other options
+})
+```
+
 # Background
@@ -17,0 +46,0 @@

src/content-routing.ts

 import { NotStartedError } from '@libp2p/interface'
 import { PeerSet } from '@libp2p/peer-collections'
 import merge from 'it-merge'
+import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
 import { NoContentRoutersError } from './errors.js'
-import type { AbortOptions, ComponentLogger, ContentRouting, PeerInfo, PeerRouting, PeerStore, RoutingOptions, Startable } from '@libp2p/interface'
+import type { AbortOptions, ComponentLogger, ContentRouting, Metrics, PeerInfo, PeerRouting, PeerStore, RoutingOptions, Startable } from '@libp2p/interface'
 import type { CID } from 'multiformats/cid'
@@ -16,2 +17,3 @@
   logger: ComponentLogger
+  metrics?: Metrics
 }
@@ -28,2 +30,52 @@
     this.components = components
+
+    this.findProviders = components.metrics?.traceFunction('libp2p.contentRouting.findProviders', this.findProviders.bind(this), {
+      optionsIndex: 1,
+      getAttributesFromArgs: ([cid], attrs) => {
+        return {
+          ...attrs,
+          cid: cid.toString()
+        }
+      },
+      getAttributesFromYieldedValue: (value, attrs: { providers?: string[] }) => {
+        return {
+          ...attrs,
+          providers: [...(Array.isArray(attrs.providers) ? attrs.providers : []), value.id.toString()]
+        }
+      }
+    }) ?? this.findProviders
+    this.provide = components.metrics?.traceFunction('libp2p.contentRouting.provide', this.provide.bind(this), {
+      optionsIndex: 1,
+      getAttributesFromArgs: ([cid], attrs) => {
+        return {
+          ...attrs,
+          cid: cid.toString()
+        }
+      }
+    }) ?? this.provide
+    this.cancelReprovide = components.metrics?.traceFunction('libp2p.contentRouting.cancelReprovide', this.cancelReprovide.bind(this), {
+      optionsIndex: 1,
+      getAttributesFromArgs: ([cid], attrs) => {
+        return {
+          ...attrs,
+          cid: cid.toString()
+        }
+      }
+    }) ?? this.cancelReprovide
+    this.put = components.metrics?.traceFunction('libp2p.contentRouting.put', this.put.bind(this), {
+      optionsIndex: 2,
+      getAttributesFromArgs: ([key]) => {
+        return {
+          key: uint8ArrayToString(key, 'base36')
+        }
+      }
+    }) ?? this.put
+    this.get = components.metrics?.traceFunction('libp2p.contentRouting.get', this.get.bind(this), {
+      optionsIndex: 1,
+      getAttributesFromArgs: ([key]) => {
+        return {
+          key: uint8ArrayToString(key, 'base36')
+        }
+      }
+    }) ?? this.get
   }
@@ -48,3 +100,3 @@
    */
-  async * findProviders (key: CID, options: RoutingOptions = {}): AsyncIterable<PeerInfo> {
+  async * findProviders (key: CID, options: RoutingOptions = {}): AsyncGenerator<PeerInfo> {
     if (this.routers.length === 0) {
@@ -51,0 +103,0 @@ throw new NoContentRoutersError('No content routers available')

src/peer-routing.ts

@@ -5,4 +5,5 @@ import { NotFoundError } from '@libp2p/interface'
 import parallel from 'it-parallel'
+import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
 import { NoPeerRoutersError, QueriedForSelfError } from './errors.js'
-import type { Logger, PeerId, PeerInfo, PeerRouting, PeerStore, RoutingOptions } from '@libp2p/interface'
+import type { Logger, Metrics, PeerId, PeerInfo, PeerRouting, PeerStore, RoutingOptions } from '@libp2p/interface'
 import type { ComponentLogger } from '@libp2p/logger'
@@ -18,2 +19,3 @@
   logger: ComponentLogger
+  metrics?: Metrics
 }
@@ -32,2 +34,27 @@
     this.routers = init.routers ?? []
+
+    this.findPeer = components.metrics?.traceFunction('libp2p.peerRouting.findPeer', this.findPeer.bind(this), {
+      optionsIndex: 1,
+      getAttributesFromArgs: ([peer], attrs) => {
+        return {
+          ...attrs,
+          peer: peer.toString()
+        }
+      }
+    }) ?? this.findPeer
+    this.getClosestPeers = components.metrics?.traceFunction('libp2p.peerRouting.getClosestPeers', this.getClosestPeers.bind(this), {
+      optionsIndex: 1,
+      getAttributesFromArgs: ([key], attrs) => {
+        return {
+          ...attrs,
+          key: uint8ArrayToString(key, 'base36')
+        }
+      },
+      getAttributesFromYieldedValue: (value, attrs: { peers?: string[] }) => {
+        return {
+          ...attrs,
+          peers: [...(Array.isArray(attrs.peers) ? attrs.peers : []), value.id.toString()]
+        }
+      }
+    }) ?? this.getClosestPeers
   }
@@ -81,3 +108,3 @@
    */
-  async * getClosestPeers (key: Uint8Array, options: RoutingOptions = {}): AsyncIterable<PeerInfo> {
+  async * getClosestPeers (key: Uint8Array, options: RoutingOptions = {}): AsyncGenerator<PeerInfo> {
     if (this.routers.length === 0) {
@@ -84,0 +111,0 @@ throw new NoPeerRoutersError('No peer routers available')

src/version.ts

@@ -1,2 +0,2 @@
-export const version = '2.4.2'
+export const version = '2.5.0-06fc82da8'
 export const name = 'js-libp2p'

New alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

976986

0.47%

Lines of code

12097

1.02%

Number of lines in readme file

191

17.9%

Worsened metrics

Number of package files

158

-0.63%

Number of low quality alerts

1

Infinity%

Dependency changes

• + Added

  @libp2p/crypto@5.0.9-06fc82da8
  (transitive)

• + Added

  @libp2p/interface@2.4.0-06fc82da8
  (transitive)

• + Added

  @libp2p/interface-internal@2.2.2-06fc82da8
  (transitive)

• + Added

  @libp2p/logger@5.1.6-06fc82da8
  (transitive)

• + Added

  @libp2p/multistream-select@6.0.11-06fc82da8
  (transitive)

• + Added

  @libp2p/peer-collections@6.0.14-06fc82da8
  (transitive)

• + Added

  @libp2p/peer-id@5.0.10-06fc82da8
  (transitive)

• + Added

  @libp2p/peer-record@8.0.14-06fc82da8
  (transitive)

• + Added

  @libp2p/peer-store@11.0.14-06fc82da8
  (transitive)

• + Added

  @libp2p/utils@6.3.1-06fc82da8
  (transitive)

• + Added

  @types/murmurhash3js-revisited@3.0.3
  (transitive)

• + Added

  asn1js@3.0.5
  (transitive)

• + Added

  it-length-prefixed@9.1.1
  (transitive)

• + Added

  murmurhash3js-revisited@3.0.0
  (transitive)

• + Added

  pvtsutils@1.3.6
  (transitive)

• + Added

  pvutils@1.1.3
  (transitive)

• + Added

  tslib@2.8.1
  (transitive)

• - Removed

  @libp2p/crypto@5.0.15
  (transitive)

• - Removed

  @libp2p/interface-internal@2.3.7
  (transitive)

• - Removed

  @libp2p/multistream-select@6.0.19
  (transitive)

• - Removed

  @libp2p/peer-collections@6.0.23
  (transitive)

• - Removed

  @libp2p/peer-id@5.0.16
  (transitive)

• - Removed

  @libp2p/peer-record@8.0.23
  (transitive)

• - Removed

  @libp2p/peer-store@11.1.0
  (transitive)

• - Removed

  @libp2p/utils@6.5.7
  (transitive)

• - Removed

  it-length-prefixed@10.0.1
  (transitive)

• Updated

  @libp2p/crypto@5.0.9-06fc82da8

• Updated

  @libp2p/interface@2.4.0-06fc82da8

• Updated

  @libp2p/interface-internal@2.2.2-06fc82da8

• Updated

  @libp2p/logger@5.1.6-06fc82da8

• Updated

  @libp2p/multistream-select@6.0.11-06fc82da8

• Updated

  @libp2p/peer-collections@6.0.14-06fc82da8

• Updated

  @libp2p/peer-id@5.0.10-06fc82da8

• Updated

  @libp2p/peer-store@11.0.14-06fc82da8

• Updated

  @libp2p/utils@6.3.1-06fc82da8