feat!: simplify dataset status to two-state lifecycle (Inactive/Active) #314

rjan90 · 2025-10-22T06:07:06Z

Implements simplified dataset status system as specified in issue #169, replacing the 3-state system with a clearer 2-state system.

Summary

This PR introduces a two-state dataset lifecycle system (Inactive/Active) to make dataset status easier to understand and use across clients, SDKs, and smart contracts.

Key Concept: Status reflects data existence, not operational state.

Inactive = Dataset doesn't exist or has no pieces
Active = Dataset has data and proving history (including terminated datasets)

Changes

Smart Contracts

1. Updated `DataSetStatus` Enum

Changed from 3 states (NotFound, Active, Terminating) to 2 states (Inactive, Active)
File: service_contracts/src/FilecoinWarmStorageService.sol

enum DataSetStatus {
    Inactive,  // non-existent or no pieces
    Active     // has pieces (including terminated)
}

Breaking Changes

⚠️ This is a breaking change

Enum Changes

Old Status	Old Value	New Status	New Value	Notes
`NotFound`	0	`Inactive`	0	Non-existent datasets
`Active`	1	`Active`	1	Operational datasets (no change)
`Terminating`	2	`Active`	1	Terminated datasets with pieces

Key Semantic Changes

Terminated datasets are now Active (not Inactive or Terminating)
- They still have data and proving history
- Use pdpEndEpoch or isTerminated to check operational state
Status reflects data existence, not operational state
- Active = "has data"
- Inactive = "doesn't exist or no data"

Closes #169

Kubuxu · 2025-10-23T16:03:53Z

service_contracts/docs/integration-guide.md

@@ -0,0 +1,942 @@
+# Dataset Status Integration Guide


I'm not reviewing this or the other .md file unless someone explicitly tells me to. It is probably best to either remove it or have someone rewrite it into a few paragraphs.

Removed the added .md-files in the PR here: 6408bdc. Will open a draft-PR with those, so that we can get proper review and edit of those

Kubuxu · 2025-10-23T16:04:35Z

service_contracts/src/FilecoinWarmStorageService.sol

+    // Event for dataset status changes
+    event DataSetStatusChanged(
+        uint256 indexed dataSetId, DataSetStatus indexed oldStatus, DataSetStatus indexed newStatus, uint256 epoch
+    );


Why are we adding an event? It is the first time I'm hearing about it.
Also, newStatus almost for sure should not be indexed, it just isn't worth indexing.

Kubuxu · 2025-10-23T16:05:49Z

service_contracts/src/FilecoinWarmStorageService.sol

+        // Dataset is inactive: non-existent (pdpRailId==0) or no pieces added yet (rate==0, no proving)
+        Inactive,
+        // Dataset has pieces and proving history (includes terminated datasets)
+        // Note: Terminated datasets remain Active - use pdpEndEpoch to check termination status


This comment is wrong. The datasets in the process of being terminated remain Active, but Terminated datasets will become Inactive as their data will be wiped when provider deletes the dataset from PDP side.

Kubuxu · 2025-10-23T16:07:08Z

service_contracts/src/lib/FilecoinWarmStorageServiceStateInternalLibrary.sol

+     */
+    function isDataSetActive(FilecoinWarmStorageService service, uint256 dataSetId) internal view returns (bool) {
+        return getDataSetStatus(service, dataSetId) == FilecoinWarmStorageService.DataSetStatus.Active;
+    }


This getter serves no purpose

Kubuxu · 2025-10-23T16:08:07Z

service_contracts/src/lib/FilecoinWarmStorageServiceStateInternalLibrary.sol

+        hasProving = activationEpoch != 0;
+
+        // Check if terminated
+        isTerminated = info.pdpEndEpoch != 0;


this is terminating not terminated

Kubuxu · 2025-10-23T16:09:34Z

service_contracts/src/lib/FilecoinWarmStorageServiceStateLibrary.sol

