btcd/mempool/README.md

mempool
=======

[![Build Status](http://img.shields.io/travis/btcsuite/btcd.svg)]
(https://travis-ci.org/btcsuite/btcd) [![ISC License]
(http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)]
(http://godoc.org/github.com/btcsuite/btcd/mempool)

## Overview

This package is currently a work in progress.

## Installation and Updating

```bash
$ go get -u github.com/btcsuite/btcd/mempool
```

## License

Package mempool is licensed under the [copyfree](http://copyfree.org) ISC
License.
mempool: Refactor mempool code to its own package. (#737) This does the minimum work necessary to refactor the mempool code into its own package. The idea is that separating this code into its own package will greatly improve its testability, allow independent benchmarking and profiling, and open up some interesting opportunities for future development related to the memory pool. There are likely some areas related to policy that could be further refactored, however it is better to do that in future commits in order to keep the changeset as small as possible during this refactor. Overview of the major changes: - Create the new package - Move several files into the new package: - mempool.go -> mempool/mempool.go - mempoolerror.go -> mempool/error.go - policy.go -> mempool/policy.go - policy_test.go -> mempool/policy_test.go - Update mempool logging to use the new mempool package logger - Rename mempoolPolicy to Policy (so it's now mempool.Policy) - Rename mempoolConfig to Config (so it's now mempool.Config) - Rename mempoolTxDesc to TxDesc (so it's now mempool.TxDesc) - Rename txMemPool to TxPool (so it's now mempool.TxPool) - Move defaultBlockPrioritySize to the new package and export it - Export DefaultMinRelayTxFee from the mempool package - Export the CalcPriority function from the mempool package - Introduce a new RawMempoolVerbose function on the TxPool and update the RPC server to use it - Update all references to the mempool to use the package. - Add a skeleton README.md 2016-08-19 11:08:37 -05:00			`mempool`
			`=======`

			`[![Build Status](http://img.shields.io/travis/btcsuite/btcd.svg)]`
			`(https://travis-ci.org/btcsuite/btcd) [![ISC License]`
			`(http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)`
			`[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)]`
			`(http://godoc.org/github.com/btcsuite/btcd/mempool)`

			`## Overview`

			`This package is currently a work in progress.`

			`## Installation and Updating`

			```bash
			`$ go get -u github.com/btcsuite/btcd/mempool`
			```

			`## License`

			`Package mempool is licensed under the [copyfree](http://copyfree.org) ISC`
			`License.`