init

Documentation

Index

• Variables
• type ConstructorParams
  • func (t *ConstructorParams) MarshalCBOR(w io.Writer) error
  • func (t *ConstructorParams) UnmarshalCBOR(r io.Reader) (err error)
• type ExecParams
  • func (t *ExecParams) MarshalCBOR(w io.Writer) error
  • func (t *ExecParams) UnmarshalCBOR(r io.Reader) (err error)
• type ExecReturn
  • func (t *ExecReturn) MarshalCBOR(w io.Writer) error
  • func (t *ExecReturn) UnmarshalCBOR(r io.Reader) (err error)
• type State
  • func ConstructState(store adt.Store, networkName string) (*State, error)
  • func (s *State) MapAddressToNewID(store adt.Store, address addr.Address) (addr.Address, error)
  • func (t *State) MarshalCBOR(w io.Writer) error
  • func (s *State) ResolveAddress(store adt.Store, address addr.Address) (addr.Address, bool, error)
  • func (t *State) UnmarshalCBOR(r io.Reader) (err error)
• type StateSummary
  • func CheckStateInvariants(st *State, store adt.Store) (*StateSummary, *builtin.MessageAccumulator)

Variables

var Methods = map[abi.MethodNum]builtin.MethodMeta{
	1: builtin.NewMethodMeta("Constructor", *new(func(*ConstructorParams) *abi.EmptyValue)),
	2: builtin.NewMethodMeta("Exec", *new(func(*ExecParams) *ExecReturn)),
}

Types

type ConstructorParams

type ConstructorParams struct {
	NetworkName string
}

func (*ConstructorParams) MarshalCBOR

func (t *ConstructorParams) MarshalCBOR(w io.Writer) error

func (*ConstructorParams) UnmarshalCBOR

func (t *ConstructorParams) UnmarshalCBOR(r io.Reader) (err error)

type ExecParams

type ExecParams struct {
	CodeCID           cid.Cid `checked:"true"` // invalid CIDs won't get committed to the state tree
	ConstructorParams []byte
}

func (*ExecParams) MarshalCBOR

func (t *ExecParams) MarshalCBOR(w io.Writer) error

func (*ExecParams) UnmarshalCBOR

func (t *ExecParams) UnmarshalCBOR(r io.Reader) (err error)

type ExecReturn

type ExecReturn 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 (*ExecReturn) MarshalCBOR

func (t *ExecReturn) MarshalCBOR(w io.Writer) error

func (*ExecReturn) UnmarshalCBOR

func (t *ExecReturn) UnmarshalCBOR(r io.Reader) (err error)

type State

type State struct {
	AddressMap  cid.Cid // HAMT[addr.Address]abi.ActorID
	NextID      abi.ActorID
	NetworkName string
}

func ConstructState

func ConstructState(store adt.Store, networkName string) (*State, error)

func (*State) MapAddressToNewID

func (s *State) MapAddressToNewID(store adt.Store, address addr.Address) (addr.Address, error)

Allocates a new ID address and stores a mapping of the argument address to it. Returns the newly-allocated address.

func (*State) MarshalCBOR

func (t *State) MarshalCBOR(w io.Writer) error

func (*State) ResolveAddress

func (s *State) ResolveAddress(store adt.Store, address addr.Address) (addr.Address, bool, error)

ResolveAddress resolves an address to an ID-address, if possible. If the provided address is an ID address, it is returned as-is. This means that mapped ID-addresses (which should only appear as values, not keys) and singleton actor addresses (which are not in the map) pass through unchanged.

Returns an ID-address and `true` if the address was already an ID-address or was resolved in the mapping. Returns an undefined address and `false` if the address was not an ID-address and not found in the mapping. Returns an error only if state was inconsistent.

func (*State) UnmarshalCBOR

func (t *State) UnmarshalCBOR(r io.Reader) (err error)

type StateSummary

type StateSummary struct {
	AddrIDs map[addr.Address]abi.ActorID
	NextID  abi.ActorID
}

func CheckStateInvariants

func CheckStateInvariants(st *State, store adt.Store) (*StateSummary, *builtin.MessageAccumulator)

Checks internal invariants of init state.