system

Documentation

Index

• type ActiveSetFetcher
• type AtxFetcher
• type BallotFetcher
• type BeaconCollector
• type BeaconGetter
• type BlockFetcher
• type Fetcher
• type GetAtxOpt
  • func WithoutLimiting() GetAtxOpt
• type GetAtxOpts
• type PeerTracker
• type PoetProofFetcher
• type ProposalFetcher
• type SyncStateProvider
• type Tortoise
• type TxFetcher
• type ValidationRequest

Types

type ActiveSetFetcher

type ActiveSetFetcher interface {
	GetActiveSet(context.Context, types.Hash32) error
}

ActiveSetFetcher defines an interface downloading active set.

type AtxFetcher

type AtxFetcher interface {
	GetAtxs(context.Context, []types.ATXID, ...GetAtxOpt) error
}

AtxFetcher defines an interface for fetching ATXs from remote peers.

type BallotFetcher

type BallotFetcher interface {
	GetBallots(context.Context, []types.BallotID) error
}

BallotFetcher defines an interface for fetching Ballot from remote peers.

type BeaconCollector

type BeaconCollector interface {
	ReportBeaconFromBallot(types.EpochID, *types.Ballot, types.Beacon, fixed.Fixed)
}

BeaconCollector defines the interface that collect beacon values from Ballots.

type BeaconGetter

type BeaconGetter interface {
	GetBeacon(types.EpochID) (types.Beacon, error)
}

BeaconGetter gets a beacon value.

type BlockFetcher

type BlockFetcher interface {
	GetBlocks(context.Context, []types.BlockID) error
}

BlockFetcher defines an interface for fetching blocks from remote peers.

type Fetcher

type Fetcher interface {
	AtxFetcher
	BlockFetcher
	PoetProofFetcher
	BallotFetcher
	ActiveSetFetcher
	ProposalFetcher
	TxFetcher
	PeerTracker
}

Fetcher is a general interface that defines a component capable of fetching data from remote peers.

type GetAtxOpt

type GetAtxOpt func(*GetAtxOpts)

func WithoutLimiting

func WithoutLimiting() GetAtxOpt

type GetAtxOpts

type GetAtxOpts struct {
	LimitingOff bool
}

type PeerTracker

type PeerTracker interface {
	RegisterPeerHashes(peer p2p.Peer, hashes []types.Hash32)
}

PeerTracker defines an interface to track peer hashes.

type PoetProofFetcher

type PoetProofFetcher interface {
	GetPoetProof(context.Context, types.Hash32) error
}

PoetProofFetcher defines an interface for fetching PoET proofs from remote peers.

type ProposalFetcher

type ProposalFetcher interface {
	GetProposals(context.Context, []types.ProposalID) error
}

ProposalFetcher defines an interface for fetching Proposal from remote peers.

type SyncStateProvider

type SyncStateProvider interface {
	IsSynced(context.Context) bool
	IsBeaconSynced(types.EpochID) bool
}

SyncStateProvider defines the interface that provides the node's sync state.

type Tortoise

type Tortoise interface {
	OnBlock(types.BlockHeader)
	OnHareOutput(types.LayerID, types.BlockID)
	OnWeakCoin(types.LayerID, bool)
	TallyVotes(context.Context, types.LayerID)
	LatestComplete() types.LayerID
	Updates() []result.Layer
	OnApplied(types.LayerID, types.Hash32) bool
	OnMalfeasance(types.NodeID)
	OnAtx(types.EpochID, types.ATXID, *atxsdata.ATX)
	GetMissingActiveSet(types.EpochID, []types.ATXID) []types.ATXID
}

Tortoise is an interface provided by tortoise implementation.

type TxFetcher

type TxFetcher interface {
	GetBlockTxs(context.Context, []types.TransactionID) error
	GetProposalTxs(context.Context, []types.TransactionID) error
}

TxFetcher defines an interface for fetching transactions from remote peers.

type ValidationRequest

type ValidationRequest interface {
	Parse() (*types.TxHeader, error)
	Verify() bool
}

ValidationRequest parses transaction and verifies it.