@libp2p/autonat-v2 0.0.0-2d6079bc1

package/src/index.ts

@@ -0,0 +1,110 @@
+/**
+ * @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.ts'
+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 function autoNATv2 (init: AutoNATv2ServiceInit = {}): (components: AutoNATv2Components) => unknown {
+  return (components) => {
+    return new AutoNATv2Service(components, init)
+  }
+}

package/src/pb/index.proto

@@ -0,0 +1,56 @@
+syntax = "proto3";
+
+message Message {
+    oneof msg {
+        DialRequest dialRequest           = 1;
+        DialResponse dialResponse         = 2;
+        DialDataRequest dialDataRequest   = 3;
+        DialDataResponse dialDataResponse = 4;
+    }
+}
+
+message DialRequest {
+    repeated bytes addrs = 1;
+    fixed64 nonce        = 2;
+}
+
+message DialDataRequest {
+    uint32 addrIdx  = 1;
+    uint64 numBytes = 2;
+}
+
+enum DialStatus {
+    UNUSED            = 0;
+    E_DIAL_ERROR      = 100;
+    E_DIAL_BACK_ERROR = 101;
+    OK                = 200;
+}
+
+message DialResponse {
+    enum ResponseStatus {
+        E_INTERNAL_ERROR   = 0;
+        E_REQUEST_REJECTED = 100;
+        E_DIAL_REFUSED     = 101;
+        OK  = 200;
+    }
+
+    ResponseStatus status = 1;
+    uint32 addrIdx        = 2;
+    DialStatus dialStatus = 3;
+}
+
+message DialDataResponse {
+    bytes data = 1;
+}
+
+message DialBack {
+    fixed64 nonce = 1;
+}
+
+message DialBackResponse {
+    enum DialBackStatus {
+        OK = 0;
+    }
+
+    DialBackStatus status = 1;
+}