feat: api: add SectorNumber to MarketDealState (nv22)

filecoin-project · May 17, 2024 · f098fc2 · f098fc2
1 parent 3ee0911
commit f098fc2
Show file tree

Hide file tree

Showing 24 changed files with 142 additions and 3 deletions.
diff --git a/api/api_full.go b/api/api_full.go
@@ -1166,13 +1166,15 @@ type MarketBalance struct {
 }
 
 type MarketDealState struct {
-	SectorStartEpoch abi.ChainEpoch // -1 if not yet included in proven sector
-	LastUpdatedEpoch abi.ChainEpoch // -1 if deal state never updated
-	SlashEpoch       abi.ChainEpoch // -1 if deal never slashed
+	SectorNumber     abi.SectorNumber // 0 if not yet included in proven sector (0 is also a valid sector number).
+	SectorStartEpoch abi.ChainEpoch   // -1 if not yet included in proven sector
+	LastUpdatedEpoch abi.ChainEpoch   // -1 if deal state never updated
+	SlashEpoch       abi.ChainEpoch   // -1 if deal never slashed
 }
 
 func MakeDealState(mds market.DealState) MarketDealState {
 	return MarketDealState{
+		SectorNumber:     mds.SectorNumber(),
 		SectorStartEpoch: mds.SectorStartEpoch(),
 		LastUpdatedEpoch: mds.LastUpdatedEpoch(),
 		SlashEpoch:       mds.SlashEpoch(),
@@ -1183,6 +1185,10 @@ type mstate struct {
 	s MarketDealState
 }
 
+func (m mstate) SectorNumber() abi.SectorNumber {
+	return m.s.SectorNumber
+}
+
 func (m mstate) SectorStartEpoch() abi.ChainEpoch {
 	return m.s.SectorStartEpoch
 }

diff --git a/build/openrpc/full.json b/build/openrpc/full.json
@@ -21611,6 +21611,7 @@
                                     "ClientCollateral": "0"
                                 },
                                 "State": {
+                                    "SectorNumber": 9,
                                     "SectorStartEpoch": 10101,
                                     "LastUpdatedEpoch": 10101,
                                     "SlashEpoch": 10101
@@ -21678,6 +21679,10 @@
                                             "title": "number",
                                             "type": "number"
                                         },
+                                        "SectorNumber": {
+                                            "title": "number",
+                                            "type": "number"
+                                        },
                                         "SectorStartEpoch": {
                                             "title": "number",
                                             "type": "number"
@@ -21848,6 +21853,7 @@
                                 "ClientCollateral": "0"
                             },
                             "State": {
+                                "SectorNumber": 9,
                                 "SectorStartEpoch": 10101,
                                 "LastUpdatedEpoch": 10101,
                                 "SlashEpoch": 10101
@@ -21912,6 +21918,10 @@
                                     "title": "number",
                                     "type": "number"
                                 },
+                                "SectorNumber": {
+                                    "title": "number",
+                                    "type": "number"
+                                },
                                 "SectorStartEpoch": {
                                     "title": "number",
                                     "type": "number"

diff --git a/build/openrpc/gateway.json b/build/openrpc/gateway.json
@@ -8179,6 +8179,7 @@
                                 "ClientCollateral": "0"
                             },
                             "State": {
+                                "SectorNumber": 9,
                                 "SectorStartEpoch": 10101,
                                 "LastUpdatedEpoch": 10101,
                                 "SlashEpoch": 10101
@@ -8243,6 +8244,10 @@
                                     "title": "number",
                                     "type": "number"
                                 },
+                                "SectorNumber": {
+                                    "title": "number",
+                                    "type": "number"
+                                },
                                 "SectorStartEpoch": {
                                     "title": "number",
                                     "type": "number"

diff --git a/build/openrpc/miner.json b/build/openrpc/miner.json
@@ -1327,6 +1327,7 @@
                                     "ClientCollateral": "0"
                                 },
                                 "State": {
+                                    "SectorNumber": 9,
                                     "SectorStartEpoch": 10101,
                                     "LastUpdatedEpoch": 10101,
                                     "SlashEpoch": 10101
@@ -1394,6 +1395,10 @@
                                             "title": "number",
                                             "type": "number"
                                         },
+                                        "SectorNumber": {
+                                            "title": "number",
+                                            "type": "number"
+                                        },
                                         "SectorStartEpoch": {
                                             "title": "number",
                                             "type": "number"
@@ -2649,6 +2654,7 @@
                                     "ClientCollateral": "0"
                                 },
                                 "State": {
+                                    "SectorNumber": 9,
                                     "SectorStartEpoch": 10101,
                                     "LastUpdatedEpoch": 10101,
                                     "SlashEpoch": 10101
@@ -2716,6 +2722,10 @@
                                             "title": "number",
                                             "type": "number"
                                         },
+                                        "SectorNumber": {
+                                            "title": "number",
+                                            "type": "number"
+                                        },
                                         "SectorStartEpoch": {
                                             "title": "number",
                                             "type": "number"

diff --git a/chain/actors/builtin/market/actor.go.template b/chain/actors/builtin/market/actor.go.template
@@ -143,6 +143,7 @@ type DealProposal = markettypes.DealProposal
 type DealLabel = markettypes.DealLabel
 
 type DealState interface {
+	SectorNumber() abi.SectorNumber   // 0 if not yet included in proven sector (0 is also a valid sector number)
 	SectorStartEpoch() abi.ChainEpoch // -1 if not yet included in proven sector
 	LastUpdatedEpoch() abi.ChainEpoch // -1 if deal state never updated
 	SlashEpoch() abi.ChainEpoch       // -1 if deal never slashed
@@ -185,6 +186,10 @@ type ProposalIDState struct {
 
 type emptyDealState struct{}
 
+func (e *emptyDealState) SectorNumber() abi.SectorNumber {
+	return 0
+}
+
 func (e *emptyDealState) SectorStartEpoch() abi.ChainEpoch {
 	return -1
 }

diff --git a/chain/actors/builtin/market/market.go b/chain/actors/builtin/market/market.go
@@ -252,6 +252,7 @@ type DealProposal = markettypes.DealProposal
 type DealLabel = markettypes.DealLabel
 
 type DealState interface {
+	SectorNumber() abi.SectorNumber   // 0 if not yet included in proven sector (0 is also a valid sector number)
 	SectorStartEpoch() abi.ChainEpoch // -1 if not yet included in proven sector
 	LastUpdatedEpoch() abi.ChainEpoch // -1 if deal state never updated
 	SlashEpoch() abi.ChainEpoch       // -1 if deal never slashed
@@ -293,6 +294,10 @@ type ProposalIDState struct {
 
 type emptyDealState struct{}
 
+func (e *emptyDealState) SectorNumber() abi.SectorNumber {
+	return 0
+}
+
 func (e *emptyDealState) SectorStartEpoch() abi.ChainEpoch {
 	return -1
 }

diff --git a/chain/actors/builtin/market/state.go.template b/chain/actors/builtin/market/state.go.template
@@ -212,6 +212,14 @@ type dealStateV{{.v}} struct {
 	ds{{.v}} market{{.v}}.DealState
 }
 
+func (d dealStateV{{.v}}) SectorNumber() abi.SectorNumber {
+{{if (le .v 12)}}
+	return 0
+{{else}}
+	return d.ds{{.v}}.SectorNumber
+{{end}}
+}
+
 func (d dealStateV{{.v}}) SectorStartEpoch() abi.ChainEpoch {
 	return d.ds{{.v}}.SectorStartEpoch
 }

diff --git a/chain/actors/builtin/market/v0.go b/chain/actors/builtin/market/v0.go
diff --git a/chain/actors/builtin/market/v10.go b/chain/actors/builtin/market/v10.go
diff --git a/chain/actors/builtin/market/v11.go b/chain/actors/builtin/market/v11.go
diff --git a/chain/actors/builtin/market/v12.go b/chain/actors/builtin/market/v12.go
diff --git a/chain/actors/builtin/market/v13.go b/chain/actors/builtin/market/v13.go
diff --git a/chain/actors/builtin/market/v14.go b/chain/actors/builtin/market/v14.go
diff --git a/chain/actors/builtin/market/v2.go b/chain/actors/builtin/market/v2.go
diff --git a/chain/actors/builtin/market/v3.go b/chain/actors/builtin/market/v3.go
diff --git a/chain/actors/builtin/market/v4.go b/chain/actors/builtin/market/v4.go
diff --git a/chain/actors/builtin/market/v5.go b/chain/actors/builtin/market/v5.go
diff --git a/chain/actors/builtin/market/v6.go b/chain/actors/builtin/market/v6.go
diff --git a/chain/actors/builtin/market/v7.go b/chain/actors/builtin/market/v7.go
diff --git a/chain/actors/builtin/market/v8.go b/chain/actors/builtin/market/v8.go
diff --git a/chain/actors/builtin/market/v9.go b/chain/actors/builtin/market/v9.go
diff --git a/documentation/en/api-v0-methods-miner.md b/documentation/en/api-v0-methods-miner.md
@@ -824,6 +824,7 @@ Response:
       "ClientCollateral": "0"
     },
     "State": {
+      "SectorNumber": 9,
       "SectorStartEpoch": 10101,
       "LastUpdatedEpoch": 10101,
       "SlashEpoch": 10101
@@ -1423,6 +1424,7 @@ Response:
       "ClientCollateral": "0"
     },
     "State": {
+      "SectorNumber": 9,
       "SectorStartEpoch": 10101,
       "LastUpdatedEpoch": 10101,
       "SlashEpoch": 10101

diff --git a/documentation/en/api-v0-methods.md b/documentation/en/api-v0-methods.md
@@ -5841,6 +5841,7 @@ Response:
       "ClientCollateral": "0"
     },
     "State": {
+      "SectorNumber": 9,
       "SectorStartEpoch": 10101,
       "LastUpdatedEpoch": 10101,
       "SlashEpoch": 10101
@@ -5919,6 +5920,7 @@ Response:
     "ClientCollateral": "0"
   },
   "State": {
+    "SectorNumber": 9,
     "SectorStartEpoch": 10101,
     "LastUpdatedEpoch": 10101,
     "SlashEpoch": 10101