txhelpers

package
v8.0.1 Latest Latest
Warning

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

 Go to latest Published: Jun 27, 2022 License: ISC Imports: 26 Imported by: 0

Documentation

Overview

Package txhelpers contains helper functions for working with transactions and blocks (e.g. checking for a transaction in a block).

Index

Constants

View Source 
const (
	AddressTypeP2PK = iota
	AddressTypeP2PKH
	AddressTypeP2SH
	AddressTypeOther
	AddressTypeUnknown
)

These are the AddressType values, as returned by AddressValidation.

View Source 
const (

	// DefaultStakeDbName is the default database name
	DefaultStakeDbName = "ffldb_stake"
)

Variables

View Source 
var CoinbaseFlags = "/dcrd/"
View Source 
var CoinbaseScript = append([]byte{0x00, 0x00}, []byte(CoinbaseFlags)...)

Functions

func AddressValidation 

func AddressValidation(address string, params *chaincfg.Params) (dcrutil.Address, AddressType, AddressError)

AddressValidation performs several validation checks on the given address string. Initially, decoding as a Decred address is attempted. If it fails to decode, AddressErrorDecodeFailed is returned with AddressTypeUnknown. If the address decoded successfully as a Decred address, it is checked against the specified network. If it is the wrong network, AddressErrorWrongNet is returned with AddressTypeUnknown. If the address is the correct network, the address type is obtained. A final check is performed to determine if the address is the zero pubkey hash address, in which case AddressErrorZeroAddress is returned with the determined address type. If it is another address, AddressErrorNoError is returned with the determined address type.

func BlockConsumesOutpointWithAddresses 

func BlockConsumesOutpointWithAddresses(block *dcrutil.Block, addrs map[string]TxAction,
	c RawTransactionGetter, params *chaincfg.Params) map[string][]*dcrutil.Tx

BlockConsumesOutpointWithAddresses checks the specified block to see if it includes transactions that spend from outputs created using any of the addresses in addrs. The TxAction for each address is not important, but it would logically be TxMined. Both regular and stake transactions are checked. The RPC client is used to get the PreviousOutPoint for each TxIn of each transaction in the block, from which the address is obtained from the PkScript of that output. chaincfg Params is required to decode the script.

func BlockReceivesToAddresses 

func BlockReceivesToAddresses(block *dcrutil.Block, addrs map[string]TxAction,
	params *chaincfg.Params) map[string][]*dcrutil.Tx

BlockReceivesToAddresses checks a block for transactions paying to the specified addresses, and creates a map of addresses to a slice of dcrutil.Tx involving the address.

func BuildStakeTree 

func BuildStakeTree(blocks map[int64]*dcrutil.Block, netParams *chaincfg.Params,
	nodeClient *rpcclient.Client, poolRequiredHeight int64, DBName ...string) (database.DB, []int64, error)

BuildStakeTree returns a database with a stake tree

func CalcMeanVotingBlocks 

func CalcMeanVotingBlocks(params *chaincfg.Params) int64

CalcMeanVotingBlocks computes the average number of blocks a ticket will be live before voting. The expected block (aka mean) of the probability distribution is given by: 

sum(B * P(B)), B=1 to 40960

Where B is the block number and P(B) is the probability of voting at block B. For more information see: https://github.com/Decred-Next/dcrndata/v8/issues/471#issuecomment-390063025

func DetermineTxTypeString 

func DetermineTxTypeString(msgTx *wire.MsgTx) string

DetermineTxTypeString returns a string representing the transaction type given a wire.MsgTx struct

func FeeInfoBlock 

func FeeInfoBlock(block *dcrutil.Block) *chainjson.FeeInfoBlock

FeeInfoBlock computes ticket fee statistics for the tickets included in the specified block.

func FeeRate 

func FeeRate(amtIn, amtOut, sizeBytes int64) int64

FeeRate computes the fee rate in atoms/kB for a transaction provided the total amount of the transaction's inputs, the total amount of the transaction's outputs, and the size of the transaction in bytes. Note that a kB refers to 1000 bytes, not a kiB. If the size is 0, the returned fee is -1.

func FeeRateInfoBlock 

func FeeRateInfoBlock(block *dcrutil.Block) *chainjson.FeeInfoBlock

FeeRateInfoBlock computes ticket fee rate statistics for the tickets included in the specified block.

func FilterHashSlice 

func FilterHashSlice(s []chainhash.Hash, doRemove func(h chainhash.Hash) bool) []chainhash.Hash

