Modules

Structs

Miner Actor here in order to update the Power Actor to v3.
Base penalty for a successful disputed window post proof.
Base reward for successfully disputing a window posts proofs.
Wrapper for working with an AMTChainEpoch*Bitfield functioning as a queue, bucketed by epoch. Keys in the queue are quantized (upwards), modulo some offset, to reduce the cardinality of keys.
CompactCommD represents a Cid with compact representation of context dependant zero value
Quality multiplier for unverified deals in a sector
Deadline holds the state for all sectors due at a specific deadline.
Deadline calculations with respect to a current epoch. “Deadline” refers to the window during which proofs may be submitted. Windows are non-overlapping ranges [Open, Close), but the challenge epoch for a window occurs before the window opens.
Maps deadlines to partition maps.
Deadlines contains Deadline objects, describing the sectors due at the given deadline and their state (faulty, terminated, recovering, etc.).
A queue of expiration sets by epoch, representing the on-time or early termination epoch for a collection of sectors. Wraps an AMTChainEpoch*ExpirationSet. Keys in the queue are quantized (upwards), modulo some offset, to reduce the cardinality of keys.
ExpirationSet is a collection of sector numbers that are expiring, either due to expected “on-time” expiration at the end of their life, or unexpected “early” termination due to being faulty for too long consecutively. Note that there is not a direct correspondence between on-time sectors and active power; a sector may be faulty but expiring on-time if it faults just prior to expected termination. Early sectors are always faulty, and active power always represents on-time sectors.
Storage miner actor constructor params are defined here so the power actor can send them to the init actor to instantiate miners.
Static information about miner
Maps partitions to sector bitfields.
Quality multiplier for committed capacity (no deals) in a sector
ReplicaUpdate param with Option for CommD None means unknown
Information stored on-chain for a proven sector.
Information stored on-chain for a pre-committed sector.
Balance of Miner Actor should be greater than or equal to the sum of PreCommitDeposits and LockedFunds. It is possible for balance to fall below the sum of PCD, LF and InitialPledgeRequirements, and this is a bad state (IP Debt) that limits a miner actor’s behavior (i.e. no balance withdrawals) Excess balance as computed by st.GetAvailableBalance will be withdrawable or usable for pre-commit deposit or pledge lock-up.
Information submitted by a miner to provide a Window PoSt.
Quality multiplier for verified deals in a sector
Specification for a linear vesting schedule.
Represents the vesting table state for the miner. It is a slice of (VestingEpoch, VestingAmount). The slice will always be sorted by the VestingEpoch.

Enums

Storage Miner actor methods available

Constants

Functions

Checks whether a seal proof type is supported for new miners and sectors.
List of proof types which can be used when creating new miner actors
Returns true if the deadline at the given index is currently mutable.
The projected block reward a sector would earn over some period. Also known as “BR(t)”. BR(t) = ProjectedRewardFraction(t) * SectorQualityAdjustedPower ProjectedRewardFraction(t) is the sum of estimated reward over estimated total power over all epochs in the projection period [t t+projectionDuration]
Computes the pledge requirement for committing new quality-adjusted power to the network, given the current network total and baseline power, per-epoch reward, and circulating token supply. The pledge comprises two parts:
Prefix for sealed sector CIDs (CommR).
Prefix for unsealed sector CIDs (CommD).
The maximum number of partitions that may be required to be loaded in a single invocation, when all the sector infos for the partitions will be loaded.
Returns the amount of a reward to vest, and the vesting schedule, for a reward amount.
Maximum duration to allow for the sealing process for seal algorithms. Dependent on algorithm and sector size
The penalty for a sector continuing faulty for another proving period. It is a projection of the expected reward earned by the sector. Also known as “FF(t)”
Penalty to locked pledge collateral for the termination of a sector before scheduled expiry. SectorAge is the time between the sector’s activation and termination.
This is the SP(t) penalty for a newly faulty sector that has not been declared. SP(t) = UndeclaredFaultFactor * BR(t)
Returns the sum of the raw byte and quality-adjusted power for sectors.
Computes the PreCommit deposit given sector qa weight and current network conditions. PreCommit Deposit = BR(PreCommitDepositProjectionPeriod)
Returns the quality-adjusted power for a sector.
Returns the power for a sector size and weight.
Returns maximum achievable QA power.
DealWeight and VerifiedDealWeight are spacetime occupied by regular deals and verified deals in a sector. Sum of DealWeight and VerifiedDealWeight should be less than or equal to total SpaceTime of a sector. Sectors full of VerifiedDeals will have a SectorQuality of VerifiedDealWeightMultiplier/QualityBaseMultiplier. Sectors full of Deals will have a SectorQuality of DealWeightMultiplier/QualityBaseMultiplier. Sectors with neither will have a SectorQuality of QualityBaseMultiplier/QualityBaseMultiplier. SectorQuality of a sector is a weighted average of multipliers based on their proportions.
Maximum duration to allow for the sealing process for seal algorithms. Dependent on algorithm and sector size
Determine maximum number of deal miner’s sector can hold

Type Definitions