builtin

Documentation

Index

• Constants
• Variables
• func ConsensusMinerMinPower(p stabi.RegisteredPoStProof) (stabi.StoragePower, error)
• func PoStProofWindowPoStPartitionSectors(p stabi.RegisteredPoStProof) (uint64, error)
• func SealProofSectorMaximumLifetime(p stabi.RegisteredSealProof) (stabi.ChainEpoch, error)
• func SealProofWindowPoStPartitionSectors(p stabi.RegisteredSealProof) (uint64, error)
• type BigFrac
• type PoStProofPolicy
• type QuantSpec
  • func NewQuantSpec(unit, offset abi.ChainEpoch) QuantSpec
• type SealProofPolicy

Constants

const (
	MethodSend                     = abi.MethodNum(0)
	MethodConstructor              = abi.MethodNum(1)
	UniversalReceiverHookMethodNum = abi.MethodNum(3726118371)
)

const DefaultHamtBitwidth = 5

Default log2 of branching factor for HAMTs. This value has been empirically chosen, but the optimal value for maps with different mutation profiles may differ.

const DefaultTokenActorBitwidth = 3

const EpochDurationSeconds = 30

PARAM_SPEC The duration of a chain epoch. Motivation: It guarantees that a block is propagated and WinningPoSt can be successfully done in time all supported miners. Usage: It is used for deriving epoch-denominated periods that are more naturally expressed in clock time. TODO: In lieu of a real configuration mechanism for this value, we'd like to make it a var so that implementations can override it at runtime. Doing so requires changing all the static references to it in this repo to go through late-binding function calls, or they'll see the "wrong" value. https://github.com/filecoin-project/specs-actors/issues/353 If EpochDurationSeconds is changed, update `BaselineExponent`, `lambda`, and // `expLamSubOne` in ./reward/reward_logic.go You can re-calculate these constants by changing the epoch duration in ./reward/reward_calc.py and running it.

const EpochsIn540Days = stabi.ChainEpoch(540 * EpochsInDay)

For V1 Stacked DRG sectors, the max is 540 days since Network Version 11

according to https://github.com/filecoin-project/FIPs/blob/master/FIPS/fip-0014.md

const EpochsInDay = 24 * EpochsInHour

const EpochsInFiveYears = stabi.ChainEpoch(5 * EpochsInYear)

For V1_1 Stacked DRG sectors, the max is 5 years

const EpochsInHour = SecondsInHour / EpochDurationSeconds

const EpochsInYear = 365 * EpochsInDay

const FirstNonSingletonActorId = 100

const SecondsInDay = 24 * SecondsInHour

const SecondsInHour = 60 * 60

const SectorQualityPrecision = 20

Precision used for making QA power calculations

Variables

var (
	// Distinguished AccountActor that is the source of system implicit messages.
	SystemActorAddr           = mustMakeAddress(0)
	InitActorAddr             = mustMakeAddress(1)
	RewardActorAddr           = mustMakeAddress(2)
	CronActorAddr             = mustMakeAddress(3)
	StoragePowerActorAddr     = mustMakeAddress(4)
	StorageMarketActorAddr    = mustMakeAddress(5)
	VerifiedRegistryActorAddr = mustMakeAddress(6)
	DatacapActorAddr          = mustMakeAddress(7)
	// Distinguished AccountActor that is the destination of all burnt funds.
	BurntFundsActorAddr = mustMakeAddress(99)
)

Addresses for singleton system actors.

var DealWeightMultiplier = big.NewInt(10)

Quality multiplier for unverified deals in a sector

var ExpectedLeadersPerEpoch = int64(5)

PARAM_SPEC Expected number of block quality in an epoch (e.g. 1 block with block quality 5, or 5 blocks with quality 1) Motivation: It ensures that there is enough on-chain throughput Usage: It is used to calculate the block reward.