FilterHashSlice removes elements from the specified if the doRemove function evaluates to true for a given element. For example, given a slice of hashes called blackList that should be removed from the slice hashList: 

hashList = FilterHashSlice(hashList, func(h chainhash.Hash) bool {
 return HashInSlice(h, blackList)
})

func GenesisTxHash 

func GenesisTxHash(params *chaincfg.Params) chainhash.Hash

GenesisTxHash returns the hash of the single coinbase transaction in the genesis block of the specified network. This transaction is hard coded, and the pubkey script for its one output only decodes for simnet.

func GetDifficultyRatio 

func GetDifficultyRatio(bits uint32, params *chaincfg.Params) float64

GetDifficultyRatio returns the proof-of-work difficulty as a multiple of the minimum difficulty using the passed bits field from the header of a block.

func HashInSlice 

func HashInSlice(h chainhash.Hash, list []chainhash.Hash) bool

HashInSlice determines if a hash exists in a slice of hashes.

func IncludesStakeTx 

func IncludesStakeTx(txHash *chainhash.Hash, block *dcrutil.Block) (int, int8)

IncludesStakeTx checks if a block contains a stake transaction hash

func IncludesTx 

func IncludesTx(txHash *chainhash.Hash, block *dcrutil.Block) (int, int8)

IncludesTx checks if a block contains a transaction hash

func IsMixTx 

func IsMixTx(tx *wire.MsgTx) (isMix bool, mixDenom int64, mixCount uint32)

IsMixTx tests if a transaction is a CSPP-mixed transaction, which must have 3 or more outputs of the same amount, which is one of the pre-defined mix denominations. mixDenom is the largest of such denominations. mixCount is the number of outputs of this denomination.

func IsMixedSplitTx 

func IsMixedSplitTx(tx *wire.MsgTx, relayFeeRate, ticketPrice int64) (isMix bool, ticketOutAmt int64, numTickets uint32)

IsMixedSplitTx tests if a transaction is a CSPP-mixed ticket split transaction (the transaction that creates appropriately-sized outputs to be spent by a ticket purchase). Such a transaction must have 3 or more outputs with an amount equal to the ticket price plus transaction fees, and at least as many other outputs. The expected fees to be included in the amount are based on the provided fee rate, relayFeeRate, and an assumed serialized size of a solo ticket transaction with one P2PKH input, two P2PKH outputs and one ticket commitment output.

func IsStakeTx 

func IsStakeTx(msgTx *wire.MsgTx) bool

IsStakeTx indicates if the input MsgTx is a stake transaction.

func IsZeroHash 

func IsZeroHash(hash chainhash.Hash) bool

IsZeroHash checks if the Hash is the zero hash.

func IsZeroHashP2PHKAddress 

func IsZeroHashP2PHKAddress(checkAddressString string, params *chaincfg.Params) bool

IsZeroHashP2PHKAddress checks if the given address is the dummy (zero pubkey hash) address. See https://github.com/Decred-Next/dcrndata/v8/issues/358 for details.

func IsZeroHashStr 

func IsZeroHashStr(hash string) bool

IsZeroHashStr checks if the string is the zero hash string.

func MedianAmount 

func MedianAmount(s []dcrutil.Amount) dcrutil.Amount

MedianAmount gets the median Amount from a slice of Amounts

func MedianCoin 

func MedianCoin(s []float64) float64

MedianCoin gets the median DCR from a slice of float64s

func MsgTxFromHex 

func MsgTxFromHex(txhex string) (*wire.MsgTx, error)

MsgTxFromHex returns a wire.MsgTx struct built from the transaction hex string.

func MsgTxToHex 

func MsgTxToHex(msgTx *wire.MsgTx) (string, error)

MsgTxToHex returns a transaction hex string from a wire.MsgTx struct.

func OutPointAddresses 

func OutPointAddresses(outPoint *wire.OutPoint, c RawTransactionGetter,
	params *chaincfg.Params) ([]string, dcrutil.Amount, error)

OutPointAddresses gets the addresses paid to by a transaction output.

func OutPointAddressesFromString 

func OutPointAddressesFromString(txid string, index uint32, tree int8,
	c RawTransactionGetter, params *chaincfg.Params) ([]string, dcrutil.Amount, error)

OutPointAddressesFromString is the same as OutPointAddresses, but it takes the outpoint as the tx string, vout index, and tree.

func RevokedTicketsInBlock 

func RevokedTicketsInBlock(bl *dcrutil.Block) []chainhash.Hash

