Overview
This document outlines the scope for the proposed Proof of Concept between IoTeX/W3bstream, WeatherXM, and Textile. The following defines the POC scope.
- Objectives: Demonstrate a compute-over-data flow for WeatherXM’s Quality of Data (QoD) algorithm.
- Optional: QoD queries and/or visualizations over the W3bstream-computed data.
- Optional: Rewards algorithm calculations with proofs written to faux testnet contracts.
- Timelines: the POC will run for <X> weeks and includes the following milestones:
- WeatherXM data upload start date: <date>
- WeatherXM data frequency: daily
- W3bstream QoD calculation: daily
- POC end date & review meeting: <date>
- Data processing:
- Ingest: WeatherXM pushes data to a Textile vault on a daily basis as a Parquet file.
- Compute: Calculations made over the data executed by IoTeX/W3bstream.
- Visualizations: Simple analyses/visualizations of QoD data to demonstrate what could happen within WeatherXM’s Rewards dashboard—by Textile.
Requirements
The following outlines activities that each party is responsible for.
WeatherXM
- Send Parquet files on a daily basis to a Textile vault.
- Review IoTeX QoD calculations for accuracy, e.g., compare against any internal systems.
IoTeX
- Run compute-over-data with W3bstream for the data pushed to Textile by WeatherXM.
- The computation should run the QoD algorithm over WeatherXM devices, which are identified by the
device_id
column in the Parquet file. The QoD implementation can be referenced here: https://github.com/weatherxm-network/qod.
- Results of the computation should be made available for further QoD analysis, with a future-state goal of enabling QoD queries on WeatherXM’s Rewards dashboard here: https://index.weatherxm.network. For the sake of the POC, this could happen in a couple of different ways:
- IoTeX shares this data manually, such as raw files for each QoD calculation, shared in a GitHub repo, Telegram DMs, or similar.
- IoTeX creates a Textile vault designed to store raw files for each QoD calculation.
- Optionally, proofs can be written onchain to a faux testnet contract, which could either be the QoD proof or the full rewards calculation, described here: https://docs.weatherxm.com/reward-mechanism.
Textile
- Provide support on vaults-related data ingest & extraction.
- Demonstrate a simple use case of charts/dashboards for the QoD data, e.g., show how QoD evolves over time on the entire network.
Success criteria
- IoTeX/W3bstream successfully compute QoD calculations over WeatherXM data.
- WeatherXM is able to use QoD calculations in visualizations (charts, dashboards, etc.), such as what’s demonstrated by the Textile team during the POC.