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 btcutil.Amount) error
• func FeeForSerializeSize(relayFeePerKb btcutil.Amount, txSerializeSize int) btcutil.Amount
• func IsDustOutput(output *wire.TxOut, relayFeePerKb btcutil.Amount) bool

Constants

const DefaultRelayFeePerKb btcutil.Amount = 1e3

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 btcutil.Amount) error

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

func FeeForSerializeSize

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

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

func IsDustOutput

func IsDustOutput(output *wire.TxOut, relayFeePerKb btcutil.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.