fac8a9a582
The github markdown interpreter has been changed such that it no longer allows spaces in between the brackets and parenthesis of links. This updates all of the markdown files accordingly. While here, it also corrects a couple of inconsistencies in regards to other README.md files in the project.
31 lines
1.2 KiB
Markdown
31 lines
1.2 KiB
Markdown
txsort
|
|
======
|
|
|
|
[![Build Status](http://img.shields.io/travis/btcsuite/btcutil.svg)](https://travis-ci.org/btcsuite/btcutil)
|
|
[![ISC License](http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
|
|
[![GoDoc](http://img.shields.io/badge/godoc-reference-blue.svg)](http://godoc.org/github.com/btcsuite/btcutil/txsort)
|
|
|
|
Package txsort provides the transaction sorting according to [BIP 69](https://github.com/bitcoin/bips/blob/master/bip-0069.mediawiki).
|
|
|
|
BIP 69 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
|
|
|
|
```bash
|
|
$ go get -u github.com/btcsuite/btcutil/txsort
|
|
```
|
|
|
|
## License
|
|
|
|
Package txsort is licensed under the [copyfree](http://copyfree.org) ISC
|
|
License.
|