bfg

Documentation

Index

• Variables
• type Config
  • func NewDefaultConfig() *Config
• type Server
  • func NewServer(cfg *Config) (*Server, error)
  • func (s *Server) BtcBlockCanonicalHeight(ctx context.Context) (uint64, error)
  • func (s *Server) Run(pctx context.Context) error

Variables

var ErrAlreadyProcessed error = fmt.Errorf("Already Processed BTC Block")

var (
	ErrBTCPrivateKeyMissing = errors.New("you must specify a BTC private key")
)

Types

type Config

type Config struct {
	BTCStartHeight          uint64
	EXBTCAddress            string
	EXBTCInitialConns       int
	EXBTCMaxConns           int
	PrivateListenAddress    string
	PublicListenAddress     string
	LogLevel                string
	PgURI                   string
	PrometheusListenAddress string
	PrometheusNamespace     string
	PprofListenAddress      string
	RequestLimit            int
	RequestTimeout          int // in seconds
	RemoteIPHeaders         []string
	TrustedProxies          []string
	BFGURL                  string
	BTCPrivateKey           string
}

func NewDefaultConfig

func NewDefaultConfig() *Config

type Server

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

func NewServer

func NewServer(cfg *Config) (*Server, error)

func (*Server) BtcBlockCanonicalHeight

func (s *Server) BtcBlockCanonicalHeight(ctx context.Context) (uint64, error)

func (*Server) Run

func (s *Server) Run(pctx context.Context) error