lbcutil/txsort/README.md

txsort
======

[![ISC License](http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)

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.
txsort: Convert to package This converts the txsort code into a separate package and renames 'TxSort' and 'IsTxSorted' to 'Sort' an `IsSorted`, respectively. It also adds a 'doc.go' and 'README.md' so it is consistent with the other packages. 2015-10-23 11:09:09 +02:00			`txsort`
			`======`

multi: Update markdown files for GFM changes. 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. 2017-05-25 19:56:27 +02:00			`[![ISC License](http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)`
txsort: Convert to package This converts the txsort code into a separate package and renames 'TxSort' and 'IsTxSorted' to 'Sort' an `IsSorted`, respectively. It also adds a 'doc.go' and 'README.md' so it is consistent with the other packages. 2015-10-23 11:09:09 +02:00
txsort: Update package for BIP0069 acceptance. BIPLI01 has been accepted as BIP0069, so update the README, comments, tests, and testdata files as such. 2016-03-22 02:22:08 +01:00			`Package txsort provides the transaction sorting according to [BIP 69](https://github.com/bitcoin/bips/blob/master/bip-0069.mediawiki).`
txsort: Convert to package This converts the txsort code into a separate package and renames 'TxSort' and 'IsTxSorted' to 'Sort' an `IsSorted`, respectively. It also adds a 'doc.go' and 'README.md' so it is consistent with the other packages. 2015-10-23 11:09:09 +02:00
txsort: Update package for BIP0069 acceptance. BIPLI01 has been accepted as BIP0069, so update the README, comments, tests, and testdata files as such. 2016-03-22 02:22:08 +01:00			`BIP 69 defines a standard lexicographical sort order of transaction inputs and`
txsort: Convert to package This converts the txsort code into a separate package and renames 'TxSort' and 'IsTxSorted' to 'Sort' an `IsSorted`, respectively. It also adds a 'doc.go' and 'README.md' so it is consistent with the other packages. 2015-10-23 11:09:09 +02:00			`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.`

[lbry] renamed package to lbcutil, updated refs to it 2021-09-10 22:30:39 +02:00			`A comprehensive suite of tests is provided to ensure proper functionality.`