js-ipfs

IPFS JavaScript implementation entry point and roadmap

Description

This repo will contain the entry point for the JavaScript implementation of IPFS spec, similar to go-ipfs. Right now, it holds the roadmap for the development of modules for js-ipfs, as well as their current state.

We are building js-ipfs because it will inform how go-ipfs works, separate concerns, and allow a complete in-browser-tab implementation with no install friction. Most of the work for IPFS does happen elsewhere, but this is an equally important part of our roadmap to lead to a permanent, IPFSed web.

Contribute

IPFS implementation in JavaScript is a work in progress. As such, there's a few things you can do right now to help out:

• Go through the modules below and check out existing issues. This would be especially useful for modules in active development. Some knowledge of IPFS may be required, as well as the infrasture behind it - for instance, you may need to read up on p2p and more complex operations like muxing to be able to help technically.
• Perform code reviews. Most of this has been developed by @diasdavid, which means that more eyes will help a) speed the project along b) ensure quality and c) reduce possible future bugs.
• Take a look at go-ipfs and some of the planning repositories or issues: for instance, the libp2p spec here. Contributions here that would be most helpful are top-level comments about how it should look based on our understanding. Again, the more eyes the better.
• Add tests. There can never be enough tests.
• Contribute to the FAQ repository with any questions you have about IPFS or any of the relevant technology. A good example would be asking, 'What is a merkledag tree?'. If you don't know a term, odds are, someone else doesn't either. Eventually, we should have a good understanding of where we need to improve communications and teaching together to make IPFS and IPN better.

Usage

Not ready for prime time yet

Roadmap

• Network
  • libp2p-website.
  • js-libp2p (the entry point).
    • PeerInfo
    • PeerId
    • Peer Routing
      • js-libp2p-kad-routing. Discussion issue.
        • discovery mechanisms
          • js-libp2p-mdns-discovery mDNS-discovery. Discussion issue.
          • js-libp2p-random-walk. Discussion issue.
          • js-libp2p-railing Bootstrap-list. Discussion issue.
      • mDNS-routing
    • Swarm.
      • Main repo js-libp2p-swarm. Discussion issue.
      • Identify Protocol identify.
      • js-ipfs-ping.
      • Connection Interface abstract-connection
      • Transports
        • Transport Interface abstract-transport
        • libp2p-tcp
        • libp2p-udp
        • libp2p-udt
        • libp2p-utp
        • libp2p-webrtc
        • libp2p-cjdns
      • Upgrades
        • libp2p-tls
      • Stream Muxing
        • abstract-stream-muxer.
        • js-spdy-stream-muxer stream muxer. Discussion issue.
        • libp2p-spdy stream muxer upgrade
      • Protocol Muxing
        • js-multistream protocol muxer. Discussion issue.
        • js-multistream.
    • Distributed Record Store. Discussion issue.
      • js-libp2p-record record (needs MerkleDAG node).
      • js-libp2p-distributed-record-store.
      • js-libp2p-kad-record-store implements abstract record store.
      • abstract-record-store.
• Exchange
  • js-bitswap. Discussion issue.
• MerkleDAG
  • MerkleDAG node implementation (needs IPLD).
    • js-ipld.
    • js-merkledag-store.
• Supporting modules
  • webcrypto. Discussion issue.
  • js-multihash. Discussion issue.
  • js-multihashing. Discussion issue.
  • js-multiaddr.
• Spec
  • specs/19.