nodeconf

type ChangeObserver func(prev, cur NodeConf)

type ConfigGetter interface {
	GetNodeConf() Configuration
}

type ConfigUpdateGetter interface {
	GetNodeConfUpdateInterval() int
}

type Configuration struct {
	Id        string `yaml:"id"`
	NetworkId string `yaml:"networkId"`
	// FileNetworkId is the identity of the NodeTypeFileV2 fleet's shared
	// signing key (network string encoding, crypto.DecodeNetworkId) —
	// the key fileV2 durability receipts (networkSign) verify against.
	// Empty on networks without a fileV2 fleet.
	FileNetworkId string    `yaml:"fileNetworkId,omitempty"`
	Nodes         []Node    `yaml:"nodes"`
	CreationTime  time.Time `yaml:"creationTime"`
	// Epoch is a monotonically increasing version of the network configuration.
	// It is incremented on every published topology change and is 0 for
	// configurations that predate epoch support.
	Epoch uint64 `yaml:"epoch,omitempty"`
}

type HistoryStore interface {
	Store
	// GetByEpoch returns a previously saved configuration of the given network.
	// Returns ErrConfigurationNotFound if the epoch is not retained.
	GetByEpoch(ctx context.Context, netId string, epoch uint64) (c Configuration, err error)
	// Epochs returns the retained epochs for the given network in ascending order.
	Epochs(ctx context.Context, netId string) (epochs []uint64, err error)
}

type NetworkCompatibilityStatus int

type NetworkProtoVersionChecker interface {
	IsNetworkNeedsUpdate(ctx context.Context) (bool, error)
}

type Node struct {
	PeerId    string     `yaml:"peerId" bson:"peerId"`
	Addresses []string   `yaml:"addresses" bson:"addresses"`
	Types     []NodeType `yaml:"types,omitempty" bson:"types"`
}

type NodeConf interface {
	// Id returns current nodeconf id
	Id() string
	// Configuration returns configuration struct
	Configuration() Configuration
	// NodeIds returns list of peerId for given spaceId
	NodeIds(spaceId string) []string
	// IsResponsible checks if current account responsible for given spaceId
	IsResponsible(spaceId string) bool
	// FilePeers returns list of filenodes
	FilePeers() []string
	// FileV2Peers returns the list of v2 filenodes (the NodeTypeFileV2 pool)
	FileV2Peers() []string
	// FileV2NodeIds returns the RF=2 responsible v2 filenodes for a given spaceId.
	// Unlike NodeIds, the current account is NOT excluded: the full responsible pair is
	// returned so a v2 filenode can see its partner (e.g. to derive the leader).
	FileV2NodeIds(spaceId string) []string
	// ConsensusPeers returns list of consensusnodes
	ConsensusPeers() []string
	// CoordinatorPeers returns list of coordinator nodes
	CoordinatorPeers() []string
	// Please see any-ns-node repo for details
	// Usually one network has only 1 naming node, but we support array of NNs
	NamingNodePeers() []string
	// Please see any-pp-node repo for details
	PaymentProcessingNodePeers() []string
	// PeerAddresses returns peer addresses by peer id
	PeerAddresses(peerId string) (addrs []string, ok bool)
	// CHash returns nodes consistent table
	CHash() chash.CHash
	// Partition returns partition number by spaceId
	Partition(spaceId string) (part int)
	// NodeTypes returns list of known nodeTypes by nodeId, if node not registered in configuration will return empty list
	NodeTypes(nodeId string) []NodeType
}

type NodeType string

type Service interface {
	NodeConf
	NetworkCompatibilityStatus() NetworkCompatibilityStatus
	// ObserveChanges registers an observer called every time the active network
	// configuration is replaced. It is not called for the initial configuration.
	// Observers are called sequentially from the configuration update flow and
	// must not block for long.
	ObserveChanges(observer ChangeObserver)
	app.ComponentRunnable
}

type Source interface {
	GetLast(ctx context.Context, currentId string) (c Configuration, err error)
}

type Store interface {
	GetLast(ctx context.Context, netId string) (c Configuration, err error)
	SaveLast(ctx context.Context, c Configuration) (err error)
}