Merge pull request #27 from SiaFoundation/pj/fix-redistribute-wallet

Fix 'inUse' condition in wallet.Redistribute

Author: ChrisSchinnerl

testutil/network.go

@@ -22,14 +22,20 @@ func Network() (*consensus.Network, types.Block) {
 	return n, genesisBlock
 }
 
-// MineBlock mines a block with the given transactions.
+// MineBlock mines a block with the given transactions, transaction fees are
+// added to the miner payout.
 func MineBlock(cm *chain.Manager, minerAddress types.Address) types.Block {
+	var minerFees types.Currency
+	for _, txn := range cm.PoolTransactions() {
+		minerFees = minerFees.Add(txn.TotalFees())
+	}
+
 	state := cm.TipState()
 	b := types.Block{
 		ParentID:     state.Index.ID,
 		Timestamp:    types.CurrentTimestamp(),
 		Transactions: cm.PoolTransactions(),
-		MinerPayouts: []types.SiacoinOutput{{Address: minerAddress, Value: state.BlockReward()}},
+		MinerPayouts: []types.SiacoinOutput{{Address: minerAddress, Value: state.BlockReward().Add(minerFees)}},
 	}
 	for b.ID().CmpWork(state.ChildTarget) < 0 {
 		b.Nonce += state.NonceFactor()

wallet/wallet.go

@@ -201,7 +201,7 @@ func (sw *SingleAddressWallet) Balance() (balance Balance, err error) {
 			balance.Immature = balance.Immature.Add(sco.SiacoinOutput.Value)
 		} else {
 			balance.Confirmed = balance.Confirmed.Add(sco.SiacoinOutput.Value)
-			if time.Now().After(sw.locked[sco.ID]) && !tpoolSpent[sco.ID] {
+			if !sw.isLocked(sco.ID) && !tpoolSpent[sco.ID] {
 				balance.Spendable = balance.Spendable.Add(sco.SiacoinOutput.Value)
 			}
 		}
@@ -252,7 +252,7 @@ func (sw *SingleAddressWallet) SpendableOutputs() ([]SiacoinElement, error) {
 	// filter outputs that are either locked, in the pool or have not yet matured
 	unspent := utxos[:0]
 	for _, sce := range utxos {
-		if time.Now().Before(sw.locked[sce.ID]) || inPool[sce.ID] || bh < sce.MaturityHeight {
+		if sw.isLocked(sce.ID) || inPool[sce.ID] || bh < sce.MaturityHeight {
 			continue
 		}
 		unspent = append(unspent, sce)
@@ -297,8 +297,14 @@ func (sw *SingleAddressWallet) FundTransaction(txn *types.Transaction, amount ty
 	// remove immature, locked and spent outputs
 	cs := sw.cm.TipState()
 	utxos := make([]types.SiacoinElement, 0, len(elements))
+	var usedSum types.Currency
+	var immatureSum types.Currency
 	for _, sce := range elements {
-		if time.Now().Before(sw.locked[sce.ID]) || tpoolSpent[sce.ID] || cs.Index.Height < sce.MaturityHeight {
+		if used := sw.isLocked(sce.ID) || tpoolSpent[sce.ID]; used {
+			usedSum = usedSum.Add(sce.SiacoinOutput.Value)
+			continue
+		} else if immature := cs.Index.Height < sce.MaturityHeight; immature {
+			immatureSum = immatureSum.Add(sce.SiacoinOutput.Value)
 			continue
 		}
 		utxos = append(utxos, sce.SiacoinElement)
@@ -310,20 +316,22 @@ func (sw *SingleAddressWallet) FundTransaction(txn *types.Transaction, amount ty
 	})
 
 	var unconfirmedUTXOs []types.SiacoinElement
+	var unconfirmedSum types.Currency
 	if useUnconfirmed {
 		for _, sce := range tpoolUtxos {
-			if sce.SiacoinOutput.Address != sw.addr || time.Now().Before(sw.locked[sce.ID]) {
+			if sce.SiacoinOutput.Address != sw.addr || sw.isLocked(sce.ID) {
 				continue
 			}
 			unconfirmedUTXOs = append(unconfirmedUTXOs, sce)
+			unconfirmedSum = unconfirmedSum.Add(sce.SiacoinOutput.Value)
 		}
-
-		// sort by value, descending
-		sort.Slice(unconfirmedUTXOs, func(i, j int) bool {
-			return unconfirmedUTXOs[i].SiacoinOutput.Value.Cmp(unconfirmedUTXOs[j].SiacoinOutput.Value) > 0
-		})
 	}
 
+	// sort by value, descending
+	sort.Slice(unconfirmedUTXOs, func(i, j int) bool {
+		return unconfirmedUTXOs[i].SiacoinOutput.Value.Cmp(unconfirmedUTXOs[j].SiacoinOutput.Value) > 0
+	})
+
 	// fund the transaction using the largest utxos first
 	var selected []types.SiacoinElement
 	var inputSum types.Currency
@@ -339,19 +347,19 @@ func (sw *SingleAddressWallet) FundTransaction(txn *types.Transaction, amount ty
 	if inputSum.Cmp(amount) < 0 && useUnconfirmed {
 		// try adding unconfirmed utxos.
 		for _, sce := range unconfirmedUTXOs {
+			selected = append(selected, sce)
+			inputSum = inputSum.Add(sce.SiacoinOutput.Value)
 			if inputSum.Cmp(amount) >= 0 {
 				break
 			}
-			selected = append(selected, sce)
-			inputSum = inputSum.Add(sce.SiacoinOutput.Value)
 		}
 
 		if inputSum.Cmp(amount) < 0 {
 			// still not enough funds
-			return nil, ErrNotEnoughFunds
+			return nil, fmt.Errorf("%w: inputs %v < needed %v (used: %v immature: %v unconfirmed: %v)", ErrNotEnoughFunds, inputSum.String(), amount.String(), usedSum.String(), immatureSum.String(), unconfirmedSum.String())
 		}
 	} else if inputSum.Cmp(amount) < 0 {
-		return nil, ErrNotEnoughFunds
+		return nil, fmt.Errorf("%w: inputs %v < needed %v (used: %v immature: %v", ErrNotEnoughFunds, inputSum.String(), amount.String(), usedSum.String(), immatureSum.String())
 	}
 
 	// check if remaining utxos should be defragged
@@ -496,7 +504,7 @@ func (sw *SingleAddressWallet) Redistribute(outputs int, amount, feePerByte type
 	// unused, matured and has the same value
 	utxos := make([]types.SiacoinElement, 0, len(elements))
 	for _, sce := range elements {
-		inUse := time.Now().After(sw.locked[sce.ID]) || inPool[sce.ID]
+		inUse := sw.isLocked(sce.ID) || inPool[sce.ID]
 		matured := bh >= sce.MaturityHeight
 		sameValue := sce.SiacoinOutput.Value.Equals(amount)
 
@@ -602,6 +610,12 @@ func (sw *SingleAddressWallet) ReleaseInputs(txns ...types.Transaction) {
 	}
 }
 
+// isLocked returns true if the siacoin output with given id is locked, this
+// method must be called whilst holding the mutex lock.
+func (sw *SingleAddressWallet) isLocked(id types.Hash256) bool {
+	return time.Now().Before(sw.locked[id])
+}
+
 // IsRelevantTransaction returns true if the v1 transaction is relevant to the
 // address
 func IsRelevantTransaction(txn types.Transaction, addr types.Address) bool {