popm

Documentation

Index

• type Config
  • func NewDefaultConfig() *Config
• type L2KeystoneProcessingContainer
• type Miner
  • func NewMiner(cfg *Config) (*Miner, error)
  • func (m *Miner) AddL2Keystone(val hemi.L2Keystone)
  • func (m *Miner) BitcoinBalance(ctx context.Context, scriptHash string) (*bfgapi.BitcoinBalanceResponse, error)
  • func (m *Miner) BitcoinInfo(ctx context.Context) (*bfgapi.BitcoinInfoResponse, error)
  • func (m *Miner) BitcoinUTXOs(ctx context.Context, scriptHash string) (*bfgapi.BitcoinUTXOsResponse, error)
  • func (m *Miner) L2Keystones(ctx context.Context, count uint64) (*bfgapi.L2KeystonesResponse, error)
  • func (m *Miner) Ping(ctx context.Context, timestamp int64) (*bfgapi.PingResponse, error)
  • func (m *Miner) Run(pctx context.Context) error

Types

type Config

type Config struct {
	// BFGWSURL specifies the URL of the BFG private websocket endpoint
	BFGWSURL string

	// BTCChainName specifies the name of the Bitcoin chain that
	// this PoP miner is operating on.
	BTCChainName string // XXX are we brave enough to rename this BTCNetwork?

	// BTCPrivateKey provides a BTC private key as a string of
	// hexadecimal digits.
	BTCPrivateKey string

	LogLevel string

	PrometheusListenAddress string

	PprofListenAddress string

	RetryMineThreshold uint

	StaticFee uint
}

func NewDefaultConfig

func NewDefaultConfig() *Config

type L2KeystoneProcessingContainer

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

type Miner

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

func NewMiner

func NewMiner(cfg *Config) (*Miner, error)

func (*Miner) AddL2Keystone

func (m *Miner) AddL2Keystone(val hemi.L2Keystone)

func (*Miner) BitcoinBalance

func (m *Miner) BitcoinBalance(ctx context.Context, scriptHash string) (*bfgapi.BitcoinBalanceResponse, error)

func (*Miner) BitcoinInfo

func (m *Miner) BitcoinInfo(ctx context.Context) (*bfgapi.BitcoinInfoResponse, error)

func (*Miner) BitcoinUTXOs

func (m *Miner) BitcoinUTXOs(ctx context.Context, scriptHash string) (*bfgapi.BitcoinUTXOsResponse, error)

func (*Miner) L2Keystones

func (m *Miner) L2Keystones(ctx context.Context, count uint64) (*bfgapi.L2KeystonesResponse, error)

func (*Miner) Ping

func (m *Miner) Ping(ctx context.Context, timestamp int64) (*bfgapi.PingResponse, error)

func (*Miner) Run

func (m *Miner) Run(pctx context.Context) error