btp

Documentation

Index

• Constants
• Variables
• func NewDigestFromBytes(bytes []byte) (module.BTPDigest, error)
• func NewDigestFromHashAndBytes(hash []byte, bytes []byte) (module.BTPDigest, error)
• func NewDigestWithBuilder(builder merkle.Builder, hash []byte) (module.BTPDigest, error)
• func NewProofContextMap(view StateView) (module.BTPProofContextMap, error)
• func NewSection(digest module.BTPDigest, view StateView, dbase db.Database) (module.BTPSection, error)
• type NetworkTypeView
• type NetworkView
• type SectionBuilder
  • func NewSectionBuilder(view StateView) SectionBuilder
• type StateView

Constants

const (
	NSFilterCap = 256 / 8
)

Variables

var ZeroBTPSection = newBTPSection(nil, nil)

var ZeroDigest = &digest{
	core: zeroDigestCore{},
}

var ZeroProofContextMap = &proofContextMap{
	pcMap: make(map[int64]module.BTPProofContext),
}

Functions

func NewDigestFromBytes

func NewDigestFromBytes(bytes []byte) (module.BTPDigest, error)

func NewDigestFromHashAndBytes

func NewDigestFromHashAndBytes(
	hash []byte,
	bytes []byte,
) (module.BTPDigest, error)

func NewDigestWithBuilder

func NewDigestWithBuilder(builder merkle.Builder, hash []byte) (module.BTPDigest, error)

func NewProofContextMap

func NewProofContextMap(view StateView) (module.BTPProofContextMap, error)

func NewSection

func NewSection(
	digest module.BTPDigest,
	view StateView,
	dbase db.Database,
) (module.BTPSection, error)

NewSection returns a new Section. view shall have the final value for a transition.

Types

type NetworkTypeView

type NetworkTypeView interface {
	UID() string
	NextProofContextHash() []byte
	NextProofContext() []byte
	OpenNetworkIDs() []int64
}

type NetworkView

type NetworkView interface {
	Name() string
	Owner() module.Address
	NetworkTypeID() int64
	Open() bool
	NextMessageSN() int64
	NextProofContextChanged() bool
	PrevNetworkSectionHash() []byte
	LastNetworkSectionHash() []byte
}

type SectionBuilder

type SectionBuilder interface {
	SendMessage(nid int64, msg []byte)
	EnsureSection(nid int64)
	NotifyInactivated(ntid int64)
	Build() (module.BTPSection, error)
}

func NewSectionBuilder

func NewSectionBuilder(view StateView) SectionBuilder

NewSectionBuilder returns new SectionBuilder. view shall have the final value for a transition except Network's PrevNetworkSectionHash and LastNetworkSectionHash fields. The two fields shall have initial value for the transition.

type StateView

type StateView interface {
	GetNetworkTypeIDs() ([]int64, error)
	GetNetworkView(nid int64) (NetworkView, error)
	GetNetworkTypeView(ntid int64) (NetworkTypeView, error)
}