RevokedTicketsInBlock finds all the revoked tickets in the block.

func RewardsAtBlock 

func RewardsAtBlock(blockIdx int64, votes uint16, p *chaincfg.Params) (work, stake, tax int64)

RewardsAtBlock computes the PoW, PoS (per vote), and project fund subsidies at for the specified block index, assuming a certain number of votes.

func SSGenVoteBits 

func SSGenVoteBits(tx *wire.MsgTx) (uint16, error)

SSGenVoteBits returns the VoteBits of txOut[1] of a ssgen tx

func SSGenVoteChoices 

func SSGenVoteChoices(tx *wire.MsgTx, params *chaincfg.Params) (BlockValidation, uint32, uint16, []*VoteChoice, error)

SSGenVoteChoices gets a ssgen's vote choices (block validity and any agendas). The vote's stake version, to which the vote choices correspond, and vote bits are also returned. Note that []*VoteChoice may be an empty slice if there are no consensus deployments for the transaction's vote version. The error value may be non-nil if the tx is not a valid ssgen.

func SSTXInBlock 

func SSTXInBlock(block *dcrutil.Block) []*dcrutil.Tx

SSTXInBlock gets a slice containing all of the SSTX mined in a block

func TicketTxnsInBlock 

func TicketTxnsInBlock(bl *dcrutil.Block) ([]chainhash.Hash, []*dcrutil.Tx)

TicketTxnsInBlock finds all the new tickets in the block.

func TicketsInBlock 

func TicketsInBlock(bl *dcrutil.Block) ([]chainhash.Hash, []*wire.MsgTx)

TicketsInBlock finds all the new tickets in the block.

func TicketsSpentInBlock 

func TicketsSpentInBlock(bl *dcrutil.Block) []chainhash.Hash

TicketsSpentInBlock finds all the tickets spent in the block.

func TotalOutFromMsgTx 

func TotalOutFromMsgTx(msgTx *wire.MsgTx) dcrutil.Amount

TotalOutFromMsgTx computes the total value out of a MsgTx

func TotalVout 

func TotalVout(vouts []chainjson.Vout) dcrutil.Amount

TotalVout computes the total value of a slice of chainjson.Vout

func TxConsumesOutpointWithAddress 

func TxConsumesOutpointWithAddress(msgTx *wire.MsgTx, addr string,
	c VerboseTransactionGetter, params *chaincfg.Params) (prevOuts []PrevOut, prevTxs []*TxWithBlockData)

TxConsumesOutpointWithAddress checks a transaction for inputs that spend an outpoint paying to the given address. Returned are the identified input indexes and the corresponding previous outpoints determined.

func TxFee 

func TxFee(msgTx *wire.MsgTx) dcrutil.Amount

TxFee computes and returns the fee for a given tx

func TxFeeRate 

func TxFeeRate(msgTx *wire.MsgTx) (dcrutil.Amount, dcrutil.Amount)

TxFeeRate computes and returns the total fee in atoms and fee rate in atoms/kB for a given tx.

func TxInvolvesAddress 

func TxInvolvesAddress(msgTx *wire.MsgTx, addr string, c VerboseTransactionGetter,
	params *chaincfg.Params) (outpoints []*wire.OutPoint,
	prevOuts []PrevOut, prevTxs []*TxWithBlockData)

TxInvolvesAddress checks the inputs and outputs of a transaction for involvement of the given address.

func TxIsRegular 

func TxIsRegular(txType int) bool

TxIsRegular indicates if the transaction type is a regular (non-stake) transaction.

func TxIsRevoke 

func TxIsRevoke(txType int) bool

TxIsRevoke indicates if the transaction type is a revocation (ssrtx).

func TxIsTicket 

func TxIsTicket(txType int) bool

TxIsTicket indicates if the transaction type is a ticket (sstx).

func TxIsVote 

func TxIsVote(txType int) bool

TxIsVote indicates if the transaction type is a vote (ssgen).

func TxOutpointsByAddr 

func TxOutpointsByAddr(txAddrOuts MempoolAddressStore, msgTx *wire.MsgTx, params *chaincfg.Params) (newOuts int, addrs map[string]bool)

TxOutpointsByAddr sets the Outpoints field for the AddressOutpoints stored in the input MempoolAddressStore. For addresses not yet present in the MempoolAddressStore, a new AddressOutpoints is added to the store. The provided MempoolAddressStore must be initialized. The number of msgTx outputs that pay to any address are counted and returned. The addresses paid to by the transaction are listed in the output addrs map, where the value of the stored bool indicates the address is new to the MempoolAddressStore.

