fix: require external confirmation of public addresses

packages/interface-internal/src/address-manager/index.ts

@@ -1,5 +1,38 @@
 import type { Multiaddr } from '@multiformats/multiaddr'
 
+/**
+ * The type of address:
+ *
+ * - 'transport' a listen address supplied by a transport
+ * - 'announce' a pre-configured announce address
+ * - 'observed' a peer reported this as a public address
+ * - 'dns-mapping' a DNS address dynamically mapped to one or more public addresses
+ * - 'ip-mapping' an external IP address dynamically mapped to a LAN address
+ */
+export type AddressType = 'transport' | 'announce' | 'observed' | 'dns-mapping' | 'ip-mapping'
+
+/**
+ * An address that has been configured or detected
+ */
+export interface NodeAddress {
+  /**
+   * The multiaddr that represents the address
+   */
+  multiaddr: Multiaddr
+
+  /**
+   * Whether we are confident that this address is externally routable.
+   *
+   * Once confident this address will appear in the output of `getAddresses()`
+   */
+  confident: boolean
+
+  /**
+   * The source of this address
+   */
+  type: AddressType
+}
+
 export interface AddressManager {
   /**
    * Get peer listen multiaddrs
@@ -41,6 +74,11 @@ export interface AddressManager {
    */
   getAddresses(): Multiaddr[]
 
+  /**
+   * Return all addresses we know about with metadata
+   */
+  getAddressesWithMetadata(): NodeAddress[]
+
   /**
    * Adds a mapping between one or more IP addresses and a domain name - when
    * `getAddresses` is invoked, where the IP addresses are present in a