catalyst

Documentation

Overview

Package catalyst implements the temporary eth1/eth2 RPC integration.

Index

• func Register(stack *node.Node, backend *eth.Ethereum) error
• func RegisterSimulatedBeaconAPIs(stack *node.Node, sim *SimulatedBeacon)
• type ConsensusAPI
  • func NewConsensusAPI(eth *eth.Ethereum) *ConsensusAPI
  • func (api *ConsensusAPI) ExchangeCapabilities([]string) []string
  • func (api *ConsensusAPI) ExchangeTransitionConfigurationV1(config engine.TransitionConfigurationV1) (*engine.TransitionConfigurationV1, error)
  • func (api *ConsensusAPI) ForkchoiceUpdatedV1(update engine.ForkchoiceStateV1, payloadAttributes *engine.PayloadAttributes) (engine.ForkChoiceResponse, error)
  • func (api *ConsensusAPI) ForkchoiceUpdatedV2(update engine.ForkchoiceStateV1, params *engine.PayloadAttributes) (engine.ForkChoiceResponse, error)
  • func (api *ConsensusAPI) ForkchoiceUpdatedV3(update engine.ForkchoiceStateV1, params *engine.PayloadAttributes) (engine.ForkChoiceResponse, error)
  • func (api *ConsensusAPI) GetPayloadBodiesByHashV1(hashes []common.Hash) []*engine.ExecutionPayloadBodyV1
  • func (api *ConsensusAPI) GetPayloadBodiesByRangeV1(start, count hexutil.Uint64) ([]*engine.ExecutionPayloadBodyV1, error)
  • func (api *ConsensusAPI) GetPayloadV1(payloadID engine.PayloadID) (*engine.ExecutableData, error)
  • func (api *ConsensusAPI) GetPayloadV2(payloadID engine.PayloadID) (*engine.ExecutionPayloadEnvelope, error)
  • func (api *ConsensusAPI) GetPayloadV3(payloadID engine.PayloadID) (*engine.ExecutionPayloadEnvelope, error)
  • func (api *ConsensusAPI) NewPayloadV1(params engine.ExecutableData) (engine.PayloadStatusV1, error)
  • func (api *ConsensusAPI) NewPayloadV2(params engine.ExecutableData) (engine.PayloadStatusV1, error)
  • func (api *ConsensusAPI) NewPayloadV3(params engine.ExecutableData, versionedHashes []common.Hash, ...) (engine.PayloadStatusV1, error)
• type FullSyncTester
  • func RegisterFullSyncTester(stack *node.Node, backend *eth.Ethereum, target common.Hash) (*FullSyncTester, error)
  • func (tester *FullSyncTester) Start() error
  • func (tester *FullSyncTester) Stop() error
• type SimulatedBeacon
  • func NewSimulatedBeacon(period uint64, eth *eth.Ethereum) (*SimulatedBeacon, error)
  • func (c *SimulatedBeacon) AdjustTime(adjustment time.Duration) error
  • func (c *SimulatedBeacon) Commit() common.Hash
  • func (c *SimulatedBeacon) Fork(parentHash common.Hash) error
  • func (c *SimulatedBeacon) Rollback()
  • func (c *SimulatedBeacon) Start() error
  • func (c *SimulatedBeacon) Stop() error

Functions

func Register

func Register(stack *node.Node, backend *eth.Ethereum) error

Register adds the engine API to the full node.

func RegisterSimulatedBeaconAPIs

func RegisterSimulatedBeaconAPIs(stack *node.Node, sim *SimulatedBeacon)

Types

type ConsensusAPI

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

func NewConsensusAPI

func NewConsensusAPI(eth *eth.Ethereum) *ConsensusAPI

NewConsensusAPI creates a new consensus api for the given backend. The underlying blockchain needs to have a valid terminal total difficulty set.

func (*ConsensusAPI) ExchangeCapabilities

func (api *ConsensusAPI) ExchangeCapabilities([]string) []string

ExchangeCapabilities returns the current methods provided by this node.

func (*ConsensusAPI) ExchangeTransitionConfigurationV1

func (api *ConsensusAPI) ExchangeTransitionConfigurationV1(config engine.TransitionConfigurationV1) (*engine.TransitionConfigurationV1, error)

ExchangeTransitionConfigurationV1 checks the given configuration against the configuration of the node.

func (*ConsensusAPI) ForkchoiceUpdatedV1

func (api *ConsensusAPI) ForkchoiceUpdatedV1(update engine.ForkchoiceStateV1, payloadAttributes *engine.PayloadAttributes) (engine.ForkChoiceResponse, error)

ForkchoiceUpdatedV1 has several responsibilities:

We try to set our blockchain to the headBlock.

If the method is called with an empty head block: we return success, which can be used to check if the engine API is enabled.

If the total difficulty was not reached: we return INVALID.

If the finalizedBlockHash is set: we check if we have the finalizedBlockHash in our db, if not we start a sync.

If there are payloadAttributes: we try to assemble a block with the payloadAttributes and return its payloadID.

func (*ConsensusAPI) ForkchoiceUpdatedV2

