txrules

Documentation

Overview

Package txrules provides transaction rules that should be followed by transaction authors for wide mempool acceptance and quick mining.

Index

• Constants
• Variables
• func CheckOutput(output *wire.TxOut, relayFeePerKb dcrutil.Amount) error
• func FeeForSerializeSize(relayFeePerKb dcrutil.Amount, txSerializeSize int) dcrutil.Amount
• func IsDustAmount(amount dcrutil.Amount, scriptSize int, relayFeePerKb dcrutil.Amount) bool
• func IsDustOutput(output *wire.TxOut, relayFeePerKb dcrutil.Amount) bool

Constants

const DefaultRelayFeePerKb dcrutil.Amount = 1e6

DefaultRelayFeePerKb is the default minimum relay fee policy for a mempool.

Variables

var (
	ErrAmountNegative   = errors.New("transaction output amount is negative")
	ErrAmountExceedsMax = errors.New("transaction output amount exceeds maximum value")
	ErrOutputIsDust     = errors.New("transaction output is dust")
)

Transaction rule violations

Functions

func CheckOutput

func CheckOutput(output *wire.TxOut, relayFeePerKb dcrutil.Amount) error

CheckOutput performs simple consensus and policy tests on a transaction output.

func FeeForSerializeSize

func FeeForSerializeSize(relayFeePerKb dcrutil.Amount, txSerializeSize int) dcrutil.Amount

FeeForSerializeSize calculates the required fee for a transaction of some arbitrary size given a mempool's relay fee policy.

func IsDustAmount

func IsDustAmount(amount dcrutil.Amount, scriptSize int, relayFeePerKb dcrutil.Amount) bool

IsDustAmount determines whether a transaction output value and script length would cause the output to be considered dust. Transactions with dust outputs are not standard and are rejected by mempools with default policies.

func IsDustOutput

func IsDustOutput(output *wire.TxOut, relayFeePerKb dcrutil.Amount) bool

IsDustOutput determines whether a transaction output is considered dust. Transactions with dust outputs are not standard and are rejected by mempools with default policies.