mempool

package
v0.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 26, 2018 License: BSD-2-Clause Imports: 25 Imported by: 0

Documentation

Index

Constants

View Source 
const (

	// DefaultEstimateFeeMaxRollback is the default number of rollbacks
	// allowed by the fee estimator for orphaned blocks.
	DefaultEstimateFeeMaxRollback = 2

	// DefaultEstimateFeeMinRegisteredBlocks is the default minimum
	// number of blocks which must be observed by the fee estimator before
	// it will provide fee estimations.
	DefaultEstimateFeeMinRegisteredBlocks = 3
)
View Source 
const (
	OrphanTxExpireTime          = 20 * 60
	OrphanTxExpireInterval      = 5 * 60
	DefaultMaxOrphanTransaction = 100
)
View Source 
const (
	RollingFeeHalfLife = 12 * 60 * 60
)
View Source 
const (
	// UnminedHeight is the height used for the "block" height field of the
	// contextual transaction information provided in a transaction store
	// when it has not yet been mined into a block.
	UnminedHeight = 0x7fffffff
)

Variables

View Source 
var (
	// EstimateFeeDatabaseKey is the key that we use to
	// store the fee estimator in the database.
	EstimateFeeDatabaseKey = []byte("estimatefee")
)

Functions

func InitMempool 

func InitMempool()

Types

type BtcPerKilobyte 

type BtcPerKilobyte float64

BtcPerKilobyte is number with units of bitcoins per kilobyte.

type EntryAncestorFeeRateSort 

type EntryAncestorFeeRateSort TxEntry

func (EntryAncestorFeeRateSort) Less 

func (r EntryAncestorFeeRateSort) Less(than btree.Item) bool

type EntryFeeSort 

type EntryFeeSort TxEntry

func (EntryFeeSort) Less 

func (e EntryFeeSort) Less(than btree.Item) bool

type FeeEstimator 

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

FeeEstimator manages the data necessary to create fee estimations. It is safe for concurrent access.

func NewFeeEstimator 

func NewFeeEstimator(maxRollback, minRegisteredBlocks uint32) *FeeEstimator

NewFeeEstimator creates a FeeEstimator for which at most maxRollback blocks can be unregistered and which returns an error unless minRegisteredBlocks have been registered with it.

func RestoreFeeEstimator 

func RestoreFeeEstimator(data FeeEstimatorState) (*FeeEstimator, error)

RestoreFeeEstimator takes a FeeEstimatorState that was previously returned by Save and restores it to a FeeEstimator

func (*FeeEstimator) EstimateFee 

func (ef *FeeEstimator) EstimateFee(numBlocks uint32) (BtcPerKilobyte, error)

EstimateFee estimates the fee per byte to have a tx confirmed a given number of blocks from now.

func (*FeeEstimator) LastKnownHeight 

func (ef *FeeEstimator) LastKnownHeight() int32

LastKnownHeight returns the height of the last block which was registered.

func (*FeeEstimator) ObserveTransaction 

func (ef *FeeEstimator) ObserveTransaction(t *tx.Tx)

ObserveTransaction is called when a new transaction is observed in the mempool.

func (*FeeEstimator) RegisterBlock 

func (ef *FeeEstimator) RegisterBlock(block *block.Block) error

RegisterBlock informs the fee estimator of a new block to take into account.

func (*FeeEstimator) Rollback 

func (ef *FeeEstimator) Rollback(hash *util.Hash) error

Rollback unregisters a recently registered block from the FeeEstimator. This can be used to reverse the effect of an orphaned block on the fee estimator. The maximum number of rollbacks allowed is given by maxRollbacks.

Note: not everything can be rolled back because some transactions are deleted if they have been observed too long ago. That means the result of Rollback won't always be exactly the same as if the last block had not happened, but it should be close enough.

func (*FeeEstimator) Save 

func (ef *FeeEstimator) Save() FeeEstimatorState

