@chainsafe/libp2p-quic/dist/src/index.d.ts

A QUIC transport for libp2p

/**
 * @packageDocumentation
 *
 * A [libp2p transport](https://docs.libp2p.io/concepts/transports/overview/) based on the QUIC networking stack.
 *
 * @example
 *
 * ```TypeScript
 * import { createLibp2p } from 'libp2p'
 * import { quic } from '@chainsafe/libp2p-quic'
 * import { multiaddr } from '@multiformats/multiaddr'
 *
 * const node = await createLibp2p({
 *   transports: [
 *     quic()
 *   ]
 * })
 *
 * const ma = multiaddr('/ip4/123.123.123.123/udp/1234/quic-v1')
 *
 * // dial a TCP connection, timing out after 10 seconds
 * const connection = await node.dial(ma, {
 *   signal: AbortSignal.timeout(10_000)
 * })
 *
 * // use connection...
 * ```
 */
import type * as napi from './napi.js';
import type { ComponentLogger, DialTransportOptions, Metrics, PrivateKey, Transport } from '@libp2p/interface';
export type QuicOptions = Omit<napi.Config, 'privateKeyProto'>;
export interface QuicComponents {
    metrics?: Metrics;
    logger: ComponentLogger;
    privateKey: PrivateKey;
}
export type QuicDialOptions = DialTransportOptions;
export declare function quic(options?: Partial<QuicOptions>): (components: QuicComponents) => Transport;
export declare const defaultOptions: QuicOptions;
//# sourceMappingURL=index.d.ts.map