relayer

Documentation

Index

• Variables
• func SetOracle(o Oracle) func(GravityRelayer)
• func SetSymbolRetriever(coinGecko SymbolRetriever) func(GravityRelayer)
• type BridgeValidators
  • func (b BridgeValidators) GetPowers() []uint64
  • func (b BridgeValidators) HasDuplicates() bool
  • func (b BridgeValidators) Sort()
• type GravityRelayer
  • func NewGravityRelayer(logger zerolog.Logger, gravityQueryClient gravitytypes.QueryClient, ...) GravityRelayer
• type GravityValsetUpdatedEvents
  • func (a GravityValsetUpdatedEvents) Len() int
  • func (a GravityValsetUpdatedEvents) Less(i, j int) bool
  • func (a GravityValsetUpdatedEvents) Swap(i, j int)
• type Oracle
• type SubmittableBatch
• type SymbolRetriever
• type ValsetRelayMode
  • func (d ValsetRelayMode) String() string

Variables

var ErrNotFound = errors.New("not found")

Functions

func SetOracle

func SetOracle(o Oracle) func(GravityRelayer)

SetOracle sets a new oracle to the Gravity Relayer.

func SetSymbolRetriever

func SetSymbolRetriever(coinGecko SymbolRetriever) func(GravityRelayer)

Types

type BridgeValidators

type BridgeValidators []types.BridgeValidator

func (BridgeValidators) GetPowers

func (b BridgeValidators) GetPowers() []uint64

GetPowers returns only the power values for all members

func (BridgeValidators) HasDuplicates

func (b BridgeValidators) HasDuplicates() bool

HasDuplicates returns true if there are duplicates in the set

func (BridgeValidators) Sort

func (b BridgeValidators) Sort()

Sort sorts the validators by power

type GravityRelayer

type GravityRelayer interface {
	Start(ctx context.Context) error

	FindLatestValset(ctx context.Context) (*gravitytypes.Valset, error)

	RelayBatches(
		ctx context.Context,
		currentValset gravitytypes.Valset,
		possibleBatches map[ethcmn.Address][]SubmittableBatch,
	) error

	RelayValsets(ctx context.Context, currentValset gravitytypes.Valset) error

	// SetSymbolRetriever sets the Symbol Retriever api to get the symbol from contract address.
	SetSymbolRetriever(SymbolRetriever)

	// SetOracle sets the oracle for price feeder used when performing profitable
	// batch calculations.
	SetOracle(Oracle)

	GetProfitMultiplier() float64
}

func NewGravityRelayer

func NewGravityRelayer(
	logger zerolog.Logger,
	gravityQueryClient gravitytypes.QueryClient,
	gravityContract gravity.Contract,
	valsetRelayMode ValsetRelayMode,
	batchRelayEnabled bool,
	loopDuration time.Duration,
	pendingTxWait time.Duration,
	profitMultiplier float64,
	options ...func(GravityRelayer),
) GravityRelayer

type GravityValsetUpdatedEvents

type GravityValsetUpdatedEvents []*wrappers.GravityValsetUpdatedEvent

func (GravityValsetUpdatedEvents) Len

func (a GravityValsetUpdatedEvents) Len() int

func (GravityValsetUpdatedEvents) Less

func (a GravityValsetUpdatedEvents) Less(i, j int) bool

func (GravityValsetUpdatedEvents) Swap

func (a GravityValsetUpdatedEvents) Swap(i, j int)

type Oracle

type Oracle interface {
	// GetPrices returns the price for the provided base symbols.
	GetPrices(baseSymbols ...string) (map[string]sdk.Dec, error)

	// GetPrice returns the price based on the base symbol ex.: UMEE, ETH.
	GetPrice(baseSymbol string) (sdk.Dec, error)

	// SubscribeSymbols attempts to subscribe the symbols in all the providers.
	// baseSymbols is the base to be subscribed ex.: ["UMEE", "ATOM"].
	SubscribeSymbols(baseSymbols ...string) error
}

Oracle defines the Oracle interface that the relayer depends on.

type SubmittableBatch

type SubmittableBatch struct {
	Batch      types.OutgoingTxBatch
	Signatures []types.MsgConfirmBatch
}

type SymbolRetriever

type SymbolRetriever interface {
	// GetTokenSymbol executes an API client to retrieve the
	// correct Symbol from the contract address
	GetTokenSymbol(erc20Contract ethcmn.Address) (string, error)
}

SymbolRetriever wraps the interface to convert an ethereum contract address into an token symbol like 0xdAC17F958D2ee523a2206206994597C13D831ec7 -> USDT

type ValsetRelayMode

type ValsetRelayMode int64

ValsetRelayMode defines an enumerated validator set relay mode.

const (
	ValsetRelayModeNone ValsetRelayMode = iota
	ValsetRelayModeMinimum
	ValsetRelayModeAll
)

Allowed validator set relay modes

func (ValsetRelayMode) String

func (d ValsetRelayMode) String() string

String gets the string representation of the validator set relay mode.