@libp2p/circuit-relay-v2 0.0.0-05b52d69c

package/dist/src/transport/reservation-store.js

@@ -0,0 +1,209 @@
+import { TypedEventEmitter } from '@libp2p/interface/events';
+import { PeerMap } from '@libp2p/peer-collections';
+import { PeerJobQueue } from '@libp2p/utils/peer-job-queue';
+import { multiaddr } from '@multiformats/multiaddr';
+import { pbStream } from 'it-protobuf-stream';
+import { DEFAULT_RESERVATION_CONCURRENCY, RELAY_TAG, RELAY_V2_HOP_CODEC } from '../constants.js';
+import { HopMessage, Status } from '../pb/index.js';
+import { getExpirationMilliseconds } from '../utils.js';
+// allow refreshing a relay reservation if it will expire in the next 10 minutes
+const REFRESH_WINDOW = (60 * 1000) * 10;
+// try to refresh relay reservations 5 minutes before expiry
+const REFRESH_TIMEOUT = (60 * 1000) * 5;
+// minimum duration before which a reservation must not be refreshed
+const REFRESH_TIMEOUT_MIN = 30 * 1000;
+export class ReservationStore extends TypedEventEmitter {
+    peerId;
+    connectionManager;
+    transportManager;
+    peerStore;
+    events;
+    reserveQueue;
+    reservations;
+    maxDiscoveredRelays;
+    maxReservationQueueLength;
+    reservationCompletionTimeout;
+    started;
+    log;
+    constructor(components, init) {
+        super();
+        this.log = components.logger.forComponent('libp2p:circuit-relay:transport:reservation-store');
+        this.peerId = components.peerId;
+        this.connectionManager = components.connectionManager;
+        this.transportManager = components.transportManager;
+        this.peerStore = components.peerStore;
+        this.events = components.events;
+        this.reservations = new PeerMap();
+        this.maxDiscoveredRelays = init?.discoverRelays ?? 0;
+        this.maxReservationQueueLength = init?.maxReservationQueueLength ?? 100;
+        this.reservationCompletionTimeout = init?.reservationCompletionTimeout ?? 10000;
+        this.started = false;
+        // ensure we don't listen on multiple relays simultaneously
+        this.reserveQueue = new PeerJobQueue({
+            concurrency: init?.reservationConcurrency ?? DEFAULT_RESERVATION_CONCURRENCY
+        });
+        // When a peer disconnects, if we had a reservation on that peer
+        // remove the reservation and multiaddr and maybe trigger search
+        // for new relays
+        this.events.addEventListener('peer:disconnect', (evt) => {
+            this.#removeRelay(evt.detail);
+        });
+    }
+    isStarted() {
+        return this.started;
+    }
+    async start() {
+        this.started = true;
+    }
+    async stop() {
+        this.reserveQueue.clear();
+        this.reservations.forEach(({ timeout }) => {
+            clearTimeout(timeout);
+        });
+        this.reservations.clear();
+        this.started = false;
+    }
+    /**
+     * If the number of current relays is beneath the configured `maxReservations`
+     * value, and the passed peer id is not our own, and we have a non-relayed connection
+     * to the remote, and the remote peer speaks the hop protocol, try to reserve a slot
+     * on the remote peer
+     */
+    async addRelay(peerId, type) {
+        if (this.peerId.equals(peerId)) {
+            this.log('not trying to use self as relay');
+            return;
+        }
+        if (this.reserveQueue.size > this.maxReservationQueueLength) {
+            this.log('not adding relay as the queue is full');
+            return;
+        }
+        if (this.reserveQueue.hasJob(peerId)) {
+            this.log('relay peer is already in the reservation queue');
+            return;
+        }
+        this.log('add relay %p', peerId);
+        await this.reserveQueue.add(async () => {
+            try {
+                // allow refresh of an existing reservation if it is about to expire
+                const existingReservation = this.reservations.get(peerId);
+                if (existingReservation != null) {
+                    if (getExpirationMilliseconds(existingReservation.reservation.expire) > REFRESH_WINDOW) {
+                        this.log('already have reservation on relay peer %p and it expires in more than 10 minutes', peerId);
+                        return;
+                    }
+                    clearTimeout(existingReservation.timeout);
+                    this.reservations.delete(peerId);
+                }
+                if (type === 'discovered' && [...this.reservations.values()].reduce((acc, curr) => {
+                    if (curr.type === 'discovered') {
+                        acc++;
+                    }
+                    return acc;
+                }, 0) >= this.maxDiscoveredRelays) {
+                    this.log('already have enough discovered relays');
+                    return;
+                }
+                const signal = AbortSignal.timeout(this.reservationCompletionTimeout);
+                const connection = await this.connectionManager.openConnection(peerId, {
+                    signal
+                });
+                if (connection.remoteAddr.protoNames().includes('p2p-circuit')) {
+                    this.log('not creating reservation over relayed connection');
+                    return;
+                }
+                const reservation = await this.#createReservation(connection, {
+                    signal
+                });
+                this.log('created reservation on relay peer %p', peerId);
+                const expiration = getExpirationMilliseconds(reservation.expire);
+                // sets a lower bound on the timeout, and also don't let it go over
+                // 2^31 - 1 (setTimeout will only accept signed 32 bit integers)
+                const timeoutDuration = Math.min(Math.max(expiration - REFRESH_TIMEOUT, REFRESH_TIMEOUT_MIN), Math.pow(2, 31) - 1);
+                const timeout = setTimeout(() => {
+                    this.addRelay(peerId, type).catch(err => {
+                        this.log.error('could not refresh reservation to relay %p', peerId, err);
+                    });
+                }, timeoutDuration);
+                // we've managed to create a reservation successfully
+                this.reservations.set(peerId, {
+                    timeout,
+                    reservation,
+                    type
+                });
+                // ensure we don't close the connection to the relay
+                await this.peerStore.merge(peerId, {
+                    tags: {
+                        [RELAY_TAG]: {
+                            value: 1,
+                            ttl: expiration
+                        }
+                    }
+                });
+                // listen on multiaddr that only the circuit transport is listening for
+                await this.transportManager.listen([multiaddr(`/p2p/${peerId.toString()}/p2p-circuit`)]);
+            }
+            catch (err) {
+                this.log.error('could not reserve slot on %p', peerId, err);
+                // cancel the renewal timeout if it's been set
+                const reservation = this.reservations.get(peerId);
+                if (reservation != null) {
+                    clearTimeout(reservation.timeout);
+                }
+                // if listening failed, remove the reservation
+                this.reservations.delete(peerId);
+            }
+        }, {
+            peerId
+        });
+    }
+    hasReservation(peerId) {
+        return this.reservations.has(peerId);
+    }
+    getReservation(peerId) {
+        return this.reservations.get(peerId)?.reservation;
+    }
+    async #createReservation(connection, options) {
+        options.signal?.throwIfAborted();
+        this.log('requesting reservation from %p', connection.remotePeer);
+        const stream = await connection.newStream(RELAY_V2_HOP_CODEC, options);
+        const pbstr = pbStream(stream);
+        const hopstr = pbstr.pb(HopMessage);
+        await hopstr.write({ type: HopMessage.Type.RESERVE }, options);
+        let response;
+        try {
+            response = await hopstr.read(options);
+        }
+        catch (err) {
+            this.log.error('error parsing reserve message response from %p because', connection.remotePeer, err);
+            throw err;
+        }
+        finally {
+            await stream.close();
+        }
+        if (response.status === Status.OK && (response.reservation != null)) {
+            return response.reservation;
+        }
+        const errMsg = `reservation failed with status ${response.status ?? 'undefined'}`;
+        this.log.error(errMsg);
+        throw new Error(errMsg);
+    }
+    /**
+     * Remove listen relay
+     */
+    #removeRelay(peerId) {
+        const existingReservation = this.reservations.get(peerId);
+        if (existingReservation == null) {
+            return;
+        }
+        this.log('connection to relay %p closed, removing reservation from local store', peerId);
+        clearTimeout(existingReservation.timeout);
+        this.reservations.delete(peerId);
+        this.safeDispatchEvent('relay:removed', { detail: peerId });
+        if (this.reservations.size < this.maxDiscoveredRelays) {
+            this.log('not enough relays %d/%d', this.reservations.size, this.maxDiscoveredRelays);
+            this.safeDispatchEvent('relay:not-enough-relays', {});
+        }
+    }
+}
+//# sourceMappingURL=reservation-store.js.map

