builtin

README

Actors

This package contains shims for abstracting over different actor versions.

Design

Shims in this package follow a few common design principles.

Generation

Shims are generated using make actors-gen

Structure Agnostic

Shims interfaces defined in this package should (ideally) not change even if the structure of the underlying data changes. For example:

• All shims store an internal "store" object. That way, state can be moved into a separate object without needing to add a store to the function signature.
• All functions must return an error, even if unused for now.

Minimal

These interfaces should be expanded only as necessary to reduce maintenance burden.

Queries, not field assessors.

When possible, functions should query the state instead of simply acting as field assessors. These queries are more likely to remain stable across specs-actor upgrades than specific state fields.

Note: there is a trade-off here. Avoid implementing complicated query logic inside these shims, as it will need to be replicated in every shim.

Documentation

Overview

Code generated by: `make actors-gen`. DO NOT EDIT.

Index

• Constants
• func ActorFamily(name string) string
• func ActorNameByCode(c cid.Cid) string
• func QAPowerForWeight(size abi.SectorSize, duration abi.ChainEpoch, ...) abi.StoragePower
• type ActorStateLoader
• type FilterEstimate
  • func FromV0FilterEstimate(v0 smoothing0.FilterEstimate) FilterEstimate
  • func FromV2FilterEstimate(v2 smoothing2.FilterEstimate) FilterEstimate
  • func FromV3FilterEstimate(v3 smoothing3.FilterEstimate) FilterEstimate
  • func FromV4FilterEstimate(v4 smoothing4.FilterEstimate) FilterEstimate
  • func FromV5FilterEstimate(v5 smoothing5.FilterEstimate) FilterEstimate
  • func FromV6FilterEstimate(v6 smoothing6.FilterEstimate) FilterEstimate
  • func FromV7FilterEstimate(v7 smoothing7.FilterEstimate) FilterEstimate
  • func FromV8FilterEstimate(v8 smoothing8.FilterEstimate) FilterEstimate
• type PoStProof

Constants

const (
	EpochDurationSeconds = builtin8.EpochDurationSeconds
)

Functions

func ActorFamily

func ActorFamily(name string) string

func ActorNameByCode

func ActorNameByCode(c cid.Cid) string

func QAPowerForWeight

func QAPowerForWeight(size abi.SectorSize, duration abi.ChainEpoch, dealWeight, verifiedWeight abi.DealWeight) abi.StoragePower

Types

type ActorStateLoader

type ActorStateLoader func(store adt.Store, root cid.Cid) (cbor.Marshaler, error)

type FilterEstimate

type FilterEstimate = smoothing0.FilterEstimate

func FromV0FilterEstimate

func FromV0FilterEstimate(v0 smoothing0.FilterEstimate) FilterEstimate

func FromV2FilterEstimate

func FromV2FilterEstimate(v2 smoothing2.FilterEstimate) FilterEstimate

func FromV3FilterEstimate

func FromV3FilterEstimate(v3 smoothing3.FilterEstimate) FilterEstimate

func FromV4FilterEstimate

func FromV4FilterEstimate(v4 smoothing4.FilterEstimate) FilterEstimate

func FromV5FilterEstimate

func FromV5FilterEstimate(v5 smoothing5.FilterEstimate) FilterEstimate

func FromV6FilterEstimate

func FromV6FilterEstimate(v6 smoothing6.FilterEstimate) FilterEstimate

func FromV7FilterEstimate

func FromV7FilterEstimate(v7 smoothing7.FilterEstimate) FilterEstimate

func FromV8FilterEstimate

func FromV8FilterEstimate(v8 smoothing8.FilterEstimate) FilterEstimate

type PoStProof

type PoStProof = proof8.PoStProof

These are all just type aliases across actor versions. In the future, that might change and we might need to do something fancier.