Merge pull request NebulousLabs#1889 from NebulousLabs/send-to-many

use types.SiacoinOutput for /wallet/siacoins param

Author: David Vorick

api/wallet.go

@@ -1,6 +1,7 @@
 package api
 
 import (
+	"encoding/json"
 	"net/http"
 	"path/filepath"
 	"strconv"
@@ -367,42 +368,44 @@ func (api *API) walletSeedsHandler(w http.ResponseWriter, req *http.Request, _ h
 
 // walletSiacoinsHandler handles API calls to /wallet/siacoins.
 func (api *API) walletSiacoinsHandler(w http.ResponseWriter, req *http.Request, _ httprouter.Params) {
-	amountStrs := strings.Split(req.FormValue("amount"), ",")
-	destStrs := strings.Split(req.FormValue("destination"), ",")
-	amounts := make([]types.Currency, len(amountStrs))
-	dests := make([]types.UnlockHash, len(destStrs))
-	for i, amountStr := range amountStrs {
-		var ok bool
-		amounts[i], ok = scanAmount(amountStr)
-		if !ok {
-			WriteError(w, Error{"could not read amount from POST call to /wallet/siacoins"}, http.StatusBadRequest)
+	var txns []types.Transaction
+	if req.FormValue("outputs") != "" {
+		// multiple amounts + destinations
+		if req.FormValue("amount") != "" || req.FormValue("destination") != "" {
+			WriteError(w, Error{"cannot supply both 'outputs' and single amount+destination pair"}, http.StatusInternalServerError)
 			return
 		}
-	}
-	var err error
-	for i, destStr := range destStrs {
-		dests[i], err = scanAddress(destStr)
+
+		var outputs []types.SiacoinOutput
+		err := json.Unmarshal([]byte(req.FormValue("outputs")), &outputs)
 		if err != nil {
-			WriteError(w, Error{"could not read address from POST call to /wallet/siacoins"}, http.StatusBadRequest)
+			WriteError(w, Error{"could not decode outputs: " + err.Error()}, http.StatusInternalServerError)
 			return
 		}
-	}
-
-	var txns []types.Transaction
-	if len(amounts) == 1 && len(dests) == 1 {
-		// single amount + destination
-		txns, err = api.wallet.SendSiacoins(amounts[0], dests[0])
+		txns, err = api.wallet.SendSiacoinsMulti(outputs)
 		if err != nil {
 			WriteError(w, Error{"error after call to /wallet/siacoins: " + err.Error()}, http.StatusInternalServerError)
 			return
 		}
 	} else {
-		// multiple amounts + destinations
-		txns, err = api.wallet.SendSiacoinsMulti(amounts, dests)
+		// single amount + destination
+		amount, ok := scanAmount(req.FormValue("amount"))
+		if !ok {
+			WriteError(w, Error{"could not read amount from POST call to /wallet/siacoins"}, http.StatusBadRequest)
+			return
+		}
+		dest, err := scanAddress(req.FormValue("destination"))
+		if err != nil {
+			WriteError(w, Error{"could not read address from POST call to /wallet/siacoins"}, http.StatusBadRequest)
+			return
+		}
+
+		txns, err = api.wallet.SendSiacoins(amount, dest)
 		if err != nil {
 			WriteError(w, Error{"error after call to /wallet/siacoins: " + err.Error()}, http.StatusInternalServerError)
 			return
 		}
+
 	}
 
 	var txids []types.TransactionID

api/wallet_test.go

@@ -1,12 +1,12 @@
 package api
 
 import (
+	"encoding/json"
 	"errors"
 	"fmt"
 	"net/url"
 	"os"
 	"path/filepath"
-	"strings"
 	"testing"
 	"time"
 
@@ -1501,46 +1501,52 @@ func TestWalletSiacoins(t *testing.T) {
 		t.Fatal(err)
 	}
 	sendSiacoinsValues := url.Values{}
-	sendSiacoinsValues.Set("amount", sendAmount.String())
-	sendSiacoinsValues.Set("destination", wag.Address.String())
+	outputsJSON, _ := json.Marshal([]types.SiacoinOutput{{
+		UnlockHash: wag.Address,
+		Value:      sendAmount,
+	}})
+	sendSiacoinsValues.Set("outputs", string(outputsJSON))
 	if err = st.stdPostAPI("/wallet/siacoins", sendSiacoinsValues); err != nil {
 		t.Fatal(err)
 	}
 
 	// Send 10KS to 3, 4, 5 in a single send.
-	var amounts, dests []string
+	var outputs []types.SiacoinOutput
 	for _, w := range wallets[2:5] {
 		var wag WalletAddressGET
 		err = w.getAPI("/wallet/address", &wag)
 		if err != nil {
 			t.Fatal(err)
 		}
-		amounts = append(amounts, sendAmount.String())
-		dests = append(dests, wag.Address.String())
+		outputs = append(outputs, types.SiacoinOutput{
+			UnlockHash: wag.Address,
+			Value:      sendAmount,
+		})
 	}
+	outputsJSON, _ = json.Marshal(outputs)
 	sendSiacoinsValues = url.Values{}
-	sendSiacoinsValues.Set("amount", strings.Join(amounts, ","))
-	sendSiacoinsValues.Set("destination", strings.Join(dests, ","))
+	sendSiacoinsValues.Set("outputs", string(outputsJSON))
 	if err = st.stdPostAPI("/wallet/siacoins", sendSiacoinsValues); err != nil {
 		t.Fatal(err)
 	}
 
 	// Send 10KS to 6 through a joined 250 sends.
-	amounts = nil
-	dests = nil
+	outputs = nil
 	smallSend := sendAmount.Div64(250)
 	for i := 0; i < 250; i++ {
 		var wag WalletAddressGET
 		err = st6.getAPI("/wallet/address", &wag)
 		if err != nil {
 			t.Fatal(err)
 		}
-		amounts = append(amounts, smallSend.String())
-		dests = append(dests, wag.Address.String())
+		outputs = append(outputs, types.SiacoinOutput{
+			UnlockHash: wag.Address,
+			Value:      smallSend,
+		})
 	}
+	outputsJSON, _ = json.Marshal(outputs)
 	sendSiacoinsValues = url.Values{}
-	sendSiacoinsValues.Set("amount", strings.Join(amounts, ","))
-	sendSiacoinsValues.Set("destination", strings.Join(dests, ","))
+	sendSiacoinsValues.Set("outputs", string(outputsJSON))
 	if err = st.stdPostAPI("/wallet/siacoins", sendSiacoinsValues); err != nil {
 		t.Fatal(err)
 	}

doc/API.md

@@ -1177,14 +1177,15 @@ dictionary
 
 #### /wallet/siacoins [POST]
 
-sends siacoins to a set of addresses. The outputs are arbitrarily selected
-from addresses in the wallet. The number of amounts must match the number of
-destinations.
+sends siacoins to an address or set of addresses. The outputs are arbitrarily
+selected from addresses in the wallet. If 'outputs' is supplied, 'amount' and
+'destination' must be empty.
 
 ###### Query String Parameters [(with comments)](/doc/api/Wallet.md#query-string-parameters-6)
 ```
-amount      // list of hastings (comma separated)
-destination // list of addresses (comma separated)
+amount      // hastings
+destination // address
+outputs     // JSON array of {unlockhash, value} pairs
 ```
 
 ###### JSON Response [(with comments)](/doc/api/Wallet.md#json-response-5)

doc/api/Wallet.md

@@ -314,20 +314,24 @@ dictionary
 
 #### /wallet/siacoins [POST]
 
-Function: Send siacoins to a set of addresses. The outputs are arbitrarily
-selected from addresses in the wallet. Each address is paired with an amount;
-the number of amounts must match the number of addresses. The number of pairs
-should not exceed 250; this may result in a transaction too large to fit in
-the transaction pool.
+Function: Send siacoins to an address or set of addresses. The outputs are
+arbitrarily selected from addresses in the wallet. If 'outputs' is supplied,
+'amount' and 'destination' must be empty. The number of outputs should not
+exceed 400; this may result in a transaction too large to fit in the
+transaction pool.
 
 ###### Query String Parameters
 ```
-// Comma-separated list of hastings being sent to each address. A hasting is
-// the smallest unit in Sia. There are 10^24 hastings in a siacoin.
+// Number of hastings being sent. A hasting is the smallest unit in Sia. There
+// are 10^24 hastings in a siacoin.
 amount      // hastings
 
-// Comma-separated list of addresses that are receiving coins.
+// Address that is receiving the coins.
 destination // address
+
+// JSON array of outputs. The structure of each output is:
+// {"unlockhash": "<destination>", "value": "<amount>"}
+outputs
 ```
 
 ###### JSON Response

modules/wallet.go

@@ -383,9 +383,8 @@ type (
 		// are also returned to the caller.
 		SendSiacoins(amount types.Currency, dest types.UnlockHash) ([]types.Transaction, error)
 
-		// SendSiacoinsMulti sends coins to multiple addresses. The number of
-		// amounts and destinations must match.
-		SendSiacoinsMulti(amounts []types.Currency, dests []types.UnlockHash) ([]types.Transaction, error)
+		// SendSiacoinsMulti sends coins to multiple addresses.
+		SendSiacoinsMulti(outputs []types.SiacoinOutput) ([]types.Transaction, error)
 
 		// SendSiafunds is a tool for sending siafunds from the wallet to an
 		// address. Sending money usually results in multiple transactions. The

modules/wallet/money.go

@@ -1,8 +1,6 @@
 package wallet
 
 import (
-	"errors"
-
 	"github.com/NebulousLabs/Sia/build"
 	"github.com/NebulousLabs/Sia/modules"
 	"github.com/NebulousLabs/Sia/types"
@@ -113,10 +111,10 @@ func (w *Wallet) SendSiacoins(amount types.Currency, dest types.UnlockHash) ([]t
 	return txnSet, nil
 }
 
-// SendSiacoinsMulti creates a transaction sending each amount in 'amounts' to
-// it's corresponding destination in 'dests'. The transaction is submitted to
-// the transaction pool and is also returned.
-func (w *Wallet) SendSiacoinsMulti(amounts []types.Currency, dests []types.UnlockHash) ([]types.Transaction, error) {
+// SendSiacoinsMulti creates a transaction that includes the specified
+// outputs. The transaction is submitted to the transaction pool and is also
+// returned.
+func (w *Wallet) SendSiacoinsMulti(outputs []types.SiacoinOutput) ([]types.Transaction, error) {
 	if err := w.tg.Add(); err != nil {
 		return nil, err
 	}
@@ -125,35 +123,29 @@ func (w *Wallet) SendSiacoinsMulti(amounts []types.Currency, dests []types.Unloc
 		w.log.Println("Attempt to send coins has failed - wallet is locked")
 		return nil, modules.ErrLockedWallet
 	}
-	if len(amounts) != len(dests) {
-		return nil, errors.New("number of amounts and destinations must match")
-	}
 
 	txnBuilder := w.StartTransaction()
 
 	// Add estimated transaction fee.
 	_, tpoolFee := w.tpool.FeeEstimation()
-	tpoolFee = tpoolFee.Mul64(1000 + 60*uint64(len(dests))) // Estimated transaction size in bytes
+	tpoolFee = tpoolFee.Mul64(1000 + 60*uint64(len(outputs))) // Estimated transaction size in bytes
 	txnBuilder.AddMinerFee(tpoolFee)
 
 	// Calculate total cost to wallet.
 	// NOTE: we only want to call FundSiacoins once; that way, it will
 	// (ideally) fund the entire transaction with a single input, instead of
 	// many smaller ones.
 	totalCost := tpoolFee
-	for _, amount := range amounts {
-		totalCost = totalCost.Add(amount)
+	for _, sco := range outputs {
+		totalCost = totalCost.Add(sco.Value)
 	}
 	err := txnBuilder.FundSiacoins(totalCost)
 	if err != nil {
 		return nil, build.ExtendErr("unable to fund transaction", err)
 	}
 
-	for i := range dests {
-		txnBuilder.AddSiacoinOutput(types.SiacoinOutput{
-			Value:      amounts[i],
-			UnlockHash: dests[i],
-		})
+	for _, sco := range outputs {
+		txnBuilder.AddSiacoinOutput(sco)
 	}
 
 	txnSet, err := txnBuilder.Sign(true)