package/dist/src/transport/reservation-store.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reservation-store.js","sourceRoot":"","sources":["../../../src/transport/reservation-store.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAyB,MAAM,0BAA0B,CAAA;AACnF,OAAO,EAAE,OAAO,EAAE,MAAM,0BAA0B,CAAA;AAClD,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAA;AAC3D,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACnD,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAA;AAC7C,OAAO,EAAE,+BAA+B,EAAE,SAAS,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAA;AAChG,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AACnD,OAAO,EAAE,yBAAyB,EAAE,MAAM,aAAa,CAAA;AAUvD,gFAAgF;AAChF,MAAM,cAAc,GAAG,CAAC,EAAE,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;AAEvC,4DAA4D;AAC5D,MAAM,eAAe,GAAG,CAAC,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,CAAA;AAEvC,oEAAoE;AACpE,MAAM,mBAAmB,GAAG,EAAE,GAAG,IAAI,CAAA;AAoDrC,MAAM,OAAO,gBAAiB,SAAQ,iBAAyC;IAC5D,MAAM,CAAQ;IACd,iBAAiB,CAAmB;IACpC,gBAAgB,CAAkB;IAClC,SAAS,CAAW;IACpB,MAAM,CAAgC;IACtC,YAAY,CAAc;IAC1B,YAAY,CAAqB;IACjC,mBAAmB,CAAQ;IAC3B,yBAAyB,CAAQ;IACjC,4BAA4B,CAAQ;IAC7C,OAAO,CAAS;IACP,GAAG,CAAQ;IAE5B,YAAa,UAAgC,EAAE,IAAqB;QAClE,KAAK,EAAE,CAAA;QAEP,IAAI,CAAC,GAAG,GAAG,UAAU,CAAC,MAAM,CAAC,YAAY,CAAC,kDAAkD,CAAC,CAAA;QAC7F,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC,MAAM,CAAA;QAC/B,IAAI,CAAC,iBAAiB,GAAG,UAAU,CAAC,iBAAiB,CAAA;QACrD,IAAI,CAAC,gBAAgB,GAAG,UAAU,CAAC,gBAAgB,CAAA;QACnD,IAAI,CAAC,SAAS,GAAG,UAAU,CAAC,SAAS,CAAA;QACrC,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC,MAAM,CAAA;QAC/B,IAAI,CAAC,YAAY,GAAG,IAAI,OAAO,EAAE,CAAA;QACjC,IAAI,CAAC,mBAAmB,GAAG,IAAI,EAAE,cAAc,IAAI,CAAC,CAAA;QACpD,IAAI,CAAC,yBAAyB,GAAG,IAAI,EAAE,yBAAyB,IAAI,GAAG,CAAA;QACvE,IAAI,CAAC,4BAA4B,GAAG,IAAI,EAAE,4BAA4B,IAAI,KAAK,CAAA;QAC/E,IAAI,CAAC,OAAO,GAAG,KAAK,CAAA;QAEpB,2DAA2D;QAC3D,IAAI,CAAC,YAAY,GAAG,IAAI,YAAY,CAAC;YACnC,WAAW,EAAE,IAAI,EAAE,sBAAsB,IAAI,+BAA+B;SAC7E,CAAC,CAAA;QAEF,gEAAgE;QAChE,gEAAgE;QAChE,iBAAiB;QACjB,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,iBAAiB,EAAE,CAAC,GAAG,EAAE,EAAE;YACtD,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;QAC/B,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,OAAO,CAAA;IACrB,CAAC;IAED,KAAK,CAAC,KAAK;QACT,IAAI,CAAC,OAAO,GAAG,IAAI,CAAA;IACrB,CAAC;IAED,KAAK,CAAC,IAAI;QACR,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,CAAA;QACzB,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE;YACxC,YAAY,CAAC,OAAO,CAAC,CAAA;QACvB,CAAC,CAAC,CAAA;QACF,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,CAAA;QACzB,IAAI,CAAC,OAAO,GAAG,KAAK,CAAA;IACtB,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,QAAQ,CAAE,MAAc,EAAE,IAAe;QAC7C,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE;YAC9B,IAAI,CAAC,GAAG,CAAC,iCAAiC,CAAC,CAAA;YAC3C,OAAM;SACP;QAED,IAAI,IAAI,CAAC,YAAY,CAAC,IAAI,GAAG,IAAI,CAAC,yBAAyB,EAAE;YAC3D,IAAI,CAAC,GAAG,CAAC,uCAAuC,CAAC,CAAA;YACjD,OAAM;SACP;QAED,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE;YACpC,IAAI,CAAC,GAAG,CAAC,gDAAgD,CAAC,CAAA;YAC1D,OAAM;SACP;QAED,IAAI,CAAC,GAAG,CAAC,cAAc,EAAE,MAAM,CAAC,CAAA;QAEhC,MAAM,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE;YACrC,IAAI;gBACF,oEAAoE;gBACpE,MAAM,mBAAmB,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;gBAEzD,IAAI,mBAAmB,IAAI,IAAI,EAAE;oBAC/B,IAAI,yBAAyB,CAAC,mBAAmB,CAAC,WAAW,CAAC,MAAM,CAAC,GAAG,cAAc,EAAE;wBACtF,IAAI,CAAC,GAAG,CAAC,kFAAkF,EAAE,MAAM,CAAC,CAAA;wBACpG,OAAM;qBACP;oBAED,YAAY,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAA;oBACzC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;iBACjC;gBAED,IAAI,IAAI,KAAK,YAAY,IAAI,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;oBAChF,IAAI,IAAI,CAAC,IAAI,KAAK,YAAY,EAAE;wBAC9B,GAAG,EAAE,CAAA;qBACN;oBAED,OAAO,GAAG,CAAA;gBACZ,CAAC,EAAE,CAAC,CAAC,IAAI,IAAI,CAAC,mBAAmB,EAAE;oBACjC,IAAI,CAAC,GAAG,CAAC,uCAAuC,CAAC,CAAA;oBACjD,OAAM;iBACP;gBAED,MAAM,MAAM,GAAG,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAA;gBAErE,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,cAAc,CAAC,MAAM,EAAE;oBACrE,MAAM;iBACP,CAAC,CAAA;gBAEF,IAAI,UAAU,CAAC,UAAU,CAAC,UAAU,EAAE,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE;oBAC9D,IAAI,CAAC,GAAG,CAAC,kDAAkD,CAAC,CAAA;oBAC5D,OAAM;iBACP;gBAED,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,UAAU,EAAE;oBAC5D,MAAM;iBACP,CAAC,CAAA;gBAEF,IAAI,CAAC,GAAG,CAAC,sCAAsC,EAAE,MAAM,CAAC,CAAA;gBAExD,MAAM,UAAU,GAAG,yBAAyB,CAAC,WAAW,CAAC,MAAM,CAAC,CAAA;gBAEhE,mEAAmE;gBACnE,gEAAgE;gBAChE,MAAM,eAAe,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,GAAG,eAAe,EAAE,mBAAmB,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,CAAA;gBAElH,MAAM,OAAO,GAAG,UAAU,CAAC,GAAG,EAAE;oBAC9B,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;wBACtC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,2CAA2C,EAAE,MAAM,EAAE,GAAG,CAAC,CAAA;oBAC1E,CAAC,CAAC,CAAA;gBACJ,CAAC,EAAE,eAAe,CAAC,CAAA;gBAEnB,qDAAqD;gBACrD,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,EAAE;oBAC5B,OAAO;oBACP,WAAW;oBACX,IAAI;iBACL,CAAC,CAAA;gBAEF,oDAAoD;gBACpD,MAAM,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,MAAM,EAAE;oBACjC,IAAI,EAAE;wBACJ,CAAC,SAAS,CAAC,EAAE;4BACX,KAAK,EAAE,CAAC;4BACR,GAAG,EAAE,UAAU;yBAChB;qBACF;iBACF,CAAC,CAAA;gBAEF,uEAAuE;gBACvE,MAAM,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,QAAQ,MAAM,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC,CAAC,CAAA;aACzF;YAAC,OAAO,GAAG,EAAE;gBACZ,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,8BAA8B,EAAE,MAAM,EAAE,GAAG,CAAC,CAAA;gBAE3D,8CAA8C;gBAC9C,MAAM,WAAW,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;gBAEjD,IAAI,WAAW,IAAI,IAAI,EAAE;oBACvB,YAAY,CAAC,WAAW,CAAC,OAAO,CAAC,CAAA;iBAClC;gBAED,8CAA8C;gBAC9C,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;aACjC;QACH,CAAC,EAAE;YACD,MAAM;SACP,CAAC,CAAA;IACJ,CAAC;IAED,cAAc,CAAE,MAAc;QAC5B,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;IACtC,CAAC;IAED,cAAc,CAAE,MAAc;QAC5B,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,WAAW,CAAA;IACnD,CAAC;IAED,KAAK,CAAC,kBAAkB,CAAE,UAAsB,EAAE,OAAqB;QACrE,OAAO,CAAC,MAAM,EAAE,cAAc,EAAE,CAAA;QAEhC,IAAI,CAAC,GAAG,CAAC,gCAAgC,EAAE,UAAU,CAAC,UAAU,CAAC,CAAA;QACjE,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,SAAS,CAAC,kBAAkB,EAAE,OAAO,CAAC,CAAA;QACtE,MAAM,KAAK,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAA;QAC9B,MAAM,MAAM,GAAG,KAAK,CAAC,EAAE,CAAC,UAAU,CAAC,CAAA;QACnC,MAAM,MAAM,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,OAAO,CAAC,CAAA;QAE9D,IAAI,QAAoB,CAAA;QAExB,IAAI;YACF,QAAQ,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;SACtC;QAAC,OAAO,GAAQ,EAAE;YACjB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,wDAAwD,EAAE,UAAU,CAAC,UAAU,EAAE,GAAG,CAAC,CAAA;YACpG,MAAM,GAAG,CAAA;SACV;gBAAS;YACR,MAAM,MAAM,CAAC,KAAK,EAAE,CAAA;SACrB;QAED,IAAI,QAAQ,CAAC,MAAM,KAAK,MAAM,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,WAAW,IAAI,IAAI,CAAC,EAAE;YACnE,OAAO,QAAQ,CAAC,WAAW,CAAA;SAC5B;QAED,MAAM,MAAM,GAAG,kCAAkC,QAAQ,CAAC,MAAM,IAAI,WAAW,EAAE,CAAA;QACjF,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;QAEtB,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,CAAA;IACzB,CAAC;IAED;;OAEG;IACH,YAAY,CAAE,MAAc;QAC1B,MAAM,mBAAmB,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;QAEzD,IAAI,mBAAmB,IAAI,IAAI,EAAE;YAC/B,OAAM;SACP;QAED,IAAI,CAAC,GAAG,CAAC,sEAAsE,EAAE,MAAM,CAAC,CAAA;QAExF,YAAY,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAA;QACzC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;QAEhC,IAAI,CAAC,iBAAiB,CAAC,eAAe,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;QAE3D,IAAI,IAAI,CAAC,YAAY,CAAC,IAAI,GAAG,IAAI,CAAC,mBAAmB,EAAE;YACrD,IAAI,CAAC,GAAG,CAAC,yBAAyB,EAAE,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,IAAI,CAAC,mBAAmB,CAAC,CAAA;YACrF,IAAI,CAAC,iBAAiB,CAAC,yBAAyB,EAAE,EAAE,CAAC,CAAA;SACtD;IACH,CAAC;CACF"}

