submitter

README

submitter

This package implements the vigilant submitter. The code is adapted from https://github.com/btcsuite/btcwallet/tree/master/wallet.

Documentation

Index

• type Submitter
  • func New(cfg *config.SubmitterConfig, btcWallet *btcclient.Client, ...) (*Submitter, error)
  • func (s *Submitter) GetBabylonClient() (*babylonclient.Client, error)
  • func (s *Submitter) MustGetBabylonClient() *babylonclient.Client
  • func (s *Submitter) ShuttingDown() bool
  • func (s *Submitter) Start()
  • func (s *Submitter) Stop()
  • func (s *Submitter) WaitForShutdown()

Types

type Submitter

type Submitter struct {
	Cfg *config.SubmitterConfig
	// contains filtered or unexported fields
}

func New

func New(cfg *config.SubmitterConfig, btcWallet *btcclient.Client, babylonClient *babylonclient.Client) (*Submitter, error)

func (*Submitter) GetBabylonClient

func (s *Submitter) GetBabylonClient() (*babylonclient.Client, error)

func (*Submitter) MustGetBabylonClient

func (s *Submitter) MustGetBabylonClient() *babylonclient.Client

func (*Submitter) ShuttingDown

func (s *Submitter) ShuttingDown() bool

ShuttingDown returns whether the vigilante is currently in the process of shutting down or not.

func (*Submitter) Start

func (s *Submitter) Start()

Start starts the goroutines necessary to manage a vigilante.

func (*Submitter) Stop

func (s *Submitter) Stop()

Stop signals all vigilante goroutines to shutdown.

func (*Submitter) WaitForShutdown

func (s *Submitter) WaitForShutdown()

WaitForShutdown blocks until all vigilante goroutines have finished executing.