From 27e2d8bfb5678e79d956b9f1aa50c1b14177d748 Mon Sep 17 00:00:00 2001 From: super3 Date: Tue, 15 Oct 2013 23:14:30 -0400 Subject: Finished /Contrib Index. Standardized READMEs. File and Link Fix. --- contrib/spendfrom/README.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 contrib/spendfrom/README.md (limited to 'contrib/spendfrom/README.md') diff --git a/contrib/spendfrom/README.md b/contrib/spendfrom/README.md new file mode 100644 index 0000000000..bc4def5f74 --- /dev/null +++ b/contrib/spendfrom/README.md @@ -0,0 +1,34 @@ +### SpendFrom ### + +Use the raw transactions API to send coins received on a particular +address (or addresses). + +Depends on `jsonrpc` + +Usage: + + spendfrom.py --from=FROMADDRESS1[,FROMADDRESS2] --to=TOADDRESS --amount=amount \ + --fee=fee --datadir=/path/to/.bitcoin --testnet --dry_run + +With no arguments, outputs a list of amounts associated with addresses. + +With arguments, sends coins received by the `FROMADDRESS` addresses to the `TOADDRESS`. + +You may explictly specify how much fee to pay (a fee more than 1% of the amount +will fail, though, to prevent bitcoin-losing accidents). Spendfrom may fail if +it thinks the transaction would never be confirmed (if the amount being sent is +too small, or if the transaction is too many bytes for the fee). + +If a change output needs to be created, the change will be sent to the last +`FROMADDRESS` (if you specify just one `FROMADDRESS`, change will go back to it). + +If `--datadir` is not specified, the default datadir is used. + +The `--dry_run` option will just create and sign the the transaction and print +the transaction data (as hexadecimal), instead of broadcasting it. + +If the transaction is created and broadcast successfully, a transaction id +is printed. + +If this was a tool for end-users and not programmers, it would have much friendlier +error-handling. -- cgit v1.2.3