runner

Documentation

Index

• Variables
• 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 FuryNodeRunner
  • func NewFuryNode(config Config) *FuryNodeRunner
  • func (k *FuryNodeRunner) Shutdown()
  • func (k *FuryNodeRunner) StartChains() Chains
• type NodeRunner

Variables

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

Types

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 {
	FuryConfigTemplate string

	ImageTag   string
	IncludeIBC bool

	EnableAutomatedUpgrade  bool
	FuryUpgradeName         string
	FuryUpgradeHeight       int64
	FuryUpgradeBaseImageTag string

	SkipShutdown bool
}

type FuryNodeRunner

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

FuryNodeRunner manages and runs a single Fury node.

func NewFuryNode

func NewFuryNode(config Config) *FuryNodeRunner

func (*FuryNodeRunner) Shutdown

func (k *FuryNodeRunner) Shutdown()

func (*FuryNodeRunner) StartChains

func (k *FuryNodeRunner) StartChains() Chains

type NodeRunner

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

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