libp2p 0.36.2 → 0.37.0-5934b13

package/dist/src/circuit/circuit/hop.d.ts

@@ -1,67 +1,40 @@
-export type ICircuitRelay = import('../protocol').ICircuitRelay;
-export type Connection = import("libp2p-interfaces/src/connection/connection");
-export type MuxedStream = import('libp2p-interfaces/src/stream-muxer/types').MuxedStream;
-export type Transport = import('../transport');
-export type HopRequest = {
+import { StreamHandler } from './stream-handler.js';
+import { CircuitRelay as CircuitPB } from '../pb/index.js';
+import type { Connection } from '@libp2p/interfaces/connection';
+import type { Duplex } from 'it-stream-types';
+import type { Circuit } from '../transport.js';
+import type { ConnectionManager } from '@libp2p/interfaces/connection-manager';
+export interface HopRequest {
     connection: Connection;
-    request: ICircuitRelay;
+    request: CircuitPB;
     streamHandler: StreamHandler;
-    circuit: Transport;
-};
-/**
- * @typedef {import('../protocol').ICircuitRelay} ICircuitRelay
- * @typedef {import('libp2p-interfaces/src/connection').Connection} Connection
- * @typedef {import('libp2p-interfaces/src/stream-muxer/types').MuxedStream} MuxedStream
- * @typedef {import('../transport')} Transport
- */
-/**
- * @typedef {Object} HopRequest
- * @property {Connection} connection
- * @property {ICircuitRelay} request
- * @property {StreamHandler} streamHandler
- * @property {Transport} circuit
- */
-/**
- * @param {HopRequest} options
- * @returns {Promise<void>}
- */
-export function handleHop({ connection, request, streamHandler, circuit }: HopRequest): Promise<void>;
+    circuit: Circuit;
+    connectionManager: ConnectionManager;
+}
+export declare function handleHop(hopRequest: HopRequest): Promise<void>;
+export interface HopConfig {
+    connection: Connection;
+    request: CircuitPB;
+}
 /**
  * Performs a HOP request to a relay peer, to request a connection to another
  * peer. A new, virtual, connection will be created between the two via the relay.
- *
- * @param {object} options
- * @param {Connection} options.connection - Connection to the relay
- * @param {ICircuitRelay} options.request
- * @returns {Promise<MuxedStream>}
  */
-export function hop({ connection, request }: {
+export declare function hop(options: HopConfig): Promise<Duplex<Uint8Array>>;
+export interface CanHopOptions {
     connection: Connection;
-    request: ICircuitRelay;
-}): Promise<MuxedStream>;
+}
 /**
- * Performs a CAN_HOP request to a relay peer, in order to understand its capabilities.
- *
- * @param {object} options
- * @param {Connection} options.connection - Connection to the relay
- * @returns {Promise<boolean>}
+ * Performs a CAN_HOP request to a relay peer, in order to understand its capabilities
  */
-export function canHop({ connection }: {
+export declare function canHop(options: CanHopOptions): Promise<boolean>;
+export interface HandleCanHopOptions {
     connection: Connection;
-}): Promise<boolean>;
+    streamHandler: StreamHandler;
+    circuit: Circuit;
+}
 /**
  * Creates an unencoded CAN_HOP response based on the Circuits configuration
- *
- * @param {Object} options
- * @param {Connection} options.connection
- * @param {StreamHandler} options.streamHandler
- * @param {Transport} options.circuit
- * @private
  */
-export function handleCanHop({ connection, streamHandler, circuit }: {
-    connection: Connection;
-    streamHandler: StreamHandler;
-    circuit: Transport;
-}): void;
-import StreamHandler = require("./stream-handler");
+export declare function handleCanHop(options: HandleCanHopOptions): void;
 //# sourceMappingURL=hop.d.ts.map

