@libp2p/interface-internal 0.0.1-6fdaa7dc

package/dist/src/transport-manager/index.d.ts

@@ -0,0 +1,15 @@
+import type { Connection } from '@libp2p/interface/connection';
+import type { Listener, Transport } from '@libp2p/interface/transport';
+import type { Multiaddr } from '@multiformats/multiaddr';
+export interface TransportManager {
+    add: (transport: Transport) => void;
+    dial: (ma: Multiaddr, options?: any) => Promise<Connection>;
+    getAddrs: () => Multiaddr[];
+    getTransports: () => Transport[];
+    getListeners: () => Listener[];
+    transportForMultiaddr: (ma: Multiaddr) => Transport | undefined;
+    listen: (addrs: Multiaddr[]) => Promise<void>;
+    remove: (key: string) => Promise<void>;
+    removeAll: () => Promise<void>;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/src/transport-manager/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/transport-manager/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAA;AAC9D,OAAO,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAA;AACtE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AAExD,MAAM,WAAW,gBAAgB;IAC/B,GAAG,EAAE,CAAC,SAAS,EAAE,SAAS,KAAK,IAAI,CAAA;IACnC,IAAI,EAAE,CAAC,EAAE,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,GAAG,KAAK,OAAO,CAAC,UAAU,CAAC,CAAA;IAC3D,QAAQ,EAAE,MAAM,SAAS,EAAE,CAAA;IAC3B,aAAa,EAAE,MAAM,SAAS,EAAE,CAAA;IAChC,YAAY,EAAE,MAAM,QAAQ,EAAE,CAAA;IAC9B,qBAAqB,EAAE,CAAC,EAAE,EAAE,SAAS,KAAK,SAAS,GAAG,SAAS,CAAA;IAC/D,MAAM,EAAE,CAAC,KAAK,EAAE,SAAS,EAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IAC7C,MAAM,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IACtC,SAAS,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;CAC/B"}

package/dist/src/transport-manager/index.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.js.map

package/dist/src/transport-manager/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/transport-manager/index.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,18 @@
+import type { Connection, MultiaddrConnection } from '@libp2p/interface/connection';
+import type { StreamMuxerFactory } from '@libp2p/interface/stream-muxer';
+export interface UpgraderOptions {
+    skipEncryption?: boolean;
+    skipProtection?: boolean;
+    muxerFactory?: StreamMuxerFactory;
+}
+export interface Upgrader {
+    /**
+     * Upgrades an outbound connection on `transport.dial`.
+     */
+    upgradeOutbound: (maConn: MultiaddrConnection, opts?: UpgraderOptions) => Promise<Connection>;
+    /**
+     * Upgrades an inbound connection on transport listener.
+     */
+    upgradeInbound: (maConn: MultiaddrConnection, opts?: UpgraderOptions) => Promise<Connection>;
+}
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/upgrader/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAA;AACnF,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAA;AAExE,MAAM,WAAW,eAAe;IAC9B,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,YAAY,CAAC,EAAE,kBAAkB,CAAA;CAClC;AAED,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,eAAe,EAAE,CAAC,MAAM,EAAE,mBAAmB,EAAE,IAAI,CAAC,EAAE,eAAe,KAAK,OAAO,CAAC,UAAU,CAAC,CAAA;IAE7F;;OAEG;IACH,cAAc,EAAE,CAAC,MAAM,EAAE,mBAAmB,EAAE,IAAI,CAAC,EAAE,eAAe,KAAK,OAAO,CAAC,UAAU,CAAC,CAAA;CAC7F"}

package/dist/src/upgrader/index.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.js.map

package/dist/src/upgrader/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/upgrader/index.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,96 @@
+{
+  "name": "@libp2p/interface-internal",
+  "version": "0.0.1-6fdaa7dc",
+  "description": "Interfaces implemented by internal libp2p components",
+  "license": "Apache-2.0 OR MIT",
+  "homepage": "https://github.com/libp2p/js-libp2p/tree/master/packages/interface-internal#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/libp2p/js-libp2p.git"
+  },
+  "bugs": {
+    "url": "https://github.com/libp2p/js-libp2p/issues"
+  },
+  "keywords": [
+    "interface",
+    "libp2p"
+  ],
+  "type": "module",
+  "types": "./dist/src/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "*": [
+        "*",
+        "dist/*",
+        "dist/src/*",
+        "dist/src/*/index"
+      ],
+      "src/*": [
+        "*",
+        "dist/*",
+        "dist/src/*",
+        "dist/src/*/index"
+      ]
+    }
+  },
+  "files": [
+    "src",
+    "dist",
+    "!dist/test",
+    "!**/*.tsbuildinfo"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/src/index.d.ts",
+      "import": "./dist/src/index.js"
+    },
+    "./address-manager": {
+      "types": "./dist/src/address-manager/index.d.ts",
+      "import": "./dist/src/address-manager/index.js"
+    },
+    "./connection-manager": {
+      "types": "./dist/src/connection-manager/index.d.ts",
+      "import": "./dist/src/connection-manager/index.js"
+    },
+    "./record": {
+      "types": "./dist/src/record/index.d.ts",
+      "import": "./dist/src/record/index.js"
+    },
+    "./registrar": {
+      "types": "./dist/src/registrar/index.d.ts",
+      "import": "./dist/src/registrar/index.js"
+    },
+    "./transport": {
+      "types": "./dist/src/transport/index.d.ts",
+      "import": "./dist/src/transport/index.js"
+    },
+    "./transport-manager": {
+      "types": "./dist/src/transport-manager/index.d.ts",
+      "import": "./dist/src/transport-manager/index.js"
+    }
+  },
+  "eslintConfig": {
+    "extends": "ipfs",
+    "parserOptions": {
+      "sourceType": "module"
+    }
+  },
+  "scripts": {
+    "clean": "aegir clean",
+    "lint": "aegir lint",
+    "dep-check": "aegir dep-check",
+    "build": "aegir build"
+  },
+  "dependencies": {
+    "@libp2p/interface": "0.0.1-6fdaa7dc",
+    "@libp2p/peer-collections": "3.0.2-6fdaa7dc",
+    "@multiformats/multiaddr": "^12.1.3",
+    "uint8arraylist": "^2.4.3"
+  },
+  "devDependencies": {
+    "aegir": "^39.0.10"
+  },
+  "typedoc": {
+    "entryPoint": "./src/index.ts"
+  }
+}

