feat: convert to typescript

[achingbrain]

Converts this module to typescript.

• Ecosystem modules renamed from (e.g.) libp2p-tcp to @libp2p/tcp
• Ecosystem module now have named exports
• Configuration has been updated, now pass instances of modules instead of classes:
• Some configuration keys have been renamed to make them more descriptive. transport -> transports, connEncryption -> connectionEncryption. In general where we pass multiple things, the key is now plural, e.g. streamMuxer -> streamMuxers, contentRouting -> contentRouters, etc. Where we are configuring a singleton the config key is singular, e.g. connProtector -> connectionProtector etc.
• Properties of the modules config key have been moved to the root
• Properties of the config config key have been moved to the root

// before
import Libp2p from 'libp2p'
import TCP from 'libp2p-tcp'

await Libp2p.create({
  modules: {
    transport: [
      TCP
    ],
  }
  config: {
    transport: {
      [TCP.tag]: {
        foo: 'bar'
      }
    },
    relay: {
      enabled: true,
      hop: {
        enabled: true,
        active: true
      }
    }
  }
})

// after
import { createLibp2p } from 'libp2p'
import { TCP } from '@libp2p/tcp'

await createLibp2p({
  transports: [
    new TCP({ foo: 'bar' })
  ],
  relay: {
    enabled: true,
    hop: {
      enabled: true,
      active: true
    }
  }
})

• Use of enabled flag has been reduced - previously you could pass a module but disable it with config. Now if you don't want a feature, just don't pass an implementation. Eg:

// before
await Libp2p.create({
  modules: {
    transport: [
      TCP
    ],
    pubsub: Gossipsub
  },
  config: {
    pubsub: {
      enabled: false
    }
  }
})

// after
await createLibp2p({
  transports: [
    new TCP()
  ]
})

• .multiaddrs renamed to .getMultiaddrs() because it's not a property accessor, work is done by that method to calculate announce addresses, observed addresses, etc
• /p2p/${peerId} is now appended to all addresses returned by .getMultiaddrs() so they can be used opaquely (every consumer has to append the peer ID to the address to actually use it otherwise). If you need low-level unadulterated addresses, call methods on the address manager.

BREAKING CHANGE: types are no longer hand crafted, this module is now ESM only

[BigLep]

2022-03-22 conversation for someone reviewing this code:

1. Check it out
2. See if can integrate it with another project.

[mpetrunic]

How come you put Partial here?

Shouldn't we enforce that whoever adds a new module must put defaults here? Maybe even create some type which would make everything mandatory here 😄

[achingbrain]

Without Partial is becomes necessary to define things things like .peerId and .datastore that aren't simple values.

[mpetrunic]

Suggested change

	const DefaultConfig: Partial<Libp2pInit> = {
	const DefaultConfig: Required<Omit<Libp2pInit, "peer" | "datastore">> & Libp2pInit = {

would probably do the trick but I don't have a strong preference, it might end up being too hard to maintain what to keep optional.

[achingbrain]

Yeah, it starts getting a bit fiddly like this, maybe let's look at it again later.

[wemeetagain]

Update LGTM. Some small comments regarding code snippets in docs. We should consider adding something like https://github.com/bbc/typescript-docs-verifier to the CI pipeline.

[wemeetagain]

I think this doesn't work anymore, same below where classes are used instead of instances.

[wemeetagain]

invalid syntax

[wemeetagain]

syntax error

[wemeetagain]

syntax

[achingbrain]

@wemeetagain thanks for your review - I've addressed the points in #1182

bbc/typescript-docs-verifier - this looks really useful, I didn't know it existed. Would you like to give adding it to CI a go?

[wemeetagain]

Ok, I'll open a PR