package miner import ( "github.com/filecoin-project/go-state-types/big" "github.com/filecoin-project/go-state-types/network" "github.com/filecoin-project/lotus/chain/actors" "github.com/ipfs/go-cid" "github.com/libp2p/go-libp2p-core/peer" cbg "github.com/whyrusleeping/cbor-gen" "golang.org/x/xerrors" "github.com/filecoin-project/go-address" "github.com/filecoin-project/go-bitfield" "github.com/filecoin-project/go-state-types/abi" "github.com/filecoin-project/go-state-types/cbor" "github.com/filecoin-project/go-state-types/dline" "github.com/filecoin-project/lotus/chain/actors/adt" "github.com/filecoin-project/lotus/chain/actors/builtin" "github.com/filecoin-project/lotus/chain/types" miner0 "github.com/filecoin-project/specs-actors/actors/builtin/miner" miner2 "github.com/filecoin-project/specs-actors/v2/actors/builtin/miner" miner3 "github.com/filecoin-project/specs-actors/v3/actors/builtin/miner" miner5 "github.com/filecoin-project/specs-actors/v5/actors/builtin/miner" miner7 "github.com/filecoin-project/specs-actors/v7/actors/builtin/miner" {{range .versions}} builtin{{.}} "github.com/filecoin-project/specs-actors{{import .}}actors/builtin" {{end}} ) func init() { {{range .versions}} builtin.RegisterActorState(builtin{{.}}.StorageMinerActorCodeID, func(store adt.Store, root cid.Cid) (cbor.Marshaler, error) { return load{{.}}(store, root) }) if c, ok := actors.GetActorCodeID(actors.Version{{.}}, "storageminer"); ok { builtin.RegisterActorState(c, func(store adt.Store, root cid.Cid) (cbor.Marshaler, error) { return load{{.}}(store, root) }) } {{end}} } var Methods = builtin{{.latestVersion}}.MethodsMiner // Unchanged between v0, v2, v3, v4, and v5 actors var WPoStProvingPeriod = miner0.WPoStProvingPeriod var WPoStPeriodDeadlines = miner0.WPoStPeriodDeadlines var WPoStChallengeWindow = miner0.WPoStChallengeWindow var WPoStChallengeLookback = miner0.WPoStChallengeLookback var FaultDeclarationCutoff = miner0.FaultDeclarationCutoff const MinSectorExpiration = miner0.MinSectorExpiration // Not used / checked in v0 // TODO: Abstract over network versions var DeclarationsMax = miner2.DeclarationsMax var AddressedSectorsMax = miner2.AddressedSectorsMax func Load(store adt.Store, act *types.Actor) (State, error) { if name, av, ok := actors.GetActorMetaByCode(act.Code); ok { if name != "storageminer" { return nil, xerrors.Errorf("actor code is not storageminer: %s", name) } switch av { {{range .versions}} case actors.Version{{.}}: return load{{.}}(store, act.Head) {{end}} default: return nil, xerrors.Errorf("unknown actor version: %d", av) } } switch act.Code { {{range .versions}} case builtin{{.}}.StorageMinerActorCodeID: return load{{.}}(store, act.Head) {{end}} } return nil, xerrors.Errorf("unknown actor code %s", act.Code) } func MakeState(store adt.Store, av actors.Version) (State, error) { switch av { {{range .versions}} case actors.Version{{.}}: return make{{.}}(store) {{end}} } return nil, xerrors.Errorf("unknown actor version %d", av) } func GetActorCodeID(av actors.Version) (cid.Cid, error) { if c, ok := actors.GetActorCodeID(av, "storageminer"); ok { return c, nil } switch av { {{range .versions}} case actors.Version{{.}}: return builtin{{.}}.StorageMinerActorCodeID, nil {{end}} } return cid.Undef, xerrors.Errorf("unknown actor version %d", av) } type State interface { cbor.Marshaler // Total available balance to spend. AvailableBalance(abi.TokenAmount) (abi.TokenAmount, error) // Funds that will vest by the given epoch. VestedFunds(abi.ChainEpoch) (abi.TokenAmount, error) // Funds locked for various reasons. LockedFunds() (LockedFunds, error) FeeDebt() (abi.TokenAmount, error) GetSector(abi.SectorNumber) (*SectorOnChainInfo, error) FindSector(abi.SectorNumber) (*SectorLocation, error) GetSectorExpiration(abi.SectorNumber) (*SectorExpiration, error) GetPrecommittedSector(abi.SectorNumber) (*SectorPreCommitOnChainInfo, error) ForEachPrecommittedSector(func(SectorPreCommitOnChainInfo) error) error LoadSectors(sectorNos *bitfield.BitField) ([]*SectorOnChainInfo, error) NumLiveSectors() (uint64, error) IsAllocated(abi.SectorNumber) (bool, error) // UnallocatedSectorNumbers returns up to count unallocated sector numbers (or less than // count if there aren't enough). UnallocatedSectorNumbers(count int) ([]abi.SectorNumber, error) GetAllocatedSectors() (*bitfield.BitField, error) // Note that ProvingPeriodStart is deprecated and will be renamed / removed in a future version of actors GetProvingPeriodStart() (abi.ChainEpoch, error) // Testing only EraseAllUnproven() error LoadDeadline(idx uint64) (Deadline, error) ForEachDeadline(cb func(idx uint64, dl Deadline) error) error NumDeadlines() (uint64, error) DeadlinesChanged(State) (bool, error) Info() (MinerInfo, error) MinerInfoChanged(State) (bool, error) DeadlineInfo(epoch abi.ChainEpoch) (*dline.Info, error) DeadlineCronActive() (bool, error) // Diff helpers. Used by Diff* functions internally. sectors() (adt.Array, error) decodeSectorOnChainInfo(*cbg.Deferred) (SectorOnChainInfo, error) precommits() (adt.Map, error) decodeSectorPreCommitOnChainInfo(*cbg.Deferred) (SectorPreCommitOnChainInfo, error) GetState() interface{} } type Deadline interface { LoadPartition(idx uint64) (Partition, error) ForEachPartition(cb func(idx uint64, part Partition) error) error PartitionsPoSted() (bitfield.BitField, error) PartitionsChanged(Deadline) (bool, error) DisputableProofCount() (uint64, error) } type Partition interface { // AllSectors returns all sector numbers in this partition, including faulty, unproven, and terminated sectors AllSectors() (bitfield.BitField, error) // Subset of sectors detected/declared faulty and not yet recovered (excl. from PoSt). // Faults ∩ Terminated = ∅ FaultySectors() (bitfield.BitField, error) // Subset of faulty sectors expected to recover on next PoSt // Recoveries ∩ Terminated = ∅ RecoveringSectors() (bitfield.BitField, error) // Live sectors are those that are not terminated (but may be faulty). LiveSectors() (bitfield.BitField, error) // Active sectors are those that are neither terminated nor faulty nor unproven, i.e. actively contributing power. ActiveSectors() (bitfield.BitField, error) // Unproven sectors in this partition. This bitfield will be cleared on // a successful window post (or at the end of the partition's next // deadline). At that time, any still unproven sectors will be added to // the faulty sector bitfield. UnprovenSectors() (bitfield.BitField, error) } type SectorOnChainInfo struct { SectorNumber abi.SectorNumber SealProof abi.RegisteredSealProof SealedCID cid.Cid DealIDs []abi.DealID Activation abi.ChainEpoch Expiration abi.ChainEpoch DealWeight abi.DealWeight VerifiedDealWeight abi.DealWeight InitialPledge abi.TokenAmount ExpectedDayReward abi.TokenAmount ExpectedStoragePledge abi.TokenAmount SectorKeyCID *cid.Cid } type SectorPreCommitInfo = miner0.SectorPreCommitInfo type SectorPreCommitOnChainInfo struct { Info SectorPreCommitInfo PreCommitDeposit abi.TokenAmount PreCommitEpoch abi.ChainEpoch DealWeight abi.DealWeight VerifiedDealWeight abi.DealWeight } type PoStPartition = miner0.PoStPartition type RecoveryDeclaration = miner0.RecoveryDeclaration type FaultDeclaration = miner0.FaultDeclaration type ReplicaUpdate = miner7.ReplicaUpdate // Params type DeclareFaultsParams = miner0.DeclareFaultsParams type DeclareFaultsRecoveredParams = miner0.DeclareFaultsRecoveredParams type SubmitWindowedPoStParams = miner0.SubmitWindowedPoStParams type ProveCommitSectorParams = miner0.ProveCommitSectorParams type DisputeWindowedPoStParams = miner3.DisputeWindowedPoStParams type ProveCommitAggregateParams = miner5.ProveCommitAggregateParams type ProveReplicaUpdatesParams = miner7.ProveReplicaUpdatesParams func PreferredSealProofTypeFromWindowPoStType(nver network.Version, proof abi.RegisteredPoStProof) (abi.RegisteredSealProof, error) { // We added support for the new proofs in network version 7, and removed support for the old // ones in network version 8. if nver < network.Version7 { switch proof { case abi.RegisteredPoStProof_StackedDrgWindow2KiBV1: return abi.RegisteredSealProof_StackedDrg2KiBV1, nil case abi.RegisteredPoStProof_StackedDrgWindow8MiBV1: return abi.RegisteredSealProof_StackedDrg8MiBV1, nil case abi.RegisteredPoStProof_StackedDrgWindow512MiBV1: return abi.RegisteredSealProof_StackedDrg512MiBV1, nil case abi.RegisteredPoStProof_StackedDrgWindow32GiBV1: return abi.RegisteredSealProof_StackedDrg32GiBV1, nil case abi.RegisteredPoStProof_StackedDrgWindow64GiBV1: return abi.RegisteredSealProof_StackedDrg64GiBV1, nil default: return -1, xerrors.Errorf("unrecognized window post type: %d", proof) } } switch proof { case abi.RegisteredPoStProof_StackedDrgWindow2KiBV1: return abi.RegisteredSealProof_StackedDrg2KiBV1_1, nil case abi.RegisteredPoStProof_StackedDrgWindow8MiBV1: return abi.RegisteredSealProof_StackedDrg8MiBV1_1, nil case abi.RegisteredPoStProof_StackedDrgWindow512MiBV1: return abi.RegisteredSealProof_StackedDrg512MiBV1_1, nil case abi.RegisteredPoStProof_StackedDrgWindow32GiBV1: return abi.RegisteredSealProof_StackedDrg32GiBV1_1, nil case abi.RegisteredPoStProof_StackedDrgWindow64GiBV1: return abi.RegisteredSealProof_StackedDrg64GiBV1_1, nil default: return -1, xerrors.Errorf("unrecognized window post type: %d", proof) } } func WinningPoStProofTypeFromWindowPoStProofType(nver network.Version, proof abi.RegisteredPoStProof) (abi.RegisteredPoStProof, error) { switch proof { case abi.RegisteredPoStProof_StackedDrgWindow2KiBV1: return abi.RegisteredPoStProof_StackedDrgWinning2KiBV1, nil case abi.RegisteredPoStProof_StackedDrgWindow8MiBV1: return abi.RegisteredPoStProof_StackedDrgWinning8MiBV1, nil case abi.RegisteredPoStProof_StackedDrgWindow512MiBV1: return abi.RegisteredPoStProof_StackedDrgWinning512MiBV1, nil case abi.RegisteredPoStProof_StackedDrgWindow32GiBV1: return abi.RegisteredPoStProof_StackedDrgWinning32GiBV1, nil case abi.RegisteredPoStProof_StackedDrgWindow64GiBV1: return abi.RegisteredPoStProof_StackedDrgWinning64GiBV1, nil default: return -1, xerrors.Errorf("unknown proof type %d", proof) } } type MinerInfo struct { Owner address.Address // Must be an ID-address. Worker address.Address // Must be an ID-address. NewWorker address.Address // Must be an ID-address. ControlAddresses []address.Address // Must be an ID-addresses. WorkerChangeEpoch abi.ChainEpoch PeerId *peer.ID Multiaddrs []abi.Multiaddrs WindowPoStProofType abi.RegisteredPoStProof SectorSize abi.SectorSize WindowPoStPartitionSectors uint64 ConsensusFaultElapsed abi.ChainEpoch } func (mi MinerInfo) IsController(addr address.Address) bool { if addr == mi.Owner || addr == mi.Worker { return true } for _, ca := range mi.ControlAddresses { if addr == ca { return true } } return false } type SectorExpiration struct { OnTime abi.ChainEpoch // non-zero if sector is faulty, epoch at which it will be permanently // removed if it doesn't recover Early abi.ChainEpoch } type SectorLocation struct { Deadline uint64 Partition uint64 } type SectorChanges struct { Added []SectorOnChainInfo Extended []SectorExtensions Removed []SectorOnChainInfo } type SectorExtensions struct { From SectorOnChainInfo To SectorOnChainInfo } type PreCommitChanges struct { Added []SectorPreCommitOnChainInfo Removed []SectorPreCommitOnChainInfo } type LockedFunds struct { VestingFunds abi.TokenAmount InitialPledgeRequirement abi.TokenAmount PreCommitDeposits abi.TokenAmount } func (lf LockedFunds) TotalLockedFunds() abi.TokenAmount { return big.Add(lf.VestingFunds, big.Add(lf.InitialPledgeRequirement, lf.PreCommitDeposits)) }