@libp2p/autonat-v2 0.0.0-2d6079bc1

package/dist/src/constants.js

@@ -0,0 +1,22 @@
+/**
+ * The prefix to use in the protocol
+ */
+export const PROTOCOL_PREFIX = 'libp2p';
+/**
+ * The name to use in the protocol
+ */
+export const PROTOCOL_NAME = 'autonat';
+/**
+ * The version to use in the protocol
+ */
+export const PROTOCOL_VERSION = '2';
+export const TIMEOUT = 30_000;
+export const MAX_INBOUND_STREAMS = 2;
+export const MAX_OUTBOUND_STREAMS = 20;
+export const DEFAULT_CONNECTION_THRESHOLD = 80;
+export const MAX_MESSAGE_SIZE = 8192;
+export const DIAL_REQUEST = 'dial-request';
+export const DIAL_BACK = 'dial-back';
+export const MAX_DIAL_DATA_BYTES = 200n * 1024n;
+export const DIAL_DATA_CHUNK_SIZE = 4096;
+//# sourceMappingURL=constants.js.map

package/dist/src/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,QAAQ,CAAA;AAEvC;;GAEG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,SAAS,CAAA;AAEtC;;GAEG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,GAAG,CAAA;AACnC,MAAM,CAAC,MAAM,OAAO,GAAG,MAAM,CAAA;AAC7B,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAA;AACpC,MAAM,CAAC,MAAM,oBAAoB,GAAG,EAAE,CAAA;AACtC,MAAM,CAAC,MAAM,4BAA4B,GAAG,EAAE,CAAA;AAC9C,MAAM,CAAC,MAAM,gBAAgB,GAAG,IAAI,CAAA;AAEpC,MAAM,CAAC,MAAM,YAAY,GAAG,cAAc,CAAA;AAC1C,MAAM,CAAC,MAAM,SAAS,GAAG,WAAW,CAAA;AACpC,MAAM,CAAC,MAAM,mBAAmB,GAAG,IAAI,GAAG,KAAK,CAAA;AAC/C,MAAM,CAAC,MAAM,oBAAoB,GAAG,IAAI,CAAA"}

package/dist/src/index.d.ts

@@ -0,0 +1,93 @@
+/**
+ * @packageDocumentation
+ *
+ * The AutoNATv2 service implements the [AutoNAT v2 protocol](https://github.com/libp2p/specs/blob/master/autonat/autonat-v2.md)
+ * to confirm whether addresses the node is listening on are dialable by remote
+ * peers.
+ *
+ * It does not implement NAT hole punching.
+ *
+ * @example
+ *
+ * ```typescript
+ * import { createLibp2p } from 'libp2p'
+ * import { autoNATv2 } from '@libp2p/autonat-v2'
+ *
+ * const node = await createLibp2p({
+ *   // ...other options
+ *   services: {
+ *     autoNAT: autoNATv2()
+ *   }
+ * })
+ * ```
+ */
+import type { ComponentLogger, Metrics, PeerStore } from '@libp2p/interface';
+import type { AddressManager, ConnectionManager, RandomWalk, Registrar } from '@libp2p/interface-internal';
+export interface AutoNATv2ServiceInit {
+    /**
+     * Allows overriding the protocol prefix used
+     */
+    protocolPrefix?: string;
+    /**
+     * How long we should wait for a remote peer to verify our external address
+     */
+    timeout?: number;
+    /**
+     * How long to wait after startup before trying to verify our external address
+     */
+    startupDelay?: number;
+    /**
+     * Verify our external addresses this often
+     */
+    refreshInterval?: number;
+    /**
+     * How many parallel inbound autoNAT streams we allow per-connection
+     */
+    maxInboundStreams?: number;
+    /**
+     * How many parallel outbound autoNAT streams we allow per-connection
+     */
+    maxOutboundStreams?: number;
+    /**
+     * If the number of currently open connections is higher than this value as
+     * a percentage of the maximum number of allowed connections, automatically
+     * reverify previously verified addresses since auto nat peers may find it
+     * hard to dial and will report that the address is not dialable leading this
+     * node to delist it.
+     *
+     * @default 80
+     */
+    connectionThreshold?: number;
+    /**
+     * How large incoming autonat messages are allowed to be in bytes. If messages
+     * larger than this are received the stream will be reset.
+     *
+     * @default 8192
+     */
+    maxMessageSize?: number;
+    /**
+     * When asked to send data as part of the amplification attack protection,
+     * refuse to send more than this amount of data.
+     *
+     * @default 200_000n
+     */
+    maxDialDataBytes?: bigint;
+    /**
+     * When asked to send data as part of the amplification attack protection,
+     * send data in with this size chunks
+     *
+     * @default 4096
+     */
+    dialDataChunkSize?: number;
+}
+export interface AutoNATv2Components {
+    registrar: Registrar;
+    addressManager: AddressManager;
+    connectionManager: ConnectionManager;
+    logger: ComponentLogger;
+    randomWalk: RandomWalk;
+    peerStore: PeerStore;
+    metrics?: Metrics;
+}
+export declare function autoNATv2(init?: AutoNATv2ServiceInit): (components: AutoNATv2Components) => unknown;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAGH,OAAO,KAAK,EAAE,eAAe,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAC5E,OAAO,KAAK,EAAE,cAAc,EAAE,iBAAiB,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAA;AAE1G,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;IAEvB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;IAExB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAE1B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAE3B;;;;;;;;OAQG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAE5B;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;IAEvB;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IAEzB;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAA;CAC3B;AAED,MAAM,WAAW,mBAAmB;IAClC,SAAS,EAAE,SAAS,CAAA;IACpB,cAAc,EAAE,cAAc,CAAA;IAC9B,iBAAiB,EAAE,iBAAiB,CAAA;IACpC,MAAM,EAAE,eAAe,CAAA;IACvB,UAAU,EAAE,UAAU,CAAA;IACtB,SAAS,EAAE,SAAS,CAAA;IACpB,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB;AAED,wBAAgB,SAAS,CAAE,IAAI,GAAE,oBAAyB,GAAG,CAAC,UAAU,EAAE,mBAAmB,KAAK,OAAO,CAIxG"}

