structure research repo

[serapath]

@todo

• [ ] refine research repo based on https://github.com/ipfs/notes
• [ ] describe process to get from arbitrary ideas + research to roadmap to spec + implementation
  • more pragmatic than: https://github.com/ipfs/team-mgmt/blob/master/ROADMAP_HOW_TO.md
• [ ] add structure similar to https://github.com/ipfs/specs
  • [ ] datdot-cli, the datdit daemon interface
  • [ ] core api
  • [ ] http api
  • [ ] ws api
  • [ ] web api
  • [ ] architecture
  • [ ] hypercore
  • [ ] hypercore protocol
  • [ ] hyperswarm
  • [ ] addresses

---

Inspiration

The specs contained in this repository are:

• IPFS Protocol:
  • Protocol Architecture Overview - the top-level spec and the stack
  • Other IPFS Overviews - quick overviews of the various parts of IPFS
• User Interface (aka Public APIs):
  • Core API (aka using IPFS as a package/module)
  • JavaScript Interface
  • Golang Interface
  • CLI (the ipfs daemon API)
  • HTTP API
  • HTTP Gateway
• Data Formats:
  • IPLD - InterPlanetary Linked Data.
  • Merkle DAG (Deprecated)
  • Self Describing Formats (multiformats):
  • multihash - self-describing hash digest format.
  • multiaddr - self-describing addressing format.
  • multicodec - self-describing protocol/encoding >streams (note: a file is a stream).
  • multistream - multistream is a format -- or >simple protocol -- for disambiguating, and layering streams. It is extremely simple.
• Files / Mutable File System:
  • UnixFS
  • Mutable File System (the Files API) - Virtual File System interface, unix like, on top of the MerkleDAG
• Storage Layer:
  • Pinning
  • Repo - IPFS node local repository spec
  • FileSystem Repo - IPFS node local repository spec
• Block Exchanges:
  • Bitswap - BitTorrent-inspired exchange
• Key Management:
  • KeyStore - Key management on IPFS
  • KeyChain - Distribution of cryptographic Artifacts
• Networking layer:
  • libp2p - libp2p is a modular and extensible network stack, built and use by IPFS, but that it can be reused as a standalone project. Covers:
• Records, Naming and Record Systems:
  • IPNS - InterPlanetary Naming System
• Other/related/included:
  • PDD - Protocol Driven Development