Next Step Microgrant: IPFS-Comments

[Soptq]

1. What is your project? (max 100 words)

Currently other comment systems like Disqus or twikoo.js requires centralized servers to store users' comments, where data are possibly censored. Consequently, we are building a SDK for developers to integrate a comment system into their applications with just few lines of codes. All data are stored to IPFS.

2. Project links

Link to Github repo: https://github.com/Soptq/ipfs-comments Link to demo or website, if applicable: https://youtu.be/yCMAubHsoHQ also there is an example in the GitHub repo where you can install and try it out yourself. License: MIT

3. How is IPFS, Filecoin, or related technology used in this project? (max 100 words)

All users' comments data, reply data etc. are stored to IPFS. IPFS upload/retrieval backend is customizable in our SDKs, currently we are using web3storage as a backend.

4. How will you improve your project with this grant? What steps will you take to meet this objective? (max 200 words)

1. Currently our code is like a POC, we will mainly focus to improve the code style and add more comments as it is for developers.
2. Add type annotation.
3. Since IPFS uploading / retrieval can be time-consuming, we are investigating approaches to optimize for better user experiences, including more backends (decentralized solutions only), caching mechanism, etc.
4. researching possible conflict resolving algorithms to support concurrent commenting from multiple users.

5. Do you agree to share grant reports upon request, including a final grant report at the end of the three month period?

Yes, we will report our progress once per two weeks in this thread.

6. Does your proposal comply with our Community Code of Conduct?

Yes

7. Links and submissions

• If your project began at a hackathon, have you submitted it for the relevant Protocol Labs prizes? Include links here if available:

Additional questions:

• For each team member(s), please list name, email, Github account, and role in the project. Name: Soptq Email: outline_spoiler0t@icloud.com Github: Soptq Role: Developer

• How did you learn about our microgrant program? Email

• If your project was created as part of an event or hackathon:

  • What was the name of the event? (e.g. ETHGlobal NFTHack, Cal Hacks hello:world, Chainlink, CivHacks, GameDevJ, ETHGlobal Scaling Ethereum)
  • Please link to your hackathon submission

[ErinOCon]

Hi @Soptq, thank you for your proposal. This grant has been approved! Look out for an email to confirm payment details.

[Soptq]

Update:

• 10.15~11.15:
  • Rethinking and designing the conflict resolving algorithm and engine. It has to be efficient and lazy. For now I am still thinking about it all the time, hopefully we can come up with a efficient resolver for using on IPFS.
  • Rewriting the library to Typescript, with comments and type annotations. During rewriting, the structure of the library will be improved as well.
  • Investigating possible other IPFS backends like NFT storage.
  • Investigating orbit, the IPFS database. However, for now I have some problems running its example page. If it is truly that powerful as it’s readme suggests then maybe we can use it as a backend.
• 11.15~12.15 (Got heavily sick this month so the progress is a bit slow):
  • Continue refactoring the library.
• 12.15~1.10
  • Type annotation completed, more comments are added as well for developers.
  • Code style formatted according to current standard.
  • Cache system refactored.
  • Plugin supported, now other developers can extend it more easily, including backends and interfaces.

[ErinOCon]

Hi @Soptq, I hope you are doing well! Can you provide a final report for this project here? Please let us know if you have any questions!