Class Endpoint

An iroh endpoint.

Constructors

constructor

new Endpoint(): Endpoint

Returns Endpoint

Methods

acceptNext

acceptNext(): Promise<Incoming>
Pull the next incoming connection attempt.

Returns Promise<Incoming>
- Defined in index.d.ts:88

addExternalAddr

addExternalAddr(addr: string): Promise<void>
Add an external (manually-known) socket address.
Parameters
- addr: string
Returns Promise<void>
- Defined in index.d.ts:72

addr

addr(): EndpointAddr
The [EndpointAddr] for this endpoint.

Returns EndpointAddr
- Defined in index.d.ts:62

boundSockets

boundSockets(): string[]
The local socket addresses this endpoint is bound to.

Returns string[]
- Defined in index.d.ts:76

close

close(): Promise<void>
Close the endpoint.

Returns Promise<void>
- Defined in index.d.ts:96

connect

connect(addr: EndpointAddr, alpn: number[]): Promise<Connection>
Connect to a remote endpoint via the given ALPN.
Parameters
- addr: EndpointAddr
- alpn: number[]
Returns Promise<Connection>
- Defined in index.d.ts:84

connectPending

connectPending(addr: EndpointAddr, alpn: number[]): Promise<Connecting>
Begin a connection attempt, returning the in-progress handle.
Parameters
- addr: EndpointAddr
- alpn: number[]
Returns Promise<Connecting>
- Defined in index.d.ts:86

id

id(): EndpointId
This endpoint's id.

Returns EndpointId
- Defined in index.d.ts:60

insertRelay

insertRelay(config: RelayConfig): Promise<void>
Insert (or replace) a relay configuration at runtime.
Parameters
- config: RelayConfig
Returns Promise<void>
- Defined in index.d.ts:80

isClosed

isClosed(): boolean
True if the endpoint is closed.

Returns boolean
- Defined in index.d.ts:98

online

online(): Promise<void>
Resolves once the endpoint has a usable home relay.

Returns Promise<void>
- Defined in index.d.ts:78

remoteAddr

remoteAddr(id: EndpointId): Promise<EndpointAddr>
Look up cached information about a remote endpoint, if any.
Parameters
- id: EndpointId
Returns Promise<EndpointAddr>
- Defined in index.d.ts:64

removeExternalAddr

removeExternalAddr(addr: string): Promise<boolean>
Remove a previously-added external address.
Parameters
- addr: string
Returns Promise<boolean>
- Defined in index.d.ts:74

removeRelay

removeRelay(url: string): Promise<boolean>
Remove a relay configuration at runtime.
Parameters
- url: string
Returns Promise<boolean>
- Defined in index.d.ts:82

secretKey

secretKey(): SecretKey
The secret key backing this endpoint's identity.

Returns SecretKey
- Defined in index.d.ts:68

setAlpns

setAlpns(alpns: number[][]): void
Replace the set of advertised ALPNs.
Parameters
- alpns: number[][]
Returns void
- Defined in index.d.ts:70

stats

stats(): Record<string, CounterStats>
Current statistics for this endpoint.

Returns Record<string, CounterStats>
- Defined in index.d.ts:66

watchAddr

watchAddr(callback: (addr: EndpointAddr) => void): WatchHandle
Watch for changes to this endpoint's address.
Parameters
- callback: (addr: EndpointAddr) => void
Returns WatchHandle
- Defined in index.d.ts:90

watchHomeRelay

watchHomeRelay(callback: (relayUrls: string[]) => void): WatchHandle
Watch for changes to the connected relays.
Parameters
- callback: (relayUrls: string[]) => void
Returns WatchHandle
- Defined in index.d.ts:92

watchNetworkChange

watchNetworkChange(callback: () => void): WatchHandle
Watch for network-stack changes.
Parameters
- callback: () => void
Returns WatchHandle
- Defined in index.d.ts:94

`Static`bind

bind(options?: EndpointOptions, relayMode?: RelayMode): Promise<Endpoint>
Bind a new endpoint. Applies the n0 preset, then the given options. For a custom preset use [Endpoint::builder].
Parameters
- Optionaloptions: EndpointOptions
- OptionalrelayMode: RelayMode
Returns Promise<Endpoint>
- Defined in index.d.ts:58

`Static`builder

builder(): EndpointBuilder
Create an endpoint builder (starts empty — apply a preset).

Returns EndpointBuilder
- Defined in index.d.ts:53