Skip to content

litepaper

askender edited this page May 24, 2021 · 7 revisions

The finalized scope of problems we will solve in phase 1

You can directly read them on https://dweb-search.on.fleek.co/ too.

You can also read the research article: Research before the product

Motivations and the problems we are solving

  • A lot of webpage/datasets on ipfs&filecoin lack metadata, thus it's not easy for them to be searched and used.
  • An open and decentralized web is in need for more and more people, so we need to design a search engine that supports web3 rss and web3 Creative Commons licence and other standards which has better decentralized features and incentive mechanism.
  • The reward of creators and curators are controlled by big companies at present which is not good.
  • Many creators are not familiar with new technology such IPFS, so they need someone to help them solve these problems.

Our product

A decentralized Search Engine for IPFS and Filecoin.

Architecture design and Technical selection

  • Code is open-sourced and all the metadatas will be exported as jsonl file and stored in IPFS/Filecoin so that everyone can use them to build a dweb-search-engine again.
  • We use and extend https://jsonfeed.org/ specification in API, so every search API is a valid json-feed(silimar to RSS) with licence and wallet info.
  • We use python and mongodb as backend. We use tornado(a asynchronous web framework) and motorengine(asynchronous database driver).
  • We use independent front-end codebase which can be hosted on IPFS, so everyone can access them easily. And other developers can design and write their own frontend UI.
  • We use tags and titles to search data in mongodb, and ElasticSearch will be supported too.
  • We cooperate with the https://iscn.io/ team about the storing of metadata in a blockchain.
  • We made a filecoin explorer which support deals-info analysis and export, so that metadata of the deals can be add easilier.

Workflow design

  • The research, architecture design, technical selection and docs took 3 weeks.
  • Back-end and front-end developing took 4 weeks.
  • Collecting IPFS&Filecoin metadata took 2 weeks.
  • User survey and alpha testing took 1 week.

Prototype and a Minimum Viable Product

Service implementation

  • Full implementation of the Service is done. More extra features will be added later.
  • Anyone can insert/query the meta information. (we won't offer the comment api) If anyone wants to comment about the metadata, they can use: https://github.com/anwen/dweb-search/discussions .
  • The incentive APIs are implemented. Users can add wallets in the metadata. Now we support Filecoin-qrcode, likecoin-web2 and the API that wikipedia is using. We will support more APIs in the future.