package/dist/src/utils.d.ts

@@ -0,0 +1,14 @@
+import { CID } from 'multiformats/cid';
+import type { Limit } from './pb/index.js';
+import type { LoggerOptions } from '@libp2p/interface';
+import type { Stream } from '@libp2p/interface/connection';
+export declare function createLimitedRelay(src: Stream, dst: Stream, abortSignal: AbortSignal, limit: Limit | undefined, options: LoggerOptions): void;
+/**
+ * Convert a namespace string into a cid
+ */
+export declare function namespaceToCid(namespace: string): Promise<CID>;
+/**
+ * returns number of ms between now and expiration time
+ */
+export declare function getExpirationMilliseconds(expireTimeSeconds: bigint): number;
+//# sourceMappingURL=utils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAGtC,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,eAAe,CAAA;AAC1C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAA;AACtD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,8BAA8B,CAAA;AA+B1D,wBAAgB,kBAAkB,CAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE,KAAK,EAAE,KAAK,GAAG,SAAS,EAAE,OAAO,EAAE,aAAa,GAAG,IAAI,CA0E9I;AAED;;GAEG;AACH,wBAAsB,cAAc,CAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAKrE;AAED;;GAEG;AACH,wBAAgB,yBAAyB,CAAE,iBAAiB,EAAE,MAAM,GAAG,MAAM,CAM5E"}