func TxPaysToAddress 

func TxPaysToAddress(msgTx *wire.MsgTx, addr string,
	params *chaincfg.Params) (outpoints []*wire.OutPoint)

TxPaysToAddress returns a slice of outpoints of a transaction which pay to specified address.

func TxPrevOutsByAddr 

func TxPrevOutsByAddr(txAddrOuts MempoolAddressStore, txnsStore TxnsStore, msgTx *wire.MsgTx, c VerboseTransactionGetter, params *chaincfg.Params) (newPrevOuts int, addrs map[string]bool, valsIn []int64)

TxPrevOutsByAddr sets the PrevOuts field for the AddressOutpoints stored in the MempoolAddressStore. For addresses not yet present in the MempoolAddressStore, a new AddressOutpoints is added to the store. The provided MempoolAddressStore must be initialized. A VerboseTransactionGetter is required to retrieve the pkScripts for the previous outpoints. The number of consumed previous outpoints that paid addresses in the provided transaction are counted and returned. The addresses in the previous outpoints are listed in the output addrs map, where the value of the stored bool indicates the address is new to the MempoolAddressStore.

func TxTree 

func TxTree(msgTx *wire.MsgTx) int8

TxTree returns for a wire.MsgTx either wire.TxTreeStake or wire.TxTreeRegular depending on the type of transaction.

func TxTypeToString 

func TxTypeToString(txType int) string

TxTypeToString returns a string representation of the provided transaction type, which corresponds to the txn types defined for stake.TxType type.

func TxhashInSlice 

func TxhashInSlice(txs []*dcrutil.Tx, txHash *chainhash.Hash) *dcrutil.Tx

TxhashInSlice searches a slice of *dcrutil.Tx for a transaction with the hash txHash. If found, it returns the corresponding *Tx, otherwise nil.

func UltimateSubsidy 

func UltimateSubsidy(params *chaincfg.Params) int64

UltimateSubsidy computes the total subsidy over the entire subsidy distribution period of the network.

func VoteBitsInBlock 

func VoteBitsInBlock(block *dcrutil.Block) []stake.VoteVersionTuple

VoteBitsInBlock returns a list of vote bits for the votes in a block

func VoteVersion 

func VoteVersion(pkScript []byte) uint32

VoteVersion extracts the vote version from the input pubkey script.

func VotesInBlock 

func VotesInBlock(bl *dcrutil.Block) []chainhash.Hash

VotesInBlock finds all the votes in the block.

Types

type AddressError 

type AddressError error

AddressError is the type of error returned by AddressValidation. 

var (
	AddressErrorNoError      AddressError
	AddressErrorZeroAddress  AddressError = errors.New("null address")
	AddressErrorWrongNet     AddressError = errors.New("wrong network")
	AddressErrorDecodeFailed AddressError = errors.New("decoding failed")
	AddressErrorUnknown      AddressError = errors.New("unknown error")
	AddressErrorUnsupported  AddressError = errors.New("recognized, but unsupported address type")
)

type AddressOutpoints 

type AddressOutpoints struct {
	Address   string
	Outpoints []*wire.OutPoint
	PrevOuts  []PrevOut
	TxnsStore map[chainhash.Hash]*TxWithBlockData
}

AddressOutpoints collects spendable and spent transactions outpoints paying to a certain address. The transactions referenced by the outpoints are stored for quick access.

func NewAddressOutpoints 

func NewAddressOutpoints(address string) *AddressOutpoints

NewAddressOutpoints creates a new AddressOutpoints, initializing the transaction store/cache, and setting the address string.

func (*AddressOutpoints) Merge 

func (a *AddressOutpoints) Merge(ao *AddressOutpoints)

Merge concatenates the outpoints of two AddressOutpoints, and merges the transactions.

func (*AddressOutpoints) Update 

func (a *AddressOutpoints) Update(txns []*TxWithBlockData,
	outpoints []*wire.OutPoint, prevOutpoint []PrevOut)

Update appends the provided outpoints, and merges the transactions.

type AddressType 

type AddressType int

AddressType is used to label type of an address as returned by base58.CheckDecode.

type BlockValidation 

type BlockValidation struct {
	// Hash is the hash of the block being targeted (in)validated
	Hash chainhash.Hash

	// Height is the height of the block
	Height int64

	// Validity indicates the vote is to validate (true) or invalidate (false)
	// the block.
	Validity bool
}

BlockValidation models the block validation indicated by an ssgen (vote) transaction.

