teleportevm

Documentation

Index

• Constants
• type Client
• type Signer
  • func NewSigner(signer ethereum.Signer, types []string) *Signer
  • func (l *Signer) Sign(event *messages.Event) (bool, error)
• type TeleportEventProvider
  • func New(cfg TeleportEventProviderConfig) *TeleportEventProvider
  • func (tp *TeleportEventProvider) Events() chan *messages.Event
  • func (tp *TeleportEventProvider) Start(ctx context.Context) error
• type TeleportEventProviderConfig

Constants

const LoggerTag = "ETHEREUM_TELEPORT"

const SignatureKey = "ethereum"

const TeleportEventType = "teleport_evm"

Types

type Client

type Client interface {
	BlockNumber(ctx context.Context) (uint64, error)
	FilterLogs(ctx context.Context, q geth.FilterQuery) ([]types.Log, error)
}

Client is a Ethereum compatible client.

type Signer

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

Signer signs Ethereum logger messages using Ethereum signature.

func NewSigner

func NewSigner(signer ethereum.Signer, types []string) *Signer

NewSigner returns a new instance of the Signer struct.

func (*Signer) Sign

func (l *Signer) Sign(event *messages.Event) (bool, error)

Sign implements the Signer interface.

type TeleportEventProvider

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

TeleportEventProvider listens to TeleportGUID events on Ethereum compatible blockchains.

https://github.com/makerdao/dss-teleport

func New

func New(cfg TeleportEventProviderConfig) *TeleportEventProvider

New returns a new instance of the TeleportEventProvider struct.

func (*TeleportEventProvider) Events

func (tp *TeleportEventProvider) Events() chan *messages.Event

Events implements the publisher.Listener interface.

func (*TeleportEventProvider) Start

func (tp *TeleportEventProvider) Start(ctx context.Context) error

Start implements the publisher.Listener interface.

type TeleportEventProviderConfig

type TeleportEventProviderConfig struct {
	// Client is an instance of Ethereum RPC client.
	Client Client
	// Addresses is a list of contracts from which logs will be fetched.
	Addresses []ethereum.Address
	// Interval specifies how often provider should check for new logs.
	Interval time.Duration
	// BlocksDelta is a list of distances between the latest block on the
	// blockchain and blocks from which logs are to be taken. The purpose of
	// this field is to ensure that older events are resent from time to time.
	BlocksDelta []int
	// BlocksLimit specifies how from many blocks logs can be fetched at once.
	BlocksLimit int
	// Logger is a current logger interface used by the TeleportEventProvider.
	// The Logger is used to monitor asynchronous processes.
	Logger log.Logger
}

TeleportEventProviderConfig contains a configuration options for New.