mercury

package
v2.11.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 1, 2024 License: MIT Imports: 41 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// Mercury server error codes
	DuplicateReport = 2
)

Variables

View Source 
var FeedScopedConfigSet common.Hash

FeedScopedConfigSet ConfigSet with FeedID for use with mercury (and multi-config DON)

View Source 
var PayloadTypes = getPayloadTypes()

Functions

func BuildSamplePayload added in v2.5.0 

func BuildSamplePayload(report []byte, reportCtx ocrtypes.ReportContext, sigs []ocrtypes.AttributedOnchainSignature) []byte

func FeedIDFromReport added in v2.5.0 

func FeedIDFromReport(report ocrtypes.Report) (feedID utils.FeedID, err error)

func FilterName 

func FilterName(addr common.Address, feedID common.Hash) string

func MustHexToConfigDigest added in v2.5.0 

func MustHexToConfigDigest(s string) (cd ocrtypes.ConfigDigest)

func NewTransmitter 

func NewTransmitter(lggr logger.Logger, clients map[string]wsrpc.Client, fromAccount ed25519.PublicKey, jobID int32, feedID [32]byte, orm ORM, codec TransmitterReportDecoder) *mercuryTransmitter

Types

type ConfigPoller 

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

ConfigPoller defines the Mercury Config Poller

func NewConfigPoller 

func NewConfigPoller(ctx context.Context, lggr logger.Logger, destChainPoller logpoller.LogPoller, addr common.Address, feedId common.Hash) (*ConfigPoller, error)

NewConfigPoller creates a new Mercury ConfigPoller

func (*ConfigPoller) Close added in v2.3.0 

func (cp *ConfigPoller) Close() error

func (*ConfigPoller) LatestBlockHeight 

func (cp *ConfigPoller) LatestBlockHeight(ctx context.Context) (blockHeight uint64, err error)

LatestBlockHeight returns the latest block height from the logs

func (*ConfigPoller) LatestConfig 

func (cp *ConfigPoller) LatestConfig(ctx context.Context, changedInBlock uint64) (ocrtypes.ContractConfig, error)

LatestConfig returns the latest config from the logs on a certain block

func (*ConfigPoller) LatestConfigDetails 

func (cp *ConfigPoller) LatestConfigDetails(ctx context.Context) (changedInBlock uint64, configDigest ocrtypes.ConfigDigest, err error)

LatestConfigDetails returns the latest config details from the logs

func (*ConfigPoller) Notify 

func (cp *ConfigPoller) Notify() <-chan struct{}

func (*ConfigPoller) Replay 

func (cp *ConfigPoller) Replay(ctx context.Context, fromBlock int64) error

Replay abstracts the logpoller.LogPoller Replay() implementation

func (*ConfigPoller) Start added in v2.3.0 

func (cp *ConfigPoller) Start()

type ConfigTracker 

type ConfigTracker interface {
	LatestConfigDetails(ctx context.Context) (changedInBlock uint64, configDigest ocrtypes.ConfigDigest, err error)
}

type FullConfigFromLog 

type FullConfigFromLog struct {
	ocrtypes.ContractConfig
	// contains filtered or unexported fields
}

FullConfigFromLog defines the contract config with the feedID

type ORM added in v2.4.0 

type ORM interface {
	InsertTransmitRequest(serverURL string, req *pb.TransmitRequest, jobID int32, reportCtx ocrtypes.ReportContext, qopts ...pg.QOpt) error
	DeleteTransmitRequests(serverURL string, reqs []*pb.TransmitRequest, qopts ...pg.QOpt) error
	GetTransmitRequests(serverURL string, jobID int32, qopts ...pg.QOpt) ([]*Transmission, error)
	PruneTransmitRequests(serverURL string, jobID int32, maxSize int, qopts ...pg.QOpt) error
	LatestReport(ctx context.Context, feedID [32]byte, qopts ...pg.QOpt) (report []byte, err error)
}

func NewORM added in v2.4.0 

func NewORM(db *sqlx.DB, lggr logger.Logger, cfg pg.QConfig) ORM

type OffchainConfigDigester 

type OffchainConfigDigester struct {
	FeedID          utils.FeedID
	ChainID         *big.Int
	ContractAddress common.Address
}

func NewOffchainConfigDigester 