+     * @return hasProving Whether proving is activated
+     * @return isTerminated Whether the rail is terminated
+     */
+    function getDataSetStatusDetails(FilecoinWarmStorageService service, uint256 dataSetId)


This method seems counter to the whole PR. We decide to reduce the fidelity of status, but now this exposes even more internal detail.

@rjan90 are you sure we want to keep this?

Removed in the latest commit: 6408bdc

Kubuxu · 2025-10-23T16:10:54Z

service_contracts/src/lib/FilecoinWarmStorageServiceStateLibrary.sol

+
+        // Inactive only if no proving has started
+        // Everything else is Active (including terminated datasets)
+        if (!hasProving) {


combine this with the line above, as the layer of indirection just makes it more confusing

service_contracts/test/FilecoinWarmStorageService.t.sol

Kubuxu · 2025-10-24T13:54:06Z

If we remove getDataSetStatusDetails and the unreviewed markdown documents (which I'm quite sure will require many changes), it would be good to merge.
IDK what the idea is behind getDataSetStatusDetails and why we would expose it.

Implement simplified dataset status system as specified in issue #169. Replaces the 3-state system (NotFound/Active/Terminating) with a clearer 2-state system (Inactive/Active). Key changes: - Updated DataSetStatus enum from 3 states to 2 states (Inactive/Active) - Status now reflects data existence, not operational state - Inactive = Dataset doesn't exist or has no pieces - Active = Dataset has data and proving history (including terminated) - Updated contract logic, tests, subgraph, and documentation BREAKING CHANGE: DataSetStatus enum values changed. Terminated datasets are now Active (not Terminating). Check operational state using pdpEndEpoch or isTerminated() instead.

fix: update ABIs

FilOzzy added this to FS Oct 22, 2025

github-project-automation bot moved this to 📌 Triage in FS Oct 22, 2025

rjan90 moved this from 📌 Triage to ⌨️ In Progress in FS Oct 22, 2025

rjan90 moved this from ⌨️ In Progress to 🔎 Awaiting review in FS Oct 23, 2025

rjan90 marked this pull request as ready for review October 23, 2025 11:17

rjan90 requested a review from Kubuxu October 23, 2025 15:34

Kubuxu reviewed Oct 23, 2025

View reviewed changes

service_contracts/test/FilecoinWarmStorageService.t.sol Outdated Show resolved Hide resolved

Kubuxu reviewed Oct 23, 2025

View reviewed changes

service_contracts/test/FilecoinWarmStorageService.t.sol Outdated Show resolved Hide resolved

rjan90 force-pushed the phi/dataset-lifecycle branch from 522ae83 to ddd6ccd Compare October 24, 2025 16:34

fix: update ABIs

771274a

fix: update ABIs

Kubuxu approved these changes Oct 24, 2025

View reviewed changes

github-project-automation bot moved this from 🔎 Awaiting review to ✔️ Approved by reviewer in FS Oct 24, 2025

rjan90 merged commit 8399813 into main Oct 24, 2025
6 checks passed

github-project-automation bot moved this from ✔️ Approved by reviewer to 🎉 Done in FS Oct 24, 2025

rjan90 deleted the phi/dataset-lifecycle branch October 24, 2025 18:29

rjan90 mentioned this pull request Oct 27, 2025

build: prep FWSS v1.0.0 release #332

Open

feat!: simplify dataset status to two-state lifecycle (Inactive/Active) #314

feat!: simplify dataset status to two-state lifecycle (Inactive/Active) #314

Uh oh!

Conversation

rjan90 commented Oct 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Changes

Smart Contracts

1. Updated DataSetStatus Enum

Breaking Changes

Enum Changes

Key Semantic Changes

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Kubuxu Oct 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rjan90 Oct 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Kubuxu commented Oct 24, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

rjan90 commented Oct 22, 2025 •

edited

Loading

1. Updated `DataSetStatus` Enum

Kubuxu Oct 23, 2025 •

edited

Loading

rjan90 Oct 24, 2025 •

edited

Loading