package/dist/src/utils.js

@@ -0,0 +1,106 @@
+import { CodeError } from '@libp2p/interface/errors';
+import { anySignal } from 'any-signal';
+import { CID } from 'multiformats/cid';
+import { sha256 } from 'multiformats/hashes/sha2';
+import { ERR_TRANSFER_LIMIT_EXCEEDED } from './constants.js';
+async function* countStreamBytes(source, limit, options) {
+    const limitBytes = limit.remaining;
+    for await (const buf of source) {
+        const len = BigInt(buf.byteLength);
+        if ((limit.remaining - len) < 0) {
+            // this is a safe downcast since len is guarantee to be in the range for a number
+            const remaining = Number(limit.remaining);
+            limit.remaining = 0n;
+            try {
+                if (remaining !== 0) {
+                    yield buf.subarray(0, remaining);
+                }
+            }
+            catch (err) {
+                options.log.error(err);
+            }
+            throw new CodeError(`data limit of ${limitBytes} bytes exceeded`, ERR_TRANSFER_LIMIT_EXCEEDED);
+        }
+        limit.remaining -= len;
+        yield buf;
+    }
+}
+export function createLimitedRelay(src, dst, abortSignal, limit, options) {
+    function abortStreams(err) {
+        src.abort(err);
+        dst.abort(err);
+        clearTimeout(timeout);
+    }
+    const abortController = new AbortController();
+    const signal = anySignal([abortSignal, abortController.signal]);
+    let timeout;
+    if (limit?.duration != null) {
+        timeout = setTimeout(() => {
+            abortController.abort();
+        }, limit.duration);
+    }
+    let srcDstFinished = false;
+    let dstSrcFinished = false;
+    let dataLimit;
+    if (limit?.data != null) {
+        dataLimit = {
+            remaining: limit.data
+        };
+    }
+    queueMicrotask(() => {
+        const onAbort = () => {
+            dst.abort(new CodeError(`duration limit of ${limit?.duration} ms exceeded`, ERR_TRANSFER_LIMIT_EXCEEDED));
+        };
+        signal.addEventListener('abort', onAbort, { once: true });
+        void dst.sink(dataLimit == null ? src.source : countStreamBytes(src.source, dataLimit, options))
+            .catch(err => {
+            options.log.error('error while relaying streams src -> dst', err);
+            abortStreams(err);
+        })
+            .finally(() => {
+            srcDstFinished = true;
+            if (dstSrcFinished) {
+                signal.removeEventListener('abort', onAbort);
+                signal.clear();
+                clearTimeout(timeout);
+            }
+        });
+    });
+    queueMicrotask(() => {
+        const onAbort = () => {
+            src.abort(new CodeError(`duration limit of ${limit?.duration} ms exceeded`, ERR_TRANSFER_LIMIT_EXCEEDED));
+        };
+        signal.addEventListener('abort', onAbort, { once: true });
+        void src.sink(dataLimit == null ? dst.source : countStreamBytes(dst.source, dataLimit, options))
+            .catch(err => {
+            options.log.error('error while relaying streams dst -> src', err);
+            abortStreams(err);
+        })
+            .finally(() => {
+            dstSrcFinished = true;
+            if (srcDstFinished) {
+                signal.removeEventListener('abort', onAbort);
+                signal.clear();
+                clearTimeout(timeout);
+            }
+        });
+    });
+}
+/**
+ * Convert a namespace string into a cid
+ */
+export async function namespaceToCid(namespace) {
+    const bytes = new TextEncoder().encode(namespace);
+    const hash = await sha256.digest(bytes);
+    return CID.createV0(hash);
+}
+/**
+ * returns number of ms between now and expiration time
+ */
+export function getExpirationMilliseconds(expireTimeSeconds) {
+    const expireTimeMillis = expireTimeSeconds * BigInt(1000);
+    const currentTime = new Date().getTime();
+    // downcast to number to use with setTimeout
+    return Number(expireTimeMillis - BigInt(currentTime));
+}
+//# sourceMappingURL=utils.js.map

