light

Documentation

Overview

Package light provides a light Tendermint consensus backend implementation.

Index

• type Client
  • func NewClient(ctx context.Context, cfg ClientConfig) (Client, error)
• type ClientConfig

Types

type Client

type Client interface {
	consensus.LightClientBackend

	// GetVerifiedLightBlock returns a verified light block.
	GetVerifiedLightBlock(ctx context.Context, height int64) (*tmtypes.LightBlock, error)

	// GetVerifiedParameters returns verified consensus parameters.
	GetVerifiedParameters(ctx context.Context, height int64) (*tmproto.ConsensusParams, error)
}

Client is a Tendermint consensus light client that talks with a remote oasis-node that is using the Tendermint consensus backend and verifies responses.

func NewClient

func NewClient(ctx context.Context, cfg ClientConfig) (Client, error)

NewClient creates a new light client.

type ClientConfig

type ClientConfig struct {
	// GenesisDocument is the Tendermint genesis document.
	GenesisDocument *tmtypes.GenesisDoc

	// ConsensusNodes is a list of nodes exposing the Oasis Core public consensus services that are
	// used to fetch data required for syncing light clients. The first node is considered the
	// primary and at least two nodes must be specified.
	ConsensusNodes []node.TLSAddress

	// TrustOptions are Tendermint light client trust options.
	TrustOptions tmlight.TrustOptions
}

ClientConfig is the configuration for the light client.