protocol

Documentation

Index

• Variables
• type EthCallEngine
• type EventForwarderEngine
• type L2EthCallEngines
  • func NewL2EthCallEngines(log *logging.Logger, cfg ethcall.Config, isValidator bool, ...) *L2EthCallEngines
  • func (v *L2EthCallEngines) GetOrInstantiate(chainID string) (ethverifier.EthCallEngine, error)
  • func (v *L2EthCallEngines) OnEthereumL2ConfigsUpdated(ctx context.Context, ethCfg *types.EthereumL2Configs) error
• type Protocol
  • func New(ctx context.Context, confWatcher *config.Watcher, log *logging.Logger, ...) (proto *Protocol, err error)
  • func (n *Protocol) GetBroker() *broker.Broker
  • func (n *Protocol) GetEventForwarder() *evtforward.Forwarder
  • func (n *Protocol) GetEventService() *subscribers.Service
  • func (n *Protocol) GetPoW() api.ProofOfWorkParams
  • func (n *Protocol) GetPowEngine() processor.PoWEngine
  • func (n *Protocol) GetProtocolUpgradeService() *protocolupgrade.Engine
  • func (n *Protocol) GetSpamEngine() *spam.Engine
  • func (n *Protocol) GetTimeService() *vegatime.Svc
  • func (n *Protocol) Protocol() semver.Version
  • func (n *Protocol) Start(ctx context.Context) error
  • func (n *Protocol) Stop() error
• type SpecActivationListener

Variables

var Version = semver.MustParse("0.1.0")

Types

type EthCallEngine

type EthCallEngine interface {
	Start()
	StartAtHeight(height uint64, timestamp uint64)
	Stop()
	MakeResult(specID string, bytes []byte) (ethcall.Result, error)
	CallSpec(ctx context.Context, id string, atBlock uint64) (ethcall.Result, error)
	GetEthTime(ctx context.Context, atBlock uint64) (uint64, error)
	GetRequiredConfirmations(id string) (uint64, error)
	GetInitialTriggerTime(id string) (uint64, error)
	OnSpecActivated(ctx context.Context, spec datasource.Spec) error
	OnSpecDeactivated(ctx context.Context, spec datasource.Spec)
	EnsureChainID(ctx context.Context, chainID string, blockInterval uint64, confirmWithClient bool)
}

type EventForwarderEngine

type EventForwarderEngine interface {
	ReloadConf(ethereum.Config)
	SetupEthereumEngine(evtfwdeth.Client, evtfwdeth.Forwarder, evtfwdeth.Config, *types.EthereumConfig, evtfwdeth.Assets) error
	SetupSecondaryEthereumEngine(evtfwdeth.Client, evtfwdeth.Forwarder, evtfwdeth.Config, *types.EVMChainConfig, evtfwdeth.Assets) error
	Start()
	Stop()

	// methods used to update starting blocks of the eef
	UpdateCollateralStartingBlock(uint64)
	UpdateStakingStartingBlock(uint64)
	UpdateMultisigControlStartingBlock(uint64)
	VerifyHeartbeat(context.Context, uint64, string, string, uint64) error
	UpdateStartingBlock(string, uint64)
}

type L2EthCallEngines

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

func NewL2EthCallEngines

func NewL2EthCallEngines(log *logging.Logger, cfg ethcall.Config, isValidator bool, clients *eth.L2Clients, forwarder ethcall.Forwarder, specActivationListener SpecActivationListener) *L2EthCallEngines

func (*L2EthCallEngines) GetOrInstantiate

func (v *L2EthCallEngines) GetOrInstantiate(chainID string) (ethverifier.EthCallEngine, error)

func (*L2EthCallEngines) OnEthereumL2ConfigsUpdated

func (v *L2EthCallEngines) OnEthereumL2ConfigsUpdated(
	ctx context.Context, ethCfg *types.EthereumL2Configs,
) error

type Protocol

type Protocol struct {
	*processor.App
	// contains filtered or unexported fields
}

func New

func New(
	ctx context.Context,
	confWatcher *config.Watcher,
	log *logging.Logger,
	cancel func(),
	stopBlockchain func() error,
	nodewallets *nodewallets.NodeWallets,
	primaryEthClient *ethclient.PrimaryClient,
	secondaryEthClient *ethclient.SecondaryClient,
	primaryEthConfirmation *ethclient.EthereumConfirmations,
	secondaryEthConfirmation *ethclient.EthereumConfirmations,
	blockchainClient *blockchain.Client,
	vegaPaths paths.Paths,
	stats *stats.Stats,
	l2Clients *ethclient.L2Clients,
) (proto *Protocol, err error)

func (*Protocol) GetBroker

func (n *Protocol) GetBroker() *broker.Broker

func (*Protocol) GetEventForwarder

func (n *Protocol) GetEventForwarder() *evtforward.Forwarder

func (*Protocol) GetEventService

func (n *Protocol) GetEventService() *subscribers.Service

func (*Protocol) GetPoW

func (n *Protocol) GetPoW() api.ProofOfWorkParams

func (*Protocol) GetPowEngine

func (n *Protocol) GetPowEngine() processor.PoWEngine

func (*Protocol) GetProtocolUpgradeService

func (n *Protocol) GetProtocolUpgradeService() *protocolupgrade.Engine

func (*Protocol) GetSpamEngine

func (n *Protocol) GetSpamEngine() *spam.Engine

func (*Protocol) GetTimeService

func (n *Protocol) GetTimeService() *vegatime.Svc

func (*Protocol) Protocol

func (n *Protocol) Protocol() semver.Version

func (*Protocol) Start

func (n *Protocol) Start(ctx context.Context) error

Start will start the protocol, this means it's ready to process blocks from the blockchain.

func (*Protocol) Stop

func (n *Protocol) Stop() error

Stop will stop all services of the protocol.

type SpecActivationListener

type SpecActivationListener func(listener spec.SpecActivationsListener)