devgrants icon indicating copy to clipboard operation
devgrants copied to clipboard

Next Step Microgrant: Saturn Observatory

Open 31z4 opened this issue 1 year ago β€’ 6 comments

1. What is your project, and what problem does it solve? (max 100 words)

The goal of this project is to increase the transparency of πŸͺ Filecoin Saturn network.

We use historical data about the network gathered by πŸŒ– Saturn Moonlet to prepare and publish analytical reports on Saturn Observatory website every month.

Saturn Observatory compliments official tools like Saturn Node Dashboard and Saturn Explorer, aiming to provide better insights into the network state and performance.

2. Project links

Link to Github repo: https://github.com/cronian-tech/saturn-observatory Link to demo or website: https://observatory.cronian.tech License: MIT

3. a) How is IPFS, Filecoin, or related technology used in this project?

  • Raw data that is used to generate the reports for Saturn Observatory gets stored on IPFS and Filecoin using web3.storage.
  • To perform the actual analysis we run a Bacalhau job that uses DuckDB to execute a bunch of SQL queries on the input CSV data that we previously pinned to IPFS.
  • Moving forward, we're going to use Lilypad to run the analysis. We already made a couple of PRs (one, two, three) with a custom DuckDB module. But, by the time of writing the module is not yet available on Lilypad testnet.

b) Is this project building with the current microgrants focus area (FVM)? (Yes or No)

No, not directly. But it's going to use Lilypad which uses FVM.

4. How will you improve your project with this grant? What steps will you take to meet this objective?

Number Grant Deliverable Briefly describe how you will meet deliverable objectives Timeframe (within 3 months)
1. Improve website UX Split to subpages, add navigation menu, handle CSV loading errors, etc. 2 weeks
2. Accelerate CSV data using Saturn We used to use Saturn browser client on the website, but replaced it with self hosting CSV when Saturn private beta launched. We're going to participate in private beta and use Saturn again on the website. 2 days
3. Use Lilypad to generate reports Implement custom DuckDB module for Lilypad. Replace Bacalhau with Lilypad for analytical computations. 2 weeks
4. Auto generate reports every week Setup GitHub actions to auto generate reports and publish them on the website every week. Right now the process is mostly manual and done every month. 2 weeks
5. Implement new reports Add new reports based on community feedback. E.g., top performing nodes, top growing regions, node churn, node health issues, etc. 2 weeks

5. If accepted, do you agree to share monthly project updates in this Github issue for 3 months or until the project described here is complete?

Yes I do.

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

Yes it does.

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: https://www.blog.encode.club/open-data-hack-powered-by-filecoin-prizewinners-and-summary-dcdf52059867 (Saturn and Lilypad bounties)

Additional questions:

  • For each team member(s), please list name, email, Github account, and role in the project.
  • How did you learn about our microgrant program?
    • During a hackathon
  • If your project was created as part of an event or hackathon:
    • What was the name of the event?
      • Open Data Hack
    • Please link to your hackathon submission
      • https://youtu.be/ErgUU7kwUro

31z4 avatar Jan 17 '24 11:01 31z4

Hi @31z4 - Are you still interested in working on this?

We'd like to accept it but would ask that you use CoopHive which is a fork of Lilypad. They are currently finalizing deployment but recommend anyone planning to use CoopHive to start off by building Bacalhau jobs and making sure they run there: https://docs.bacalhau.org/getting-started/docker-workload-onboarding

eshon avatar Feb 29 '24 15:02 eshon

Hi @eshon yes I'm still interested in working on Saturn Observatory. Just a few comments from my side:

  1. Yes I think it's definitely possible to adapt CoopHive instead of Lilypad. I'm already pretty familiar with building and running Bacalhau jobs.
  2. I'm currently busy with another project that I'll finish by April. I'll be ready to start working on Saturn Observatory on April 10. Does that work for you?

31z4 avatar Mar 01 '24 05:03 31z4

That works!

On Fri, Mar 1, 2024, 6:23β€―AM Elisey Zanko @.***> wrote:

Hi @eshon https://github.com/eshon yes I'm still interested in working on Saturn Observatory. Just a few comments from my side:

  1. Yes I think it's definitely possible to adapt CoopHive instead of Lilypad. I'm already pretty familiar with building and running Bacalhau jobs.
  2. I'm currently busy with another project that I'll finish by April. I'll be ready to start working on Saturn Observatory on April 10. Does that work for you?

β€” Reply to this email directly, view it on GitHub https://github.com/filecoin-project/devgrants/issues/1693#issuecomment-1972531289, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAHYPIXCSYFOJ7MIWFLZVV3YWAGDTAVCNFSM6AAAAABB6LQOCGVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTSNZSGUZTCMRYHE . You are receiving this because you were mentioned.Message ID: @.***>

eshon avatar Mar 01 '24 09:03 eshon

Awesome! What's our next steps?

31z4 avatar Mar 01 '24 14:03 31z4

@31z4 Can you set a calendar reminder to touch base again here in early April and we can get your grant processed so you can start work April 10?

eshon avatar Mar 07 '24 17:03 eshon

Sure, I'll be in touch.

31z4 avatar Mar 10 '24 12:03 31z4

Hi @eshon as we agreed earlier I'm letting you know that I'm happy to start working on the project around April 10 ☺️

31z4 avatar Apr 03 '24 04:04 31z4

Hi @31z4, thank you for the update! I have sent you an email with instructions regarding next steps. This issue has been closed, but please feel welcome to include project updates to this thread.

If you have any follow up questions, please contact our team at [email protected].

FF-FOIT avatar Apr 10 '24 18:04 FF-FOIT