@ar.io/wayfinder-core 0.0.5-alpha.2 → 0.0.5-alpha.4

package/dist/wayfinder.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"wayfinder.d.ts","sourceRoot":"","sources":["../src/wayfinder.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AACH,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAE7C,OAAO,EAAE,MAAM,EAAiB,MAAM,aAAa,CAAC;AAEpD,OAAO,EACL,gBAAgB,EAChB,eAAe,EACf,oBAAoB,EACpB,cAAc,EACf,MAAM,uBAAuB,CAAC;AAM/B,eAAO,MAAM,SAAS,QAAuB,CAAC;AAC9C,eAAO,MAAM,SAAS,QAAwB,CAAC;AAE/C;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,GAAI,2CAIjC;IACD,WAAW,EAAE,MAAM,CAAC;IACpB,eAAe,EAAE,GAAG,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,KAAG,GAgDH,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,wBAAwB,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IAC3C,qBAAqB,EAAE,KAAK,CAAC;IAC7B,sBAAsB,EAAE;QAAE,WAAW,EAAE,MAAM,CAAA;KAAE,CAAC;IAChD,uBAAuB,EAAE;QACvB,IAAI,EAAE,MAAM,CAAC;QACb,cAAc,EAAE,MAAM,CAAC;QACvB,UAAU,EAAE,MAAM,CAAC;KACpB,CAAC;IACF,iBAAiB,EAAE;QAAE,WAAW,EAAE,MAAM,CAAA;KAAE,CAAC;IAC3C,iBAAiB,EAAE;QAAE,WAAW,EAAE,MAAM,CAAA;KAAE,CAAC;IAC3C,mBAAmB,EAAE;QACnB,WAAW,EAAE,MAAM,CAAC;QACpB,eAAe,EAAE,MAAM,CAAC;QACxB,WAAW,EAAE,MAAM,CAAC;KACrB,CAAC;IACF,gBAAgB,EAAE,KAAK,CAAC;IACxB,2BAA2B,EAAE;QAC3B,WAAW,EAAE,MAAM,CAAC;QACpB,eAAe,EAAE,MAAM,CAAC;QACxB,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;CACH,CAAC;AAEF,MAAM,WAAW,yBAAyB;IACxC,gBAAgB,CAAC,EAAE,CAAC,OAAO,EAAE,cAAc,CAAC,iBAAiB,CAAC,KAAK,IAAI,CAAC;IACxE,gBAAgB,CAAC,EAAE,CAAC,OAAO,EAAE,cAAc,CAAC,iBAAiB,CAAC,KAAK,IAAI,CAAC;IACxE,kBAAkB,CAAC,EAAE,CAAC,OAAO,EAAE,cAAc,CAAC,mBAAmB,CAAC,KAAK,IAAI,CAAC;CAC7E;AAED,MAAM,WAAW,8BAA8B;IAC7C,uBAAuB,CAAC,EAAE,CACxB,OAAO,EAAE,cAAc,CAAC,wBAAwB,CAAC,KAC9C,IAAI,CAAC;IACV,oBAAoB,CAAC,EAAE,CACrB,OAAO,EAAE,cAAc,CAAC,qBAAqB,CAAC,KAC3C,IAAI,CAAC;IACV,sBAAsB,CAAC,EAAE,CACvB,OAAO,EAAE,cAAc,CAAC,uBAAuB,CAAC,KAC7C,IAAI,CAAC;CACX;AAED,MAAM,WAAW,kBAAkB;IACjC,YAAY,CAAC,EAAE,8BAA8B,CAAC;IAC9C,OAAO,CAAC,EAAE,yBAAyB,CAAC;CACrC;AAED,qBAAa,gBAAiB,SAAQ,YAAY,CAAC,cAAc,CAAC;gBACpD,EAAE,YAAY,EAAE,OAAO,EAAE,GAAE,kBAAuB;CAyB/D;AAED,wBAAgB,0BAA0B,CAAC,EACzC,cAAc,EACd,aAAa,EACb,UAAU,EACV,IAAI,EACJ,OAAO,EACP,MAAc,GACf,EAAE;IACD,cAAc,EAAE,cAAc,CAAC;IAC/B,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,oBAAoB,CAAC,YAAY,CAAC,CAAC;IAC/C,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,gBAAgB,CAAC;IAC3B,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB,GAAG,cAAc,CAiFjB;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,cAAc,GAAI,+EAM5B;IACD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,gBAAgB,CAAC;IAC3B,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,oBAAoB,EAAE,WAAW,CAAC,gBAAgB,CAAC,sBAAsB,CAAC,CAAC,CAAC;IAC5E,eAAe,EAAE,WAAW,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,CAAC,CAAC;CACnE,MAEG,OAAO,GAAG,GAAG,WAAW,EACxB,OAAO,WAAW,KACjB,OAAO,CAAC,QAAQ,CAyJpB,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,gBAAgB,EAAE,gBAAgB,CAAC;IAEnC;;OAEG;IACH,oBAAoB,CAAC,EAAE;QACrB;;;WAGG;QACH,OAAO,CAAC,EAAE,OAAO,CAAC;QAElB;;WAEG;QACH,MAAM,CAAC,EAAE,8BAA8B,GAAG,SAAS,CAAC;QAEpD;;WAEG;QACH,QAAQ,EAAE,oBAAoB,CAAC;QAE/B;;;;;WAKG;QACH,MAAM,CAAC,EAAE,OAAO,CAAC;KAClB,CAAC;IAEF;;OAEG;IACH,eAAe,CAAC,EAAE;QAChB;;WAEG;QACH,MAAM,CAAC,EAAE,yBAAyB,CAAC;QAEnC;;WAEG;QACH,QAAQ,EAAE,eAAe,CAAC;KAC3B,CAAC;CACH;AAED;;GAEG;AACH,qBAAa,SAAS;IACpB;;;;;;;;;;OAUG;IACH,SAAgB,gBAAgB,EAAE,gBAAgB,CAAC;IAEnD;;;;OAIG;IACH,SAAgB,eAAe,EAAE,WAAW,CAC1C,gBAAgB,CAAC,iBAAiB,CAAC,CACpC,CAAC;IACF;;OAEG;IACH,SAAgB,oBAAoB,EAAE,gBAAgB,CAAC,sBAAsB,CAAC,CAAC;IAE/E;;;;;;;;;;;;;;OAcG;IACH,SAAgB,UAAU,EAAE,CAAC,MAAM,EAAE;QACnC,WAAW,EAAE,MAAM,CAAC;QACpB,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;IAEnB;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACI,OAAO,EAAE,cAAc,CAAC;IAE/B;;OAEG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC;IAEzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqDG;IACH,SAAgB,OAAO,EAAE,gBAAgB,CAAC;IAE1C;;;OAGG;gBACS,EACV,MAAsB,EACtB,gBAAgB,EAAE,mEAAmE;IACrF,oBAAoB,EACpB,eAAe,GAChB,EAAE,gBAAgB;CA8EpB"}
+{"version":3,"file":"wayfinder.d.ts","sourceRoot":"","sources":["../src/wayfinder.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AACH,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAI7C,OAAO,EAAE,KAAK,MAAM,EAAkB,MAAM,oBAAoB,CAAC;AAGjE,OAAO,KAAK,EACV,gBAAgB,EAChB,MAAM,EACN,eAAe,EACf,oBAAoB,EACpB,cAAc,EACd,kBAAkB,EAClB,cAAc,EACd,gBAAgB,EACjB,MAAM,YAAY,CAAC;AAKpB,eAAO,MAAM,SAAS,QAAuB,CAAC;AAC9C,eAAO,MAAM,SAAS,QAAwB,CAAC;AAE/C;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,GAAI,2CAIjC;IACD,WAAW,EAAE,MAAM,CAAC;IACpB,eAAe,EAAE,GAAG,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,KAAG,GAgDH,CAAC;AAEF,qBAAa,gBAAiB,SAAQ,YAAY,CAAC,cAAc,CAAC;gBACpD,EACV,YAAY,EACZ,OAAO,EACP,aAAa,GACd,GAAE,kBAAuB;CAiD3B;AAED,wBAAgB,0BAA0B,CAAC,EACzC,cAAc,EACd,aAAa,EACb,UAAU,EACV,IAAI,EACJ,OAAO,EACP,MAAc,GACf,EAAE;IACD,cAAc,EAAE,cAAc,CAAC;IAC/B,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,oBAAoB,CAAC,YAAY,CAAC,CAAC;IAC/C,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,gBAAgB,CAAC;IAC3B,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB,GAAG,cAAc,CAiFjB;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,cAAc,GAAI,uFAO5B;IACD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,oBAAoB,EAAE,WAAW,CAAC,gBAAgB,CAAC,sBAAsB,CAAC,CAAC,CAAC;IAC5E,eAAe,EAAE,WAAW,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAClE,OAAO,CAAC,EAAE,gBAAgB,CAAC;IAC3B,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,MAEG,OAAO,GAAG,GAAG,WAAW,EACxB,OAAO,WAAW,GAAG;IACnB,oBAAoB,CAAC,EAAE,WAAW,CAChC,gBAAgB,CAAC,sBAAsB,CAAC,CACzC,CAAC;IACF,eAAe,CAAC,EAAE,WAAW,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,CAAC,CAAC;CACpE,KACA,OAAO,CAAC,QAAQ,CA0NpB,CAAC;AAEF;;GAEG;AACH,qBAAa,SAAS;IACpB;;;;;;;;;;OAUG;IACH,SAAgB,gBAAgB,EAAE,gBAAgB,CAAC;IAEnD;;;;OAIG;IACH,SAAgB,eAAe,EAAE,QAAQ,CACvC,WAAW,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,CAAC,CACjD,CAAC;IACF;;OAEG;IACH,SAAgB,oBAAoB,EAAE,gBAAgB,CAAC,sBAAsB,CAAC,CAAC;IAE/E;;OAEG;IACH,SAAgB,iBAAiB,EAAE,eAAe,CAAC;IAEnD;;OAEG;IACH,SAAS,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAE1B;;;;;;;;;;;;;;OAcG;IACH,SAAgB,UAAU,EAAE,CAAC,MAAM,EAAE;QACnC,WAAW,EAAE,MAAM,CAAC;QACpB,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;IAEnB;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACI,OAAO,EAAE,cAAc,CAAC;IAE/B;;OAEG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC;IAEzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyDG;IACH,SAAgB,OAAO,EAAE,gBAAgB,CAAC;IAE1C;;;OAGG;gBACS,EACV,MAAsB,EACtB,gBAAgB,EAAE,mEAAmE;IACrF,oBAAoB,EACpB,eAAe,EACf,iBAAiB,GAClB,EAAE,gBAAgB;CAyEpB"}

package/dist/wayfinder.js

@@ -16,7 +16,9 @@
  */
 import { EventEmitter } from 'eventemitter3';
 import { defaultLogger } from './logger.js';
+import { context, trace } from '@opentelemetry/api';
 import { FastestPingRoutingStrategy } from './routing/ping.js';
+import { initTelemetry, startRequestSpans } from './telemetry.js';
 import { sandboxFromId } from './utils/base64.js';
 import { HashVerificationStrategy } from './verification/hash-verifier.js';
 // known regexes for wayfinder urls
@@ -68,7 +70,7 @@ export const resolveWayfinderUrl = ({ originalUrl, selectedGateway, logger, }) =
     return new URL(originalUrl);
 };
 export class WayfinderEmitter extends EventEmitter {
-    constructor({ verification, routing } = {}) {
+    constructor({ verification, routing, parentEmitter, } = {}) {
         super();
         if (verification) {
             if (verification.onVerificationSucceeded) {
@@ -92,6 +94,29 @@ export class WayfinderEmitter extends EventEmitter {
                 this.on('routing-succeeded', routing.onRoutingSucceeded);
             }
         }
+        if (parentEmitter) {
+            this.on('routing-started', (event) => {
+                parentEmitter.emit('routing-started', event);
+            });
+            this.on('routing-skipped', (event) => {
+                parentEmitter.emit('routing-skipped', event);
+            });
+            this.on('routing-succeeded', (event) => {
+                parentEmitter.emit('routing-succeeded', event);
+            });
+            this.on('verification-succeeded', (event) => {
+                parentEmitter.emit('verification-succeeded', event);
+            });
+            this.on('verification-failed', (event) => {
+                parentEmitter.emit('verification-failed', event);
+            });
+            this.on('verification-progress', (event) => {
+                parentEmitter.emit('verification-progress', event);
+            });
+            this.on('verification-skipped', (event) => {
+                parentEmitter.emit('verification-skipped', event);
+            });
+        }
     }
 }
 export function tapAndVerifyReadableStream({ originalStream, contentLength, verifyData, txId, emitter, strict = false, }) {
@@ -182,19 +207,35 @@ export function tapAndVerifyReadableStream({ originalStream, contentLength, veri
  * @param resolveUrl - the function to construct the redirect url for ar:// requests
  * @returns a wrapped fetch function that supports ar:// protocol and always returns Response
  */
-export const wayfinderFetch = ({ emitter = new WayfinderEmitter(), logger = defaultLogger, gatewaysProvider, verificationSettings, routingSettings, }) => {
+export const wayfinderFetch = ({ logger = defaultLogger, gatewaysProvider, verificationSettings, routingSettings, emitter, tracer, }) => {
     return async (input, init) => {
+        const { 
+        // allows for overriding the verification and routing settings for a single request
+        verificationSettings: requestVerificationSettings, routingSettings: requestRoutingSettings, ...restInit } = init ?? {};
         const url = input instanceof URL ? input.toString() : input.toString();
+        const requestEmitter = new WayfinderEmitter({
+            verification: requestVerificationSettings?.events,
+            routing: requestRoutingSettings?.events,
+            parentEmitter: emitter,
+        });
+        const { parentSpan } = startRequestSpans({
+            originalUrl: url,
+            verificationSettings: requestVerificationSettings ?? verificationSettings,
+            routingSettings: requestRoutingSettings ?? routingSettings,
+            gatewaysProvider,
+            emitter: requestEmitter,
+            tracer,
+        });
         if (!url.toString().startsWith('ar://')) {
             logger?.debug('URL is not a wayfinder url, skipping routing', {
                 input,
             });
-            emitter?.emit('routing-skipped', {
+            requestEmitter.emit('routing-skipped', {
                 originalUrl: JSON.stringify(input),
             });
             return fetch(input, init);
         }
-        emitter?.emit('routing-started', {
+        requestEmitter.emit('routing-started', {
             originalUrl: input.toString(),
         });
         const maxRetries = 3;
@@ -220,7 +261,7 @@ export const wayfinderFetch = ({ emitter = new WayfinderEmitter(), logger = defa
                     selectedGateway,
                     logger,
                 });
-                emitter?.emit('routing-succeeded', {
+                requestEmitter.emit('routing-succeeded', {
                     originalUrl: url,
                     selectedGateway: selectedGateway.toString(),
                     redirectUrl: redirectUrl.toString(),
@@ -229,70 +270,97 @@ export const wayfinderFetch = ({ emitter = new WayfinderEmitter(), logger = defa
                     originalUrl: url,
                     redirectUrl: redirectUrl.toString(),
                 });
+                const requestSpan = parentSpan
+                    ? tracer?.startSpan('wayfinder.fetch', undefined, trace.setSpan(context.active(), parentSpan))
+                    : undefined;
                 // make the request to the target gateway using the redirect url
                 const response = await fetch(redirectUrl.toString(), {
                     // enforce CORS given we're likely going to a different origin, but always allow the client to override
                     redirect: 'follow',
                     mode: 'cors',
-                    ...init,
+                    ...restInit,
+                });
+                // add response attributes to the span
+                requestSpan?.setAttribute('response.status', response.status);
+                requestSpan?.setAttribute('response.statusText', response.statusText);
+                response.headers.forEach((value, key) => {
+                    requestSpan?.setAttribute(`response.headers.${key}`, value);
                 });
                 logger?.debug(`Successfully routed request to gateway`, {
                     redirectUrl: redirectUrl.toString(),
                     originalUrl: url,
                 });
                 // only verify data if the redirect url is different from the original url
-                if (redirectUrl.toString() !== url) {
-                    if (verificationSettings.enabled &&
-                        verificationSettings.strategy?.verifyData) {
-                        const headers = response.headers;
-                        // transaction id is either in the response headers or the path of the request as the first parameter
-                        const txId = headers.get('x-arns-resolved-id') ??
-                            redirectUrl.pathname.split('/')[1];
-                        const contentLength = +(headers.get('content-length') ?? 0);
-                        if (!txIdRegex.test(txId)) {
-                            // no transaction id found, skip verification
-                            logger?.debug('No transaction id found, skipping verification', {
-                                redirectUrl: redirectUrl.toString(),
-                                originalUrl: url,
-                            });
-                            emitter?.emit('verification-skipped', {
-                                originalUrl: url,
-                            });
-                            return response;
-                        }
-                        emitter?.emit('identified-transaction-id', {
-                            originalUrl: url,
-                            selectedGateway: redirectUrl.toString(),
-                            txId,
-                        });
-                        // Check if the response has a body
-                        if (response.body) {
-                            const newClientStream = tapAndVerifyReadableStream({
-                                originalStream: response.body,
-                                contentLength,
-                                verifyData: verificationSettings.strategy?.verifyData.bind(verificationSettings.strategy),
-                                txId,
-                                emitter,
-                                strict: verificationSettings.strict,
-                            });
-                            return new Response(newClientStream, {
-                                status: response.status,
-                                statusText: response.statusText,
-                                headers: response.headers,
-                            });
-                        }
-                        else {
-                            // No response body to verify, skip verification
-                            logger?.debug('No response body to verify', {
-                                redirectUrl: redirectUrl.toString(),
-                                originalUrl: url,
-                                txId,
-                            });
-                            return response;
-                        }
-                    }
+                if (redirectUrl.toString() === url) {
+                    logger?.debug('Redirect URL is the same as the original URL, skipping verification', {
+                        redirectUrl: redirectUrl.toString(),
+                        originalUrl: url,
+                    });
+                    requestEmitter.emit('verification-skipped', {
+                        originalUrl: url,
+                    });
+                    requestSpan?.end();
+                    return response;
+                }
+                // if verification is disabled, return the response
+                if (!(verificationSettings.enabled &&
+                    verificationSettings.strategy?.verifyData)) {
+                    logger?.debug('Verification is disabled or no verification strategy is provided, skipping verification', {
+                        redirectUrl: redirectUrl.toString(),
+                        originalUrl: url,
+                    });
+                    requestEmitter.emit('verification-skipped', {
+                        originalUrl: url,
+                    });
+                    requestSpan?.end();
+                    return response;
+                }
+                // Verify the response
+                // TODO: add more verification and response attributes to the span
+                const headers = response.headers;
+                // transaction id is either in the response headers or the path of the request as the first parameter
+                const txId = headers.get('x-arns-resolved-id') ??
+                    redirectUrl.pathname.split('/')[1];
+                const contentLength = +(headers.get('content-length') ?? 0);
+                requestSpan?.setAttribute('txId', txId);
+                requestSpan?.setAttribute('contentLength', contentLength);
+                requestSpan?.end();
+                if (!txIdRegex.test(txId)) {
+                    // no transaction id found, skip verification
+                    logger?.debug('No transaction id found, skipping verification', {
+                        redirectUrl: redirectUrl.toString(),
+                        originalUrl: url,
+                    });
+                    requestEmitter.emit('verification-skipped', {
+                        originalUrl: url,
+                    });
+                    return response;
+                }
+                // Check if the response has a body
+                if (response.body) {
+                    const newClientStream = tapAndVerifyReadableStream({
+                        originalStream: response.body,
+                        contentLength,
+                        verifyData: verificationSettings.strategy?.verifyData.bind(verificationSettings.strategy),
+                        txId,
+                        emitter: requestEmitter,
+                        strict: verificationSettings.strict,
+                    });
+                    return new Response(newClientStream, {
+                        status: response.status,
+                        statusText: response.statusText,
+                        headers: response.headers,
+                    });
+                }
+                else {
+                    // No response body to verify, skip verification
+                    logger?.debug('No response body to verify', {
+                        redirectUrl: redirectUrl.toString(),
+                        originalUrl: url,
+                        txId,
+                    });
+                    return response;
                 }
-                return response;
             }
             catch (error) {
                 logger?.debug('Failed to route request', {
@@ -341,6 +409,14 @@ export class Wayfinder {
      * The verification settings to use when verifying data.
      */
     verificationSettings;
+    /**
+     * Telemetry configuration used for OpenTelemetry tracing
+     */
+    telemetrySettings;
+    /**
+     * OpenTelemetry tracer instance
+     */
+    tracer;
     /**
      * A helper function that resolves the redirect url for ar:// requests to a target gateway.
      *
@@ -392,7 +468,13 @@ export class Wayfinder {
      */
     logger;
     /**
-     * The event emitter for wayfinder that emits routing and verification events.
+     * The event emitter for wayfinder that emits routing and verification events for all requests.
+     *
+     * This is useful for tracking all requests and their statuses, and is updated for each request.
+     *
+     * If you prefer request-specific events, you can pass in the events to the `request` function.
+     *
+     * @example
      *
      * const wayfinder = new Wayfinder()
      *
@@ -419,10 +501,8 @@ export class Wayfinder {
      *         console.log('Verification passed!', event);
      *       },
      *       onVerificationFailed: (event) => {
-     *       console.log('Verification failed!', event);
-     *     },
-     *     onVerificationProgress: (event) => {
-     *       console.log('Verification progress!', event);
+     *         console.log('Verification failed!', event);
+     *       },
      *     },
      *   }
      *   routingSettings: {
@@ -451,13 +531,9 @@ export class Wayfinder {
      * @param options - Wayfinder configuration options
      */
     constructor({ logger = defaultLogger, gatewaysProvider, // forcing it to be required to avoid making ar-io-sdk a dependency
-    verificationSettings, routingSettings, }) {
+    verificationSettings, routingSettings, telemetrySettings, }) {
         this.logger = logger;
         this.gatewaysProvider = gatewaysProvider;
-        this.emitter = new WayfinderEmitter({
-            verification: verificationSettings?.events,
-            routing: routingSettings?.events,
-        });
         // default verification settings
         this.verificationSettings = {
             enabled: verificationSettings?.enabled ??
@@ -465,46 +541,39 @@ export class Wayfinder {
             strategy: new HashVerificationStrategy({
                 trustedGateways: [new URL('https://permagate.io')],
             }),
-            events: {
-                onVerificationFailed: (event) => {
-                    this.logger.error('Verification failed', event);
-                },
-                onVerificationSucceeded: (event) => {
-                    this.logger.info('Verification succeeded', event);
-                },
-                onVerificationProgress: (event) => {
-                    this.logger.info('Verification progress', event);
-                },
-            },
             // overwrite the default settings with the provided ones
             ...verificationSettings,
         };
         // default routing settings
         this.routingSettings = {
+            events: {},
             strategy: new FastestPingRoutingStrategy({
                 timeoutMs: 1000,
+                maxConcurrency: 5, // 5 concurrent HEAD requests on the requested path
                 logger: defaultLogger,
             }),
-            events: {
-                onRoutingStarted: (event) => {
-                    this.logger.debug('Routing started', event);
-                },
-                onRoutingSkipped: (event) => {
-                    this.logger.debug('Routing skipped', event);
-                },
-                onRoutingSucceeded: (event) => {
-                    this.logger.debug('Routing succeeded', event);
-                },
-            },
             // overwrite the default settings with the provided ones
             ...routingSettings,
         };
+        this.emitter = new WayfinderEmitter({
+            verification: this.verificationSettings?.events,
+            routing: this.routingSettings?.events,
+        });
+        this.telemetrySettings = {
+            enabled: telemetrySettings?.enabled ?? false,
+            sampleRate: telemetrySettings?.sampleRate ?? 0.1, // 10% sample rate by default
+            apiKey: telemetrySettings?.apiKey ?? 'c8gU8dHlu6V7e5k2Gn9LaG', // intentionally left here - if it gets abused we'll disable it
+            exporterUrl: telemetrySettings?.exporterUrl ?? 'https://api.honeycomb.io/v1/traces', // TODO: replace with proxy url and remove api key
+            serviceName: telemetrySettings?.serviceName ?? 'wayfinder-core',
+        };
+        this.tracer = initTelemetry(this.telemetrySettings);
         this.request = wayfinderFetch({
             logger: this.logger,
             emitter: this.emitter,
             gatewaysProvider: this.gatewaysProvider,
             routingSettings: this.routingSettings,
             verificationSettings: this.verificationSettings,
+            tracer: this.tracer,
         });
         this.resolveUrl = async ({ originalUrl, logger = this.logger }) => {
             const selectedGateway = await this.routingSettings.strategy.selectGateway({
@@ -516,6 +585,10 @@ export class Wayfinder {
                 logger,
             });
         };
-        this.logger.debug(`Wayfinder initialized with ${this.routingSettings.strategy?.constructor.name} routing strategy`);
+        this.logger.debug('Wayfinder initialized', {
+            verificationSettings: this.verificationSettings,
+            routingSettings: this.routingSettings,
+            telemetrySettings: this.telemetrySettings,
+        });
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ar.io/wayfinder-core",
-  "version": "0.0.5-alpha.2",
+  "version": "0.0.5-alpha.4",
   "description": "WayFinder core library for intelligently routing to optimal AR.IO gateways",
   "main": "dist/index.js",
   "module": "dist/index.js",
@@ -49,6 +49,11 @@
   },
   "dependencies": {
     "@dha-team/arbundles": "^1.0.3",
+    "@opentelemetry/api": "^1.9.0",
+    "@opentelemetry/exporter-trace-otlp-http": "^0.202.0",
+    "@opentelemetry/sdk-trace-base": "^2.0.1",
+    "@opentelemetry/sdk-trace-node": "^2.0.1",
+    "@opentelemetry/sdk-trace-web": "^2.0.1",
     "arweave": "^1.14.0",
     "eventemitter3": "^5.0.1",
     "plimit-lit": "^3.0.1",