Save records the current state of the FeeEstimator to a []byte that can be restored later.

type FeeEstimatorState 

type FeeEstimatorState []byte

FeeEstimatorState represents a saved FeeEstimator that can be restored with data from an earlier session of the program.

type LockPoints 

type LockPoints struct {
	// Height and Time will be set to the blockChain height and median time past values that
	// would be necessary to satisfy all relative lockTime constraints (BIP68)
	// of this tx given our view of block chain history
	Height int32
	Time   int64
	// MaxInputBlock as long as the current chain descends from the highest height block
	// containing one of the inputs used in the calculation, then the cached
	// values are still valid even after a reOrg.
	MaxInputBlock *blockindex.BlockIndex
}

func NewLockPoints 

func NewLockPoints() *LockPoints

type OrphanTx 

type OrphanTx struct {
	Tx         *tx.Tx
	NodeID     int64
	Expiration int
}

type PoolRemovalReason 

type PoolRemovalReason int
const (
	// UNKNOWN Manually removed or unknown reason
	UNKNOWN PoolRemovalReason = iota
	// EXPIRY Expired from memPool
	EXPIRY
	// SIZELIMIT Removed in size limiting
	SIZELIMIT
	// REORG Removed for reorganization
	REORG
	// BLOCK Removed for block
	BLOCK
	// CONFLICT Removed for conflict with in-block transaction
	CONFLICT
	// REPLACED Removed for replacement
	REPLACED
)

Reason why a transaction was removed from the memPool, this is passed to the notification signal.

type SatoshiPerByte 

type SatoshiPerByte float64

SatoshiPerByte is number with units of satoshis per byte.

func NewSatoshiPerByte 

func NewSatoshiPerByte(fee amount.Amount, size uint32) SatoshiPerByte

NewSatoshiPerByte creates a SatoshiPerByte from an Amount and a size in bytes.

func (SatoshiPerByte) Fee 

func (rate SatoshiPerByte) Fee(size uint32) amount.Amount

Fee returns the fee for a transaction of a given size for the given fee rate.

func (SatoshiPerByte) ToBtcPerKb 

func (rate SatoshiPerByte) ToBtcPerKb() BtcPerKilobyte

ToBtcPerKb returns a float value that represents the given SatoshiPerByte converted to satoshis per kb.

type StatisInformation 

type StatisInformation struct {
	// sumTxCountWithDescendants is this tx and all Descendants transaction's number. init number is 1.
	SumTxCountWithDescendants int64
	// sumFeeWithDescendants is calculated by this tx and all Descendants transaction;
	SumTxFeeWithDescendants int64
	// sumSizeWithDescendants size calculated by this tx and all Descendants transaction;
	SumTxSizeWithDescendants int64

	SumTxCountWithAncestors      int64
	SumTxSizeWitAncestors        int64
	SumTxSigOpCountWithAncestors int64
	SumTxFeeWithAncestors        int64
}

type TxEntry 

type TxEntry struct {
	Tx     *tx.Tx
	TxSize int
	// txFee tis transaction fee
	TxFee    int64
	TxHeight int32
	// sigOpCount sigop plus P2SH sigops count
	SigOpCount int

	// childTx the tx's all Descendants transaction
	ChildTx map[*TxEntry]struct{}
	// parentTx the tx's all Ancestors transaction
	ParentTx map[*TxEntry]struct{}

	//Statistics Information for every txentry with its ancestors And descend.
	StatisInformation
	// contains filtered or unexported fields
}

func NewTxentry 

func NewTxentry(tx *tx.Tx, txFee int64, acceptTime int64, height int32, lp LockPoints, sigOpsCount int,
	spendCoinbase bool) *TxEntry

func (*TxEntry) CheckLockPointValidity 

func (t *TxEntry) CheckLockPointValidity(chain *chain.Chain) bool

func (*TxEntry) GetFeeRate 

func (t *TxEntry) GetFeeRate() *util.FeeRate

