light

package

v0.2400.0 Latest Latest Go to latest Published: May 13, 2024 License: Apache-2.0 Imports: 27 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package light implements a CometBFT light client service.

This section is empty.

This section is empty.

func New(ctx context.Context, dataDir string, genesis *genesisAPI.Document, c consensus.Backend, p2p rpc.P2P) (api.ClientService, error)

New creates a new CometBFT light client service backed by the local full node.

This light client is initialized with a trusted blocks obtained from the local consensus backend.

func NewInternalClient(ctx context.Context, chainContext string, p2p rpc.P2P, cfg api.ClientConfig) (api.Client, error)

NewInternalClient creates an internal and non-persistent light client.

This client is instantiated from the provided (obtained out of bound) trusted block and is used internally for CometBFT's state sync protocol.

This section is empty.

Path	Synopsis
api Package api provides a light CometBFT consensus backend API.	Package api provides a light CometBFT consensus backend API.
p2p Package p2p implements the Oasis Core libp2p backed light client provider.	Package p2p implements the Oasis Core libp2p backed light client provider.