package/dist/src/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAA;AACpD,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AACtC,OAAO,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AACtC,OAAO,EAAE,MAAM,EAAE,MAAM,0BAA0B,CAAA;AACjD,OAAO,EAAE,2BAA2B,EAAE,MAAM,gBAAgB,CAAA;AAO5D,KAAK,SAAU,CAAC,CAAC,gBAAgB,CAAE,MAA2C,EAAE,KAA4B,EAAE,OAAsB;IAClI,MAAM,UAAU,GAAG,KAAK,CAAC,SAAS,CAAA;IAElC,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,MAAM,EAAE;QAC9B,MAAM,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,CAAA;QAElC,IAAI,CAAC,KAAK,CAAC,SAAS,GAAG,GAAG,CAAC,GAAG,CAAC,EAAE;YAC/B,iFAAiF;YACjF,MAAM,SAAS,GAAG,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAA;YACzC,KAAK,CAAC,SAAS,GAAG,EAAE,CAAA;YAEpB,IAAI;gBACF,IAAI,SAAS,KAAK,CAAC,EAAE;oBACnB,MAAM,GAAG,CAAC,QAAQ,CAAC,CAAC,EAAE,SAAS,CAAC,CAAA;iBACjC;aACF;YAAC,OAAO,GAAQ,EAAE;gBACjB,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;aACvB;YAED,MAAM,IAAI,SAAS,CAAC,iBAAiB,UAAU,iBAAiB,EAAE,2BAA2B,CAAC,CAAA;SAC/F;QAED,KAAK,CAAC,SAAS,IAAI,GAAG,CAAA;QACtB,MAAM,GAAG,CAAA;KACV;AACH,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAE,GAAW,EAAE,GAAW,EAAE,WAAwB,EAAE,KAAwB,EAAE,OAAsB;IACtI,SAAS,YAAY,CAAE,GAAU;QAC/B,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QACd,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QACd,YAAY,CAAC,OAAO,CAAC,CAAA;IACvB,CAAC;IAED,MAAM,eAAe,GAAG,IAAI,eAAe,EAAE,CAAA;IAC7C,MAAM,MAAM,GAAG,SAAS,CAAC,CAAC,WAAW,EAAE,eAAe,CAAC,MAAM,CAAC,CAAC,CAAA;IAE/D,IAAI,OAAkD,CAAA;IAEtD,IAAI,KAAK,EAAE,QAAQ,IAAI,IAAI,EAAE;QAC3B,OAAO,GAAG,UAAU,CAAC,GAAG,EAAE;YACxB,eAAe,CAAC,KAAK,EAAE,CAAA;QACzB,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAA;KACnB;IAED,IAAI,cAAc,GAAG,KAAK,CAAA;IAC1B,IAAI,cAAc,GAAG,KAAK,CAAA;IAE1B,IAAI,SAA4C,CAAA;IAEhD,IAAI,KAAK,EAAE,IAAI,IAAI,IAAI,EAAE;QACvB,SAAS,GAAG;YACV,SAAS,EAAE,KAAK,CAAC,IAAI;SACtB,CAAA;KACF;IAED,cAAc,CAAC,GAAG,EAAE;QAClB,MAAM,OAAO,GAAG,GAAS,EAAE;YACzB,GAAG,CAAC,KAAK,CAAC,IAAI,SAAS,CAAC,qBAAqB,KAAK,EAAE,QAAQ,cAAc,EAAE,2BAA2B,CAAC,CAAC,CAAA;QAC3G,CAAC,CAAA;QAED,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAA;QAEzD,KAAK,GAAG,CAAC,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,gBAAgB,CAAC,GAAG,CAAC,MAAM,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;aAC7F,KAAK,CAAC,GAAG,CAAC,EAAE;YACX,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,yCAAyC,EAAE,GAAG,CAAC,CAAA;YACjE,YAAY,CAAC,GAAG,CAAC,CAAA;QACnB,CAAC,CAAC;aACD,OAAO,CAAC,GAAG,EAAE;YACZ,cAAc,GAAG,IAAI,CAAA;YAErB,IAAI,cAAc,EAAE;gBAClB,MAAM,CAAC,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;gBAC5C,MAAM,CAAC,KAAK,EAAE,CAAA;gBACd,YAAY,CAAC,OAAO,CAAC,CAAA;aACtB;QACH,CAAC,CAAC,CAAA;IACN,CAAC,CAAC,CAAA;IAEF,cAAc,CAAC,GAAG,EAAE;QAClB,MAAM,OAAO,GAAG,GAAS,EAAE;YACzB,GAAG,CAAC,KAAK,CAAC,IAAI,SAAS,CAAC,qBAAqB,KAAK,EAAE,QAAQ,cAAc,EAAE,2BAA2B,CAAC,CAAC,CAAA;QAC3G,CAAC,CAAA;QAED,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAA;QAEzD,KAAK,GAAG,CAAC,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,gBAAgB,CAAC,GAAG,CAAC,MAAM,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;aAC7F,KAAK,CAAC,GAAG,CAAC,EAAE;YACX,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,yCAAyC,EAAE,GAAG,CAAC,CAAA;YACjE,YAAY,CAAC,GAAG,CAAC,CAAA;QACnB,CAAC,CAAC;aACD,OAAO,CAAC,GAAG,EAAE;YACZ,cAAc,GAAG,IAAI,CAAA;YAErB,IAAI,cAAc,EAAE;gBAClB,MAAM,CAAC,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;gBAC5C,MAAM,CAAC,KAAK,EAAE,CAAA;gBACd,YAAY,CAAC,OAAO,CAAC,CAAA;aACtB;QACH,CAAC,CAAC,CAAA;IACN,CAAC,CAAC,CAAA;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAAE,SAAiB;IACrD,MAAM,KAAK,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,CAAA;IACjD,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;IAEvC,OAAO,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;AAC3B,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,yBAAyB,CAAE,iBAAyB;IAClE,MAAM,gBAAgB,GAAG,iBAAiB,GAAG,MAAM,CAAC,IAAI,CAAC,CAAA;IACzD,MAAM,WAAW,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAA;IAExC,4CAA4C;IAC5C,OAAO,MAAM,CAAC,gBAAgB,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC,CAAA;AACvD,CAAC"}