func SSGenVoteBlockValid 

func SSGenVoteBlockValid(msgTx *wire.MsgTx) (BlockValidation, uint16, error)

SSGenVoteBlockValid determines if a vote transaction is voting yes or no to a block, and returns the votebits in case the caller wants to check agenda votes. The error return may be ignored if the input transaction is known to be a valid ssgen (vote), otherwise it should be checked.

type MempoolAddressStore 

type MempoolAddressStore map[string]*AddressOutpoints

MempoolAddressStore organizes AddressOutpoints by address.

type PrevOut 

type PrevOut struct {
	TxSpending       chainhash.Hash
	InputIndex       int
	PreviousOutpoint *wire.OutPoint
}

PrevOut contains a transaction input's previous outpoint, the Hash of the spending (following) transaction, and input index in the transaction.

type RawTransactionGetter 

type RawTransactionGetter interface {
	GetRawTransaction(txHash *chainhash.Hash) (*dcrutil.Tx, error)
}

RawTransactionGetter is an interface satisfied by rpcclient.Client, and required by functions that would otherwise require a rpcclient.Client just for GetRawTransaction.

type ReorgData 

type ReorgData struct {
	CommonAncestor chainhash.Hash
	OldChainHead   chainhash.Hash
	OldChainHeight int32
	OldChain       []chainhash.Hash
	NewChainHead   chainhash.Hash
	NewChainHeight int32
	NewChain       []chainhash.Hash
	WG             *sync.WaitGroup
}

ReorgData contains details of a chain reorganization, including the full old and new chains, and the common ancestor that should not be included in either chain. Below is the description of the reorg data with the letter indicating the various blocks in the chain: 

			A  -> B  -> C
  			\  -> B' -> C' -> D'

CommonAncestor - Hash of A OldChainHead - Hash of C OldChainHeight - Height of C OldChain - Chain from B to C NewChainHead - Hash of D' NewChainHeight - Height of D' NewChain - Chain from B' to D'

type TxAction 

type TxAction int32

TxAction is what is happening to the transaction (mined or inserted into mempool). 

const (
	TxMined TxAction = 1 << iota
	TxInserted
)

Valid values for TxAction

type TxWithBlockData 

type TxWithBlockData struct {
	Tx          *wire.MsgTx
	BlockHeight int64
	BlockHash   string
	MemPoolTime int64
}

TxWithBlockData contains a MsgTx and the block hash and height in which it was mined and Time it entered MemPool.

func (*TxWithBlockData) Confirmed 

func (t *TxWithBlockData) Confirmed() bool

Confirmed indicates if the transaction is confirmed (mined).

func (*TxWithBlockData) Hash 

func (t *TxWithBlockData) Hash() chainhash.Hash

Hash returns the chainhash.Hash of the transaction.

type TxnsStore 

type TxnsStore map[chainhash.Hash]*TxWithBlockData

TxnsStore allows quick lookup of a TxWithBlockData by transaction Hash.

type VerboseTransactionGetter 

type VerboseTransactionGetter interface {
	GetRawTransactionVerbose(txHash *chainhash.Hash) (*chainjson.TxRawResult, error)
	GetRawTransactionVerboseAsync(txHash *chainhash.Hash) rpcclient.FutureGetRawTransactionVerboseResult
}

VerboseTransactionGetter is an interface satisfied by rpcclient.Client, and required by functions that would otherwise require a rpcclient.Client just for GetRawTransactionVerbose.

type VoteChoice 

type VoteChoice struct {
	// Single unique word identifying the vote.
	ID string `json:"id"`

	// Longer description of what the vote is about.
	Description string `json:"description"`

	// Usable bits for this vote.
	Mask uint16 `json:"mask"`

	// VoteVersion and VoteIndex specify which vote item is referenced by this
	// VoteChoice (i.e. chaincfg.Params.Deployments[VoteVersion][VoteIndex]).
	VoteVersion uint32 `json:"vote_version"`
	VoteIndex   int    `json:"vote_index"`

	// ChoiceIdx indicates the corresponding element in the vote item's []Choice
	ChoiceIdx int `json:"choice_index"`

	// Choice is the selected choice for the specified vote item
	Choice *chaincfg.Choice `json:"choice"`
}

VoteChoice represents the choice made by a vote transaction on a single vote item in an agenda. The ID, Description, and Mask fields describe the vote item for which the choice is being made. Those are the initial fields in chaincfg.Params.Deployments[VoteVersion][VoteIndex].

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.