coordinator

Oct 2, 2023

Changes in this version

+ var ErrMilestoneTimestampDidNotIncrease = errors.New("new milestone timestamp must be newer than the last milestone's timestamp")

+ func WithBlockBackups(blockBackupsEnabled bool, blockBackupsFolderPath string) options.Option[Coordinator]

+ func WithDebugFakeMilestoneTimestamps(debugFakeMilestoneTimestamps bool) options.Option[Coordinator]

+ func WithMilestoneTimeout(milestoneTimeout time.Duration) options.Option[Coordinator]

type Coordinator

+ func (coo *Coordinator) DebugFakeMilestoneTimestamps() bool

+ func (coo *Coordinator) ResetMilestoneTimeoutTicker()

+ func (coo *Coordinator) StopMilestoneTimeoutTicker()

type Events

+ MilestoneTimeout *event.Event

+ type ProtocolParameteresFunc = func() *iotago.ProtocolParameters

type QuorumClientConfig

+ Username string

May 30, 2022

Changes in this version

+ var ErrNetworkBootstrapped = errors.New("network already bootstrapped")

+ var ErrNoTipsGiven = errors.New("no tips given")

+ var ErrNodeLoadTooHigh = errors.New("node load too high")

+ var ErrQuorumGroupNoAnswer = errors.New("coordinator quorum group did not answer in time")

+ var ErrQuorumMerkleTreeHashMismatch = errors.New("coordinator quorum merkle tree hash mismatch")

+ func CheckpointCaller(handler interface{}, params ...interface{})

+ func MilestoneCaller(handler interface{}, params ...interface{})

+ func QuorumFinishedCaller(handler interface{}, params ...interface{})

+ type BackPressureFunc func() bool

+ type ComputeMilestoneMerkleRoots = func(ctx context.Context, index uint32, timestamp uint32, parents iotago.BlockIDs, ...) (*MilestoneMerkleRoots, error)

+ type Coordinator struct

+ Events *Events

+ func New(merkleRootFunc ComputeMilestoneMerkleRoots, nodeSyncedFunc IsNodeSyncedFunc, ...) (*Coordinator, error)

+ func (coo *Coordinator) AddBackPressureFunc(bpFunc BackPressureFunc)

+ func (coo *Coordinator) Bootstrap() (iotago.BlockID, error)

+ func (coo *Coordinator) InitState(bootstrap bool, startIndex uint32, latestMilestone *LatestMilestoneInfo) error

+ func (coo *Coordinator) Interval() time.Duration

+ func (coo *Coordinator) IssueCheckpoint(checkpointIndex int, lastCheckpointBlockID iotago.BlockID, ...) (iotago.BlockID, error)

+ func (coo *Coordinator) IssueMilestone(parents iotago.BlockIDs) (iotago.BlockID, error)

+ func (coo *Coordinator) QuorumStats() []QuorumClientStatistic

+ func (coo *Coordinator) State() *State

+ type Events struct

+ IssuedCheckpointBlock *events.Event

+ IssuedMilestone *events.Event

+ QuorumFinished *events.Event

+ SoftError *events.Event

+ type InMemoryEd25519MilestoneIndexSigner struct

+ func (s *InMemoryEd25519MilestoneIndexSigner) PublicKeys() []iotago.MilestonePublicKey

+ func (s *InMemoryEd25519MilestoneIndexSigner) PublicKeysSet() iotago.MilestonePublicKeySet

+ func (s *InMemoryEd25519MilestoneIndexSigner) SigningFunc() iotago.MilestoneSigningFunc

+ type InMemoryEd25519MilestoneSignerProvider struct

+ func NewInMemoryEd25519MilestoneSignerProvider(privateKeys []ed25519.PrivateKey, keyManager *keymanager.KeyManager, ...) *InMemoryEd25519MilestoneSignerProvider

+ func (p *InMemoryEd25519MilestoneSignerProvider) MilestoneIndexSigner(index uint32) MilestoneIndexSigner

+ func (p *InMemoryEd25519MilestoneSignerProvider) PublicKeysCount() int

+ type InsecureRemoteEd25519MilestoneIndexSigner struct

+ func (s *InsecureRemoteEd25519MilestoneIndexSigner) PublicKeys() []iotago.MilestonePublicKey

+ func (s *InsecureRemoteEd25519MilestoneIndexSigner) PublicKeysSet() iotago.MilestonePublicKeySet

+ func (s *InsecureRemoteEd25519MilestoneIndexSigner) SigningFunc() iotago.MilestoneSigningFunc

+ type InsecureRemoteEd25519MilestoneSignerProvider struct

+ func NewInsecureRemoteEd25519MilestoneSignerProvider(remoteEndpoint string, keyManager *keymanager.KeyManager, publicKeysCount int) *InsecureRemoteEd25519MilestoneSignerProvider

+ func (p *InsecureRemoteEd25519MilestoneSignerProvider) MilestoneIndexSigner(index uint32) MilestoneIndexSigner

+ func (p *InsecureRemoteEd25519MilestoneSignerProvider) PublicKeysCount() int

+ type IsNodeSyncedFunc = func() bool

+ type LatestMilestoneInfo struct

+ Index uint32

+ MilestoneID iotago.MilestoneID

+ Timestamp uint32

+ type LatestTreasuryOutput struct

+ Amount uint64

+ MilestoneID iotago.MilestoneID

+ type MilestoneIndexSigner interface

+ PublicKeys func() []iotago.MilestonePublicKey

+ PublicKeysSet func() iotago.MilestonePublicKeySet

+ SigningFunc func() iotago.MilestoneSigningFunc

+ type MilestoneMerkleRoots struct

+ AppliedMerkleRoot iotago.MilestoneMerkleProof

+ InclusionMerkleRoot iotago.MilestoneMerkleProof

+ type MilestoneSignerProvider interface

+ MilestoneIndexSigner func(index uint32) MilestoneIndexSigner

+ PublicKeysCount func() int

+ type Option func(opts *Options)

+ func WithLogger(logger *logger.Logger) Option

+ func WithMilestoneInterval(milestoneInterval time.Duration) Option

+ func WithQuorum(quorumEnabled bool, quorumGroups map[string][]*QuorumClientConfig, ...) Option

+ func WithSigningRetryAmount(amount int) Option

+ func WithSigningRetryTimeout(timeout time.Duration) Option

+ func WithStateFilePath(stateFilePath string) Option

+ type Options struct

+ type QuorumClientConfig struct

+ Alias string

+ BaseURL string

+ Password string

+ UserName string

+ type QuorumClientStatistic struct

+ Alias string

+ BaseURL string

+ Error error

+ Group string

+ ResponseTimeSeconds float64

+ type QuorumFinishedResult struct

+ Duration time.Duration

+ Err error

+ type SendBlockFunc = func(block *iotago.Block, msIndex ...uint32) (iotago.BlockID, error)

+ type State struct

+ LatestMilestoneBlockID iotago.BlockID

+ LatestMilestoneID iotago.MilestoneID

+ LatestMilestoneIndex uint32

+ LatestMilestoneTime time.Time

+ func (cs *State) MarshalJSON() ([]byte, error)

+ func (cs *State) UnmarshalJSON(data []byte) error

+ type UnspentTreasuryOutputFunc = func() (*LatestTreasuryOutput, error)