Documentation ¶
Index ¶
- Constants
- Variables
- type Claim
- type ClaimsByAddress
- type CreateMinerParams
- type CreateMinerReturn
- type CronEvent
- type CronEventsByAddress
- type CurrentTotalPowerReturn
- type EnrollCronEventParams
- type MinerConstructorParams
- type MinerCronEvent
- type ProofsByAddress
- type State
- type StateSummary
- type UpdateClaimedPowerParams
Constants ¶
const ConsensusMinerMinMiners = 4 // PARAM_SPEC
The number of miners that must meet the consensus minimum miner power before that minimum power is enforced as a condition of leader election. This ensures a network still functions before any miners reach that threshold.
const CronQueueAmtBitwidth = 6
Bitwidth of CronEventQueue AMT determined empirically from mutation patterns and projections of mainnet data.
const CronQueueHamtBitwidth = 6
Bitwidth of CronEventQueue HAMT determined empirically from mutation patterns and projections of mainnet data.
const MaxMinerProveCommitsPerEpoch = 200 // PARAM_SPEC
PARAM_SPEC// Maximum number of prove-commits each miner can submit in one epoch.
This limits the number of proof partitions we may need to load in the cron call path. Onboarding 1EiB/year requires at least 32 prove-commits per epoch.
const ProofValidationBatchAmtBitwidth = 4
Bitwidth of ProofValidationBatch AMT determined empirically from mutation pattersn and projections of mainnet data.
Variables ¶
genesis power in bytes = 750,000 GiB
max chain throughput in bytes per epoch = 120 ProveCommits / epoch = 3,840 GiB
var Methods = map[abi.MethodNum]builtin.MethodMeta{ 1: {"Constructor", *new(func(*abi.EmptyValue) *abi.EmptyValue)}, 2: {"CreateMiner", *new(func(*CreateMinerParams) *CreateMinerReturn)}, 3: {"UpdateClaimedPower", *new(func(*UpdateClaimedPowerParams) *abi.EmptyValue)}, 4: {"EnrollCronEvent", *new(func(*EnrollCronEventParams) *abi.EmptyValue)}, 5: {"CronTick", *new(func(*abi.EmptyValue) *abi.EmptyValue)}, 6: {"UpdatePledgeTotal", *new(func(*abi.TokenAmount) *abi.EmptyValue)}, 7: {"OnConsensusFault", nil}, 8: {"SubmitPoRepForBulkVerify", *new(func(*proof.SealVerifyInfo) *abi.EmptyValue)}, 9: {"CurrentTotalPower", *new(func(*abi.EmptyValue) *CurrentTotalPowerReturn)}, }
Functions ¶
This section is empty.
Types ¶
type Claim ¶
type Claim struct { // Miner's proof type used to determine minimum miner size WindowPoStProofType abi.RegisteredPoStProof // Sum of raw byte power for a miner's sectors. RawBytePower abi.StoragePower // Sum of quality adjusted power for a miner's sectors. QualityAdjPower abi.StoragePower }
type ClaimsByAddress ¶ added in v0.9.3
type ClaimsByAddress map[address.Address]Claim
func CheckClaimInvariants ¶ added in v0.9.3
func CheckClaimInvariants(st *State, store adt.Store, acc *builtin.MessageAccumulator) ClaimsByAddress
type CreateMinerParams ¶
type CreateMinerParams struct { Owner addr.Address Worker addr.Address WindowPoStProofType abi.RegisteredPoStProof Peer abi.PeerID Multiaddrs []abi.Multiaddrs }
func (*CreateMinerParams) MarshalCBOR ¶ added in v0.9.4
func (t *CreateMinerParams) MarshalCBOR(w io.Writer) error
func (*CreateMinerParams) UnmarshalCBOR ¶ added in v0.9.4
func (t *CreateMinerParams) UnmarshalCBOR(r io.Reader) error
type CreateMinerReturn ¶
type CreateMinerReturn struct { IDAddress addr.Address // The canonical ID-based address for the actor. RobustAddress addr.Address // A more expensive but re-org-safe address for the newly created actor. }
func (*CreateMinerReturn) MarshalCBOR ¶
func (t *CreateMinerReturn) MarshalCBOR(w io.Writer) error
func (*CreateMinerReturn) UnmarshalCBOR ¶
func (t *CreateMinerReturn) UnmarshalCBOR(r io.Reader) error
type CronEventsByAddress ¶ added in v0.9.3
type CronEventsByAddress map[address.Address][]MinerCronEvent
func CheckCronInvariants ¶ added in v0.9.3
func CheckCronInvariants(st *State, store adt.Store, acc *builtin.MessageAccumulator) CronEventsByAddress
type CurrentTotalPowerReturn ¶
type CurrentTotalPowerReturn struct { RawBytePower abi.StoragePower QualityAdjPower abi.StoragePower PledgeCollateral abi.TokenAmount QualityAdjPowerSmoothed smoothing.FilterEstimate }
func (*CurrentTotalPowerReturn) MarshalCBOR ¶
func (t *CurrentTotalPowerReturn) MarshalCBOR(w io.Writer) error
func (*CurrentTotalPowerReturn) UnmarshalCBOR ¶
func (t *CurrentTotalPowerReturn) UnmarshalCBOR(r io.Reader) error
type EnrollCronEventParams ¶
type EnrollCronEventParams struct { EventEpoch abi.ChainEpoch Payload []byte }
func (*EnrollCronEventParams) MarshalCBOR ¶
func (t *EnrollCronEventParams) MarshalCBOR(w io.Writer) error
func (*EnrollCronEventParams) UnmarshalCBOR ¶
func (t *EnrollCronEventParams) UnmarshalCBOR(r io.Reader) error
type MinerConstructorParams ¶
type MinerConstructorParams struct { OwnerAddr addr.Address WorkerAddr addr.Address ControlAddrs []addr.Address WindowPoStProofType abi.RegisteredPoStProof PeerId abi.PeerID Multiaddrs []abi.Multiaddrs }
Storage miner actor constructor params are defined here so the power actor can send them to the init actor to instantiate miners.
func (*MinerConstructorParams) MarshalCBOR ¶
func (t *MinerConstructorParams) MarshalCBOR(w io.Writer) error
func (*MinerConstructorParams) UnmarshalCBOR ¶
func (t *MinerConstructorParams) UnmarshalCBOR(r io.Reader) error
type MinerCronEvent ¶ added in v0.9.3
type MinerCronEvent struct { Epoch abi.ChainEpoch Payload []byte }
type ProofsByAddress ¶ added in v0.9.3
type ProofsByAddress map[address.Address][]proof.SealVerifyInfo
func CheckProofValidationInvariants ¶ added in v0.9.3
func CheckProofValidationInvariants(st *State, store adt.Store, claims ClaimsByAddress, acc *builtin.MessageAccumulator) ProofsByAddress
type State ¶
type State struct { TotalRawBytePower abi.StoragePower // TotalBytesCommitted includes claims from miners below min power threshold TotalBytesCommitted abi.StoragePower TotalQualityAdjPower abi.StoragePower // TotalQABytesCommitted includes claims from miners below min power threshold TotalQABytesCommitted abi.StoragePower TotalPledgeCollateral abi.TokenAmount // These fields are set once per epoch in the previous cron tick and used // for consistent values across a single epoch's state transition. ThisEpochRawBytePower abi.StoragePower ThisEpochQualityAdjPower abi.StoragePower ThisEpochPledgeCollateral abi.TokenAmount ThisEpochQAPowerSmoothed smoothing.FilterEstimate MinerCount int64 // Number of miners having proven the minimum consensus power. MinerAboveMinPowerCount int64 // A queue of events to be triggered by cron, indexed by epoch. CronEventQueue cid.Cid // Multimap, (HAMT[ChainEpoch]AMT[CronEvent]) // First epoch in which a cron task may be stored. // Cron will iterate every epoch between this and the current epoch inclusively to find tasks to execute. FirstCronEpoch abi.ChainEpoch // Claimed power for each miner. Claims cid.Cid // Map, HAMT[address]Claim ProofValidationBatch *cid.Cid // Multimap, (HAMT[Address]AMT[SealVerifyInfo]) }
func (*State) MinerNominalPowerMeetsConsensusMinimum ¶
func (st *State) MinerNominalPowerMeetsConsensusMinimum(s adt.Store, miner addr.Address) (bool, error)
MinerNominalPowerMeetsConsensusMinimum is used to validate Election PoSt winners outside the chain state. If the miner has over a threshold of power the miner meets the minimum. If the network is a below a threshold of miners and has power > zero the miner meets the minimum.
type StateSummary ¶ added in v0.9.3
type StateSummary struct { Crons CronEventsByAddress Claims ClaimsByAddress Proofs ProofsByAddress }
func CheckStateInvariants ¶ added in v0.9.3
func CheckStateInvariants(st *State, store adt.Store) (*StateSummary, *builtin.MessageAccumulator)
Checks internal invariants of power state.
type UpdateClaimedPowerParams ¶
type UpdateClaimedPowerParams struct { RawByteDelta abi.StoragePower QualityAdjustedDelta abi.StoragePower }
func (*UpdateClaimedPowerParams) MarshalCBOR ¶
func (t *UpdateClaimedPowerParams) MarshalCBOR(w io.Writer) error
func (*UpdateClaimedPowerParams) UnmarshalCBOR ¶
func (t *UpdateClaimedPowerParams) UnmarshalCBOR(r io.Reader) error