func (*TxEntry) GetInfo 

func (t *TxEntry) GetInfo() *TxMempoolInfo

func (*TxEntry) GetLockPointFromTxEntry 

func (t *TxEntry) GetLockPointFromTxEntry() LockPoints

func (*TxEntry) GetSigOpCountWithAncestors 

func (t *TxEntry) GetSigOpCountWithAncestors() int64

func (*TxEntry) GetSpendsCoinbase 

func (t *TxEntry) GetSpendsCoinbase() bool

func (*TxEntry) GetTime 

func (t *TxEntry) GetTime() int64

func (*TxEntry) GetUsageSize 

func (t *TxEntry) GetUsageSize() int64

func (*TxEntry) Less 

func (t *TxEntry) Less(than btree.Item) bool

func (*TxEntry) SetLockPointFromTxEntry 

func (t *TxEntry) SetLockPointFromTxEntry(lp LockPoints)

func (*TxEntry) UpdateAncestorState 

func (t *TxEntry) UpdateAncestorState(updateCount, updateSize, updateSigOps int, updateFee int64)

func (*TxEntry) UpdateChild 

func (t *TxEntry) UpdateChild(child *TxEntry, add bool)

func (*TxEntry) UpdateChildOfParents 

func (t *TxEntry) UpdateChildOfParents(add bool)

func (*TxEntry) UpdateDescendantState 

func (t *TxEntry) UpdateDescendantState(updateCount, updateSize int, updateFee int64)

func (*TxEntry) UpdateParent 

func (t *TxEntry) UpdateParent(parent *TxEntry, add bool)

UpdateParent update the tx's parent transaction.

type TxMempool 

type TxMempool struct {
	sync.RWMutex

	//transactionsUpdated mempool update transaction total number when create mempool late.
	TransactionsUpdated      uint64
	OrphanTransactionsByPrev map[outpoint.OutPoint]map[util.Hash]OrphanTx
	OrphanTransactions       map[util.Hash]OrphanTx
	RecentRejects            map[util.Hash]struct{}
	// contains filtered or unexported fields
}

TxMempool is safe for concurrent write And read access.

func GetInstance 

func GetInstance() *TxMempool

func NewTxMempool 

func NewTxMempool() *TxMempool

func (*TxMempool) AddOrphanTx 

func (m *TxMempool) AddOrphanTx(orphantx *tx.Tx, nodeID int64)

func (*TxMempool) AddTx 

func (m *TxMempool) AddTx(txEntry *TxEntry, ancestors map[*TxEntry]struct{}) error

AddTx operator is safe for concurrent write And read access. this function is used to add tx to the memPool, and now the tx should be passed all appropriate checks.

func (*TxMempool) CalculateDescendants 

func (m *TxMempool) CalculateDescendants(entry *TxEntry, descendants map[*TxEntry]struct{})

CalculateDescendants Calculates descendants of entry that are not already in setDescendants, and adds to setDescendants. Assumes entry it is already a tx in the mempool and setMemPoolChildren is correct for tx and all descendants. Also assumes that if an entry is in setDescendants already, then all in-mempool descendants of it are already in setDescendants as well, so that we can save time by not iterating over those entries.

func (*TxMempool) CalculateDescendantsWithLock 

func (m *TxMempool) CalculateDescendantsWithLock(txHash *util.Hash) map[*TxEntry]struct{}

func (*TxMempool) CalculateMemPoolAncestors 

func (m *TxMempool) CalculateMemPoolAncestors(tx *tx.Tx, limitAncestorCount uint64,
	limitAncestorSize uint64, limitDescendantCount uint64, limitDescendantSize uint64,
	searchForParent bool) (ancestors map[*TxEntry]struct{}, err error)

CalculateMemPoolAncestors get tx all ancestors transaction in mempool. when the find is false: the tx must in mempool, so directly get his parent.

