coordinator

type BackPressureFunc func() bool

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

type Coordinator struct {
	// the logger used to log events.
	*logger.WrappedLogger

	// events of the coordinator.
	Events *Events
	// contains filtered or unexported fields
}

type Events struct {
	// Fired when a checkpoint block is issued.
	// params: checkpointIndex int, tipIndex int, tipsTotal int, blockID iotago.BlockID
	IssuedCheckpointBlock *event.Event4[int, int, int, iotago.BlockID]
	// Fired when a milestone is issued.
	// params: index iotago.MilestoneIndex, milestoneID iotago.MilestoneID, blockID iotago.BlockID
	IssuedMilestone *event.Event3[iotago.MilestoneIndex, iotago.MilestoneID, iotago.BlockID]
	// SoftError is triggered when a soft error is encountered.
	SoftError *event.Event1[error]
	// QuorumFinished is triggered after a coordinator quorum call was finished.
	QuorumFinished *event.Event1[*QuorumFinishedResult]
	// MilestoneTimeout is triggered if no new milestones are received for some time.
	MilestoneTimeout *event.Event
}

type InMemoryEd25519MilestoneIndexSigner struct {
	// contains filtered or unexported fields
}

type InMemoryEd25519MilestoneSignerProvider struct {
	// contains filtered or unexported fields
}

type InsecureRemoteEd25519MilestoneIndexSigner struct {
	// contains filtered or unexported fields
}

type InsecureRemoteEd25519MilestoneSignerProvider struct {
	// contains filtered or unexported fields
}

type IsNodeSyncedFunc = func() bool

type LatestMilestoneInfo struct {
	Index       iotago.MilestoneIndex
	Timestamp   uint32
	MilestoneID iotago.MilestoneID
}

type LatestTreasuryOutput struct {
	MilestoneID iotago.MilestoneID
	Amount      uint64
}

type MilestoneIndexSigner interface {
	// PublicKeys returns a slice of the used public keys.
	PublicKeys() []iotago.MilestonePublicKey
	// PublicKeysSet returns a map of the used public keys.
	PublicKeysSet() iotago.MilestonePublicKeySet
	// SigningFunc returns a function to sign the particular milestone.
	SigningFunc() iotago.MilestoneSigningFunc
}

type MilestoneMerkleRoots struct {
	// InclusionMerkleRoot is the root of the merkle tree containing the hash of all included blocks.
	InclusionMerkleRoot iotago.MilestoneMerkleProof
	// AppliedMerkleRoot is the root of the merkle tree containing the hash of all include blocks that mutate the ledger.
	AppliedMerkleRoot iotago.MilestoneMerkleProof
}

type MilestoneSignerProvider interface {
	// MilestoneIndexSigner returns a new signer for the milestone index.
	MilestoneIndexSigner(index iotago.MilestoneIndex) MilestoneIndexSigner
	// PublicKeysCount returns the amount of public keys in a milestone.
	PublicKeysCount() int
}

type ProtocolParameteresFunc = func() *iotago.ProtocolParameters

type QuorumClientConfig struct {
	// optional alias of the quorum client.
	Alias string `json:"alias" koanf:"alias"`
	// baseURL of the quorum client.
	BaseURL string `json:"baseUrl" koanf:"baseUrl"`
	// optional username for basic auth.
	Username string `json:"username" koanf:"username"`
	// optional password for basic auth.
	Password string `json:"password" koanf:"password"`
}

type QuorumClientStatistic struct {
	// name of the quorum group the client is member of.
	Group string
	// optional alias of the quorum client.
	Alias string
	// baseURL of the quorum client.
	BaseURL string
	// last response time of the whiteflag API call.
	ResponseTimeSeconds float64
	// error of last whiteflag API call.
	Error error
}

type QuorumFinishedResult struct {
	Duration time.Duration
	Err      error
}

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

type State struct {
	LatestMilestoneIndex   iotago.MilestoneIndex
	LatestMilestoneBlockID iotago.BlockID
	LatestMilestoneID      iotago.MilestoneID
	LatestMilestoneTime    time.Time
}

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