header

Documentation

Index

• type Relay
  • func StartRelay(ctx context.Context, config config.Relay, btcChain btc.Handle, ...) *Relay
  • func (r *Relay) ErrChan() <-chan error
• type RelayObserver

Types

type Relay

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

Relay takes headers from the Bitcoin chain and relays them to the given host chain.

func StartRelay

func StartRelay(
	ctx context.Context,
	config config.Relay,
	btcChain btc.Handle,
	hostChain chain.Handle,
	observer RelayObserver,
) *Relay

StartRelay creates an instance of the headers relay and runs its processing loops. The lifecycle of the relay can be managed using the passed context. The relay exits automatically once an error occurs.

func (*Relay) ErrChan

func (r *Relay) ErrChan() <-chan error

ErrChan returns the error channel of the relay. Once an error appears here, all relay loops are immediately terminated.

type RelayObserver

type RelayObserver interface {
	// NotifyHeaderPulled notifies about new header pulled from the
	// Bitcoin chain.
	NotifyHeaderPulled(headerHeight int64)

	// NotifyHeadersPushed notifies about new headers pushed to the host chain.
	NotifyHeadersPushed(headersHeights []int64)
}

RelayObserver represents an observer of headers relay events.