mining

type BlkTmplGenerator struct {
	Policy      *Policy
	ChainParams *netparams.Params
	TxSource    TxSource
	Chain       *blockchain.BlockChain
	TimeSource  blockchain.MedianTimeSource
	SigCache    *txscript.SigCache
	HashCache   *txscript.HashCache
	Algo        string
}

type BlockTemplate struct {
	// Block is a block that is ready to be solved by miners.  Thus, it is
	// completely valid with the exception of satisfying the proof-of-work
	// requirement.
	Block *wire.MsgBlock
	// Fees contains the amount of fees each transaction in the generated
	// template pays in base units.  Since the first transaction is the
	// coinbase, the first entry (offset 0) will contain the negative of the
	// sum of the fees of all other transactions.
	Fees []int64
	// SigOpCosts contains the number of signature operations each
	// transaction in the generated template performs.
	SigOpCosts []int64
	// Height is the height at which the block template connects to the main
	// chain.
	Height int32
	// ValidPayAddress indicates whether or not the template coinbase
	// pays to
	// an address or is redeemable by anyone.  See the documentation on
	// NewBlockTemplate for details on which this can be useful to generate
	// templates without a coinbase payment address.
	ValidPayAddress bool
	// WitnessCommitment is a commitment to the witness data (if any) within
	// the block. This field will only be populated once segregated witness
	// has been activated, and the block contains a transaction which has
	// witness data.
	WitnessCommitment []byte
}

type Policy struct {
	// BlockMinWeight is the minimum block weight to be used when generating a block template.
	BlockMinWeight uint32
	// BlockMaxWeight is the maximum block weight to be used when generating a block template.
	BlockMaxWeight uint32
	// BlockMinWeight is the minimum block size to be used when generating a block template.
	BlockMinSize uint32
	// BlockMaxSize is the maximum block size to be used when generating a block template.
	BlockMaxSize uint32
	// BlockPrioritySize is the size in bytes for high-priority / low-fee transactions to be used when generating a block template.
	BlockPrioritySize uint32
	// TxMinFreeFee is the minimum fee in Satoshi/1000 bytes that is required for a transaction to be treated as free for mining purposes (block template generation).
	TxMinFreeFee util.Amount
}

type TxDesc struct {
	// Tx is the transaction associated with the entry.
	Tx *util.Tx
	// Added is the time when the entry was added to the source pool.
	Added time.Time
	// Height is the block height when the entry was added to the the
	// source pool.
	Height int32
	// Fee is the total fee the transaction associated with the entry pays.
	Fee int64
	// FeePerKB is the fee the transaction pays in Satoshi per 1000 bytes.
	FeePerKB int64
}

type TxSource interface {
	// LastUpdated returns the last time a transaction was added to or
	// removed from the source pool.
	LastUpdated() time.Time
	// MiningDescs returns a slice of mining descriptors for all the
	// transactions in the source pool.
	MiningDescs() []*TxDesc
	// HaveTransaction returns whether or not the passed transaction hash
	// exists in the source pool.
	HaveTransaction(hash *chainhash.Hash) bool
}