var MethodsAccount = struct {
	Constructor           abi.MethodNum
	PubkeyAddress         abi.MethodNum
	AuthenticateMessage   abi.MethodNum
	UniversalReceiverHook abi.MethodNum
}{MethodConstructor, 2, 3, UniversalReceiverHookMethodNum}

var MethodsCron = struct {
	Constructor abi.MethodNum
	EpochTick   abi.MethodNum
}{MethodConstructor, 2}

var MethodsDatacap = struct {
	Constructor       abi.MethodNum
	Mint              abi.MethodNum
	Destroy           abi.MethodNum
	Name              abi.MethodNum
	Symbol            abi.MethodNum
	TotalSupply       abi.MethodNum
	BalanceOf         abi.MethodNum
	Transfer          abi.MethodNum
	TransferFrom      abi.MethodNum
	IncreaseAllowance abi.MethodNum
	DecreaseAllowance abi.MethodNum
	RevokeAllowance   abi.MethodNum
	Burn              abi.MethodNum
	BurnFrom          abi.MethodNum
}{MethodConstructor, 2, 3, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20}

var MethodsInit = struct {
	Constructor abi.MethodNum
	Exec        abi.MethodNum
}{MethodConstructor, 2}

var MethodsMarket = struct {
	Constructor              abi.MethodNum
	AddBalance               abi.MethodNum
	WithdrawBalance          abi.MethodNum
	PublishStorageDeals      abi.MethodNum
	VerifyDealsForActivation abi.MethodNum
	ActivateDeals            abi.MethodNum
	OnMinerSectorsTerminate  abi.MethodNum
	ComputeDataCommitment    abi.MethodNum
	CronTick                 abi.MethodNum
}{MethodConstructor, 2, 3, 4, 5, 6, 7, 8, 9}

var MethodsMiner = struct {
	Constructor              abi.MethodNum
	ControlAddresses         abi.MethodNum
	ChangeWorkerAddress      abi.MethodNum
	ChangePeerID             abi.MethodNum
	SubmitWindowedPoSt       abi.MethodNum
	PreCommitSector          abi.MethodNum
	ProveCommitSector        abi.MethodNum
	ExtendSectorExpiration   abi.MethodNum
	TerminateSectors         abi.MethodNum
	DeclareFaults            abi.MethodNum
	DeclareFaultsRecovered   abi.MethodNum
	OnDeferredCronEvent      abi.MethodNum
	CheckSectorProven        abi.MethodNum
	ApplyRewards             abi.MethodNum
	ReportConsensusFault     abi.MethodNum
	WithdrawBalance          abi.MethodNum
	ConfirmSectorProofsValid abi.MethodNum
	ChangeMultiaddrs         abi.MethodNum
	CompactPartitions        abi.MethodNum
	CompactSectorNumbers     abi.MethodNum
	ConfirmUpdateWorkerKey   abi.MethodNum
	RepayDebt                abi.MethodNum
	ChangeOwnerAddress       abi.MethodNum
	DisputeWindowedPoSt      abi.MethodNum
	PreCommitSectorBatch     abi.MethodNum
	ProveCommitAggregate     abi.MethodNum
	ProveReplicaUpdates      abi.MethodNum
	PreCommitSectorBatch2    abi.MethodNum
	ProveReplicaUpdates2     abi.MethodNum
	ChangeBeneficiary        abi.MethodNum
	GetBeneficiary           abi.MethodNum
	ExtendSectorExpiration2  abi.MethodNum
}{MethodConstructor, 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}

var MethodsMultisig = struct {
	Constructor                 abi.MethodNum
	Propose                     abi.MethodNum
	Approve                     abi.MethodNum
	Cancel                      abi.MethodNum
	AddSigner                   abi.MethodNum
	RemoveSigner                abi.MethodNum
	SwapSigner                  abi.MethodNum
	ChangeNumApprovalsThreshold abi.MethodNum
	LockBalance                 abi.MethodNum
	UniversalReceiverHook       abi.MethodNum
}{MethodConstructor, 2, 3, 4, 5, 6, 7, 8, 9, UniversalReceiverHookMethodNum}