package/dist/src/index.js

@@ -0,0 +1,30 @@
+/**
+ * @packageDocumentation
+ *
+ * The AutoNATv2 service implements the [AutoNAT v2 protocol](https://github.com/libp2p/specs/blob/master/autonat/autonat-v2.md)
+ * to confirm whether addresses the node is listening on are dialable by remote
+ * peers.
+ *
+ * It does not implement NAT hole punching.
+ *
+ * @example
+ *
+ * ```typescript
+ * import { createLibp2p } from 'libp2p'
+ * import { autoNATv2 } from '@libp2p/autonat-v2'
+ *
+ * const node = await createLibp2p({
+ *   // ...other options
+ *   services: {
+ *     autoNAT: autoNATv2()
+ *   }
+ * })
+ * ```
+ */
+import { AutoNATv2Service } from "./autonat.js";
+export function autoNATv2(init = {}) {
+    return (components) => {
+        return new AutoNATv2Service(components, init);
+    };
+}
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAA;AAiF/C,MAAM,UAAU,SAAS,CAAE,OAA6B,EAAE;IACxD,OAAO,CAAC,UAAU,EAAE,EAAE;QACpB,OAAO,IAAI,gBAAgB,CAAC,UAAU,EAAE,IAAI,CAAC,CAAA;IAC/C,CAAC,CAAA;AACH,CAAC"}

package/dist/src/pb/index.d.ts

