interopcoldstart

Documentation

Overview

Package interopcoldstart allows for spinning up a deterministic-genesis local chain without the need for eth1 deposits useful for local client development and interoperability testing.

Index

• type Config
• type Service
  • func NewService(ctx context.Context, cfg *Config) *Service
  • func (s *Service) AllDepositContainers(ctx context.Context) []*ethpb.DepositContainer
  • func (_ *Service) AllDeposits(_ context.Context, _ *big.Int) []*ethpb.Deposit
  • func (_ *Service) ChainStartEth1Data() *ethpb.Eth1Data
  • func (_ *Service) ClearPreGenesisData()
  • func (_ *Service) DepositByPubkey(_ context.Context, _ []byte) (*ethpb.Deposit, *big.Int)
  • func (_ *Service) DepositsNumberAndRootAtHeight(_ context.Context, _ *big.Int) (uint64, [32]byte)
  • func (_ *Service) FinalizedDeposits(ctx context.Context) (cache.FinalizedDeposits, error)
  • func (s *Service) InsertPendingDeposit(ctx context.Context, d *ethpb.Deposit, blockNum uint64, index int64, ...)
  • func (_ *Service) NonFinalizedDeposits(_ context.Context, _ int64, _ *big.Int) []*ethpb.Deposit
  • func (s *Service) PendingContainers(ctx context.Context, untilBlk *big.Int) []*ethpb.DepositContainer
  • func (s *Service) PendingDeposits(ctx context.Context, untilBlk *big.Int) []*ethpb.Deposit
  • func (_ *Service) PreGenesisState() state.BeaconState
  • func (s *Service) PrunePendingDeposits(ctx context.Context, merkleTreeIndex int64)
  • func (s *Service) PruneProofs(ctx context.Context, untilDepositIndex int64) error
  • func (s *Service) Start()
  • func (_ *Service) Status() error
  • func (_ *Service) Stop() error

Types

type Config

type Config struct {
	GenesisTime   uint64
	NumValidators uint64
	BeaconDB      db.HeadAccessDatabase
	DepositCache  cache.DepositCache
	GenesisPath   string
}

Config options for the interop service.

type Service

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

Service spins up an client interoperability service that handles responsibilities such as kickstarting a genesis state for the beacon node from cli flags or a genesis.ssz file.

func NewService

func NewService(ctx context.Context, cfg *Config) *Service

NewService is an interoperability testing service to inject a deterministically generated genesis state into the beacon chain database and running services at start up. This service should not be used in production as it does not have any value other than ease of use for testing purposes.

func (*Service) AllDepositContainers

func (s *Service) AllDepositContainers(ctx context.Context) []*ethpb.DepositContainer

func (*Service) AllDeposits

func (_ *Service) AllDeposits(_ context.Context, _ *big.Int) []*ethpb.Deposit

AllDeposits mocks out the deposit cache functionality for interop.

func (*Service) ChainStartEth1Data

func (_ *Service) ChainStartEth1Data() *ethpb.Eth1Data

ChainStartEth1Data mocks out the powchain functionality for interop.

func (*Service) ClearPreGenesisData

func (_ *Service) ClearPreGenesisData()

ClearPreGenesisData --

func (*Service) DepositByPubkey

func (_ *Service) DepositByPubkey(_ context.Context, _ []byte) (*ethpb.Deposit, *big.Int)

DepositByPubkey mocks out the deposit cache functionality for interop.

func (*Service) DepositsNumberAndRootAtHeight

func (_ *Service) DepositsNumberAndRootAtHeight(_ context.Context, _ *big.Int) (uint64, [32]byte)

DepositsNumberAndRootAtHeight mocks out the deposit cache functionality for interop.

func (*Service) FinalizedDeposits

func (_ *Service) FinalizedDeposits(ctx context.Context) (cache.FinalizedDeposits, error)

FinalizedDeposits mocks out the deposit cache functionality for interop.

func (*Service) InsertPendingDeposit

func (s *Service) InsertPendingDeposit(ctx context.Context, d *ethpb.Deposit, blockNum uint64, index int64, depositRoot [32]byte)

func (*Service) NonFinalizedDeposits

func (_ *Service) NonFinalizedDeposits(_ context.Context, _ int64, _ *big.Int) []*ethpb.Deposit

NonFinalizedDeposits mocks out the deposit cache functionality for interop.

func (*Service) PendingContainers

func (s *Service) PendingContainers(ctx context.Context, untilBlk *big.Int) []*ethpb.DepositContainer

func (*Service) PendingDeposits

func (s *Service) PendingDeposits(ctx context.Context, untilBlk *big.Int) []*ethpb.Deposit

func (*Service) PreGenesisState

func (_ *Service) PreGenesisState() state.BeaconState

PreGenesisState returns an empty beacon state.

func (*Service) PrunePendingDeposits

func (s *Service) PrunePendingDeposits(ctx context.Context, merkleTreeIndex int64)

func (*Service) PruneProofs

func (s *Service) PruneProofs(ctx context.Context, untilDepositIndex int64) error

func (*Service) Start

func (s *Service) Start()

Start initializes the genesis state from configured flags.

func (*Service) Status

func (_ *Service) Status() error

Status always returns nil.

func (*Service) Stop

func (_ *Service) Stop() error

Stop does nothing.