package/package.json

@@ -0,0 +1,83 @@
+{
+  "name": "@libp2p/circuit-relay-v2",
+  "version": "0.0.0-05b52d69c",
+  "description": "Implementation of Circuit Relay v2",
+  "license": "Apache-2.0 OR MIT",
+  "homepage": "https://github.com/libp2p/js-libp2p/tree/master/packages/transport-circuit-relay-v2#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/libp2p/js-libp2p.git"
+  },
+  "bugs": {
+    "url": "https://github.com/libp2p/js-libp2p/issues"
+  },
+  "type": "module",
+  "types": "./dist/src/index.d.ts",
+  "files": [
+    "src",
+    "dist",
+    "!dist/test",
+    "!**/*.tsbuildinfo"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/src/index.d.ts",
+      "import": "./dist/src/index.js"
+    }
+  },
+  "eslintConfig": {
+    "extends": "ipfs",
+    "parserOptions": {
+      "project": true,
+      "sourceType": "module"
+    }
+  },
+  "scripts": {
+    "start": "node dist/src/main.js",
+    "build": "aegir build",
+    "test": "aegir test",
+    "clean": "aegir clean",
+    "generate": "protons ./src/pb/index.proto",
+    "lint": "aegir lint",
+    "test:chrome": "aegir test -t browser --cov",
+    "test:chrome-webworker": "aegir test -t webworker",
+    "test:firefox": "aegir test -t browser -- --browser firefox",
+    "test:firefox-webworker": "aegir test -t webworker -- --browser firefox",
+    "test:node": "aegir test -t node --cov",
+    "dep-check": "aegir dep-check"
+  },
+  "dependencies": {
+    "@libp2p/interface": "0.1.6-05b52d69c",
+    "@libp2p/interface-internal": "0.1.9-05b52d69c",
+    "@libp2p/peer-collections": "4.0.8-05b52d69c",
+    "@libp2p/peer-id": "3.0.6-05b52d69c",
+    "@libp2p/peer-record": "6.0.9-05b52d69c",
+    "@libp2p/utils": "4.0.7-05b52d69c",
+    "@multiformats/mafmt": "^12.1.6",
+    "@multiformats/multiaddr": "^12.1.10",
+    "any-signal": "^4.1.1",
+    "delay": "^6.0.0",
+    "it-protobuf-stream": "^1.0.2",
+    "it-stream-types": "^2.0.1",
+    "multiformats": "^12.1.3",
+    "p-defer": "^4.0.0",
+    "p-retry": "^6.1.0",
+    "protons-runtime": "^5.0.0",
+    "uint8arraylist": "^2.4.3",
+    "uint8arrays": "^4.0.6"
+  },
+  "devDependencies": {
+    "@libp2p/interface-compliance-tests": "4.1.5-05b52d69c",
+    "@libp2p/logger": "3.1.0-05b52d69c",
+    "@libp2p/peer-id-factory": "3.0.8-05b52d69c",
+    "aegir": "^41.0.2",
+    "it-drain": "^3.0.3",
+    "it-pair": "^2.0.6",
+    "it-pushable": "^3.2.1",
+    "it-to-buffer": "^4.0.3",
+    "p-wait-for": "^5.0.2",
+    "protons": "^7.3.0",
+    "sinon": "^17.0.0",
+    "sinon-ts": "^2.0.0"
+  }
+}