@@ -0,0 +1,90 @@
+import type { Codec, DecodeOptions } from 'protons-runtime';
+import type { Uint8ArrayList } from 'uint8arraylist';
+export interface Message {
+    dialRequest?: DialRequest;
+    dialResponse?: DialResponse;
+    dialDataRequest?: DialDataRequest;
+    dialDataResponse?: DialDataResponse;
+}
+export declare namespace Message {
+    const codec: () => Codec<Message>;
+    const encode: (obj: Partial<Message>) => Uint8Array;
+    const decode: (buf: Uint8Array | Uint8ArrayList, opts?: DecodeOptions<Message>) => Message;
+}
+export interface DialRequest {
+    addrs: Uint8Array[];
+    nonce: bigint;
+}
+export declare namespace DialRequest {
+    const codec: () => Codec<DialRequest>;
+    const encode: (obj: Partial<DialRequest>) => Uint8Array;
+    const decode: (buf: Uint8Array | Uint8ArrayList, opts?: DecodeOptions<DialRequest>) => DialRequest;
+}
+export interface DialDataRequest {
+    addrIdx: number;
+    numBytes: bigint;
+}
+export declare namespace DialDataRequest {
+    const codec: () => Codec<DialDataRequest>;
+    const encode: (obj: Partial<DialDataRequest>) => Uint8Array;
+    const decode: (buf: Uint8Array | Uint8ArrayList, opts?: DecodeOptions<DialDataRequest>) => DialDataRequest;
+}
+export declare enum DialStatus {
+    UNUSED = "UNUSED",
+    E_DIAL_ERROR = "E_DIAL_ERROR",
+    E_DIAL_BACK_ERROR = "E_DIAL_BACK_ERROR",
+    OK = "OK"
+}
+export declare namespace DialStatus {
+    const codec: () => Codec<DialStatus>;
+}
+export interface DialResponse {
+    status: DialResponse.ResponseStatus;
+    addrIdx: number;
+    dialStatus: DialStatus;
+}
+export declare namespace DialResponse {
+    enum ResponseStatus {
+        E_INTERNAL_ERROR = "E_INTERNAL_ERROR",
+        E_REQUEST_REJECTED = "E_REQUEST_REJECTED",
+        E_DIAL_REFUSED = "E_DIAL_REFUSED",
+        OK = "OK"
+    }
+    namespace ResponseStatus {
+        const codec: () => Codec<ResponseStatus>;
+    }
+    const codec: () => Codec<DialResponse>;
+    const encode: (obj: Partial<DialResponse>) => Uint8Array;
+    const decode: (buf: Uint8Array | Uint8ArrayList, opts?: DecodeOptions<DialResponse>) => DialResponse;
+}
+export interface DialDataResponse {
+    data: Uint8Array;
+}
+export declare namespace DialDataResponse {
+    const codec: () => Codec<DialDataResponse>;
+    const encode: (obj: Partial<DialDataResponse>) => Uint8Array;
+    const decode: (buf: Uint8Array | Uint8ArrayList, opts?: DecodeOptions<DialDataResponse>) => DialDataResponse;
+}
+export interface DialBack {
+    nonce: bigint;
+}
+export declare namespace DialBack {
+    const codec: () => Codec<DialBack>;
+    const encode: (obj: Partial<DialBack>) => Uint8Array;
+    const decode: (buf: Uint8Array | Uint8ArrayList, opts?: DecodeOptions<DialBack>) => DialBack;
+}
+export interface DialBackResponse {
+    status: DialBackResponse.DialBackStatus;
+}
+export declare namespace DialBackResponse {
+    enum DialBackStatus {
+        OK = "OK"
+    }
+    namespace DialBackStatus {
+        const codec: () => Codec<DialBackStatus>;
+    }
+    const codec: () => Codec<DialBackResponse>;
+    const encode: (obj: Partial<DialBackResponse>) => Uint8Array;
+    const decode: (buf: Uint8Array | Uint8ArrayList, opts?: DecodeOptions<DialBackResponse>) => DialBackResponse;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/src/pb/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/pb/index.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC3D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAEpD,MAAM,WAAW,OAAO;IACtB,WAAW,CAAC,EAAE,WAAW,CAAA;IACzB,YAAY,CAAC,EAAE,YAAY,CAAA;IAC3B,eAAe,CAAC,EAAE,eAAe,CAAA;IACjC,gBAAgB,CAAC,EAAE,gBAAgB,CAAA;CACpC;AAED,yBAAiB,OAAO,CAAC;IAGhB,MAAM,KAAK,QAAO,KAAK,CAAC,OAAO,CA6HrC,CAAA;IAEM,MAAM,MAAM,GAAI,KAAK,OAAO,CAAC,OAAO,CAAC,KAAG,UAE9C,CAAA;IAEM,MAAM,MAAM,GAAI,KAAK,UAAU,GAAG,cAAc,EAAE,OAAO,aAAa,CAAC,OAAO,CAAC,KAAG,OAExF,CAAA;CACF;AAED,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,UAAU,EAAE,CAAA;IACnB,KAAK,EAAE,MAAM,CAAA;CACd;AAED,yBAAiB,WAAW,CAAC;IAGpB,MAAM,KAAK,QAAO,KAAK,CAAC,WAAW,CA0DzC,CAAA;IAEM,MAAM,MAAM,GAAI,KAAK,OAAO,CAAC,WAAW,CAAC,KAAG,UAElD,CAAA;IAEM,MAAM,MAAM,GAAI,KAAK,UAAU,GAAG,cAAc,EAAE,OAAO,aAAa,CAAC,WAAW,CAAC,KAAG,WAE5F,CAAA;CACF;AAED,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED,yBAAiB,eAAe,CAAC;IAGxB,MAAM,KAAK,QAAO,KAAK,CAAC,eAAe,CAoD7C,CAAA;IAEM,MAAM,MAAM,GAAI,KAAK,OAAO,CAAC,eAAe,CAAC,KAAG,UAEtD,CAAA;IAEM,MAAM,MAAM,GAAI,KAAK,UAAU,GAAG,cAAc,EAAE,OAAO,aAAa,CAAC,eAAe,CAAC,KAAG,eAEhG,CAAA;CACF;AAED,oBAAY,UAAU;IACpB,MAAM,WAAW;IACjB,YAAY,iBAAiB;IAC7B,iBAAiB,sBAAsB;IACvC,EAAE,OAAO;CACV;AASD,yBAAiB,UAAU,CAAC;IACnB,MAAM,KAAK,QAAO,KAAK,CAAC,UAAU,CAExC,CAAA;CACF;AAED,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,YAAY,CAAC,cAAc,CAAA;IACnC,OAAO,EAAE,MAAM,CAAA;IACf,UAAU,EAAE,UAAU,CAAA;CACvB;AAED,yBAAiB,YAAY,CAAC;IAC5B,KAAY,cAAc;QACxB,gBAAgB,qBAAqB;QACrC,kBAAkB,uBAAuB;QACzC,cAAc,mBAAmB;QACjC,EAAE,OAAO;KACV;IASD,UAAiB,cAAc,CAAC;QACvB,MAAM,KAAK,QAAO,KAAK,CAAC,cAAc,CAE5C,CAAA;KACF;IAIM,MAAM,KAAK,QAAO,KAAK,CAAC,YAAY,CA8D1C,CAAA;IAEM,MAAM,MAAM,GAAI,KAAK,OAAO,CAAC,YAAY,CAAC,KAAG,UAEnD,CAAA;IAEM,MAAM,MAAM,GAAI,KAAK,UAAU,GAAG,cAAc,EAAE,OAAO,aAAa,CAAC,YAAY,CAAC,KAAG,YAE7F,CAAA;CACF;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,UAAU,CAAA;CACjB;AAED,yBAAiB,gBAAgB,CAAC;IAGzB,MAAM,KAAK,QAAO,KAAK,CAAC,gBAAgB,CA0C9C,CAAA;IAEM,MAAM,MAAM,GAAI,KAAK,OAAO,CAAC,gBAAgB,CAAC,KAAG,UAEvD,CAAA;IAEM,MAAM,MAAM,GAAI,KAAK,UAAU,GAAG,cAAc,EAAE,OAAO,aAAa,CAAC,gBAAgB,CAAC,KAAG,gBAEjG,CAAA;CACF;AAED,MAAM,WAAW,QAAQ;IACvB,KAAK,EAAE,MAAM,CAAA;CACd;AAED,yBAAiB,QAAQ,CAAC;IAGjB,MAAM,KAAK,QAAO,KAAK,CAAC,QAAQ,CA0CtC,CAAA;IAEM,MAAM,MAAM,GAAI,KAAK,OAAO,CAAC,QAAQ,CAAC,KAAG,UAE/C,CAAA;IAEM,MAAM,MAAM,GAAI,KAAK,UAAU,GAAG,cAAc,EAAE,OAAO,aAAa,CAAC,QAAQ,CAAC,KAAG,QAEzF,CAAA;CACF;AAED,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,gBAAgB,CAAC,cAAc,CAAA;CACxC;AAED,yBAAiB,gBAAgB,CAAC;IAChC,KAAY,cAAc;QACxB,EAAE,OAAO;KACV;IAMD,UAAiB,cAAc,CAAC;QACvB,MAAM,KAAK,QAAO,KAAK,CAAC,cAAc,CAE5C,CAAA;KACF;IAIM,MAAM,KAAK,QAAO,KAAK,CAAC,gBAAgB,CA0C9C,CAAA;IAEM,MAAM,MAAM,GAAI,KAAK,OAAO,CAAC,gBAAgB,CAAC,KAAG,UAEvD,CAAA;IAEM,MAAM,MAAM,GAAI,KAAK,UAAU,GAAG,cAAc,EAAE,OAAO,aAAa,CAAC,gBAAgB,CAAC,KAAG,gBAEjG,CAAA;CACF"}