@libp2p/utils 7.0.15 → 7.0.17

package/dist/src/rate-limiter.js

@@ -1,4 +1,4 @@
-import { RateLimitError } from './errors.js';
+import { RateLimitError } from "./errors.js";
 export class RateLimiter {
     memoryStorage;
     points;

package/dist/src/stream-utils.js

@@ -5,7 +5,7 @@ import { pEvent } from 'p-event';
 import { raceSignal } from 'race-signal';
 import * as varint from 'uint8-varint';
 import { Uint8ArrayList } from 'uint8arraylist';
-import { UnexpectedEOFError } from './errors.js';
+import { UnexpectedEOFError } from "./errors.js";
 const DEFAULT_MAX_BUFFER_SIZE = 4_194_304;
 export class UnwrappedError extends Error {
     static name = 'UnwrappedError';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@libp2p/utils",
-  "version": "7.0.15",
+  "version": "7.0.17",
   "description": "Package to aggregate shared logic and dependencies for the libp2p ecosystem",
   "license": "Apache-2.0 OR MIT",
   "homepage": "https://github.com/libp2p/js-libp2p/tree/main/packages/utils#readme",
@@ -26,7 +26,8 @@
   "exports": {
     ".": {
       "types": "./dist/src/index.d.ts",
-      "import": "./dist/src/index.js"
+      "import": "./dist/src/index.js",
+      "module-sync": "./dist/src/index.js"
     }
   },
   "scripts": {
@@ -46,13 +47,13 @@
   "dependencies": {
     "@chainsafe/is-ip": "^2.1.0",
     "@chainsafe/netmask": "^2.0.0",
-    "@libp2p/crypto": "^5.1.15",
-    "@libp2p/interface": "^3.2.0",
-    "@libp2p/logger": "^6.2.4",
+    "@libp2p/crypto": "^5.1.17",
+    "@libp2p/interface": "^3.2.2",
+    "@libp2p/logger": "^6.2.6",
     "@multiformats/multiaddr": "^13.0.1",
     "@sindresorhus/fnv1a": "^3.1.0",
     "any-signal": "^4.1.1",
-    "cborg": "^4.2.14",
+    "cborg": "^5.1.0",
     "delay": "^7.0.0",
     "is-loopback-addr": "^2.0.2",
     "it-length-prefixed": "^10.0.1",
@@ -63,13 +64,14 @@
     "netmask": "^2.0.2",
     "p-defer": "^4.0.1",
     "p-event": "^7.0.0",
+    "progress-events": "^1.1.0",
     "race-signal": "^2.0.0",
     "uint8-varint": "^2.0.4",
     "uint8arraylist": "^2.4.8",
     "uint8arrays": "^5.1.0"
   },
   "devDependencies": {
-    "@libp2p/peer-id": "^6.0.6",
+    "@libp2p/peer-id": "^6.0.8",
     "@types/netmask": "^2.0.5",
     "aegir": "^47.0.22",
     "benchmark": "^2.1.4",

package/src/abstract-stream.ts

@@ -1,6 +1,6 @@
 import { pEvent } from 'p-event'
-import { AbstractMessageStream } from './abstract-message-stream.js'
-import type { MessageStreamInit } from './abstract-message-stream.js'
+import { AbstractMessageStream } from './abstract-message-stream.ts'
+import type { MessageStreamInit } from './abstract-message-stream.ts'
 import type { AbortOptions, Stream } from '@libp2p/interface'
 
 export interface AbstractStreamInit extends MessageStreamInit {

package/src/adaptive-timeout.ts

@@ -1,6 +1,6 @@
 import { anySignal } from 'any-signal'
 import { setMaxListeners } from 'main-event'
-import { MovingAverage } from './moving-average.js'
+import { MovingAverage } from './moving-average.ts'
 import type { MetricGroup, Metrics } from '@libp2p/interface'
 import type { ClearableSignal } from 'any-signal'
 

package/src/errors.ts

@@ -1,4 +1,4 @@
-import type { RateLimiterResult } from './rate-limiter.js'
+import type { RateLimiterResult } from './rate-limiter.ts'
 
 /**
  * A rate limit was hit

package/src/filters/bloom-filter.ts

@@ -3,8 +3,8 @@ import { randomBytes } from '@libp2p/crypto'
 import { Uint8ArrayList } from 'uint8arraylist'
 import { alloc } from 'uint8arrays/alloc'
 import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
-import { fnv1a } from './hashes.js'
-import type { Filter } from './index.js'
+import { fnv1a } from './hashes.ts'
+import type { Filter } from './index.ts'
 
 const LN2_SQUARED = Math.LN2 * Math.LN2
 

package/src/filters/bucket.ts

@@ -1,5 +1,5 @@
-import { Fingerprint } from './fingerprint.js'
-import { getRandomInt } from './utils.js'
+import { Fingerprint } from './fingerprint.ts'
+import { getRandomInt } from './utils.ts'
 
 export class Bucket {
   private readonly contents: Array<Fingerprint | null>

package/src/filters/cuckoo-filter.ts

@@ -1,10 +1,10 @@
 import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
-import { Bucket } from './bucket.js'
-import { Fingerprint, MAX_FINGERPRINT_SIZE } from './fingerprint.js'
-import { fnv1a } from './hashes.js'
-import { getRandomInt } from './utils.js'
-import type { Hash } from './hashes.js'
-import type { Filter } from './index.js'
+import { Bucket } from './bucket.ts'
+import { Fingerprint, MAX_FINGERPRINT_SIZE } from './fingerprint.ts'
+import { fnv1a } from './hashes.ts'
+import { getRandomInt } from './utils.ts'
+import type { Hash } from './hashes.ts'
+import type { Filter } from './index.ts'
 
 const maxCuckooCount = 500
 

package/src/filters/fingerprint.ts

@@ -1,6 +1,6 @@
 import { alloc as uint8ArrayAlloc } from 'uint8arrays/alloc'
 import { equals as uint8ArrayEquals } from 'uint8arrays/equals'
-import type { Hash } from './hashes.js'
+import type { Hash } from './hashes.ts'
 
 export const MAX_FINGERPRINT_SIZE = 64
 

package/src/filters/index.ts

@@ -1,9 +1,9 @@
-export { BloomFilter, createBloomFilter, type BloomFilterOptions } from './bloom-filter.js'
-export { CuckooFilter, createCuckooFilter, type CuckooFilterInit } from './cuckoo-filter.js'
-export { ScalableCuckooFilter, createScalableCuckooFilter, type ScalableCuckooFilterInit } from './scalable-cuckoo-filter.js'
-export type { Bucket } from './bucket.js'
-export type { Fingerprint } from './fingerprint.js'
-export type { Hash } from './hashes.js'
+export { BloomFilter, createBloomFilter, type BloomFilterOptions } from './bloom-filter.ts'
+export { CuckooFilter, createCuckooFilter, type CuckooFilterInit } from './cuckoo-filter.ts'
+export { ScalableCuckooFilter, createScalableCuckooFilter, type ScalableCuckooFilterInit } from './scalable-cuckoo-filter.ts'
+export type { Bucket } from './bucket.ts'
+export type { Fingerprint } from './fingerprint.ts'
+export type { Hash } from './hashes.ts'
 
 export interface Filter {
   add(item: Uint8Array | string): void

package/src/filters/scalable-cuckoo-filter.ts

@@ -1,10 +1,10 @@
 import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
-import { CuckooFilter, optimize } from './cuckoo-filter.js'
-import { fnv1a } from './hashes.js'
-import { getRandomInt } from './utils.js'
-import type { CuckooFilterInit } from './cuckoo-filter.js'
-import type { Hash } from './hashes.js'
-import type { Filter } from './index.js'
+import { CuckooFilter, optimize } from './cuckoo-filter.ts'
+import { fnv1a } from './hashes.ts'
+import { getRandomInt } from './utils.ts'
+import type { CuckooFilterInit } from './cuckoo-filter.ts'
+import type { Hash } from './hashes.ts'
+import type { Filter } from './index.ts'
 
 export interface ScalableCuckooFilterInit extends CuckooFilterInit {
   /**

package/src/get-thin-waist-addresses.ts

@@ -1,5 +1,5 @@
 import os from 'node:os'
-import { isLinkLocalIp } from './link-local-ip.js'
+import { isLinkLocalIp } from './link-local-ip.ts'
 import { getNetConfig } from './multiaddr/get-net-config.ts'
 import { netConfigToMultiaddr } from './multiaddr/utils.ts'
 import type { Multiaddr } from '@multiformats/multiaddr'

package/src/index.ts

@@ -4,34 +4,34 @@
  * This module contains utility functions used by libp2p modules.
  */
 
-export * from './filters/index.js'
-export * from './multiaddr/index.js'
-export * from './queue/index.js'
-export * from './abstract-message-stream.js'
-export * from './abstract-multiaddr-connection.js'
-export * from './abstract-stream-muxer.js'
-export * from './abstract-stream.js'
-export * from './adaptive-timeout.js'
-export * from './debounce.js'
-export * from './errors.js'
-export * from './get-thin-waist-addresses.js'
-export * from './global-unicast-ip.js'
-export * from './ip-port-to-multiaddr.js'
-export * from './is-async-generator.js'
-export * from './is-generator.js'
-export * from './is-promise.js'
-export * from './length-prefixed-decoder.js'
-export * from './link-local-ip.js'
-export * from './mock-muxer.js'
-export * from './mock-stream.js'
-export * from './moving-average.js'
-export * from './multiaddr-connection-pair.js'
-export * from './peer-queue.js'
-export * from './priority-queue.js'
-export * from './private-ip.js'
-export * from './rate-limiter.js'
-export * from './repeating-task.js'
-export * from './stream-pair.js'
-export * from './stream-utils.js'
-export * from './tracked-list.js'
-export * from './tracked-map.js'
+export * from './filters/index.ts'
+export * from './multiaddr/index.ts'
+export * from './queue/index.ts'
+export * from './abstract-message-stream.ts'
+export * from './abstract-multiaddr-connection.ts'
+export * from './abstract-stream-muxer.ts'
+export * from './abstract-stream.ts'
+export * from './adaptive-timeout.ts'
+export * from './debounce.ts'
+export * from './errors.ts'
+export * from './get-thin-waist-addresses.ts'
+export * from './global-unicast-ip.ts'
+export * from './ip-port-to-multiaddr.ts'
+export * from './is-async-generator.ts'
+export * from './is-generator.ts'
+export * from './is-promise.ts'
+export * from './length-prefixed-decoder.ts'
+export * from './link-local-ip.ts'
+export * from './mock-muxer.ts'
+export * from './mock-stream.ts'
+export * from './moving-average.ts'
+export * from './multiaddr-connection-pair.ts'
+export * from './peer-queue.ts'
+export * from './priority-queue.ts'
+export * from './private-ip.ts'
+export * from './rate-limiter.ts'
+export * from './repeating-task.ts'
+export * from './stream-pair.ts'
+export * from './stream-utils.ts'
+export * from './tracked-list.ts'
+export * from './tracked-map.ts'

package/src/message-queue.ts

@@ -3,7 +3,7 @@ import delay from 'delay'
 import { TypedEventEmitter } from 'main-event'
 import { raceSignal } from 'race-signal'
 import { isUint8ArrayList, Uint8ArrayList } from 'uint8arraylist'
-import { Queue } from './queue/index.js'
+import { Queue } from './queue/index.ts'
 import type { AbortOptions, Logger } from '@libp2p/interface'
 
 const DEFAULT_CHUNK_SIZE = 1024 * 64

package/src/mock-muxer.ts

@@ -4,7 +4,7 @@ import { pushable } from 'it-pushable'
 import { Uint8ArrayList } from 'uint8arraylist'
 import { AbstractStreamMuxer } from './abstract-stream-muxer.ts'
 import { AbstractStream } from './abstract-stream.ts'
-import { Queue } from './queue/index.js'
+import { Queue } from './queue/index.ts'
 import type { SendResult } from './abstract-message-stream.ts'
 import type { AbstractStreamInit } from './abstract-stream.ts'
 import type { AbortOptions, MessageStreamDirection, CreateStreamOptions, StreamMuxerFactory, StreamMuxer, MultiaddrConnection, StreamMuxerOptions } from '@libp2p/interface'

package/src/multiaddr/index.ts

@@ -1,6 +1,6 @@
 export * from './get-net-config.ts'
-export * from './is-global-unicast.js'
-export * from './is-link-local.js'
-export * from './is-loopback.js'
-export * from './is-network-address.js'
-export * from './is-private.js'
+export * from './is-global-unicast.ts'
+export * from './is-link-local.ts'
+export * from './is-loopback.ts'
+export * from './is-network-address.ts'
+export * from './is-private.ts'

package/src/peer-queue.ts

@@ -1,5 +1,5 @@
-import { Queue } from './queue/index.js'
-import type { Job } from './queue/job.js'
+import { Queue } from './queue/index.ts'
+import type { Job } from './queue/job.ts'
 import type { AbortOptions, PeerId } from '@libp2p/interface'
 
 export interface PeerQueueJobOptions extends AbortOptions {

package/src/priority-queue.ts

@@ -1,5 +1,5 @@
-import { Queue } from './queue/index.js'
-import type { QueueInit } from './queue/index.js'
+import { Queue } from './queue/index.ts'
+import type { QueueInit } from './queue/index.ts'
 import type { AbortOptions } from '@libp2p/interface'
 
 export interface PriorityQueueJobOptions extends AbortOptions {

package/src/queue/index.ts

@@ -4,11 +4,12 @@ import { TypedEventEmitter } from 'main-event'
 import { pEvent } from 'p-event'
 import { debounce } from '../debounce.js'
 import { QueueFullError } from '../errors.js'
-import { Job } from './job.js'
+import { Job } from './job.ts'
 import type { AbortOptions, Metrics } from '@libp2p/interface'
+import type { ProgressOptions } from 'progress-events'
 
-export type { Job, JobTimeline } from './job.js'
-export type { JobRecipient } from './recipient.js'
+export type { Job, JobTimeline } from './job.ts'
+export type { JobRecipient } from './recipient.ts'
 
 export interface Comparator<T> {
   (a: T, b: T): -1 | 0 | 1
@@ -118,7 +119,7 @@ export interface QueueEvents<JobReturnType, JobOptions extends AbortOptions = Ab
  * 1. Items remain at the head of the queue while they are running so `queue.size` includes `queue.pending` items - this is so interested parties can join the results of a queue item while it is running
  * 2. The options for a job are stored separately to the job in order for them to be modified while they are still in the queue
  */
-export class Queue<JobReturnType = unknown, JobOptions extends AbortOptions = AbortOptions> extends TypedEventEmitter<QueueEvents<JobReturnType, JobOptions>> {
+export class Queue<JobReturnType = unknown, JobOptions extends AbortOptions & ProgressOptions = AbortOptions> extends TypedEventEmitter<QueueEvents<JobReturnType, JobOptions>> {
   public concurrency: number
   public maxSize: number
   public queue: Array<Job<JobOptions, JobReturnType>>
@@ -257,9 +258,8 @@ export class Queue<JobReturnType = unknown, JobOptions extends AbortOptions = Ab
     const job = new Job<JobOptions, JobReturnType>(fn, options)
     this.enqueue(job)
     this.safeDispatchEvent('add')
-    this.tryToStartAnother()
 
-    return job.join(options)
+    const result = job.join(options)
       .then(result => {
         this.safeDispatchEvent('completed', { detail: result })
         this.safeDispatchEvent('success', { detail: { job, result } })
@@ -281,6 +281,10 @@ export class Queue<JobReturnType = unknown, JobOptions extends AbortOptions = Ab
 
         throw err
       })
+
+    this.tryToStartAnother()
+
+    return result
   }
 
   /**

package/src/queue/job.ts

@@ -1,9 +1,10 @@
 import { AbortError } from '@libp2p/interface'
 import { setMaxListeners } from 'main-event'
 import { raceSignal } from 'race-signal'
-import { JobRecipient } from './recipient.js'
-import type { JobStatus } from './index.js'
+import { JobRecipient } from './recipient.ts'
+import type { JobStatus } from './index.ts'
 import type { AbortOptions } from '@libp2p/interface'
+import type { ProgressOptions } from 'progress-events'
 
 /**
  * Returns a random string
@@ -18,7 +19,7 @@ export interface JobTimeline {
   finished?: number
 }
 
-export class Job <JobOptions extends AbortOptions = AbortOptions, JobReturnType = unknown> {
+export class Job <JobOptions extends AbortOptions & ProgressOptions = AbortOptions, JobReturnType = unknown> {
   public id: string
   public fn: (options: JobOptions) => Promise<JobReturnType>
   public options: JobOptions
@@ -59,11 +60,11 @@ export class Job <JobOptions extends AbortOptions = AbortOptions, JobReturnType
     }
   }
 
-  async join (options: AbortOptions = {}): Promise<JobReturnType> {
-    const recipient = new JobRecipient<JobReturnType>(options.signal)
+  async join (options?: Partial<Pick<JobOptions, 'signal' | 'onProgress'>>): Promise<JobReturnType> {
+    const recipient = new JobRecipient<JobReturnType>(options)
     this.recipients.push(recipient)
 
-    options.signal?.addEventListener('abort', this.onAbort)
+    options?.signal?.addEventListener('abort', this.onAbort)
 
     return recipient.deferred.promise
   }
@@ -77,7 +78,12 @@ export class Job <JobOptions extends AbortOptions = AbortOptions, JobReturnType
 
       const result = await raceSignal(this.fn({
         ...(this.options ?? {}),
-        signal: this.controller.signal
+        signal: this.controller.signal,
+        onProgress: (evt: any): void => {
+          this.recipients.forEach(recipient => {
+            recipient.onProgress?.(evt)
+          })
+        }
       }), this.controller.signal)
 
       this.recipients.forEach(recipient => {

package/src/queue/recipient.ts

@@ -1,13 +1,17 @@
 import { AbortError } from '@libp2p/interface'
 import pDefer from 'p-defer'
+import type { AbortOptions } from '@libp2p/interface'
 import type { DeferredPromise } from 'p-defer'
+import type { ProgressOptions, ProgressEventListener } from 'progress-events'
 
-export class JobRecipient<JobReturnType> {
+export class JobRecipient<JobReturnType, JobOptions extends AbortOptions & ProgressOptions = any> {
   public deferred: DeferredPromise<JobReturnType>
   public signal?: AbortSignal
+  public onProgress?: ProgressEventListener
 
-  constructor (signal?: AbortSignal) {
-    this.signal = signal
+  constructor (options?: Partial<Pick<JobOptions, 'signal' | 'onProgress'>>) {
+    this.signal = options?.signal
+    this.onProgress = options?.onProgress
     this.deferred = pDefer()
 
     this.onAbort = this.onAbort.bind(this)

package/src/rate-limiter.ts

@@ -1,4 +1,4 @@
-import { RateLimitError } from './errors.js'
+import { RateLimitError } from './errors.ts'
 
 export interface RateLimiterInit {
   /**

package/src/stream-utils.ts

@@ -5,7 +5,7 @@ import { pEvent } from 'p-event'
 import { raceSignal } from 'race-signal'
 import * as varint from 'uint8-varint'
 import { Uint8ArrayList } from 'uint8arraylist'
-import { UnexpectedEOFError } from './errors.js'
+import { UnexpectedEOFError } from './errors.ts'
 import type { MessageStream, MultiaddrConnection, Stream, AbortOptions } from '@libp2p/interface'
 import type { Duplex, Source, Transform, Sink } from 'it-stream-types'