api

Documentation

Index

• type Builder
• type Context
• type ExtensionName
• type Extensions
• type GRPCClient
• type Platform
• type PlatformFactory
• type PortName
• type Ports
• type Topologies
  • func (t *Topologies) Export() ([]byte, error)
• type Topology
• type ViewClient
• type WebClient

Types

type Builder

type Builder interface {
	Build(path string) string
}

type Context

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 view.SigningIdentity)
	SetAdminSigningIdentity(name string, id view.SigningIdentity)
	SetViewIdentity(name string, cert []byte)
	ConnectionConfig(name string) *grpc.ConnectionConfig
	ClientSigningIdentity(name string) view.SigningIdentity
	SetViewClient(name string, c GRPCClient)
	SetWebClient(name string, c WebClient)
	SetCLI(name string, client ViewClient)
	GetViewIdentityAliases(name string) []string
	AdminSigningIdentity(name string) view.SigningIdentity
	IgnoreSigHUP() bool
}

type ExtensionName

type ExtensionName string

const (
	FabricExtension ExtensionName = "FabricExtension"
	OrionExtension  ExtensionName = "OrionExtension"
)

type Extensions

type Extensions map[ExtensionName][]string

type GRPCClient

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

type Platform

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

	GenerateConfigTree()
	GenerateArtifacts()
	Load()

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

type PlatformFactory

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

type PortName

type PortName string

type Ports

type Ports map[PortName]uint16

type Topologies

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

func (*Topologies) Export

func (t *Topologies) Export() ([]byte, error)

type Topology

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

Topology represents a topology of a given network type (fabric, fsc, etc...)

type ViewClient

type ViewClient interface {
	CallView(fid string, in []byte) (interface{}, error)
	IsTxFinal(txid string, opts ...api.ServiceOption) error
}

type WebClient

type WebClient interface {
	ViewClient
	StreamCallView(fid string, input []byte) (*web.WSStream, error)
}