9f7d6a1aac
This finishes separating the mining code from the mempool that was
partially done in commit 9031d85 by extending the TxSource interface to
include the new functionality required by Decred.
The following is an overview of the changes to accomplish this:
- Move the VoteTx struct out of the mempool package in the mining
package and rename it to VoteDesc instead to signify it is a vote
descriptor and be consistent with the naming of TxDesc
- Update mempool to use the new mining.VoteDesc struct
- Rename CheckIfTxsExist to HaveAllTransactions to be more consistent
with HaveTransaction in the TxSource interface as it now lives
alongside it
- Add VoteHashesForBlock, VotesForBlocks, and IsTxTreeKnownInvalid
to the TxSource interface
- Switch the mining code to call the functions on the TxSource interface
instead and remove the reference to the concrete mempool
80 lines
2.5 KiB
Go
80 lines
2.5 KiB
Go
// Copyright (c) 2014-2016 The btcsuite developers
|
|
// Copyright (c) 2016 The Decred developers
|
|
// Use of this source code is governed by an ISC
|
|
// license that can be found in the LICENSE file.
|
|
|
|
package mining
|
|
|
|
import (
|
|
"time"
|
|
|
|
"github.com/decred/dcrd/blockchain/stake"
|
|
"github.com/decred/dcrd/chaincfg/chainhash"
|
|
"github.com/decred/dcrd/dcrutil"
|
|
)
|
|
|
|
// TxDesc is a descriptor about a transaction in a transaction source along with
|
|
// additional metadata.
|
|
type TxDesc struct {
|
|
// Tx is the transaction associated with the entry.
|
|
Tx *dcrutil.Tx
|
|
|
|
// Type is the type of the transaction associated with the entry.
|
|
Type stake.TxType
|
|
|
|
// 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 int64
|
|
|
|
// Fee is the total fee the transaction associated with the entry pays.
|
|
Fee int64
|
|
}
|
|
|
|
// VoteDesc is a descriptor about a vote transaction in a transaction source
|
|
// along with additional metadata.
|
|
type VoteDesc struct {
|
|
VoteHash chainhash.Hash
|
|
TicketHash chainhash.Hash
|
|
ApprovesParent bool
|
|
}
|
|
|
|
// TxSource represents a source of transactions to consider for inclusion in
|
|
// new blocks.
|
|
//
|
|
// The interface contract requires that all of these methods are safe for
|
|
// concurrent access with respect to the source.
|
|
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
|
|
|
|
// HaveAllTransactions returns whether or not all of the passed
|
|
// transaction hashes exist in the source pool.
|
|
HaveAllTransactions(hashes []chainhash.Hash) bool
|
|
|
|
// VoteHashesForBlock returns the hashes for all votes on the provided
|
|
// block hash that are currently available in the source pool.
|
|
VoteHashesForBlock(hash *chainhash.Hash) []chainhash.Hash
|
|
|
|
// VotesForBlocks returns a slice of vote descriptors for all votes on
|
|
// the provided block hashes that are currently available in the source
|
|
// pool.
|
|
VotesForBlocks(hashes []chainhash.Hash) [][]VoteDesc
|
|
|
|
// IsTxTreeKnownInvalid returns whether or not the transaction tree of
|
|
// the provided hash is known to be invalid according to the votes
|
|
// currently in the memory pool.
|
|
IsTxTreeKnownInvalid(hash *chainhash.Hash) bool
|
|
}
|