github.com/fozzysec/SiaPrime@v0.0.0-20190612043147-66c8e8d11fe3/modules/transactionpool/database.go

package transactionpool

import (
	"encoding/json"

	"SiaPrime/build"
	"SiaPrime/encoding"
	"SiaPrime/modules"
	"SiaPrime/types"

	"gitlab.com/NebulousLabs/bolt"
	"gitlab.com/NebulousLabs/errors"
)

// database.go contains objects related to the layout of the transaction pool's
// database, as well as getters and setters. Logic for interacting with the
// database can be found in persist.go

// Buckets in the database.
var (
	// bucketBlockHeight holds the most recent block height seen by the
	// transaction pool.
	bucketBlockHeight = []byte("BlockHeight")

	// bucketConfirmedTransactions holds the ids of every transaction that has
	// been confirmed on the blockchain.
	bucketConfirmedTransactions = []byte("ConfirmedTransactions")

	// bucketFeeMedian stores all of the persist data relating to the fee
	// median.
	bucketFeeMedian = []byte("FeeMedian")

	// bucketRecentConsensusChange holds the most recent consensus change seen
	// by the transaction pool.
	bucketRecentConsensusChange = []byte("RecentConsensusChange")
)

// Explicitly named fields in the database.
var (
	// fieldBlockHeight is the field in bucketBlockHeight that holds the value of
	// the most recent block height.
	fieldBlockHeight = []byte("BlockHeight")

	// fieldFeeMedian is the fee median persist data stored in a fee median
	// field.
	fieldFeeMedian = []byte("FeeMedian")

	// fieldRecentBlockID is used to store the id of the most recent block seen
	// by the transaction pool.
	fieldRecentBlockID = []byte("RecentBlockID")

	// fieldRecentConsensusChange is the field in bucketRecentConsensusChange
	// that holds the value of the most recent consensus change.
	fieldRecentConsensusChange = []byte("RecentConsensusChange")
)

// Errors relating to the database.
var (
	// errNilConsensusChange is returned if there is no consensus change in the
	// database.
	errNilConsensusChange = errors.New("no consensus change found")

	// errNilFeeMedian is the message returned if a database does not find fee
	// median persistence.
	errNilFeeMedian = errors.New("no fee median found")

	// errNilRecentBlock is returned if there is no data stored in
	// fieldRecentBlockID.
	errNilRecentBlock = errors.New("no recent block found in the database")
)

// Complex objects that get stored in database fields.
type (
	// medianPersist is the json object that gets stored in the database so that
	// the transaction pool can persist its block based fee estimations.
	medianPersist struct {
		RecentMedians   []types.Currency
		RecentMedianFee types.Currency
	}
)

// deleteTransaction deletes a transaction from the list of confirmed
// transactions.
func (tp *TransactionPool) deleteTransaction(tx *bolt.Tx, id types.TransactionID) error {
	return tx.Bucket(bucketConfirmedTransactions).Delete(id[:])
}

// getBlockHeight returns the most recent block height from the database.
func (tp *TransactionPool) getBlockHeight(tx *bolt.Tx) (bh types.BlockHeight, err error) {
	err = encoding.Unmarshal(tx.Bucket(bucketBlockHeight).Get(fieldBlockHeight), &bh)
	return
}

// getFeeMedian will get the fee median struct stored in the database.
func (tp *TransactionPool) getFeeMedian(tx *bolt.Tx) (medianPersist, error) {
	medianBytes := tp.dbTx.Bucket(bucketFeeMedian).Get(fieldFeeMedian)
	if medianBytes == nil {
		return medianPersist{}, errNilFeeMedian
	}

	var mp medianPersist
	err := json.Unmarshal(medianBytes, &mp)
	if err != nil {
		return medianPersist{}, build.ExtendErr("unable to unmarshal median data:", err)
	}
	return mp, nil
}

// getRecentBlockID will fetch the most recent block id and most recent parent
// id from the database.
func (tp *TransactionPool) getRecentBlockID(tx *bolt.Tx) (recentID types.BlockID, err error) {
	idBytes := tx.Bucket(bucketRecentConsensusChange).Get(fieldRecentBlockID)
	if idBytes == nil {
		return types.BlockID{}, errNilRecentBlock
	}
	copy(recentID[:], idBytes[:])
	if recentID == (types.BlockID{}) {
		return types.BlockID{}, errNilRecentBlock
	}
	return recentID, nil
}

// getRecentConsensusChange returns the most recent consensus change from the
// database.
func (tp *TransactionPool) getRecentConsensusChange(tx *bolt.Tx) (cc modules.ConsensusChangeID, err error) {
	ccBytes := tx.Bucket(bucketRecentConsensusChange).Get(fieldRecentConsensusChange)
	if ccBytes == nil {
		return modules.ConsensusChangeID{}, errNilConsensusChange
	}
	copy(cc[:], ccBytes)
	return cc, nil
}

// putBlockHeight updates the transaction pool's block height.
func (tp *TransactionPool) putBlockHeight(tx *bolt.Tx, height types.BlockHeight) error {
	tp.blockHeight = height
	return tx.Bucket(bucketBlockHeight).Put(fieldBlockHeight, encoding.Marshal(height))
}

// putFeeMedian puts a median fees object into the database.
func (tp *TransactionPool) putFeeMedian(tx *bolt.Tx, mp medianPersist) error {
	objBytes, err := json.Marshal(mp)
	if err != nil {
		return err
	}
	return tx.Bucket(bucketFeeMedian).Put(fieldFeeMedian, objBytes)
}

// putRecentBlockID will store the most recent block id and the parent id of
// that block in the database.
func (tp *TransactionPool) putRecentBlockID(tx *bolt.Tx, recentID types.BlockID) error {
	return tx.Bucket(bucketRecentConsensusChange).Put(fieldRecentBlockID, recentID[:])
}

// putRecentConsensusChange updates the most recent consensus change seen by
// the transaction pool.
func (tp *TransactionPool) putRecentConsensusChange(tx *bolt.Tx, cc modules.ConsensusChangeID) error {
	return tx.Bucket(bucketRecentConsensusChange).Put(fieldRecentConsensusChange, cc[:])
}

// putTransaction adds a transaction to the list of confirmed transactions.
func (tp *TransactionPool) putTransaction(tx *bolt.Tx, id types.TransactionID) error {
	return tx.Bucket(bucketConfirmedTransactions).Put(id[:], []byte{})
}