Skip to content

fix: expose config for max inbound/outbound stop streams #1812

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 14, 2023
Merged

fix: expose config for max inbound/outbound stop streams #1812

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions packages/libp2p/src/circuit-relay/transport/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import { streamToMaConnection } from '@libp2p/utils/stream-to-ma-conn'
import * as mafmt from '@multiformats/mafmt'
import { multiaddr } from '@multiformats/multiaddr'
import { pbStream } from 'it-pb-stream'
import { MAX_CONNECTIONS } from '../../connection-manager/constants.js'
import { codes } from '../../errors.js'
import { CIRCUIT_PROTO_CODE, RELAY_V2_HOP_CODEC, RELAY_V2_STOP_CODEC } from '../constants.js'
import { StopMessage, HopMessage, Status } from '../pb/index.js'
Expand Down Expand Up @@ -72,6 +73,23 @@ export interface CircuitRelayTransportInit extends RelayStoreInit {
* connect to. (default: 0)
*/
discoverRelays?: number

/**
* The maximum number of simultaneous STOP inbound streams that can be open at
* once - each inbound relayed connection uses a STOP stream (default: 300)
*/
maxInboundStopStreams?: number

/**
* The maximum number of simultaneous STOP outbound streams that can be open at
* once. STOP streams are opened by the relay server so this setting is
* effectively ignored. (default: 32)
*/
maxOutboundStopStreams?: number
}

const defaults = {
maxInboundStopStreams: MAX_CONNECTIONS
}

class CircuitRelayTransport implements Transport {
Expand All @@ -84,6 +102,8 @@ class CircuitRelayTransport implements Transport {
private readonly addressManager: AddressManager
private readonly connectionGater: ConnectionGater
private readonly reservationStore: ReservationStore
private readonly maxInboundStopStreams: number
private readonly maxOutboundStopStreams?: number
private started: boolean

constructor (components: CircuitRelayTransportComponents, init: CircuitRelayTransportInit) {
Expand All @@ -94,6 +114,8 @@ class CircuitRelayTransport implements Transport {
this.upgrader = components.upgrader
this.addressManager = components.addressManager
this.connectionGater = components.connectionGater
this.maxInboundStopStreams = init.maxInboundStopStreams ?? defaults.maxInboundStopStreams
this.maxOutboundStopStreams = init.maxOutboundStopStreams

if (init.discoverRelays != null && init.discoverRelays > 0) {
this.discovery = new RelayDiscovery(components)
Expand Down Expand Up @@ -128,6 +150,9 @@ class CircuitRelayTransport implements Transport {
void this.onStop(data).catch(err => {
log.error(err)
})
}, {
maxInboundStreams: this.maxInboundStopStreams,
maxOutboundStreams: this.maxOutboundStopStreams
})

this.started = true
Expand Down