states

Documentation

Index

• type Actor
  • func (t *Actor) MarshalCBOR(w io.Writer) error
  • func (t *Actor) UnmarshalCBOR(r io.Reader) error
• type Tree
  • func LoadTree(s adt.Store, r cid.Cid) (*Tree, error)
  • func NewTree(store adt.Store) (*Tree, error)
  • func (t *Tree) Flush() (cid.Cid, error)
  • func (t *Tree) ForEach(fn func(addr address.Address, actor *Actor) error) error
  • func (t *Tree) ForEachKey(fn func(addr address.Address) error) error
  • func (t *Tree) GetActor(addr address.Address) (*Actor, bool, error)
  • func (t *Tree) SetActor(addr address.Address, actor *Actor) error

Types

type Actor

type Actor struct {
	Code       cid.Cid // CID representing the code associated with the actor
	Head       cid.Cid // CID of the head state object for the actor
	CallSeqNum uint64  // CallSeqNum for the next message to be received by the actor (non-zero for accounts only)
	Balance    big.Int // Token balance of the actor
}

Value type of the top level of the state tree. Represents the on-chain state of a single actor.

func (*Actor) MarshalCBOR

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

func (*Actor) UnmarshalCBOR

func (t *Actor) UnmarshalCBOR(r io.Reader) error

type Tree

type Tree struct {
	Map   *adt.Map
	Store adt.Store
}

A specialization of a map of ID-addresses to actor heads.

func LoadTree

func LoadTree(s adt.Store, r cid.Cid) (*Tree, error)

Loads a tree from a root CID and store.

func NewTree

func NewTree(store adt.Store) (*Tree, error)

Initializes a new, empty state tree backed by a store.

func (*Tree) Flush

func (t *Tree) Flush() (cid.Cid, error)

Writes the tree root node to the store, and returns its CID.

func (*Tree) ForEach

func (t *Tree) ForEach(fn func(addr address.Address, actor *Actor) error) error

Traverses all entries in the tree.

func (*Tree) ForEachKey

func (t *Tree) ForEachKey(fn func(addr address.Address) error) error

Traverses all keys in the tree, without decoding the actor states.

func (*Tree) GetActor

func (t *Tree) GetActor(addr address.Address) (*Actor, bool, error)

Loads the state associated with an address.

func (*Tree) SetActor

func (t *Tree) SetActor(addr address.Address, actor *Actor) error

Sets the state associated with an address, overwriting if it already present.