txsort

README

txsort

[] (https://travis-ci.org/btcsuite/btcutil) ![ISC License] (http://img.shields.io/badge/license-ISC-blue.svg) [] (http://godoc.org/github.com/btcsuite/btcutil/txsort)

Package txsort provides the transaction sorting according to BIPLI01.

BIPLI01 defines a standard lexicographical sort order of transaction inputs and outputs. This is useful to standardize transactions for faster multi-party agreement as well as preventing information leaks in a single-party use case.

The BIP goes into more detail, but for a quick and simplistic overview, the order for inputs is defined as first sorting on the previous output hash and then on the index as a tie breaker. The order for outputs is defined as first sorting on the amount and then on the raw public key script bytes as a tie breaker.

A comprehensive suite of tests is provided to ensure proper functionality.

Installation and Updating

$ go get -u github.com/btcsuite/btcutil/txsort

License

Package txsort is licensed under the copyfree ISC License.

Documentation

Overview

Package txsort provides the transaction sorting according to BIPLI01.

Overview

BIPLI01 defines a standard lexicographical sort order of transaction inputs and outputs. This is useful to standardize transactions for faster multi-party agreement as well as preventing information leaks in a single-party use case.

The BIP goes into more detail, but for a quick and simplistic overview, the order for inputs is defined as first sorting on the previous output hash and then on the index as a tie breaker. The order for outputs is defined as first sorting on the amount and then on the raw public key script bytes as a tie breaker.

Index

• func InPlaceSort(tx *wire.MsgTx)
• func IsSorted(tx *wire.MsgTx) bool
• func Sort(tx *wire.MsgTx) *wire.MsgTx

Functions

func InPlaceSort

func InPlaceSort(tx *wire.MsgTx)

InPlaceSort modifies the passed transaction inputs and outputs to be sorted based on BIP LI01.

WARNING: This function must NOT be called with published transactions since it will mutate the transaction if it's not already sorted. This can cause issues if you mutate a tx in a block, for example, which would invalidate the block. It could also cause cached hashes, such as in a btcutil.Tx to become invalidated.

The function should only be used if the caller is creating the transaction or is otherwise 100% positive mutating will not cause adverse affects due to other dependencies.

func IsSorted

func IsSorted(tx *wire.MsgTx) bool

IsSorted checks whether tx has inputs and outputs sorted according to BIP LI01.

func Sort

func Sort(tx *wire.MsgTx) *wire.MsgTx

Sort returns a new transaction with the inputs and outputs sorted based on BIP LI01. The passed transaction is not modified and the new transaction might have a different hash if any sorting was done.