package/src/constants.ts

@@ -0,0 +1,79 @@
+const second = 1000
+const minute = 60 * second
+
+/**
+ * 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
+
+/**
+ * Relay HOP relay service namespace for discovery
+ */
+export const RELAY_RENDEZVOUS_NS = '/libp2p/relay'
+
+/**
+ * The maximum number of relay reservations the relay server will accept
+ */
+export const DEFAULT_MAX_RESERVATION_STORE_SIZE = 15
+
+/**
+ * How often to check for reservation expiry
+ */
+export const DEFAULT_MAX_RESERVATION_CLEAR_INTERVAL = 300 * second
+
+/**
+ * How often to check for reservation expiry
+ */
+export const DEFAULT_MAX_RESERVATION_TTL = 2 * 60 * minute
+
+export const DEFAULT_RESERVATION_CONCURRENCY = 1
+
+export const RELAY_SOURCE_TAG = 'circuit-relay-source'
+
+export const RELAY_TAG = 'circuit-relay-relay'
+
+// circuit v2 connection limits
+// https://github.com/libp2p/go-libp2p/blob/master/p2p/protocol/circuitv2/relay/resources.go#L61-L66
+
+// 2 min is the default connection duration
+export const DEFAULT_DURATION_LIMIT = 2 * minute
+
+// 128k is the default data limit
+export const DEFAULT_DATA_LIMIT = BigInt(1 << 17)
+
+/**
+ * The hop protocol
+ */
+export const RELAY_V2_HOP_CODEC = '/libp2p/circuit/relay/0.2.0/hop'
+
+/**
+ * the stop protocol
+ */
+export const RELAY_V2_STOP_CODEC = '/libp2p/circuit/relay/0.2.0/stop'
+
+/**
+ * Hop messages must be exchanged inside this timeout
+ */
+export const DEFAULT_HOP_TIMEOUT = 30 * second
+
+/**
+ * How long to wait before starting to advertise the relay service
+ */
+export const DEFAULT_ADVERT_BOOT_DELAY = 30 * second
+
+export const MAX_CONNECTIONS = 300
+
+export const ERR_NO_ROUTERS_AVAILABLE = 'ERR_NO_ROUTERS_AVAILABLE'
+export const ERR_RELAYED_DIAL = 'ERR_RELAYED_DIAL'
+export const ERR_HOP_REQUEST_FAILED = 'ERR_HOP_REQUEST_FAILED'
+export const ERR_TRANSFER_LIMIT_EXCEEDED = 'ERR_TRANSFER_LIMIT_EXCEEDED'

