provider

Documentation

Overview

Package provider implements the cchain.Provider interface.

Index

• Variables
• func IsErrHistoryPruned(err error) bool
• func WithCtxHeight(ctx context.Context, height uint64) (context.Context, error)
• type Provider
  • func Dial(network netconf.ID) (Provider, error)
  • func NewABCI(cmtCl rpcclient.Client, network netconf.ID, opts ...func(*Provider)) Provider
  • func NewGRPC(target string, network netconf.ID, ir codectypes.InterfaceRegistry, ...) (Provider, error)
  • func NewProviderForT(_ *testing.T, fetch fetchFunc, latest latestFunc, window windowFunc, ...) Provider
  • func (p Provider) AllAttestationsFrom(ctx context.Context, chainVer xchain.ChainVersion, attestOffset uint64) ([]xchain.Attestation, error)
  • func (p Provider) AppliedPlan(ctx context.Context, name string) (upgradetypes.Plan, bool, error)
  • func (p Provider) AttestationsFrom(ctx context.Context, chainVer xchain.ChainVersion, attestOffset uint64) ([]xchain.Attestation, error)
  • func (p Provider) BlockHeight(ctx context.Context) (uint64, error)
  • func (p Provider) CurrentPlannedPlan(ctx context.Context) (upgradetypes.Plan, bool, error)
  • func (p Provider) GenesisFiles(ctx context.Context) (execution []byte, consensus []byte, err error)
  • func (p Provider) LatestAttestation(ctx context.Context, chainVer xchain.ChainVersion) (xchain.Attestation, bool, error)
  • func (p Provider) PortalValidatorSet(ctx context.Context, valSetID uint64) ([]cchain.PortalValidator, bool, error)
  • func (p Provider) Portals(ctx context.Context) ([]rtypes.Portal, bool, error)
  • func (p Provider) QueryClients() cchain.QueryClients
  • func (p Provider) SDKRewards(ctx context.Context, operator common.Address) (float64, bool, error)
  • func (p Provider) SDKSigningInfos(ctx context.Context) ([]cchain.SDKSigningInfo, error)
  • func (p Provider) SDKValidator(ctx context.Context, operator common.Address) (cchain.SDKValidator, bool, error)
  • func (p Provider) SDKValidators(ctx context.Context) ([]cchain.SDKValidator, error)
  • func (p Provider) StreamAsync(ctx context.Context, chainVer xchain.ChainVersion, attestOffset uint64, ...)
  • func (p Provider) StreamAttestations(ctx context.Context, chainVer xchain.ChainVersion, attestOffset uint64, ...) error
  • func (p Provider) WindowCompare(ctx context.Context, chainVer xchain.ChainVersion, attestOffset uint64) (int, error)
  • func (p Provider) XBlock(ctx context.Context, height uint64, latest bool) (xchain.Block, bool, error)

Variables

var ErrHistoryPruned = errors.New("no commit info found (history pruned)")

ErrHistoryPruned indicates that the necessary state for the requested height isn't found in the store.

Functions

func IsErrHistoryPruned

func IsErrHistoryPruned(err error) bool

IsErrHistoryPruned reports whether the input error matches the CosmosSDK errors returned when the state for the requested height isn't found in the store.

func WithCtxHeight

func WithCtxHeight(ctx context.Context, height uint64) (context.Context, error)

WithCtxHeight returns a copy of the context with the `x-cosmos-block-height` grpc metadata header set to the provided height.

This height will be supplied in ABCIQueryOptions when issuing queries in the rpcAdaptor. It will also be added to grpc queries automatically.

Types

type Provider

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

Provider implements cchain.Provider.

func Dial

func Dial(network netconf.ID) (Provider, error)

Dial returns a ABCI provider to the provided network connecting to well-known public RPCs.

func NewABCI

func NewABCI(cmtCl rpcclient.Client, network netconf.ID, opts ...func(*Provider)) Provider

NewABCI returns a new provider using the provided cometBFT ABCI client.

func NewGRPC

func NewGRPC(target string, network netconf.ID, ir codectypes.InterfaceRegistry, opts ...func(*Provider)) (Provider, error)

NewGRPC returns a new provider using the provided gRPC server address. This is preferred to NewABCI as it bypasses CometBFT so is much faster and doesn't affect chain performance.

func NewProviderForT

func NewProviderForT(_ *testing.T, fetch fetchFunc, latest latestFunc, window windowFunc,
	backoffFunc func(context.Context) func(),
) Provider

NewProviderForT creates a new provider for testing.

func (Provider) AllAttestationsFrom

func (p Provider) AllAttestationsFrom(ctx context.Context, chainVer xchain.ChainVersion, attestOffset uint64,
) ([]xchain.Attestation, error)

func (Provider) AppliedPlan

func (p Provider) AppliedPlan(ctx context.Context, name string) (upgradetypes.Plan, bool, error)

func (Provider) AttestationsFrom

func (p Provider) AttestationsFrom(
	ctx context.Context,
	chainVer xchain.ChainVersion,
	attestOffset uint64,
) ([]xchain.Attestation, error)

func (Provider) BlockHeight

func (p Provider) BlockHeight(ctx context.Context) (uint64, error)

BlockHeight returns the current consensus block height.

func (Provider) CurrentPlannedPlan

func (p Provider) CurrentPlannedPlan(ctx context.Context) (upgradetypes.Plan, bool, error)

func (Provider) GenesisFiles

func (p Provider) GenesisFiles(ctx context.Context) (execution []byte, consensus []byte, err error)

func (Provider) LatestAttestation

func (p Provider) LatestAttestation(ctx context.Context, chainVer xchain.ChainVersion,
) (xchain.Attestation, bool, error)

func (Provider) PortalValidatorSet

func (p Provider) PortalValidatorSet(ctx context.Context, valSetID uint64) ([]cchain.PortalValidator, bool, error)

func (Provider) Portals

func (p Provider) Portals(ctx context.Context) ([]rtypes.Portal, bool, error)

func (Provider) QueryClients

func (p Provider) QueryClients() cchain.QueryClients

func (Provider) SDKRewards

func (p Provider) SDKRewards(ctx context.Context, operator common.Address) (float64, bool, error)

func (Provider) SDKSigningInfos

func (p Provider) SDKSigningInfos(ctx context.Context) ([]cchain.SDKSigningInfo, error)

func (Provider) SDKValidator

func (p Provider) SDKValidator(ctx context.Context, operator common.Address) (cchain.SDKValidator, bool, error)

func (Provider) SDKValidators

func (p Provider) SDKValidators(ctx context.Context) ([]cchain.SDKValidator, error)

func (Provider) StreamAsync

func (p Provider) StreamAsync(
	ctx context.Context,
	chainVer xchain.ChainVersion,
	attestOffset uint64,
	workerName string,
	callback cchain.ProviderCallback,
)

func (Provider) StreamAttestations

func (p Provider) StreamAttestations(
	ctx context.Context,
	chainVer xchain.ChainVersion,
	attestOffset uint64,
	workerName string,
	callback cchain.ProviderCallback,
) error

func (Provider) WindowCompare

func (p Provider) WindowCompare(ctx context.Context, chainVer xchain.ChainVersion, attestOffset uint64) (int, error)

func (Provider) XBlock

func (p Provider) XBlock(ctx context.Context, height uint64, latest bool) (xchain.Block, bool, error)

XBlock returns the consensus XBlock at the given height/offset or latest, or false if not available, or an error.