-
Notifications
You must be signed in to change notification settings - Fork 37
/
invariants.go
345 lines (286 loc) · 12.7 KB
/
invariants.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
package market
import (
"bytes"
"encoding/binary"
"github.com/ipfs/go-cid"
cbg "github.com/whyrusleeping/cbor-gen"
"github.com/filecoin-project/go-address"
"github.com/filecoin-project/go-state-types/abi"
"github.com/filecoin-project/go-state-types/big"
"github.com/filecoin-project/go-state-types/builtin"
"github.com/filecoin-project/go-state-types/builtin/v13/util/adt"
"github.com/filecoin-project/go-state-types/builtin/v13/verifreg"
)
type DealSummary struct {
Provider address.Address
StartEpoch abi.ChainEpoch
EndEpoch abi.ChainEpoch
SectorStartEpoch abi.ChainEpoch
LastUpdatedEpoch abi.ChainEpoch
SlashEpoch abi.ChainEpoch
// Populated from market's States, not the miner state
SectorNumber abi.SectorNumber
PieceCid cid.Cid
}
type StateSummary struct {
Deals map[abi.DealID]*DealSummary
PendingDealAllocationIds map[abi.DealID]verifreg.AllocationId
ClaimIdToDealId map[verifreg.ClaimId]abi.DealID
AllocIdToDealId map[verifreg.AllocationId]abi.DealID
ProviderSectors map[abi.SectorID][]abi.DealID
PendingProposalCount uint64
DealStateCount uint64
LockTableCount uint64
DealOpEpochCount uint64
DealOpCount uint64
}
// Checks internal invariants of market state.
func CheckStateInvariants(st *State, store adt.Store, balance abi.TokenAmount, currEpoch abi.ChainEpoch) (*StateSummary, *builtin.MessageAccumulator) {
acc := &builtin.MessageAccumulator{}
acc.Require(
st.TotalClientLockedCollateral.GreaterThanEqual(big.Zero()),
"negative total client locked collateral: %v", st.TotalClientLockedCollateral)
acc.Require(
st.TotalProviderLockedCollateral.GreaterThanEqual(big.Zero()),
"negative total provider locked collateral: %v", st.TotalClientLockedCollateral)
acc.Require(
st.TotalClientStorageFee.GreaterThanEqual(big.Zero()),
"negative total client storage fee: %v", st.TotalClientLockedCollateral)
//
// Proposals
//
proposalCids := make(map[cid.Cid]struct{})
maxDealID := int64(-1)
proposalStats := make(map[abi.DealID]*DealSummary)
expectedDealOps := make(map[abi.DealID]struct{})
totalProposalCollateral := abi.NewTokenAmount(0)
if proposals, err := adt.AsArray(store, st.Proposals, ProposalsAmtBitwidth); err != nil {
acc.Addf("error loading proposals: %v", err)
} else {
var proposal DealProposal
err = proposals.ForEach(&proposal, func(dealID int64) error {
pcid, err := proposal.Cid()
acc.RequireNoError(err, "error getting cid from proposal")
if proposal.StartEpoch >= currEpoch {
expectedDealOps[abi.DealID(dealID)] = struct{}{}
}
// keep some state
proposalCids[pcid] = struct{}{}
if dealID > maxDealID {
maxDealID = dealID
}
proposalStats[abi.DealID(dealID)] = &DealSummary{
Provider: proposal.Provider,
StartEpoch: proposal.StartEpoch,
EndEpoch: proposal.EndEpoch,
SectorStartEpoch: abi.ChainEpoch(-1),
LastUpdatedEpoch: abi.ChainEpoch(-1),
SlashEpoch: abi.ChainEpoch(-1),
PieceCid: proposal.PieceCID,
}
totalProposalCollateral = big.Sum(totalProposalCollateral, proposal.ClientCollateral, proposal.ProviderCollateral)
acc.Require(proposal.Client.Protocol() == address.ID, "client address for deal %d is not an ID address", dealID)
acc.Require(proposal.Provider.Protocol() == address.ID, "provider address for deal %d is not an ID address", dealID)
return nil
})
acc.RequireNoError(err, "error iterating proposals")
}
// next id should be higher than any existing deal
acc.Require(int64(st.NextID) > maxDealID, "next id, %d, is not greater than highest id in proposals, %d", st.NextID, maxDealID)
//
// Deal States
//
pendingDealAllocationIds, err := st.GetPendingDealAllocationIds(store)
acc.RequireNoError(err, "error loading pending deal proposal Ids")
allocationIdToDealId := make(map[verifreg.AllocationId]abi.DealID)
for dealId, allocationId := range pendingDealAllocationIds {
_, found := proposalStats[dealId]
acc.Require(found, "pending deal allocation %d not found in proposals", dealId)
allocationIdToDealId[allocationId] = dealId
}
dealStateCount := uint64(0)
claimIdToDealId := make(map[verifreg.ClaimId]abi.DealID)
expectedProviderSectors := make(map[abi.DealID]struct{})
if dealStates, err := adt.AsArray(store, st.States, StatesAmtBitwidth); err != nil {
acc.Addf("error loading deal states: %v", err)
} else {
var dealState DealState
err = dealStates.ForEach(&dealState, func(dealID int64) error {
acc.Require(
dealState.SectorStartEpoch >= 0,
"deal %d state start epoch undefined: %v", dealID, dealState)
acc.Require(
dealState.LastUpdatedEpoch == EpochUndefined || dealState.LastUpdatedEpoch >= dealState.SectorStartEpoch,
"deal %d state last updated before sector start: %v", dealID, dealState)
acc.Require(
dealState.LastUpdatedEpoch == EpochUndefined || dealState.LastUpdatedEpoch <= currEpoch,
"deal %d last updated epoch %d after current %d", dealID, dealState.LastUpdatedEpoch, currEpoch)
acc.Require(
dealState.SlashEpoch == EpochUndefined || dealState.SlashEpoch >= dealState.SectorStartEpoch,
"deal %d state slashed before sector start: %v", dealID, dealState)
acc.Require(
dealState.SlashEpoch == EpochUndefined || dealState.SlashEpoch <= currEpoch,
"deal %d state slashed after current epoch %d: %v", dealID, currEpoch, dealState)
stats, found := proposalStats[abi.DealID(dealID)]
if !found {
acc.Addf("no deal proposal for deal state %d", dealID)
} else {
stats.SectorStartEpoch = dealState.SectorStartEpoch
stats.LastUpdatedEpoch = dealState.LastUpdatedEpoch
stats.SlashEpoch = dealState.SlashEpoch
stats.SectorNumber = dealState.SectorNumber
}
_, found = pendingDealAllocationIds[abi.DealID(dealID)]
acc.Require(!found, "deal %d has pending allocation", dealID)
if dealState.SlashEpoch == EpochUndefined && dealState.SectorStartEpoch != EpochUndefined && stats.EndEpoch > currEpoch {
expectedProviderSectors[abi.DealID(dealID)] = struct{}{}
}
dealStateCount++
return nil
})
acc.RequireNoError(err, "error iterating deal states")
}
//
// Pending Proposals
//
pendingProposalCount := uint64(0)
if pendingProposals, err := adt.AsMap(store, st.PendingProposals, builtin.DefaultHamtBitwidth); err != nil {
acc.Addf("error loading pending proposals: %v", err)
} else {
err = pendingProposals.ForEach(nil, func(key string) error {
proposalCID, err := cid.Parse([]byte(key))
acc.RequireNoError(err, "error getting cid from proposal")
_, found := proposalCids[proposalCID]
acc.Require(found, "pending proposal with cid %v not found within proposals %v", proposalCID, pendingProposals)
pendingProposalCount++
return nil
})
acc.RequireNoError(err, "error iterating pending proposals")
}
//
// Escrow Table and Locked Table
//
lockTableCount := uint64(0)
escrowTable, err := adt.AsBalanceTable(store, st.EscrowTable)
acc.RequireNoError(err, "error loading escrow table")
lockTable, err := adt.AsBalanceTable(store, st.LockedTable)
acc.RequireNoError(err, "error loading locked table")
if escrowTable != nil && lockTable != nil {
var lockedAmount abi.TokenAmount
lockedTotal := abi.NewTokenAmount(0)
err = (*adt.Map)(lockTable).ForEach(&lockedAmount, func(key string) error {
addr, err := address.NewFromBytes([]byte(key))
acc.RequireNoError(err, "error getting address from bytes")
lockedTotal = big.Add(lockedTotal, lockedAmount)
// every entry in locked table should have a corresponding entry in escrow table that is at least as high
escrowAmount, err := escrowTable.Get(addr)
acc.RequireNoError(err, "error escrow amount from table for %s", addr)
acc.Require(escrowAmount.GreaterThanEqual(lockedAmount),
"locked funds for %s, %s, greater than escrow amount, %s", addr, lockedAmount, escrowAmount)
lockTableCount++
return nil
})
acc.RequireNoError(err, "error iterating locked table")
// lockTable total should be sum of client and provider locked plus client storage fee
expectedLockTotal := big.Sum(st.TotalProviderLockedCollateral, st.TotalClientLockedCollateral, st.TotalClientStorageFee)
acc.Require(lockedTotal.Equals(expectedLockTotal),
"locked total, %s, does not sum to provider locked, %s, client locked, %s, and client storage fee, %s",
lockedTotal, st.TotalProviderLockedCollateral, st.TotalClientLockedCollateral, st.TotalClientStorageFee)
// assert escrow <= actor balance
// lockTable item <= escrow item and escrowTotal <= balance implies lockTable total <= balance
escrowTotal, err := escrowTable.Total()
acc.RequireNoError(err, "error calculating escrow total")
acc.Require(escrowTotal.LessThanEqual(balance), "escrow total, %v, greater than actor balance, %v", escrowTotal, balance)
acc.Require(escrowTotal.GreaterThanEqual(totalProposalCollateral), "escrow total, %v, less than sum of proposal collateral, %v", escrowTotal, totalProposalCollateral)
}
//
// Deal Ops by Epoch
//
dealOpEpochCount := uint64(0)
dealOpCount := uint64(0)
if dealOps, err := AsSetMultimap(store, st.DealOpsByEpoch, builtin.DefaultHamtBitwidth, builtin.DefaultHamtBitwidth); err != nil {
acc.Addf("error loading deal ops: %v", err)
} else {
// get into internals just to iterate through full data structure
var setRoot cbg.CborCid
err = dealOps.mp.ForEach(&setRoot, func(key string) error {
epoch, err := binary.ReadUvarint(bytes.NewReader([]byte(key)))
acc.RequireNoError(err, "error epoch from bytes")
dealOpEpochCount++
return dealOps.ForEach(abi.ChainEpoch(epoch), func(id abi.DealID) error {
_, found := proposalStats[id]
acc.Require(found, "deal op found for deal id %d with missing proposal at epoch %d", id, epoch)
delete(expectedDealOps, id)
dealOpCount++
return nil
})
})
acc.RequireNoError(err, "error iterating deal ops")
}
acc.Require(len(expectedDealOps) == 0, "missing deal ops for proposals: %v", expectedDealOps)
//
// Provider Sectors
// Provider->sector->deal mapping
// A deal may have expired but remain in the mapping until settlement.
providerSectors := make(map[abi.SectorID][]abi.DealID)
if sectorDeals, err := adt.AsMap(store, st.ProviderSectors, ProviderSectorsHamtBitwidth); err != nil {
acc.Addf("error loading st.ProviderSectors: %v", err)
} else {
var sectorMapRoot cbg.CborCid
err = sectorDeals.ForEach(§orMapRoot, func(providerID string) error {
provider, err := abi.ParseUIntKey(providerID)
if err != nil {
acc.RequireNoError(err, "error getting address from bytes")
return nil
}
sectorMap, err := adt.AsMap(store, cid.Cid(sectorMapRoot), ProviderSectorsHamtBitwidth)
if err != nil {
acc.RequireNoError(err, "error loading sector map for provider %s", provider)
return nil
}
var dealIDs SectorDealIDs
err = sectorMap.ForEach(&dealIDs, func(sectorID string) error {
sectorNumber, err := abi.ParseUIntKey(sectorID)
acc.RequireNoError(err, "error sector number from bytes")
acc.Require(len(dealIDs) > 0, "no deal ids in sector %v", sectorID)
dealIDsCopy := make([]abi.DealID, len(dealIDs))
copy(dealIDsCopy, dealIDs)
providerSectors[abi.SectorID{Miner: abi.ActorID(provider), Number: abi.SectorNumber(sectorNumber)}] = dealIDsCopy
// check against proposalStats
for _, dealID := range dealIDsCopy {
st, found := proposalStats[dealID]
if !found || st.SlashEpoch != EpochUndefined || st.EndEpoch < currEpoch {
continue
}
acc.Require(st.SectorNumber == abi.SectorNumber(sectorNumber), "deal id %d sector number %d does not match sector id %d", dealID, st.SectorNumber, sectorNumber)
_, ok := expectedProviderSectors[dealID]
acc.Require(ok, "found unexpected deal in ProviderSectors")
delete(expectedProviderSectors, dealID)
provID, err := address.IDFromAddress(st.Provider)
if err != nil {
acc.Addf("error creating ID address: %v", err)
continue
}
acc.Require(provider == provID, "deal %d has provider %v, expected %v", dealID, provID, provider)
}
return nil
})
acc.RequireNoError(err, "error iterating sector deals")
return nil
})
acc.RequireNoError(err, "error iterating sector deals")
}
acc.Require(len(expectedProviderSectors) == 0, "missing %d providersectors entries for deals", len(expectedProviderSectors))
return &StateSummary{
Deals: proposalStats,
PendingDealAllocationIds: pendingDealAllocationIds,
PendingProposalCount: pendingProposalCount,
DealStateCount: dealStateCount,
LockTableCount: lockTableCount,
DealOpEpochCount: dealOpEpochCount,
DealOpCount: dealOpCount,
ClaimIdToDealId: claimIdToDealId,
AllocIdToDealId: allocationIdToDealId,
ProviderSectors: providerSectors,
}, acc
}