func (api *ConsensusAPI) ForkchoiceUpdatedV2(update engine.ForkchoiceStateV1, params *engine.PayloadAttributes) (engine.ForkChoiceResponse, error)

ForkchoiceUpdatedV2 is equivalent to V1 with the addition of withdrawals in the payload attributes. It supports both PayloadAttributesV1 and PayloadAttributesV2.

func (*ConsensusAPI) ForkchoiceUpdatedV3

func (api *ConsensusAPI) ForkchoiceUpdatedV3(update engine.ForkchoiceStateV1, params *engine.PayloadAttributes) (engine.ForkChoiceResponse, error)

ForkchoiceUpdatedV3 is equivalent to V2 with the addition of parent beacon block root in the payload attributes. It supports only PayloadAttributesV3.

func (*ConsensusAPI) GetPayloadBodiesByHashV1

func (api *ConsensusAPI) GetPayloadBodiesByHashV1(hashes []common.Hash) []*engine.ExecutionPayloadBodyV1

GetPayloadBodiesByHashV1 implements engine_getPayloadBodiesByHashV1 which allows for retrieval of a list of block bodies by the engine api.

func (*ConsensusAPI) GetPayloadBodiesByRangeV1

func (api *ConsensusAPI) GetPayloadBodiesByRangeV1(start, count hexutil.Uint64) ([]*engine.ExecutionPayloadBodyV1, error)

GetPayloadBodiesByRangeV1 implements engine_getPayloadBodiesByRangeV1 which allows for retrieval of a range of block bodies by the engine api.

func (*ConsensusAPI) GetPayloadV1

func (api *ConsensusAPI) GetPayloadV1(payloadID engine.PayloadID) (*engine.ExecutableData, error)

GetPayloadV1 returns a cached payload by id.

func (*ConsensusAPI) GetPayloadV2

func (api *ConsensusAPI) GetPayloadV2(payloadID engine.PayloadID) (*engine.ExecutionPayloadEnvelope, error)

GetPayloadV2 returns a cached payload by id.

func (*ConsensusAPI) GetPayloadV3

func (api *ConsensusAPI) GetPayloadV3(payloadID engine.PayloadID) (*engine.ExecutionPayloadEnvelope, error)

GetPayloadV3 returns a cached payload by id.

func (*ConsensusAPI) NewPayloadV1

func (api *ConsensusAPI) NewPayloadV1(params engine.ExecutableData) (engine.PayloadStatusV1, error)

NewPayloadV1 creates an Eth1 block, inserts it in the chain, and returns the status of the chain.

func (*ConsensusAPI) NewPayloadV2

func (api *ConsensusAPI) NewPayloadV2(params engine.ExecutableData) (engine.PayloadStatusV1, error)

NewPayloadV2 creates an Eth1 block, inserts it in the chain, and returns the status of the chain.

func (*ConsensusAPI) NewPayloadV3

func (api *ConsensusAPI) NewPayloadV3(params engine.ExecutableData, versionedHashes []common.Hash, beaconRoot *common.Hash) (engine.PayloadStatusV1, error)

NewPayloadV3 creates an Eth1 block, inserts it in the chain, and returns the status of the chain.

type FullSyncTester

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

FullSyncTester is an auxiliary service that allows Geth to perform full sync alone without consensus-layer attached. Users must specify a valid block hash as the sync target.

This tester can be applied to different networks, no matter it's pre-merge or post-merge, but only for full-sync.

func RegisterFullSyncTester

func RegisterFullSyncTester(stack *node.Node, backend *eth.Ethereum, target common.Hash) (*FullSyncTester, error)

RegisterFullSyncTester registers the full-sync tester service into the node stack for launching and stopping the service controlled by node.

func (*FullSyncTester) Start

func (tester *FullSyncTester) Start() error

Start launches the beacon sync with provided sync target.

func (*FullSyncTester) Stop

func (tester *FullSyncTester) Stop() error

Stop stops the full-sync tester to stop all background activities. This function can only be called for one time.

type SimulatedBeacon

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

func NewSimulatedBeacon

func NewSimulatedBeacon(period uint64, eth *eth.Ethereum) (*SimulatedBeacon, error)

NewSimulatedBeacon constructs a new simulated beacon chain. Period sets the period in which blocks should be produced.

• If period is set to 0, a block is produced on every transaction. via Commit, Fork and AdjustTime.

func (*SimulatedBeacon) AdjustTime

func (c *SimulatedBeacon) AdjustTime(adjustment time.Duration) error

AdjustTime creates a new block with an adjusted timestamp.

func (*SimulatedBeacon) Commit

func (c *SimulatedBeacon) Commit() common.Hash

Commit seals a block on demand.

func (*SimulatedBeacon) Fork

func (c *SimulatedBeacon) Fork(parentHash common.Hash) error

Fork sets the head to the provided hash.

func (*SimulatedBeacon) Rollback

func (c *SimulatedBeacon) Rollback()

Rollback un-sends previously added transactions.

func (*SimulatedBeacon) Start

func (c *SimulatedBeacon) Start() error

Start invokes the SimulatedBeacon life-cycle function in a goroutine.

func (*SimulatedBeacon) Stop

func (c *SimulatedBeacon) Stop() error

Stop halts the SimulatedBeacon service.