package/dist/src/circuit/circuit/hop.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"hop.d.ts","sourceRoot":"","sources":["../../../../src/circuit/circuit/hop.js"],"names":[],"mappings":"4BAoBa,OAAO,aAAa,EAAE,aAAa;;0BAEnC,OAAO,0CAA0C,EAAE,WAAW;wBAC9D,OAAO,cAAc,CAAC;;gBAKrB,UAAU;aACV,aAAa;mBACb,aAAa;aACb,SAAS;;AAZvB;;;;;GAKG;AAEH;;;;;;GAMG;AAEH;;;GAGG;AACH,2EAHW,UAAU,GACR,QAAQ,IAAI,CAAC,CA4EzB;AAED;;;;;;;;GAQG;AACH;IAJ+B,UAAU,EAA9B,UAAU;IACa,OAAO,EAA9B,aAAa;IACX,QAAQ,WAAW,CAAC,CA0BhC;AAED;;;;;;GAMG;AACH;IAH+B,UAAU,EAA9B,UAAU;IACR,QAAQ,OAAO,CAAC,CAqB5B;AAED;;;;;;;;GAQG;AACH;IAL+B,UAAU,EAA9B,UAAU;IACa,aAAa,EAApC,aAAa;IACM,OAAO,EAA1B,SAAS;SAcnB"}
+{"version":3,"file":"hop.d.ts","sourceRoot":"","sources":["../../../../src/circuit/circuit/hop.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AACnD,OAAO,EAAE,YAAY,IAAI,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAK1D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAA;AAE/D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AAC7C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AAC9C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,uCAAuC,CAAA;AAI9E,MAAM,WAAW,UAAU;IACzB,UAAU,EAAE,UAAU,CAAA;IACtB,OAAO,EAAE,SAAS,CAAA;IAClB,aAAa,EAAE,aAAa,CAAA;IAC5B,OAAO,EAAE,OAAO,CAAA;IAChB,iBAAiB,EAAE,iBAAiB,CAAA;CACrC;AAED,wBAAsB,SAAS,CAAE,UAAU,EAAE,UAAU,iBA6FtD;AAED,MAAM,WAAW,SAAS;IACxB,UAAU,EAAE,UAAU,CAAA;IACtB,OAAO,EAAE,SAAS,CAAA;CACnB;AAED;;;GAGG;AACH,wBAAsB,GAAG,CAAE,OAAO,EAAE,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CA2B1E;AAED,MAAM,WAAW,aAAa;IAC5B,UAAU,EAAE,UAAU,CAAA;CACvB;AAED;;GAEG;AACH,wBAAsB,MAAM,CAAE,OAAO,EAAE,aAAa,oBAsBnD;AAED,MAAM,WAAW,mBAAmB;IAClC,UAAU,EAAE,UAAU,CAAA;IACtB,aAAa,EAAE,aAAa,CAAA;IAC5B,OAAO,EAAE,OAAO,CAAA;CACjB;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAE,OAAO,EAAE,mBAAmB,QAYzD"}

package/dist/src/circuit/circuit/hop.js

@@ -0,0 +1,138 @@
+import { logger } from '@libp2p/logger';
+import errCode from 'err-code';
+import { validateAddrs } from './utils.js';
+import { StreamHandler } from './stream-handler.js';
+import { CircuitRelay as CircuitPB } from '../pb/index.js';
+import { pipe } from 'it-pipe';
+import { codes as Errors } from '../../errors.js';
+import { stop } from './stop.js';
+import { RELAY_CODEC } from '../multicodec.js';
+import { peerIdFromBytes } from '@libp2p/peer-id';
+const log = logger('libp2p:circuit:hop');
+export async function handleHop(hopRequest) {
+    const { connection, request, streamHandler, circuit, connectionManager } = hopRequest;
+    // Ensure hop is enabled
+    if (!circuit.hopEnabled()) {
+        log('HOP request received but we are not acting as a relay');
+        return streamHandler.end({
+            type: CircuitPB.Type.STATUS,
+            code: CircuitPB.Status.HOP_CANT_SPEAK_RELAY
+        });
+    }
+    // Validate the HOP request has the required input
+    try {
+        validateAddrs(request, streamHandler);
+    }
+    catch (err) {
+        log.error('invalid hop request via peer %p %o', connection.remotePeer, err);
+        return;
+    }
+    if (request.dstPeer == null) {
+        log('HOP request received but we do not receive a dstPeer');
+        return;
+    }
+    // Get the connection to the destination (stop) peer
+    const destinationPeer = peerIdFromBytes(request.dstPeer.id);
+    const destinationConnections = connectionManager.getConnections(destinationPeer);
+    if (destinationConnections.length === 0 && !circuit.hopActive()) {
+        log('HOP request received but we are not connected to the destination peer');
+        return streamHandler.end({
+            type: CircuitPB.Type.STATUS,
+            code: CircuitPB.Status.HOP_NO_CONN_TO_DST
+        });
+    }
+    // TODO: Handle being an active relay
+    if (destinationConnections.length === 0) {
+        log('did not have connection to remote peer');
+        return streamHandler.end({
+            type: CircuitPB.Type.STATUS,
+            code: CircuitPB.Status.HOP_NO_CONN_TO_DST
+        });
+    }
+    // Handle the incoming HOP request by performing a STOP request
+    const stopRequest = {
+        type: CircuitPB.Type.STOP,
+        dstPeer: request.dstPeer,
+        srcPeer: request.srcPeer
+    };
+    let destinationStream;
+    try {
+        log('performing STOP request');
+        const result = await stop({
+            connection: destinationConnections[0],
+            request: stopRequest
+        });
+        if (result == null) {
+            throw new Error('Could not stop');
+        }
+        destinationStream = result;
+    }
+    catch (err) {
+        log.error(err);
+        return;
+    }
+    log('hop request from %p is valid', connection.remotePeer);
+    streamHandler.write({
+        type: CircuitPB.Type.STATUS,
+        code: CircuitPB.Status.SUCCESS
+    });
+    const sourceStream = streamHandler.rest();
+    log('creating related connections');
+    // Short circuit the two streams to create the relayed connection
+    return await pipe(sourceStream, destinationStream, sourceStream);
+}
+/**
+ * Performs a HOP request to a relay peer, to request a connection to another
+ * peer. A new, virtual, connection will be created between the two via the relay.
+ */
+export async function hop(options) {
+    const { connection, request } = options;
+    // Create a new stream to the relay
+    const { stream } = await connection.newStream(RELAY_CODEC);
+    // Send the HOP request
+    const streamHandler = new StreamHandler({ stream });
+    streamHandler.write(request);
+    const response = await streamHandler.read();
+    if (response == null) {
+        throw errCode(new Error('HOP request had no response'), Errors.ERR_HOP_REQUEST_FAILED);
+    }
+    if (response.code === CircuitPB.Status.SUCCESS) {
+        log('hop request was successful');
+        return streamHandler.rest();
+    }
+    log('hop request failed with code %d, closing stream', response.code);
+    streamHandler.close();
+    throw errCode(new Error(`HOP request failed with code "${response.code ?? 'unknown'}"`), Errors.ERR_HOP_REQUEST_FAILED);
+}
+/**
+ * Performs a CAN_HOP request to a relay peer, in order to understand its capabilities
+ */
+export async function canHop(options) {
+    const { connection } = options;
+    // Create a new stream to the relay
+    const { stream } = await connection.newStream(RELAY_CODEC);
+    // Send the HOP request
+    const streamHandler = new StreamHandler({ stream });
+    streamHandler.write({
+        type: CircuitPB.Type.CAN_HOP
+    });
+    const response = await streamHandler.read();
+    await streamHandler.close();
+    if (response == null || response.code !== CircuitPB.Status.SUCCESS) {
+        return false;
+    }
+    return true;
+}
+/**
+ * Creates an unencoded CAN_HOP response based on the Circuits configuration
+ */
+export function handleCanHop(options) {
+    const { connection, streamHandler, circuit } = options;
+    const canHop = circuit.hopEnabled();
+    log('can hop (%s) request from %p', canHop, connection.remotePeer);
+    streamHandler.end({
+        type: CircuitPB.Type.STATUS,
+        code: canHop ? CircuitPB.Status.SUCCESS : CircuitPB.Status.HOP_CANT_SPEAK_RELAY
+    });
+}
+//# sourceMappingURL=hop.js.map

package/dist/src/circuit/circuit/hop.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hop.js","sourceRoot":"","sources":["../../../../src/circuit/circuit/hop.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AACvC,OAAO,OAAO,MAAM,UAAU,CAAA;AAC9B,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAA;AAC1C,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AACnD,OAAO,EAAE,YAAY,IAAI,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC1D,OAAO,EAAE,IAAI,EAAE,MAAM,SAAS,CAAA;AAC9B,OAAO,EAAE,KAAK,IAAI,MAAM,EAAE,MAAM,iBAAiB,CAAA;AACjD,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AAChC,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAE9C,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAKjD,MAAM,GAAG,GAAG,MAAM,CAAC,oBAAoB,CAAC,CAAA;AAUxC,MAAM,CAAC,KAAK,UAAU,SAAS,CAAE,UAAsB;IACrD,MAAM,EACJ,UAAU,EACV,OAAO,EACP,aAAa,EACb,OAAO,EACP,iBAAiB,EAClB,GAAG,UAAU,CAAA;IAEd,wBAAwB;IACxB,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE;QACzB,GAAG,CAAC,uDAAuD,CAAC,CAAA;QAC5D,OAAO,aAAa,CAAC,GAAG,CAAC;YACvB,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC,MAAM;YAC3B,IAAI,EAAE,SAAS,CAAC,MAAM,CAAC,oBAAoB;SAC5C,CAAC,CAAA;KACH;IAED,kDAAkD;IAClD,IAAI;QACF,aAAa,CAAC,OAAO,EAAE,aAAa,CAAC,CAAA;KACtC;IAAC,OAAO,GAAQ,EAAE;QACjB,GAAG,CAAC,KAAK,CAAC,oCAAoC,EAAE,UAAU,CAAC,UAAU,EAAE,GAAG,CAAC,CAAA;QAE3E,OAAM;KACP;IAED,IAAI,OAAO,CAAC,OAAO,IAAI,IAAI,EAAE;QAC3B,GAAG,CAAC,sDAAsD,CAAC,CAAA;QAC3D,OAAM;KACP;IAED,oDAAoD;IACpD,MAAM,eAAe,GAAG,eAAe,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;IAE3D,MAAM,sBAAsB,GAAG,iBAAiB,CAAC,cAAc,CAAC,eAAe,CAAC,CAAA;IAChF,IAAI,sBAAsB,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE;QAC/D,GAAG,CAAC,uEAAuE,CAAC,CAAA;QAC5E,OAAO,aAAa,CAAC,GAAG,CAAC;YACvB,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC,MAAM;YAC3B,IAAI,EAAE,SAAS,CAAC,MAAM,CAAC,kBAAkB;SAC1C,CAAC,CAAA;KACH;IAED,qCAAqC;IACrC,IAAI,sBAAsB,CAAC,MAAM,KAAK,CAAC,EAAE;QACvC,GAAG,CAAC,wCAAwC,CAAC,CAAA;QAC7C,OAAO,aAAa,CAAC,GAAG,CAAC;YACvB,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC,MAAM;YAC3B,IAAI,EAAE,SAAS,CAAC,MAAM,CAAC,kBAAkB;SAC1C,CAAC,CAAA;KACH;IAED,+DAA+D;IAC/D,MAAM,WAAW,GAAG;QAClB,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC,IAAI;QACzB,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,OAAO,EAAE,OAAO,CAAC,OAAO;KACzB,CAAA;IAED,IAAI,iBAAqC,CAAA;IACzC,IAAI;QACF,GAAG,CAAC,yBAAyB,CAAC,CAAA;QAC9B,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC;YACxB,UAAU,EAAE,sBAAsB,CAAC,CAAC,CAAC;YACrC,OAAO,EAAE,WAAW;SACrB,CAAC,CAAA;QAEF,IAAI,MAAM,IAAI,IAAI,EAAE;YAClB,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAA;SAClC;QAED,iBAAiB,GAAG,MAAM,CAAA;KAC3B;IAAC,OAAO,GAAQ,EAAE;QACjB,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QAEd,OAAM;KACP;IAED,GAAG,CAAC,8BAA8B,EAAE,UAAU,CAAC,UAAU,CAAC,CAAA;IAC1D,aAAa,CAAC,KAAK,CAAC;QAClB,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC,MAAM;QAC3B,IAAI,EAAE,SAAS,CAAC,MAAM,CAAC,OAAO;KAC/B,CAAC,CAAA;IACF,MAAM,YAAY,GAAG,aAAa,CAAC,IAAI,EAAE,CAAA;IAEzC,GAAG,CAAC,8BAA8B,CAAC,CAAA;IACnC,iEAAiE;IACjE,OAAO,MAAM,IAAI,CACf,YAAY,EACZ,iBAAiB,EACjB,YAAY,CACb,CAAA;AACH,CAAC;AAOD;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,GAAG,CAAE,OAAkB;IAC3C,MAAM,EACJ,UAAU,EACV,OAAO,EACR,GAAG,OAAO,CAAA;IAEX,mCAAmC;IACnC,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,UAAU,CAAC,SAAS,CAAC,WAAW,CAAC,CAAA;IAC1D,uBAAuB;IACvB,MAAM,aAAa,GAAG,IAAI,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC,CAAA;IACnD,aAAa,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;IAE5B,MAAM,QAAQ,GAAG,MAAM,aAAa,CAAC,IAAI,EAAE,CAAA;IAE3C,IAAI,QAAQ,IAAI,IAAI,EAAE;QACpB,MAAM,OAAO,CAAC,IAAI,KAAK,CAAC,6BAA6B,CAAC,EAAE,MAAM,CAAC,sBAAsB,CAAC,CAAA;KACvF;IAED,IAAI,QAAQ,CAAC,IAAI,KAAK,SAAS,CAAC,MAAM,CAAC,OAAO,EAAE;QAC9C,GAAG,CAAC,4BAA4B,CAAC,CAAA;QACjC,OAAO,aAAa,CAAC,IAAI,EAAE,CAAA;KAC5B;IAED,GAAG,CAAC,iDAAiD,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAA;IACrE,aAAa,CAAC,KAAK,EAAE,CAAA;IAErB,MAAM,OAAO,CAAC,IAAI,KAAK,CAAC,iCAAiC,QAAQ,CAAC,IAAI,IAAI,SAAS,GAAG,CAAC,EAAE,MAAM,CAAC,sBAAsB,CAAC,CAAA;AACzH,CAAC;AAMD;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,MAAM,CAAE,OAAsB;IAClD,MAAM,EACJ,UAAU,EACX,GAAG,OAAO,CAAA;IAEX,mCAAmC;IACnC,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,UAAU,CAAC,SAAS,CAAC,WAAW,CAAC,CAAA;IAE1D,uBAAuB;IACvB,MAAM,aAAa,GAAG,IAAI,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC,CAAA;IACnD,aAAa,CAAC,KAAK,CAAC;QAClB,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC,OAAO;KAC7B,CAAC,CAAA;IAEF,MAAM,QAAQ,GAAG,MAAM,aAAa,CAAC,IAAI,EAAE,CAAA;IAC3C,MAAM,aAAa,CAAC,KAAK,EAAE,CAAA;IAE3B,IAAI,QAAQ,IAAI,IAAI,IAAI,QAAQ,CAAC,IAAI,KAAK,SAAS,CAAC,MAAM,CAAC,OAAO,EAAE;QAClE,OAAO,KAAK,CAAA;KACb;IAED,OAAO,IAAI,CAAA;AACb,CAAC;AAQD;;GAEG;AACH,MAAM,UAAU,YAAY,CAAE,OAA4B;IACxD,MAAM,EACJ,UAAU,EACV,aAAa,EACb,OAAO,EACR,GAAG,OAAO,CAAA;IACX,MAAM,MAAM,GAAG,OAAO,CAAC,UAAU,EAAE,CAAA;IACnC,GAAG,CAAC,8BAA8B,EAAE,MAAM,EAAE,UAAU,CAAC,UAAU,CAAC,CAAA;IAClE,aAAa,CAAC,GAAG,CAAC;QAChB,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC,MAAM;QAC3B,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,oBAAoB;KAChF,CAAC,CAAA;AACJ,CAAC"}

package/dist/src/circuit/circuit/stop.d.ts

@@ -1,14 +1,22 @@
-export function handleStop({ connection, request, streamHandler }: {
+import { CircuitRelay as CircuitPB } from '../pb/index.js';
+import { StreamHandler } from './stream-handler.js';
+import type { Connection } from '@libp2p/interfaces/connection';
+import type { Duplex } from 'it-stream-types';
+export interface HandleStopOptions {
     connection: Connection;
-    request: ICircuitRelay;
+    request: CircuitPB;
     streamHandler: StreamHandler;
-}): Promise<MuxedStream> | void;
-export function stop({ connection, request }: {
+}
+/**
+ * Handles incoming STOP requests
+ */
+export declare function handleStop(options: HandleStopOptions): Duplex<Uint8Array> | undefined;
+export interface StopOptions {
     connection: Connection;
-    request: ICircuitRelay;
-}): Promise<MuxedStream | void>;
-export type Connection = import("libp2p-interfaces/src/connection/connection");
-export type MuxedStream = import('libp2p-interfaces/src/stream-muxer/types').MuxedStream;
-export type ICircuitRelay = import('../protocol').ICircuitRelay;
-import StreamHandler = require("./stream-handler");
+    request: CircuitPB;
+}
+/**
+ * Creates a STOP request
+ */
+export declare function stop(options: StopOptions): Promise<Duplex<Uint8Array, Uint8Array, Promise<void>> | undefined>;
 //# sourceMappingURL=stop.d.ts.map

package/dist/src/circuit/circuit/stop.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"stop.d.ts","sourceRoot":"","sources":["../../../../src/circuit/circuit/stop.js"],"names":[],"mappings":"AA4B4B;IALG,UAAU,EAA9B,UAAU;IACa,OAAO,EAA9B,aAAa;IACU,aAAa,EAApC,aAAa;IACX,QAAQ,WAAW,CAAC,GAAC,IAAI,CAqBrC;AAWqB;IAJS,UAAU,EAA9B,UAAU;IACa,OAAO,EAA9B,aAAa;IACX,QAAQ,WAAW,GAAC,IAAI,CAAC,CAwBrC;;0BAlEY,OAAO,0CAA0C,EAAE,WAAW;4BAC9D,OAAO,aAAa,EAAE,aAAa"}
+{"version":3,"file":"stop.d.ts","sourceRoot":"","sources":["../../../../src/circuit/circuit/stop.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,IAAI,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAE1D,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAEnD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAA;AAC/D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AAI7C,MAAM,WAAW,iBAAiB;IAChC,UAAU,EAAE,UAAU,CAAA;IACtB,OAAO,EAAE,SAAS,CAAA;IAClB,aAAa,EAAE,aAAa,CAAA;CAC7B;AAED;;GAEG;AACH,wBAAgB,UAAU,CAAE,OAAO,EAAE,iBAAiB,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,SAAS,CAuBtF;AAED,MAAM,WAAW,WAAW;IAC1B,UAAU,EAAE,UAAU,CAAA;IACtB,OAAO,EAAE,SAAS,CAAA;CACnB;AAED;;GAEG;AACH,wBAAsB,IAAI,CAAE,OAAO,EAAE,WAAW,sEAyB/C"}

package/dist/src/circuit/circuit/stop.js

@@ -0,0 +1,49 @@
+import { logger } from '@libp2p/logger';
+import { CircuitRelay as CircuitPB } from '../pb/index.js';
+import { RELAY_CODEC } from '../multicodec.js';
+import { StreamHandler } from './stream-handler.js';
+import { validateAddrs } from './utils.js';
+const log = logger('libp2p:circuit:stop');
+/**
+ * Handles incoming STOP requests
+ */
+export function handleStop(options) {
+    const { connection, request, streamHandler } = options;
+    // Validate the STOP request has the required input
+    try {
+        validateAddrs(request, streamHandler);
+    }
+    catch (err) {
+        log.error('invalid stop request via peer %p %o', connection.remotePeer, err);
+        return;
+    }
+    // The request is valid
+    log('stop request is valid');
+    streamHandler.write({
+        type: CircuitPB.Type.STATUS,
+        code: CircuitPB.Status.SUCCESS
+    });
+    return streamHandler.rest();
+}
+/**
+ * Creates a STOP request
+ */
+export async function stop(options) {
+    const { connection, request } = options;
+    const { stream } = await connection.newStream([RELAY_CODEC]);
+    log('starting stop request to %p', connection.remotePeer);
+    const streamHandler = new StreamHandler({ stream });
+    streamHandler.write(request);
+    const response = await streamHandler.read();
+    if (response == null) {
+        streamHandler.close();
+        return;
+    }
+    if (response.code === CircuitPB.Status.SUCCESS) {
+        log('stop request to %p was successful', connection.remotePeer);
+        return streamHandler.rest();
+    }
+    log('stop request failed with code %d', response.code);
+    streamHandler.close();
+}
+//# sourceMappingURL=stop.js.map

package/dist/src/circuit/circuit/stop.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stop.js","sourceRoot":"","sources":["../../../../src/circuit/circuit/stop.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AACvC,OAAO,EAAE,YAAY,IAAI,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC1D,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAC9C,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AACnD,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAA;AAI1C,MAAM,GAAG,GAAG,MAAM,CAAC,qBAAqB,CAAC,CAAA;AAQzC;;GAEG;AACH,MAAM,UAAU,UAAU,CAAE,OAA0B;IACpD,MAAM,EACJ,UAAU,EACV,OAAO,EACP,aAAa,EACd,GAAG,OAAO,CAAA;IAEX,mDAAmD;IACnD,IAAI;QACF,aAAa,CAAC,OAAO,EAAE,aAAa,CAAC,CAAA;KACtC;IAAC,OAAO,GAAQ,EAAE;QACjB,GAAG,CAAC,KAAK,CAAC,qCAAqC,EAAE,UAAU,CAAC,UAAU,EAAE,GAAG,CAAC,CAAA;QAC5E,OAAM;KACP;IAED,uBAAuB;IACvB,GAAG,CAAC,uBAAuB,CAAC,CAAA;IAC5B,aAAa,CAAC,KAAK,CAAC;QAClB,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC,MAAM;QAC3B,IAAI,EAAE,SAAS,CAAC,MAAM,CAAC,OAAO;KAC/B,CAAC,CAAA;IAEF,OAAO,aAAa,CAAC,IAAI,EAAE,CAAA;AAC7B,CAAC;AAOD;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,IAAI,CAAE,OAAoB;IAC9C,MAAM,EACJ,UAAU,EACV,OAAO,EACR,GAAG,OAAO,CAAA;IAEX,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,UAAU,CAAC,SAAS,CAAC,CAAC,WAAW,CAAC,CAAC,CAAA;IAC5D,GAAG,CAAC,6BAA6B,EAAE,UAAU,CAAC,UAAU,CAAC,CAAA;IACzD,MAAM,aAAa,GAAG,IAAI,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC,CAAA;IAEnD,aAAa,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;IAC5B,MAAM,QAAQ,GAAG,MAAM,aAAa,CAAC,IAAI,EAAE,CAAA;IAE3C,IAAI,QAAQ,IAAI,IAAI,EAAE;QACpB,aAAa,CAAC,KAAK,EAAE,CAAA;QACrB,OAAM;KACP;IAED,IAAI,QAAQ,CAAC,IAAI,KAAK,SAAS,CAAC,MAAM,CAAC,OAAO,EAAE;QAC9C,GAAG,CAAC,mCAAmC,EAAE,UAAU,CAAC,UAAU,CAAC,CAAA;QAC/D,OAAO,aAAa,CAAC,IAAI,EAAE,CAAA;KAC5B;IAED,GAAG,CAAC,kCAAkC,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAA;IACtD,aAAa,CAAC,KAAK,EAAE,CAAA;AACvB,CAAC"}

package/dist/src/circuit/circuit/stream-handler.d.ts

@@ -1,58 +1,39 @@
-export = StreamHandler;
-/**
- * @typedef {import('libp2p-interfaces/src/stream-muxer/types').MuxedStream} MuxedStream
- * @typedef {import('../protocol').ICircuitRelay} ICircuitRelay
- */
-declare class StreamHandler {
+import { CircuitRelay } from '../pb/index.js';
+import type { Stream } from '@libp2p/interfaces/connection';
+export interface StreamHandlerOptions {
     /**
-     * Create a stream handler for connection
-     *
-     * @class
-     * @param {object} options
-     * @param {MuxedStream} options.stream - A duplex iterable
-     * @param {number} [options.maxLength = 4096] - max bytes length of message
+     * A duplex iterable
      */
-    constructor({ stream, maxLength }: {
-        stream: MuxedStream;
-        maxLength?: number | undefined;
-    });
-    stream: import("libp2p-interfaces/src/stream-muxer/types").MuxedStream;
-    shake: any;
-    decoder: AsyncGenerator<any, void, unknown>;
+    stream: Stream;
+    /**
+     * max bytes length of message
+     */
+    maxLength?: number;
+}
+export declare class StreamHandler {
+    private readonly stream;
+    private readonly shake;
+    private readonly decoder;
+    constructor(options: StreamHandlerOptions);
     /**
      * Read and decode message
-     *
-     * @async
      */
     read(): Promise<CircuitRelay | undefined>;
     /**
      * Encode and write array of buffers
-     *
-     * @param {ICircuitRelay} msg - An unencoded CircuitRelay protobuf message
-     * @returns {void}
      */
-    write(msg: ICircuitRelay): void;
+    write(msg: CircuitRelay): void;
     /**
      * Return the handshake rest stream and invalidate handler
-     *
-     * @returns {*} A duplex iterable
      */
-    rest(): any;
+    rest(): import("it-stream-types").Duplex<Uint8Array, Uint8Array, Promise<void>>;
     /**
-     * @param {ICircuitRelay} msg - An unencoded CircuitRelay protobuf message
+     * @param {CircuitRelay} msg - An unencoded CircuitRelay protobuf message
      */
-    end(msg: ICircuitRelay): void;
+    end(msg: CircuitRelay): void;
     /**
      * Close the stream
-     *
-     * @returns {void}
      */
     close(): void;
 }
-declare namespace StreamHandler {
-    export { MuxedStream, ICircuitRelay };
-}
-import { CircuitRelay } from "../protocol";
-type ICircuitRelay = import('../protocol').ICircuitRelay;
-type MuxedStream = import('libp2p-interfaces/src/stream-muxer/types').MuxedStream;
 //# sourceMappingURL=stream-handler.d.ts.map

package/dist/src/circuit/circuit/stream-handler.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"stream-handler.d.ts","sourceRoot":"","sources":["../../../../src/circuit/circuit/stream-handler.js"],"names":[],"mappings":";AAYA;;;GAGG;AAEH;IACE;;;;;;;OAOG;IACH;QAHgC,MAAM,EAA3B,WAAW;QACM,SAAS;OAQpC;IALC,uEAAoB;IAEpB,WAAmC;IAEnC,4CAAoF;IAGtF;;;;OAIG;IACH,0CAWC;IAED;;;;;OAKG;IACH,WAHW,aAAa,GACX,IAAI,CAMhB;IAED;;;;OAIG;IACH,YAGC;IAED;;OAEG;IACH,SAFW,aAAa,QAKvB;IAED;;;;OAIG;IACH,SAFa,IAAI,CAKhB;CACF;;;;;qBA7EY,OAAO,aAAa,EAAE,aAAa;mBADnC,OAAO,0CAA0C,EAAE,WAAW"}
+{"version":3,"file":"stream-handler.d.ts","sourceRoot":"","sources":["../../../../src/circuit/circuit/stream-handler.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAC7C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,+BAA+B,CAAA;AAK3D,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED,qBAAa,aAAa;IACxB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAQ;IAC/B,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAW;IACjC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAoB;gBAE/B,OAAO,EAAE,oBAAoB;IAQ1C;;OAEG;IACG,IAAI;IAeV;;OAEG;IACH,KAAK,CAAE,GAAG,EAAE,YAAY;IAKxB;;OAEG;IACH,IAAI;IAKJ;;OAEG;IACH,GAAG,CAAE,GAAG,EAAE,YAAY;IAKtB;;OAEG;IACH,KAAK;CAMN"}

package/dist/src/circuit/circuit/stream-handler.js

@@ -0,0 +1,59 @@
+import { logger } from '@libp2p/logger';
+import * as lp from 'it-length-prefixed';
+import { handshake } from 'it-handshake';
+import { CircuitRelay } from '../pb/index.js';
+const log = logger('libp2p:circuit:stream-handler');
+export class StreamHandler {
+    constructor(options) {
+        const { stream, maxLength = 4096 } = options;
+        this.stream = stream;
+        this.shake = handshake(this.stream);
+        this.decoder = lp.decode.fromReader(this.shake.reader, { maxDataLength: maxLength });
+    }
+    /**
+     * Read and decode message
+     */
+    async read() {
+        // @ts-expect-error FIXME is a source, needs to be a generator
+        const msg = await this.decoder.next();
+        if (msg.value != null) {
+            const value = CircuitRelay.decode(msg.value.slice());
+            log('read message type', value.type);
+            return value;
+        }
+        log('read received no value, closing stream');
+        // End the stream, we didn't get data
+        this.close();
+    }
+    /**
+     * Encode and write array of buffers
+     */
+    write(msg) {
+        log('write message type %s', msg.type);
+        this.shake.write(lp.encode.single(CircuitRelay.encode(msg)).slice());
+    }
+    /**
+     * Return the handshake rest stream and invalidate handler
+     */
+    rest() {
+        this.shake.rest();
+        return this.shake.stream;
+    }
+    /**
+     * @param {CircuitRelay} msg - An unencoded CircuitRelay protobuf message
+     */
+    end(msg) {
+        this.write(msg);
+        this.close();
+    }
+    /**
+     * Close the stream
+     */
+    close() {
+        log('closing the stream');
+        void this.rest().sink([]).catch(err => {
+            log.error(err);
+        });
+    }
+}
+//# sourceMappingURL=stream-handler.js.map

package/dist/src/circuit/circuit/stream-handler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stream-handler.js","sourceRoot":"","sources":["../../../../src/circuit/circuit/stream-handler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AACvC,OAAO,KAAK,EAAE,MAAM,oBAAoB,CAAA;AACxC,OAAO,EAAa,SAAS,EAAE,MAAM,cAAc,CAAA;AACnD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAI7C,MAAM,GAAG,GAAG,MAAM,CAAC,+BAA+B,CAAC,CAAA;AAcnD,MAAM,OAAO,aAAa;IAKxB,YAAa,OAA6B;QACxC,MAAM,EAAE,MAAM,EAAE,SAAS,GAAG,IAAI,EAAE,GAAG,OAAO,CAAA;QAE5C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QACnC,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,CAAC,CAAA;IACtF,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI;QACR,8DAA8D;QAC9D,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAA;QAErC,IAAI,GAAG,CAAC,KAAK,IAAI,IAAI,EAAE;YACrB,MAAM,KAAK,GAAG,YAAY,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,CAAA;YACpD,GAAG,CAAC,mBAAmB,EAAE,KAAK,CAAC,IAAI,CAAC,CAAA;YACpC,OAAO,KAAK,CAAA;SACb;QAED,GAAG,CAAC,wCAAwC,CAAC,CAAA;QAC7C,qCAAqC;QACrC,IAAI,CAAC,KAAK,EAAE,CAAA;IACd,CAAC;IAED;;OAEG;IACH,KAAK,CAAE,GAAiB;QACtB,GAAG,CAAC,uBAAuB,EAAE,GAAG,CAAC,IAAI,CAAC,CAAA;QACtC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAA;IACtE,CAAC;IAED;;OAEG;IACH,IAAI;QACF,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAA;QACjB,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAA;IAC1B,CAAC;IAED;;OAEG;IACH,GAAG,CAAE,GAAiB;QACpB,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QACf,IAAI,CAAC,KAAK,EAAE,CAAA;IACd,CAAC;IAED;;OAEG;IACH,KAAK;QACH,GAAG,CAAC,oBAAoB,CAAC,CAAA;QACzB,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;YACpC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QAChB,CAAC,CAAC,CAAA;IACJ,CAAC;CACF"}

package/dist/src/circuit/circuit/utils.d.ts

@@ -1,10 +1,7 @@
-export type StreamHandler = import('./stream-handler');
-export type ICircuitRelay = import('../protocol').ICircuitRelay;
+import { CircuitRelay } from '../pb/index.js';
+import type { StreamHandler } from './stream-handler.js';
 /**
  * Validate incomming HOP/STOP message
- *
- * @param {ICircuitRelay} msg - A CircuitRelay unencoded protobuf message
- * @param {StreamHandler} streamHandler
  */
-export function validateAddrs(msg: ICircuitRelay, streamHandler: StreamHandler): void;
+export declare function validateAddrs(msg: CircuitRelay, streamHandler: StreamHandler): void;
 //# sourceMappingURL=utils.d.ts.map

package/dist/src/circuit/circuit/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../../src/circuit/circuit/utils.js"],"names":[],"mappings":"4BAMa,OAAO,kBAAkB,CAAC;4BAC1B,OAAO,aAAa,EAAE,aAAa;AAgBhD;;;;;GAKG;AACH,mCAHW,aAAa,iBACb,aAAa,QA4BvB"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../../src/circuit/circuit/utils.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAC7C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAYxD;;GAEG;AACH,wBAAgB,aAAa,CAAE,GAAG,EAAE,YAAY,EAAE,aAAa,EAAE,aAAa,QA0B7E"}

package/dist/src/circuit/circuit/utils.js

@@ -0,0 +1,43 @@
+import { Multiaddr } from '@multiformats/multiaddr';
+import { CircuitRelay } from '../pb/index.js';
+/**
+ * Write a response
+ */
+function writeResponse(streamHandler, status) {
+    streamHandler.write({
+        type: CircuitRelay.Type.STATUS,
+        code: status
+    });
+}
+/**
+ * Validate incomming HOP/STOP message
+ */
+export function validateAddrs(msg, streamHandler) {
+    try {
+        if (msg.dstPeer?.addrs != null) {
+            msg.dstPeer.addrs.forEach((addr) => {
+                return new Multiaddr(addr);
+            });
+        }
+    }
+    catch (err) {
+        writeResponse(streamHandler, msg.type === CircuitRelay.Type.HOP
+            ? CircuitRelay.Status.HOP_DST_MULTIADDR_INVALID
+            : CircuitRelay.Status.STOP_DST_MULTIADDR_INVALID);
+        throw err;
+    }
+    try {
+        if (msg.srcPeer?.addrs != null) {
+            msg.srcPeer.addrs.forEach((addr) => {
+                return new Multiaddr(addr);
+            });
+        }
+    }
+    catch (err) {
+        writeResponse(streamHandler, msg.type === CircuitRelay.Type.HOP
+            ? CircuitRelay.Status.HOP_SRC_MULTIADDR_INVALID
+            : CircuitRelay.Status.STOP_SRC_MULTIADDR_INVALID);
+        throw err;
+    }
+}
+//# sourceMappingURL=utils.js.map

package/dist/src/circuit/circuit/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../../src/circuit/circuit/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACnD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAG7C;;GAEG;AACH,SAAS,aAAa,CAAE,aAA4B,EAAE,MAA2B;IAC/E,aAAa,CAAC,KAAK,CAAC;QAClB,IAAI,EAAE,YAAY,CAAC,IAAI,CAAC,MAAM;QAC9B,IAAI,EAAE,MAAM;KACb,CAAC,CAAA;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,aAAa,CAAE,GAAiB,EAAE,aAA4B;IAC5E,IAAI;QACF,IAAI,GAAG,CAAC,OAAO,EAAE,KAAK,IAAI,IAAI,EAAE;YAC9B,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;gBACjC,OAAO,IAAI,SAAS,CAAC,IAAI,CAAC,CAAA;YAC5B,CAAC,CAAC,CAAA;SACH;KACF;IAAC,OAAO,GAAQ,EAAE;QACjB,aAAa,CAAC,aAAa,EAAE,GAAG,CAAC,IAAI,KAAK,YAAY,CAAC,IAAI,CAAC,GAAG;YAC7D,CAAC,CAAC,YAAY,CAAC,MAAM,CAAC,yBAAyB;YAC/C,CAAC,CAAC,YAAY,CAAC,MAAM,CAAC,0BAA0B,CAAC,CAAA;QACnD,MAAM,GAAG,CAAA;KACV;IAED,IAAI;QACF,IAAI,GAAG,CAAC,OAAO,EAAE,KAAK,IAAI,IAAI,EAAE;YAC9B,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;gBACjC,OAAO,IAAI,SAAS,CAAC,IAAI,CAAC,CAAA;YAC5B,CAAC,CAAC,CAAA;SACH;KACF;IAAC,OAAO,GAAQ,EAAE;QACjB,aAAa,CAAC,aAAa,EAAE,GAAG,CAAC,IAAI,KAAK,YAAY,CAAC,IAAI,CAAC,GAAG;YAC7D,CAAC,CAAC,YAAY,CAAC,MAAM,CAAC,yBAAyB;YAC/C,CAAC,CAAC,YAAY,CAAC,MAAM,CAAC,0BAA0B,CAAC,CAAA;QACnD,MAAM,GAAG,CAAA;KACV;AACH,CAAC"}

package/dist/src/circuit/constants.d.ts

@@ -1,7 +1,25 @@
-export const ADVERTISE_BOOT_DELAY: number;
-export const ADVERTISE_TTL: number;
-export const CIRCUIT_PROTO_CODE: number;
-export const HOP_METADATA_KEY: string;
-export const HOP_METADATA_VALUE: string;
-export const RELAY_RENDEZVOUS_NS: string;
+/**
+ * Delay before HOP relay service is advertised on the network
+ */
+export declare const ADVERTISE_BOOT_DELAY: number;
+/**
+ * Delay Between HOP relay service advertisements on the network
+ */
+export declare const ADVERTISE_TTL: number;
+/**
+ * Multicodec code
+ */
+export declare const CIRCUIT_PROTO_CODE = 290;
+/**
+ * PeerStore metadaBook key for HOP relay service
+ */
+export declare const HOP_METADATA_KEY = "hop_relay";
+/**
+ * PeerStore metadaBook value for HOP relay service
+ */
+export declare const HOP_METADATA_VALUE = "true";
+/**
+ * Relay HOP relay service namespace for discovery
+ */
+export declare const RELAY_RENDEZVOUS_NS = "/libp2p/relay";
 //# sourceMappingURL=constants.d.ts.map

package/dist/src/circuit/constants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../src/circuit/constants.js"],"names":[],"mappings":""}
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../src/circuit/constants.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,eAAO,MAAM,oBAAoB,QAAc,CAAA;AAE/C;;GAEG;AACH,eAAO,MAAM,aAAa,QAAc,CAAA;AAExC;;GAEG;AACH,eAAO,MAAM,kBAAkB,MAAM,CAAA;AAErC;;GAEG;AACH,eAAO,MAAM,gBAAgB,cAAc,CAAA;AAE3C;;GAEG;AACH,eAAO,MAAM,kBAAkB,SAAS,CAAA;AAExC;;GAEG;AACH,eAAO,MAAM,mBAAmB,kBAAkB,CAAA"}

package/dist/src/circuit/constants.js

@@ -0,0 +1,26 @@
+const minute = 60 * 1000;
+/**
+ * Delay before HOP relay service is advertised on the network
+ */
+export const ADVERTISE_BOOT_DELAY = 15 * minute;
+/**
+ * Delay Between HOP relay service advertisements on the network
+ */
+export const ADVERTISE_TTL = 30 * minute;
+/**
+ * Multicodec code
+ */
+export const CIRCUIT_PROTO_CODE = 290;
+/**
+ * PeerStore metadaBook key for HOP relay service
+ */
+export const HOP_METADATA_KEY = 'hop_relay';
+/**
+ * PeerStore metadaBook value for HOP relay service
+ */
+export const HOP_METADATA_VALUE = 'true';
+/**
+ * Relay HOP relay service namespace for discovery
+ */
+export const RELAY_RENDEZVOUS_NS = '/libp2p/relay';
+//# sourceMappingURL=constants.js.map

package/dist/src/circuit/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/circuit/constants.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,GAAG,EAAE,GAAG,IAAI,CAAA;AAExB;;GAEG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,EAAE,GAAG,MAAM,CAAA;AAE/C;;GAEG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,EAAE,GAAG,MAAM,CAAA;AAExC;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,GAAG,CAAA;AAErC;;GAEG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,WAAW,CAAA;AAE3C;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,MAAM,CAAA;AAExC;;GAEG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,eAAe,CAAA"}