func (*TxMempool) CalculateMemPoolAncestorsWithLock 

func (m *TxMempool) CalculateMemPoolAncestorsWithLock(txhash *util.Hash) map[*TxEntry]struct{}

func (*TxMempool) EraseOrphanTx 

func (m *TxMempool) EraseOrphanTx(txHash util.Hash, removeRedeemers bool)

func (*TxMempool) FindTx 

func (m *TxMempool) FindTx(hash util.Hash) *TxEntry

func (*TxMempool) GetAllSpentOutWithoutLock 

func (m *TxMempool) GetAllSpentOutWithoutLock() map[outpoint.OutPoint]*TxEntry

func (*TxMempool) GetAllTxEntry 

func (m *TxMempool) GetAllTxEntry() map[util.Hash]*TxEntry

func (*TxMempool) GetAllTxEntryWithoutLock 

func (m *TxMempool) GetAllTxEntryWithoutLock() map[util.Hash]*TxEntry

func (*TxMempool) GetCheckFrequency 

func (m *TxMempool) GetCheckFrequency() float64

func (*TxMempool) GetCoin 

func (m *TxMempool) GetCoin(outpoint *outpoint.OutPoint) *utxo.Coin

func (*TxMempool) GetMinFee 

func (m *TxMempool) GetMinFee(sizeLimit int64) util.FeeRate

func (*TxMempool) GetMinFeeRate 

func (m *TxMempool) GetMinFeeRate() util.FeeRate

func (*TxMempool) GetPoolAllTxSize 

func (m *TxMempool) GetPoolAllTxSize() uint64

func (*TxMempool) GetPoolUsage 

func (m *TxMempool) GetPoolUsage() int64

func (*TxMempool) GetRootTx 

func (m *TxMempool) GetRootTx() map[util.Hash]TxEntry

func (*TxMempool) HasSPentOutWithoutLock 

func (m *TxMempool) HasSPentOutWithoutLock(out *outpoint.OutPoint) *TxEntry

func (*TxMempool) HasSpentOut 

func (m *TxMempool) HasSpentOut(out *outpoint.OutPoint) bool

func (*TxMempool) LimitMempoolSize 

func (m *TxMempool) LimitMempoolSize() []*outpoint.OutPoint

LimitMempoolSize limit mempool size with time And limit size. when the noSpendsRemaining set, the function will return these have removed transaction's txin from mempool which use TrimToSize rule. Later, caller will remove these txin from uxto cache.

func (*TxMempool) LimitOrphanTx 

func (m *TxMempool) LimitOrphanTx() (removeNum int)

func (*TxMempool) RemoveOrphansByTag 

func (m *TxMempool) RemoveOrphansByTag(nodeID int64) int

func (*TxMempool) RemoveStaged 

func (m *TxMempool) RemoveStaged(entriesToRemove map[*TxEntry]struct{}, updateDescendants bool, reason PoolRemovalReason)

func (*TxMempool) RemoveTxRecursive 

func (m *TxMempool) RemoveTxRecursive(origTx *tx.Tx, reason PoolRemovalReason)

func (*TxMempool) RemoveTxSelf 

func (m *TxMempool) RemoveTxSelf(txs []*tx.Tx)

RemoveTxSelf will only remove these transaction self.

func (*TxMempool) Size 

func (m *TxMempool) Size() int

func (*TxMempool) TxInfoAll 

func (m *TxMempool) TxInfoAll() []*TxMempoolInfo

type TxMempoolInfo 

type TxMempoolInfo struct {
	Tx      *tx.Tx       // The transaction itself
	Time    int64        // Time the transaction entered the memPool
	FeeRate util.FeeRate // FeeRate of the transaction
}

func (*TxMempoolInfo) Serialize 

func (info *TxMempoolInfo) Serialize(w io.Writer) error

func (*TxMempoolInfo) Unserialize 

func (info *TxMempoolInfo) Unserialize(r io.Reader) error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.