func NewOffchainConfigDigester(feedID [32]byte, chainID *big.Int, contractAddress common.Address) OffchainConfigDigester

func (OffchainConfigDigester) ConfigDigest 

func (d OffchainConfigDigester) ConfigDigest(cc ocrtypes.ContractConfig) (ocrtypes.ConfigDigest, error)

func (OffchainConfigDigester) ConfigDigestPrefix 

func (d OffchainConfigDigester) ConfigDigestPrefix() (ocrtypes.ConfigDigestPrefix, error)

type PersistenceManager added in v2.4.0 

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

func NewPersistenceManager added in v2.4.0 

func NewPersistenceManager(lggr logger.Logger, serverURL string, orm ORM, jobID int32, maxTransmitQueueSize int, flushDeletesFrequency, pruneFrequency time.Duration) *PersistenceManager

func (*PersistenceManager) AsyncDelete added in v2.4.0 

func (pm *PersistenceManager) AsyncDelete(req *pb.TransmitRequest)

func (*PersistenceManager) Close added in v2.4.0 

func (pm *PersistenceManager) Close() error

func (*PersistenceManager) Delete added in v2.4.0 

func (pm *PersistenceManager) Delete(ctx context.Context, req *pb.TransmitRequest) error

func (*PersistenceManager) Insert added in v2.4.0 

func (pm *PersistenceManager) Insert(ctx context.Context, req *pb.TransmitRequest, reportCtx ocrtypes.ReportContext) error

func (*PersistenceManager) Load added in v2.4.0 

func (pm *PersistenceManager) Load(ctx context.Context) ([]*Transmission, error)

func (*PersistenceManager) Start added in v2.4.0 

func (pm *PersistenceManager) Start(ctx context.Context) error

type Transmission added in v2.2.0 

type Transmission struct {
	Req       *pb.TransmitRequest    // the payload to transmit
	ReportCtx ocrtypes.ReportContext // contains priority information (latest epoch/round wins)
}

type TransmitQueue added in v2.2.0 

type TransmitQueue struct {
	services.StateMachine
	// contains filtered or unexported fields
}

TransmitQueue is the high-level package that everything outside of this file should be using It stores pending transmissions, yielding the latest (highest priority) first to the caller

func NewTransmitQueue added in v2.2.0 

func NewTransmitQueue(lggr logger.Logger, serverURL, feedID string, maxlen int, asyncDeleter asyncDeleter) *TransmitQueue

maxlen controls how many items will be stored in the queue 0 means unlimited - be careful, this can cause memory leaks

func (*TransmitQueue) BlockingPop added in v2.2.0 

func (tq *TransmitQueue) BlockingPop() (t *Transmission)

BlockingPop will block until at least one item is in the heap, and then return it If the queue is closed, it will immediately return nil

func (*TransmitQueue) Close added in v2.2.0 

func (tq *TransmitQueue) Close() error

func (*TransmitQueue) HealthReport added in v2.2.0 

func (tq *TransmitQueue) HealthReport() map[string]error

func (*TransmitQueue) Init added in v2.11.0 

func (tq *TransmitQueue) Init(transmissions []*Transmission)

func (*TransmitQueue) IsEmpty added in v2.2.0 

func (tq *TransmitQueue) IsEmpty() bool

func (*TransmitQueue) Name added in v2.2.0 

func (tq *TransmitQueue) Name() string

func (*TransmitQueue) Push added in v2.2.0 

func (tq *TransmitQueue) Push(req *pb.TransmitRequest, reportCtx ocrtypes.ReportContext) (ok bool)

func (*TransmitQueue) Ready added in v2.2.0 

func (tq *TransmitQueue) Ready() error

func (*TransmitQueue) Start added in v2.2.0 

func (tq *TransmitQueue) Start(context.Context) error

type Transmitter 

type Transmitter interface {
	mercury.Transmitter
	services.Service
}

type TransmitterReportDecoder added in v2.6.0 

type TransmitterReportDecoder interface {
	BenchmarkPriceFromReport(report ocrtypes.Report) (*big.Int, error)
}

Source Files

View all Source files

Directories

Path Synopsis
v1
reportcodec
types
v2
reportcodec
types
v3
reportcodec
types
cache
mocks
pb

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.