btp

package

v1.4.1 Latest Latest Go to latest Published: Mar 21, 2024 License: Apache-2.0 Imports: 12 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/icon-project/goloop

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func NewBTPBlockHeader(height int64, round int32, nts module.NetworkTypeSection, nid int64, flag uint) (module.BTPBlockHeader, error)
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 ¶

View Source

const (
	NSFilterCap = 256 / 8
)

Variables ¶

View Source

var ZeroBTPSection = newBTPSection(nil, nil)

View Source

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

View Source

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

Functions ¶

func NewBTPBlockHeader ¶ added in v1.3.2

func NewBTPBlockHeader(
	height int64,
	round int32,
	nts module.NetworkTypeSection,
	nid int64,
	flag uint,
) (module.BTPBlockHeader, error)

NewBTPBlockHeader returns a new BTPBlockHeader for the height and nid. If flag's IncludeNextProofContext bit is on, the header includes NextProofContext.

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)
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
ntm

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL