LBRYCommunity/lbcutil
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

whitespace

Browse source
This commit is contained in:
David Hill 2014-03-24 22:04:02 -04:00
parent 2db41b1f56
commit fca025945f
1 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
coinset/README.md
View file

@ -1,7 +1,7 @@
coinset coinset
======= =======
Package coinset provides bitcoin-specific convenience functions for selecting Package coinset provides bitcoin-specific convenience functions for selecting
from and managing sets of unspent transaction outpoints (UTXOs). from and managing sets of unspent transaction outpoints (UTXOs).
A comprehensive suite of tests is provided to ensure proper functionality. See A comprehensive suite of tests is provided to ensure proper functionality. See
@ -27,7 +27,7 @@ $ go get github.com/conformal/btcutil/coinset
## Usage ## Usage
Each unspent transaction outpoint is represented by the Coin interface. An Each unspent transaction outpoint is represented by the Coin interface. An
example of a concrete type that implements Coin is coinset.SimpleCoin. example of a concrete type that implements Coin is coinset.SimpleCoin.
The typical use case for this library is for creating raw bitcoin transactions The typical use case for this library is for creating raw bitcoin transactions
@ -37,8 +37,8 @@ given a set of Coins that may be spent by the user, for example as below:
var unspentCoins = []coinset.Coin{ ... } var unspentCoins = []coinset.Coin{ ... }
``` ```
When the user needs to spend a certain amount, they will need to select a When the user needs to spend a certain amount, they will need to select a
subset of these coins which contain at least that value. CoinSelector is subset of these coins which contain at least that value. CoinSelector is
an interface that represents types that implement coin selection algos, an interface that represents types that implement coin selection algos,
subject to various criteria. There are a few examples of CoinSelector's: subject to various criteria. There are a few examples of CoinSelector's:
@ -50,13 +50,13 @@ subject to various criteria. There are a few examples of CoinSelector's:
- MinPriorityCoinSelector - MinPriorityCoinSelector
For example, if the user wishes to maximize the probability that their For example, if the user wishes to maximize the probability that their
transaction is mined quickly, they could use the MaxValueAgeCoinSelector to transaction is mined quickly, they could use the MaxValueAgeCoinSelector to
select high priority coins, then also attach a relatively high fee. select high priority coins, then also attach a relatively high fee.
```Go ```Go
selector := &coinset.MaxValueAgeCoinSelector{ selector := &coinset.MaxValueAgeCoinSelector{
MaxInputs: 10, MaxInputs: 10,
MinAmountChange: 10000, MinAmountChange: 10000,
} }
selectedCoins, err := selector.CoinSelect(targetAmount + bigFee, unspentCoins) selectedCoins, err := selector.CoinSelect(targetAmount + bigFee, unspentCoins)
@ -68,7 +68,7 @@ msgTx := coinset.NewMsgTxWithInputCoins(selectedCoins)
``` ```
The user can then create the msgTx.TxOut's as required, then sign the The user can then create the msgTx.TxOut's as required, then sign the
transaction and transmit it to the network. transaction and transmit it to the network.
## License ## License