relayer

README

dfuse Relayer

The relayer process fans out and propagates blocks from instrumented blockchain nodes, down to services, serving as a redundant and highly-available access to streaming block & transaction data. It is part of dfuse.

Installation & Usage

See the different protocol-specific dfuse binaries at https://github.com/dfuse-io/dfuse#protocols

Current implementations:

• dfuse for EOSIO
• dfuse for Ethereum, soon to be open sourced

Contributing

Issues and PR in this repo related strictly to the relayer functionalities

Report any protocol-specific issues in their respective repositories

Please first refer to the general dfuse contribution guide, if you wish to contribute to this code base.

License

Apache 2.0

Documentation

Index

• type Relayer
  • func NewRelayer(sourceAddresses []string, mergerAddr string, maxSourceLatency time.Duration, ...) *Relayer
  • func (r *Relayer) BuildPipeline(startBlock uint64, blockStore dstore.Store)
  • func (r *Relayer) Check(ctx context.Context, in *pbhealth.HealthCheckRequest) (*pbhealth.HealthCheckResponse, error)
  • func (r *Relayer) Drift() time.Duration
  • func (r *Relayer) PollSourceHeadUntilReady(readyStartBlock chan uint64, maxSourceLatency time.Duration, ...)
  • func (r *Relayer) SetupBlockStreamServer(bufferSize int)
  • func (r *Relayer) StartListening(bufferSize int) error
  • func (r *Relayer) StartRelayingBlocks(startBlockReady chan uint64, blockStore dstore.Store, ...)

Types

type Relayer

type Relayer struct {
	*shutter.Shutter
	// contains filtered or unexported fields
}

func NewRelayer

func NewRelayer(sourceAddresses []string, mergerAddr string, maxSourceLatency time.Duration, grpcListenAddr string, maxDriftTolerance time.Duration, bufferSize int) *Relayer

func (*Relayer) BuildPipeline

func (r *Relayer) BuildPipeline(startBlock uint64, blockStore dstore.Store)

func (*Relayer) Check

func (r *Relayer) Check(ctx context.Context, in *pbhealth.HealthCheckRequest) (*pbhealth.HealthCheckResponse, error)

func (*Relayer) Drift

func (r *Relayer) Drift() time.Duration

func (*Relayer) PollSourceHeadUntilReady

func (r *Relayer) PollSourceHeadUntilReady(readyStartBlock chan uint64, maxSourceLatency time.Duration, minOffsetToHead uint64)

func (*Relayer) SetupBlockStreamServer

func (r *Relayer) SetupBlockStreamServer(bufferSize int)

func (*Relayer) StartListening

func (r *Relayer) StartListening(bufferSize int) error

func (*Relayer) StartRelayingBlocks

func (r *Relayer) StartRelayingBlocks(startBlockReady chan uint64, blockStore dstore.Store, driftMonitorDelay time.Duration)