light

Documentation

Overview

Package light implements a consensus light client protocol.

Index

• Constants
• Variables
• func NewServer(p2p rpc.P2P, chainContext string, consensus consensus.Backend, ...) rpc.Server
• func ProtocolID(chainContext string) core.ProtocolID

Constants

const (
	MethodGetLightBlock  = "GetLightBlock"
	MethodGetParameters  = "GetParameters"
	MethodSubmitEvidence = "SubmitEvidence"
)

const LightProtocolID = "light"

LightProtocolID is a unique protocol identifier for the light client sync protocol.

Variables

var LightProtocolVersion = version.Version{Major: 1, Minor: 0, Patch: 0}

LightProtocolVersion is the supported version of the light client sync protocol.

Functions

func NewServer

func NewServer(
	p2p rpc.P2P,
	chainContext string,
	consensus consensus.Backend,
	lightClient consensus.LightClient,
) rpc.Server

NewServer creates a new light block sync protocol server.

func ProtocolID

func ProtocolID(chainContext string) core.ProtocolID

ProtocolID returns the light client sync protocol ID.