runner

Documentation

Index

• Variables
• type BlackNodeRunner
  • func NewBlackNode(config Config) *BlackNodeRunner
  • func (k *BlackNodeRunner) Shutdown()
  • func (k *BlackNodeRunner) StartChains() Chains
• type ChainDetails
  • func (c ChainDetails) EvmClient() (*ethclient.Client, error)
  • func (c ChainDetails) GrpcConn() (*grpc.ClientConn, error)
• type Chains
  • func NewChains() Chains
  • func (c Chains) MustGetChain(name string) *ChainDetails
  • func (c *Chains) Register(name string, chain *ChainDetails) error
• type Config
• type NodeRunner

Variables

var (
	ErrChainAlreadyExists = errors.New("chain already exists")
)

Types

type BlackNodeRunner

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

BlackNodeRunner manages and runs a single Black node.

func NewBlackNode

func NewBlackNode(config Config) *BlackNodeRunner

func (*BlackNodeRunner) Shutdown

func (k *BlackNodeRunner) Shutdown()

func (*BlackNodeRunner) StartChains

func (k *BlackNodeRunner) StartChains() Chains

type ChainDetails

type ChainDetails struct {
	RpcPort  string
	GrpcPort string
	RestPort string
	EvmPort  string

	ChainId      string
	StakingDenom string
}

ChainDetails wraps information about the ports exposed to the host that endpoints could be access on.

func (ChainDetails) EvmClient

func (c ChainDetails) EvmClient() (*ethclient.Client, error)

func (ChainDetails) GrpcConn

func (c ChainDetails) GrpcConn() (*grpc.ClientConn, error)

type Chains

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

func NewChains

func NewChains() Chains

func (Chains) MustGetChain

func (c Chains) MustGetChain(name string) *ChainDetails

func (*Chains) Register

func (c *Chains) Register(name string, chain *ChainDetails) error

type Config

type Config struct {
	BlackConfigTemplate string

	ImageTag   string
	IncludeIBC bool

	EnableAutomatedUpgrade   bool
	BlackUpgradeName         string
	BlackUpgradeHeight       int64
	BlackUpgradeBaseImageTag string

	SkipShutdown bool
}

type NodeRunner

type NodeRunner interface {
	StartChains() Chains
	Shutdown()
}

NodeRunner is responsible for starting and managing docker containers to run a node.