var MethodsPaych = struct {
	Constructor        abi.MethodNum
	UpdateChannelState abi.MethodNum
	Settle             abi.MethodNum
	Collect            abi.MethodNum
}{MethodConstructor, 2, 3, 4}

var MethodsPower = struct {
	Constructor              abi.MethodNum
	CreateMiner              abi.MethodNum
	UpdateClaimedPower       abi.MethodNum
	EnrollCronEvent          abi.MethodNum
	CronTick                 abi.MethodNum
	UpdatePledgeTotal        abi.MethodNum
	Deprecated1              abi.MethodNum
	SubmitPoRepForBulkVerify abi.MethodNum
	CurrentTotalPower        abi.MethodNum
}{MethodConstructor, 2, 3, 4, 5, 6, 7, 8, 9}

var MethodsReward = struct {
	Constructor      abi.MethodNum
	AwardBlockReward abi.MethodNum
	ThisEpochReward  abi.MethodNum
	UpdateNetworkKPI abi.MethodNum
}{MethodConstructor, 2, 3, 4}

var MethodsVerifiedRegistry = struct {
	Constructor                 abi.MethodNum
	AddVerifier                 abi.MethodNum
	RemoveVerifier              abi.MethodNum
	AddVerifiedClient           abi.MethodNum
	Deprecated1                 abi.MethodNum
	Deprecated2                 abi.MethodNum
	RemoveVerifiedClientDataCap abi.MethodNum
	RemoveExpiredAllocations    abi.MethodNum
	ClaimAllocations            abi.MethodNum
	GetClaims                   abi.MethodNum
	ExtendClaimTerms            abi.MethodNum
	RemoveExpiredClaims         abi.MethodNum
	UniversalReceiverHook       abi.MethodNum
}{MethodConstructor, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, UniversalReceiverHookMethodNum}

var OneNanoFIL = big.NewInt(1_000_000_000)

1 NanoFIL

var PoStProofPolicies = map[stabi.RegisteredPoStProof]*PoStProofPolicy{
	stabi.RegisteredPoStProof_StackedDrgWindow2KiBV1: {
		WindowPoStPartitionSectors: 2,
		ConsensusMinerMinPower:     stabi.NewStoragePower(10 << 40),
	},
	stabi.RegisteredPoStProof_StackedDrgWindow8MiBV1: {
		WindowPoStPartitionSectors: 2,
		ConsensusMinerMinPower:     stabi.NewStoragePower(10 << 40),
	},
	stabi.RegisteredPoStProof_StackedDrgWindow512MiBV1: {
		WindowPoStPartitionSectors: 2,
		ConsensusMinerMinPower:     stabi.NewStoragePower(10 << 40),
	},
	stabi.RegisteredPoStProof_StackedDrgWindow32GiBV1: {
		WindowPoStPartitionSectors: 2349,
		ConsensusMinerMinPower:     stabi.NewStoragePower(10 << 40),
	},
	stabi.RegisteredPoStProof_StackedDrgWindow64GiBV1: {
		WindowPoStPartitionSectors: 2300,
		ConsensusMinerMinPower:     stabi.NewStoragePower(10 << 40),
	},
}

Partition sizes must match those used by the proofs library. See https://github.com/filecoin-project/rust-fil-proofs/blob/master/filecoin-proofs/src/constants.rs#L85

var QualityBaseMultiplier = big.NewInt(10)

Quality multiplier for committed capacity (no deals) in a sector

