wallet: add config, make reservations time based

SiaFoundation · Jan 13, 2024 · cee8d7b · cee8d7b
1 parent 441f570
commit cee8d7b
Show file tree

Hide file tree

Showing 4 changed files with 198 additions and 196 deletions.
diff --git a/testutil/wallet.go b/testutil/wallet.go
@@ -76,22 +76,19 @@ func (es *EphemeralWalletStore) ProcessChainApplyUpdate(cau *chain.ApplyUpdate,
 		return nil
 	}
 
-	walletAddress := types.StandardAddress(es.privateKey.PublicKey())
+	walletAddress := types.StandardUnlockHash(es.privateKey.PublicKey())
 
 	for _, update := range es.uncommitted {
-		// add matured transactions
-		for _, txn := range es.immaturePayoutTransactions[update.State.Index.Height] {
-			txn.Index = update.State.Index
-			txn.Timestamp = update.Block.Timestamp
-			es.transactions = append(es.transactions, txn)
+		// cache the source of new immature outputs to show payout transactions
+		siacoinOutputSources := map[types.SiacoinOutputID]wallet.TransactionSource{
+			update.Block.ID().FoundationOutputID(): wallet.TxnSourceFoundationPayout,
 		}
-
-		// determine the source of new immature outputs
-		siacoinOutputSources := make(map[types.SiacoinOutputID]wallet.TransactionSource)
+		// add the miner payouts
 		for i := range update.Block.MinerPayouts {
-			siacoinOutputSources[update.Block.ParentID.MinerOutputID(i)] = wallet.TxnSourceMinerPayout
+			siacoinOutputSources[update.Block.ID().MinerOutputID(i)] = wallet.TxnSourceMinerPayout
 		}
 
+		// add the file contract outputs
 		update.ForEachFileContractElement(func(fce types.FileContractElement, rev *types.FileContractElement, resolved bool, valid bool) {
 			if !resolved {
 				return
@@ -108,43 +105,14 @@ func (es *EphemeralWalletStore) ProcessChainApplyUpdate(cau *chain.ApplyUpdate,
 			}
 		})
 
-		for _, txn := range update.Block.Transactions {
-			for i := range txn.SiafundInputs {
-				siacoinOutputSources[txn.SiafundInputs[i].ParentID.ClaimOutputID()] = wallet.TxnSourceSiafundClaim
-			}
+		// add matured transactions first since
+		for _, txn := range es.immaturePayoutTransactions[update.State.Index.Height] {
+			txn.Index = update.State.Index
+			txn.Timestamp = update.Block.Timestamp
+			// prepend the transaction to the wallet
+			es.transactions = append([]wallet.Transaction{txn}, es.transactions...)
 		}
 
-		update.ForEachSiacoinElement(func(se types.SiacoinElement, spent bool) {
-			if se.SiacoinOutput.Address != walletAddress {
-				return
-			}
-
-			// update the utxo set
-			if spent {
-				delete(es.utxos, se.ID)
-			} else {
-				es.utxos[se.ID] = se
-			}
-
-			// create an immature payout transaction for any immature siacoin outputs
-			if se.MaturityHeight == 0 || spent {
-				return
-			}
-
-			source, ok := siacoinOutputSources[types.SiacoinOutputID(se.ID)]
-			if !ok {
-				source = wallet.TxnSourceFoundationPayout
-			}
-
-			es.immaturePayoutTransactions[se.MaturityHeight] = append(es.immaturePayoutTransactions[se.MaturityHeight], wallet.Transaction{
-				ID:          types.TransactionID(se.ID),
-				Transaction: types.Transaction{SiacoinOutputs: []types.SiacoinOutput{se.SiacoinOutput}},
-				Inflow:      se.SiacoinOutput.Value,
-				Source:      source,
-				// Index and Timestamp will be filled in later
-			})
-		})
-
 		// add the block transactions
 		for _, txn := range update.Block.Transactions {
 			if !wallet.IsRelevantTransaction(txn, walletAddress) {
@@ -178,8 +146,48 @@ func (es *EphemeralWalletStore) ProcessChainApplyUpdate(cau *chain.ApplyUpdate,
 
 				wt.Inflow = wt.Inflow.Add(sco.Value)
 			}
+
+			// prepend the transaction to the wallet
+			es.transactions = append([]wallet.Transaction{wt}, es.transactions...)
+
+			// add the siafund claim output IDs
+			for i := range txn.SiafundInputs {
+				siacoinOutputSources[txn.SiafundInputs[i].ParentID.ClaimOutputID()] = wallet.TxnSourceSiafundClaim
+			}
 		}
 
+		// update the utxo set
+		update.ForEachSiacoinElement(func(se types.SiacoinElement, spent bool) {
+			if se.SiacoinOutput.Address != walletAddress {
+				return
+			}
+
+			// update the utxo set
+			if spent {
+				delete(es.utxos, se.ID)
+			} else {
+				es.utxos[se.ID] = se
+			}
+
+			// create an immature payout transaction for any immature siacoin outputs
+			if se.MaturityHeight == 0 || spent {
+				return
+			}
+
+			source, ok := siacoinOutputSources[types.SiacoinOutputID(se.ID)]
+			if !ok {
+				panic("missing siacoin source")
+			}
+
+			es.immaturePayoutTransactions[se.MaturityHeight] = append(es.immaturePayoutTransactions[se.MaturityHeight], wallet.Transaction{
+				ID:          types.TransactionID(se.ID),
+				Transaction: types.Transaction{SiacoinOutputs: []types.SiacoinOutput{se.SiacoinOutput}},
+				Inflow:      se.SiacoinOutput.Value,
+				Source:      source,
+				// Index and Timestamp will be filled in later
+			})
+		})
+
 		// update the element proofs
 		for id, se := range es.utxos {
 			cau.UpdateElementProof(&se.StateElement)
@@ -226,34 +234,13 @@ func (es *EphemeralWalletStore) UnspentSiacoinElements() (utxos []types.SiacoinE
 	return utxos, nil
 }
 
-// LastIndexedTip returns the last indexed tip of the wallet.
-func (es *EphemeralWalletStore) LastIndexedTip() (types.ChainIndex, error) {
+// Tip returns the last indexed tip of the wallet.
+func (es *EphemeralWalletStore) Tip() (types.ChainIndex, error) {
 	es.mu.Lock()
 	defer es.mu.Unlock()
 	return es.tip, nil
 }
 
-// VerifyWalletKey checks that the wallet seed matches the existing seed
-// hash. This detects if the user's recovery phrase has changed and the
-// wallet needs to rescan.
-func (es *EphemeralWalletStore) VerifyWalletKey(seedHash types.Hash256) error {
-	return nil
-}
-
-// ResetWallet resets the wallet to its initial state. This is used when a
-// consensus subscription error occurs.
-func (es *EphemeralWalletStore) ResetWallet(seedHash types.Hash256) error {
-	es.mu.Lock()
-	defer es.mu.Unlock()
-
-	es.uncommitted = es.uncommitted[:0]
-	es.tip = types.ChainIndex{}
-	es.utxos = make(map[types.Hash256]types.SiacoinElement)
-	es.immaturePayoutTransactions = make(map[uint64][]wallet.Transaction)
-	es.transactions = nil
-	return nil
-}
-
 // NewEphemeralWalletStore returns a new EphemeralWalletStore.
 func NewEphemeralWalletStore(pk types.PrivateKey) *EphemeralWalletStore {
 	return &EphemeralWalletStore{

diff --git a/wallet/config.go b/wallet/config.go
@@ -0,0 +1,62 @@
+package wallet
+
+import (
+	"time"
+
+	"go.uber.org/zap"
+)
+
+type (
+	config struct {
+		DefragThreshold     int
+		MaxInputsForDefrag  int
+		MaxDefragUTXOs      int
+		ReservationDuration time.Duration
+
+		Log *zap.Logger
+	}
+
+	Option func(*config)
+)
+
+// WithDefragThreshold sets the transaction defrag threshold.
+func WithDefragThreshold(n int) Option {
+	return func(c *config) {
+		c.DefragThreshold = n
+	}
+}
+
+// WithMaxInputsForDefrag sets the maximum number of inputs a transaction can
+// have to be considered for defragging
+func WithMaxInputsForDefrag(n int) Option {
+	return func(c *config) {
+		c.MaxInputsForDefrag = n
+	}
+}
+
+// WithMaxDefragUTXOs sets the maximum number of additional utxos that will be
+// added to a transaction when defragging
+func WithMaxDefragUTXOs(n int) Option {
+	return func(c *config) {
+		c.MaxDefragUTXOs = n
+	}
+}
+
+// WithReservationDuration sets the duration that a reservation will be held
+// on spent utxos
+func WithReservationDuration(d time.Duration) Option {
+	if d <= 0 {
+		panic("reservation duration must be positive") // developer error
+	}
+
+	return func(c *config) {
+		c.ReservationDuration = d
+	}
+}
+
+// WithLogger sets the logger for the wallet
+func WithLogger(l *zap.Logger) Option {
+	return func(c *config) {
+		c.Log = l
+	}
+}