⚡️ 0.31 RELEASE 🚀

[vasco-santos]

libp2p configuration with types

🔦 Highlights

This releases expands the surface of libp2p with type definitions to also include its configuration. Accordingly, most of the libp2p touch points with TS developers are now covered with types and we will be adding them to the libp2p modules over time.

New typed multiaddr@9.0.x rolled up across all libp2p modules, buffer update to buffer@6.0.0. Several other libp2p dependencies have been removed or switched, in order to both decrease the bundle size of libp2p and better support for JS bundlers.

This also includes several bug fixes that were causing extra dials attempts (AddressBook events and Dialer filtering), as well as webrtc support for multiple listeners.

🏗 API Changes

Migration guide

✅ Release Checklist

• Robustness and quality
  • Ensure that all tests are passing, this includes:
    • unit
  • Publish a release candidate to npm

    # Minor prerelease (e.g. 0.24.1 -> 0.25.0-rc.0)
    $ npx aegir release --type preminor -t node -t browser --preid rc --dist-tag next
    
    # Increment prerelease (e.g. 0.25.0-rc.0 -> 0.25.0-rc.1)
    $ npx aegir release --type prerelease -t node -t browser --preid rc --dist-tag next

  • Run tests of the following projects with the new release:
    • js-ipfs
• Documentation
  • Ensure that README.md is up to date
  • Ensure that all the examples run
  • Ensure libp2p/js-libp2p-examples is updated
  • Ensure that libp2p/docs is updated
• Communication
  • Create the release issue
  • Take a snapshot between of everyone that has contributed to this release (including its subdeps in IPFS, libp2p, IPLD and multiformats) using name-your-contributors. Generate a nice markdown list with this script
  • Announcements (both pre-release and post-release)
    • Twitter
    • IRC
    • Reddit
    • discuss.libp2p.io
  • Blog post
  • Copy release notes to the GitHub Release description

❤️ Huge thank you to everyone that made this release possible

In alphabetical order, here are all the humans that contributed to the release:

• ...

🙌🏽 Want to contribute?

Would you like to contribute to the libp2p project and don't know how? Well, there are a few places you can get started:

• Check the issues with the help wanted label in the libp2p repo
• Join an IPFS All Hands, introduce yourself and let us know where you would like to contribute - https://github.com/ipfs/team-mgmt#all-hands-call
• Hack with IPFS and show us what you made! The All Hands call is also the perfect venue for demos, join in and show us what you built
• Join the discussion at http://discuss.libp2p.io/ and help users finding their answers.
• Join the ⚡️libp2p Weekly Sync 🙌🏽 and be part of the Sprint action!

⁉️ Do you have questions?

The best place to ask your questions about libp2p, how it works and what you can do with it is at discuss.libp2p.io. We are also available at the #libp2p channel on Freenode.

[vasco-santos]

This will solve:

• TypeError: TextDecoder is not a constructor when handling multiaddresses in browser #909
• UnhandledPromiseRejectionWarning related to StreamHandler #679

Unblocks:

• chore: add migration guide to 0.31 #912
• chore: update deps and remove protons ChainSafe/js-libp2p-gossipsub#153
• chore: update deps js-libp2p-kad-dht#217
• chore: update libp2p 0.31 js-libp2p-examples#37
• chore: update libp2p 0.31 js-libp2p-daemon#46