var SealProofPoliciesV11 = map[stabi.RegisteredSealProof]*SealProofPolicy{
	stabi.RegisteredSealProof_StackedDrg2KiBV1: {
		SectorMaxLifetime: EpochsIn540Days,
	},
	stabi.RegisteredSealProof_StackedDrg8MiBV1: {
		SectorMaxLifetime: EpochsIn540Days,
	},
	stabi.RegisteredSealProof_StackedDrg512MiBV1: {
		SectorMaxLifetime: EpochsIn540Days,
	},
	stabi.RegisteredSealProof_StackedDrg32GiBV1: {
		SectorMaxLifetime: EpochsIn540Days,
	},
	stabi.RegisteredSealProof_StackedDrg64GiBV1: {
		SectorMaxLifetime: EpochsIn540Days,
	},

	stabi.RegisteredSealProof_StackedDrg2KiBV1_1: {
		SectorMaxLifetime: EpochsInFiveYears,
	},
	stabi.RegisteredSealProof_StackedDrg8MiBV1_1: {
		SectorMaxLifetime: EpochsInFiveYears,
	},
	stabi.RegisteredSealProof_StackedDrg512MiBV1_1: {
		SectorMaxLifetime: EpochsInFiveYears,
	},
	stabi.RegisteredSealProof_StackedDrg32GiBV1_1: {
		SectorMaxLifetime: EpochsInFiveYears,
	},
	stabi.RegisteredSealProof_StackedDrg64GiBV1_1: {
		SectorMaxLifetime: EpochsInFiveYears,
	},
}

540-day maximum life time setting for V1 since network version 11

var TokenPrecision = big.NewIntUnsigned(1_000_000_000_000_000_000)

Number of token units in an abstract "FIL" token. The network works purely in the indivisible token amounts. This constant converts to a fixed decimal with more human-friendly scale.

var TotalFilecoin = big.Mul(big.NewIntUnsigned(2_000_000_000), TokenPrecision)

The maximum supply of Filecoin that will ever exist (in token units)

var VerifiedDealWeightMultiplier = big.NewInt(100)

Quality multiplier for verified deals in a sector

Functions

func ConsensusMinerMinPower

func ConsensusMinerMinPower(p stabi.RegisteredPoStProof) (stabi.StoragePower, error)

The minimum power of an individual miner to meet the threshold for leader election (in bytes). Motivation: - Limits sybil generation - Improves consensus fault detection - Guarantees a minimum fee for consensus faults - Ensures that a specific soundness for the power table Note: We may be able to reduce this in the future, addressing consensus faults with more complicated penalties, sybil generation with crypto-economic mechanism, and PoSt soundness by increasing the challenges for small miners.

func PoStProofWindowPoStPartitionSectors

func PoStProofWindowPoStPartitionSectors(p stabi.RegisteredPoStProof) (uint64, error)

Returns the partition size, in sectors, associated with a Window PoSt proof type. The partition size is the number of sectors proved in a single PoSt proof.

func SealProofSectorMaximumLifetime

func SealProofSectorMaximumLifetime(p stabi.RegisteredSealProof) (stabi.ChainEpoch, error)

SectorMaximumLifetime is the maximum duration a sector sealed with this proof may exist between activation and expiration

func SealProofWindowPoStPartitionSectors

func SealProofWindowPoStPartitionSectors(p stabi.RegisteredSealProof) (uint64, error)

Returns the partition size, in sectors, associated with a seal proof type. The partition size is the number of sectors proved in a single PoSt proof.

Types

type BigFrac

type BigFrac struct {
	Numerator   big.Int
	Denominator big.Int
}

type PoStProofPolicy

type PoStProofPolicy struct {
	WindowPoStPartitionSectors uint64
	ConsensusMinerMinPower     stabi.StoragePower
}

Policy values associated with a PoSt proof type.

type QuantSpec

type QuantSpec struct {
	// contains filtered or unexported fields
}

A spec for quantization.

func NewQuantSpec

func NewQuantSpec(unit, offset abi.ChainEpoch) QuantSpec

type SealProofPolicy

type SealProofPolicy struct {
	SectorMaxLifetime stabi.ChainEpoch
}

Policy values associated with a seal proof type.