Scope of Work: Neume Publisher, SDK, and UI Kit backed by Arweave

[neatonk]

Overview

This Scope of Work outlines a strategy to enhance Neume's functionality and accessibility. Our primary goal is to attract more builders by simplifying the process of building on Neume. We plan to develop a Neume Publisher for efficient data distribution to Arweave, a Neume SDK to facilitate access to this data, and potentially a Neume UI Kit and Hooks for building React applications using Neume. The work can be completed within a 4-week timeframe, dedicating up to 20 hours per week.

Phases

1. Development of Neume Publisher

Objective: Develop a node application that efficiently distributes new data to Arweave, including setting up the required infrastructure.

Approach:

• Research the latest tools and libraries for publishing data on Arweave via Bundlr.
• Confirm that all files will be less than 100KB and split large files if needed.
• Determine the best route for accessing the latest Neume data (e.g. via RPC or direct database access).
• Build and test an application to fetch the latest data from Neume and publish it to Arweave as quickly and efficiently as possible.

Duration: 1-2 week(s)

---

2. Development of Neume SDK

Objective: Develop a Software Development Kit (SDK) to simplifying the process of building on Neume. The SDK will also serve as an abstraction layer, allowing the underlying code and infrastructure to change over time.

Approach:

• Research prior art (e.g. Lens SDK) to identify best practices for an SDK built-on Arweave.
• Consider use cases the SDK can support now and may support in the future in order to design the API it exposes.
• Implement and test the SDK.
• Publish the SDK package on NPM.

Duration: 1-2 weeks

---

3. Development of Neume UI Kit and React Hooks (Stretch Goal)

Objective: Develop a UI Kit and React Hooks that are built using the Neume SDK, providing pre-designed components for building user interfaces in Neume applications.

Approach:

• Consider use cases for which the Neume SDK has been designed and select a subset of those that are most likely to benefit builders considering Neume.
• Develop a set of React hooks (using the SDK) that can be used to implement custom components.
• Design and develop a set of UI components usig the React hooks.
• Publish the hooks and UI component packages on NPM.

Duration: 1-2 weeks (if time allows)

---

Total Duration: Up to 4 weeks (at 20 hours per week)

All development tasks include some amount of integration testing to ensure the functionality and reliability of the developed tools.

Future work should include the development of comprehensive documentation for the Neume SDK and further testing to ensure its robustness and reliability. If time does not allow for the completion of the UI Kit and React Hooks within this scope of work, these tasks will be reserved for future work.

[djfnd]

This scope of work looks absolutely perfect to me. Getting to the UI Kit & React Hooks stage would be ideal, but even with an SDK neume will be so much easier to develop with.

[neatonk]

Yes, 100% agree.

[neatonk]

Also, if we can identify a primary use case that we want to support initially, I can focus on that narrow vertical through the SDK + React Hooks + UI Kit for this project.

This would reduce the time needed to complete phases 2 and 3 by reducing their minimum scope. As a result I'd be more likely to get to phase 3 and implement the hooks and UI kit for that use case. If that leaves me with additional time, I can spend it on expanding to additional use cases or leave that for future work.

[neatonk]

Use Case: Embedded NFT music player for X

• For artists: Embed a player with tracks you've released.
• For fans: Embed a player with tracks from your collection.

[il3ven]

I'm excited for this.

[estmcmxci]

Also, if we can identify a primary use case that we want to support initially, I can focus on that narrow vertical through the SDK + React Hooks + UI Kit for this project.

I am wondering if there are any potential synergy among applications on L2s like Base, Optimism, etc?