package/src/index.ts

@@ -0,0 +1,64 @@
+/**
+ * @packageDocumentation
+ *
+ * The `circuitRelayTransport` allows libp2p to dial and listen on [Circuit Relay](https://docs.libp2p.io/concepts/nat/circuit-relay/)
+ * addresses.
+ *
+ * @example
+ *
+ * ```typescript
+ * import { createLibp2p } from 'libp2p'
+ * import { circuitRelayTransport } from '@libp2p/circuit-relay-v2'
+ *
+ * const node = await createLibp2p({
+ *   transports: [
+ *     circuitRelayTransport()
+ *   ]
+ * })
+ * ```
+ *
+ * The `circuitRelayServer` function allows libp2p to function as a [Circuit Relay](https://docs.libp2p.io/concepts/nat/circuit-relay/)
+ * server.  This will not work in browsers.
+ *
+ * @example
+ *
+ * ```typescript
+ * import { createLibp2p } from 'libp2p'
+ * import { circuitRelayServer } from '@libp2p/circuit-relay-v2'
+ *
+ * const node = await createLibp2p({
+ *   services: [
+ *     circuitRelay: circuitRelayServer()
+ *   ]
+ * })
+ * ```
+ */
+
+import type { Limit } from './pb/index.js'
+import type { TypedEventEmitter } from '@libp2p/interface/events'
+import type { PeerMap } from '@libp2p/peer-collections'
+import type { Multiaddr } from '@multiformats/multiaddr'
+
+export interface RelayReservation {
+  expire: Date
+  addr: Multiaddr
+  limit?: Limit
+}
+
+export interface CircuitRelayServiceEvents {
+  'relay:reservation': CustomEvent<RelayReservation>
+  'relay:advert:success': CustomEvent<unknown>
+  'relay:advert:error': CustomEvent<Error>
+}
+
+export interface CircuitRelayService extends TypedEventEmitter<CircuitRelayServiceEvents> {
+  reservations: PeerMap<RelayReservation>
+}
+
+export { circuitRelayServer } from './server/index.js'
+export { circuitRelayTransport } from './transport/index.js'
+
+export {
+  RELAY_V2_HOP_CODEC,
+  RELAY_V2_STOP_CODEC
+} from './constants.js'

package/src/pb/index.proto

@@ -0,0 +1,67 @@
+syntax = "proto3";
+
+message HopMessage {
+  enum Type {
+    RESERVE = 0;
+    CONNECT = 1;
+    STATUS = 2;
+  }
+
+  // the presence of this field is enforced at application level
+  optional Type type = 1;
+
+  optional Peer peer = 2;
+  optional Reservation reservation = 3;
+  optional Limit limit = 4;
+
+  optional Status status = 5;
+}
+
+message StopMessage {
+  enum Type {
+    CONNECT = 0;
+    STATUS = 1;
+  }
+
+  // the presence of this field is enforced at application level
+  optional Type type = 1;
+
+  optional Peer peer = 2;
+  optional Limit limit = 3;
+
+  optional Status status = 4;
+}
+
+message Peer {
+  bytes id = 1;
+  repeated bytes addrs = 2;
+}
+
+message Reservation {
+  uint64 expire = 1; // Unix expiration time (UTC)
+  repeated bytes addrs = 2;   // relay addrs for reserving peer
+  optional bytes voucher = 3; // reservation voucher
+}
+
+message Limit {
+  optional uint32 duration = 1; // seconds
+  optional uint64 data = 2;     // bytes
+}
+
+enum Status {
+  UNUSED = 0;
+  OK                      = 100;
+  RESERVATION_REFUSED     = 200;
+  RESOURCE_LIMIT_EXCEEDED = 201;
+  PERMISSION_DENIED       = 202;
+  CONNECTION_FAILED       = 203;
+  NO_RESERVATION          = 204;
+  MALFORMED_MESSAGE       = 400;
+  UNEXPECTED_MESSAGE      = 401;
+}
+
+message ReservationVoucher {
+  bytes relay = 1;
+  bytes peer = 2;
+  uint64 expiration = 3;
+}