api

type Builder interface {
	Build(path string) string
}

type Context interface {
	RootDir() string
	ReservePort() uint16

	AddPlatform(platform Platform)
	PlatformByName(name string) Platform
	PlatformsByType(typ string) []Platform

	AddExtension(id string, extension ExtensionName, s string)
	ExtensionsByPeerID(name string) Extensions

	PortsByPeerID(prefix string, id string) Ports
	SetPortsByPeerID(prefix string, id string, ports Ports)
	HostByPeerID(prefix string, id string) string
	SetHostByPeerID(prefix string, id string, host string)

	PortsByOrdererID(prefix string, id string) Ports
	SetPortsByOrdererID(prefix string, id string, ports Ports)
	HostByOrdererID(prefix string, id string) string
	SetHostByOrdererID(prefix string, id string, host string)

	AddIdentityAlias(name string, alias string)
	TopologyByName(name string) Topology
	SetConnectionConfig(name string, cc *grpc.ConnectionConfig)
	SetClientSigningIdentity(name string, id client2.SigningIdentity)
	SetAdminSigningIdentity(name string, id client2.SigningIdentity)
	SetViewIdentity(name string, cert []byte)
	ConnectionConfig(name string) *grpc.ConnectionConfig
	ClientSigningIdentity(name string) client2.SigningIdentity
	SetViewClient(name string, c GRPCClient)
	SetWebClient(name string, c WebClient)
	SetCLI(name string, client ViewClient)
	GetViewIdentityAliases(name string) []string
	AdminSigningIdentity(name string) client2.SigningIdentity
	IgnoreSigHUP() bool
}

type ExtensionName string

type Extensions map[ExtensionName][]string

type GRPCClient interface {
	ViewClient
	StreamCallView(fid string, input []byte) (*client2.Stream, error)
}

type Platform interface {
	Name() string
	Type() string

	GenerateConfigTree()
	GenerateArtifacts()
	Load()

	Members() []grouper.Member
	PostRun(load bool)
	Cleanup()
}

type PlatformFactory interface {
	Name() string
	New(registry Context, t Topology, builder Builder) Platform
}

type PortName string

type Ports map[PortName]uint16

type Topologies struct {
	Topologies []Topology `yaml:"topologies,omitempty"`
}

type Topology interface {
	Name() string
	// Type returns the type of network this topology refers to
	Type() string
}

type ViewClient interface {
	CallViewWithContext(ctx context.Context, fid string, in []byte) (interface{}, error)
	CallView(fid string, in []byte) (interface{}, error)
}

type WebClient interface {
	ViewClient
	Metrics() (map[string]*dto.MetricFamily, error)
	StreamCallView(fid string, input []byte) (*client.WSStream, error)
}