Small Grant: API Backup Utility & Documentation

Grants Rejected
1

Introduction

Project Name: API Backup Utility & Documentation
Name of the Organization: Dapp Mentors Ltd.

Project Description:

We propose the creation of comprehensive, official documentation to support the backup and recovery of the Renterd database instance. This project will detail methods for backing up the database using the undocumented Sia Renterd feature, as well as SQLite and MySQL techniques, as discussed on the Sia Discord server and aligned with guidance received from the Foundation in our previous submission.

While Sia Renterd includes a database backup feature as part of its core functionality, the absence of official documentation leaves users without a clear and reliable guide to perform backups. This gap has resulted in frequent user queries and support requests on the Sia Discord channel.

Our proposal aims to fill this critical void by providing a straightforward and accessible solution for data backup and migration, addressing the significant challenges users face when setting up new Renterd instances. Without proper guidance, users struggle to migrate data from existing setups, hindering their ability to maintain continuity and ownership of their data. By developing robust documentation and user-friendly tools, we will empower users to back up and manage their databases confidently and efficiently.

How does the projected outcome serve the Foundation’s mission of user-owned data?
The Renterd Database Backup Documentation, Backup, and Tools Project directly support the Sia Foundation’s mission of empowering users with ownership and control over their data. By addressing the critical gap in database management for Renterd, this project delivers the following key benefits:

  1. Renterd Database Backup Documentation: Clear, official instructions enable users to confidently back up and restore their databases without external support.

  2. Renterd Database Backup: Reliable backup processes protect user data against loss, ensuring continuity and control.

  3. Renterd Database Backup Tools: Simple, user-friendly tools for MySQL and SQLite streamline backups and data migration for new Renterd instances.

  4. Cost-Free Video Demo: A free video guide enhances accessibility, making backup processes easy to follow for all users.

This project empowers users with the knowledge and tools to manage their data effectively, reinforcing the decentralized and user-first ethos of the Sia ecosystem.

Features Included:

  • Renterd database backup documentation
  • Renterd database backup
  • Renterd database backup tools.
  • Cost-free additional video demo.

Are you a resident of any jurisdiction on that list?
No

Will your payment bank account be located in any jurisdiction on that list?
No

Grant Specifics:

Project Budget:
The total budget estimate for this project is 4.5k USD for 1.5 months, to be disbursed monthly. This budget will cover expenses for:

  • Developer salary for the 1.5 months.
  • Regorious API testing and Deployments.
  • API Documentation write-ups.

The budget shall be allocated to one milestone which comprises these phases:

Phase 1 (1st Month):

  • Renterd Instance rollup
  • Rigorous testing with Renterd core backup endpoint
  • Provision of SQLite backup utility
  • Provision of MySQL backup utility.

Phase 2 (2 Weeks):

  • Renterd core backup endpoint documentation
  • SQLite backup utility documentation
  • MySQL backup utility documentation
  • Video demo recording

Potential risks that will affect the outcome of the project:
Developing, testing, and documenting an undocumented feature can be technically complex and require to and fro communications with the Sia dev team. Unexpected challenges could arise, potentially extending the projected timeline. Other than that, we are good to go.

Development Information:

Will all of your project’s code be open-source?
Yes, and completely available on GitHub.

Leave a link where the code will be accessible for review.

Here is a demo example documentation we also prepared:

Do you agree to submit monthly progress reports?
Yes, to be reported right here on the forum.

Contact info:
Email: [email protected]

Any other preferred contact methods:
Forum: @DappMentors
Discord: Daltonic
LinkedIn
X-twitter
YouTube
Website

2

Thanks for your proposal to The Sia Foundation Grants Program.

After review, the committee has decided to reject your proposal citing the following reasons:

  • We’re not interested right now in third party official documentation that we will then have to maintain and clean up.
  • The Foundation is interested in the proposed utility to automate the process and a video demo of that process.

We’ll be moving this to the Rejected section of the forum. Thanks again for your proposal, and you’re always welcome to submit new requests if you feel you can address the committee’s concerns.