package/src/address-manager/index.ts

@@ -0,0 +1,43 @@
+import type { Multiaddr } from '@multiformats/multiaddr'
+
+export interface AddressManager {
+  /**
+   * Get peer listen multiaddrs
+   */
+  getListenAddrs: () => Multiaddr[]
+
+  /**
+   * Get peer announcing multiaddrs
+   */
+  getAnnounceAddrs: () => Multiaddr[]
+
+  /**
+   * Get observed multiaddrs - these addresses may not have been confirmed as
+   * publicly dialable yet
+   */
+  getObservedAddrs: () => Multiaddr[]
+
+  /**
+   * Signal that we have confidence an observed multiaddr is publicly dialable -
+   * this will make it appear in the output of getAddresses()
+   */
+  confirmObservedAddr: (addr: Multiaddr) => void
+
+  /**
+   * Signal that we do not have confidence an observed multiaddr is publicly dialable -
+   * this will remove it from the output of getObservedAddrs()
+   */
+  removeObservedAddr: (addr: Multiaddr) => void
+
+  /**
+   * Add peer observed addresses.  These will then appear in the output of getObservedAddrs
+   * but not getAddresses() until their dialability has been confirmed via a call to
+   * confirmObservedAddr.
+   */
+  addObservedAddr: (addr: Multiaddr) => void
+
+  /**
+   * Get the current node's addresses
+   */
+  getAddresses: () => Multiaddr[]
+}

package/src/connection-manager/index.ts

@@ -0,0 +1,79 @@
+import type { AbortOptions } from '@libp2p/interface'
+import type { Connection, MultiaddrConnection } from '@libp2p/interface/connection'
+import type { PeerId } from '@libp2p/interface/peer-id'
+import type { PeerMap } from '@libp2p/peer-collections'
+import type { Multiaddr } from '@multiformats/multiaddr'
+
+export type PendingDialStatus = 'queued' | 'active' | 'error' | 'success'
+
+export interface PendingDial {
+  id: string
+  status: PendingDialStatus
+  peerId?: PeerId
+  multiaddrs: Multiaddr[]
+}
+
+export interface ConnectionManager {
+  /**
+   * Return connections, optionally filtering by a PeerId
+   *
+   * @example
+   *
+   * ```js
+   * const connections = libp2p.connectionManager.get(peerId)
+   * // []
+   * ```
+   */
+  getConnections: (peerId?: PeerId) => Connection[]
+
+  /**
+   * Return a map of all connections with their associated PeerIds
+   *
+   * @example
+   *
+   * ```js
+   * const connectionsMap = libp2p.connectionManager.getConnectionsMap()
+   * ```
+   */
+  getConnectionsMap: () => PeerMap<Connection[]>
+
+  /**
+   * Open a connection to a remote peer
+   *
+   * @example
+   *
+   * ```js
+   * const connection = await libp2p.connectionManager.openConnection(peerId)
+   * ```
+   */
+  openConnection: (peer: PeerId | Multiaddr | Multiaddr[], options?: AbortOptions) => Promise<Connection>
+
+  /**
+   * Close our connections to a peer
+   */
+  closeConnections: (peer: PeerId) => Promise<void>
+
+  /**
+   * Invoked after an incoming connection is opened but before PeerIds are
+   * exchanged, this lets the ConnectionManager check we have sufficient
+   * resources to accept the connection in which case it will return true,
+   * otherwise it will return false.
+   */
+  acceptIncomingConnection: (maConn: MultiaddrConnection) => Promise<boolean>
+
+  /**
+   * Invoked after upgrading a multiaddr connection has finished
+   */
+  afterUpgradeInbound: () => void
+
+  /**
+   * Return the list of in-progress or queued dials
+   *
+   * @example
+   *
+   * ```js
+   * const dials = libp2p.connectionManager.getDialQueue()
+   * ```
+   */
+  getDialQueue: () => PendingDial[]
+}