registrar

Documentation

Overview

Package registrar handles the mappings between the blockchain libraries in a more scalable manor.

Index

• func GetAddNodeFunc(blockchain string) (func(*testnet.TestNet) error, error)
• func GetAddSideCar(sideCarName string) (func(*testnet.Adjunct) error, error)
• func GetAdditionalLogs(blockchain string) map[string]string
• func GetBlockchainSideCars(blockchain string) ([]string, error)
• func GetBuildFunc(blockchain string) (func(*testnet.TestNet) error, error)
• func GetBuildSideCar(sideCarName string) (func(*testnet.Adjunct) error, error)
• func GetDefaultsFunc(blockchain string) (func() string, error)
• func GetParamsFunc(blockchain string) (func() string, error)
• func GetServiceFunc(blockchain string) (func() []helpers.Service, error)
• func GetSupportedBlockchains() []string
• func RegisterAddNodes(blockchain string, fn func(*testnet.TestNet) error)
• func RegisterAddSideCar(sideCarName string, fn func(*testnet.Adjunct) error)
• func RegisterAdditionalLogs(blockchain string, logs map[string]string)
• func RegisterBlockchainSideCars(blockchain string, scs []string)
• func RegisterBuild(blockchain string, fn func(*testnet.TestNet) error)
• func RegisterBuildSideCar(sideCarName string, fn func(*testnet.Adjunct) error)
• func RegisterDefaults(blockchain string, fn func() string)
• func RegisterParams(blockchain string, fn func() string)
• func RegisterServices(blockchain string, fn func() []helpers.Service)
• func RegisterSideCar(name string, sc SideCar)
• type SideCar
  • func GetSideCar(sideCarName string) (*SideCar, error)

Functions

func GetAddNodeFunc

func GetAddNodeFunc(blockchain string) (func(*testnet.TestNet) error, error)

GetAddNodeFunc gets the add node function associated with the given blockchain name or error != nil if it is not found

func GetAddSideCar

func GetAddSideCar(sideCarName string) (func(*testnet.Adjunct) error, error)

GetAddSideCar gets the function to add a sidecar

func GetAdditionalLogs

func GetAdditionalLogs(blockchain string) map[string]string

GetAdditionalLogs gets additional logs of the blockchain if there are any

func GetBlockchainSideCars

func GetBlockchainSideCars(blockchain string) ([]string, error)

GetBlockchainSideCars associates a blockchain name with a

func GetBuildFunc

func GetBuildFunc(blockchain string) (func(*testnet.TestNet) error, error)

GetBuildFunc gets the build function associated with the given blockchain name or error != nil if it is not found

func GetBuildSideCar

func GetBuildSideCar(sideCarName string) (func(*testnet.Adjunct) error, error)

GetBuildSideCar gets the function to build a sidecar

func GetDefaultsFunc

func GetDefaultsFunc(blockchain string) (func() string, error)

GetDefaultsFunc gets the Defaults function associated with the given blockchain name or error != nil if it is not found

func GetParamsFunc

func GetParamsFunc(blockchain string) (func() string, error)

GetParamsFunc gets the Params function associated with the given blockchain name or error != nil if it is not found

func GetServiceFunc

func GetServiceFunc(blockchain string) (func() []helpers.Service, error)

GetServiceFunc gets the service function associated with the given blockchain name or error != nil if it is not found

func GetSupportedBlockchains

func GetSupportedBlockchains() []string

GetSupportedBlockchains gets the blockchains which have a registered Build function

func RegisterAddNodes

func RegisterAddNodes(blockchain string, fn func(*testnet.TestNet) error)

RegisterAddNodes associates a blockchain name with a add node process

func RegisterAddSideCar

func RegisterAddSideCar(sideCarName string, fn func(*testnet.Adjunct) error)

RegisterAddSideCar associates a blockchain name with a add node process

func RegisterAdditionalLogs

func RegisterAdditionalLogs(blockchain string, logs map[string]string)

RegisterAdditionalLogs associates a blockchain name with a map of additional logs

func RegisterBlockchainSideCars

func RegisterBlockchainSideCars(blockchain string, scs []string)

RegisterBlockchainSideCars associates a blockchain name with a

func RegisterBuild

func RegisterBuild(blockchain string, fn func(*testnet.TestNet) error)

RegisterBuild associates a blockchain name with a build process

func RegisterBuildSideCar

func RegisterBuildSideCar(sideCarName string, fn func(*testnet.Adjunct) error)

RegisterBuildSideCar associates a blockchain name with a add node process

func RegisterDefaults

func RegisterDefaults(blockchain string, fn func() string)

RegisterDefaults associates a blockchain name with a function that gets its default parameter values

func RegisterParams

func RegisterParams(blockchain string, fn func() string)

RegisterParams associates a blockchain name with a function that gets its parameters

func RegisterServices

func RegisterServices(blockchain string, fn func() []helpers.Service)

RegisterServices associates a blockchain name with a function that gets its required services

func RegisterSideCar

func RegisterSideCar(name string, sc SideCar)

RegisterSideCar associates a blockchain name with a

Types

type SideCar

type SideCar struct {
	// Image is the docker image to build the side car from
	Image string
	// BuildStepsCalc calculates the number of times the sidecar will be calling IncrementSideCarProgress
	BuildStepsCalc func(int, int) int //(nodes,servers)
}

SideCar represents the side car registration details needed for building or other purposes

func GetSideCar

func GetSideCar(sideCarName string) (*SideCar, error)

GetSideCar gets the details about a sidecar