refund/deduct naming

Author: shaspitz

p2p/pkg/depositmanager/deposit.go

@@ -23,8 +23,8 @@ type Store interface {
 	GetBalance(bidder common.Address, provider common.Address) (*big.Int, error)
 	SetBalance(bidder common.Address, provider common.Address, balance *big.Int) error
 	DeleteBalance(bidder common.Address, provider common.Address) error
-	IncreaseBalanceIfExists(bidder common.Address, provider common.Address, amount *big.Int) error
-	DecreaseBalanceIfExists(bidder common.Address, provider common.Address, amount *big.Int) error
+	RefundBalanceIfExists(bidder common.Address, provider common.Address, amount *big.Int) error
+	DeductBalanceIfExists(bidder common.Address, provider common.Address, amount *big.Int) error
 }
 
 type DepositManager struct {
@@ -275,10 +275,10 @@ func (dm *DepositManager) getDefaultBalance(
 	return balance, nil
 }
 
-func (dm *DepositManager) IncreaseBalanceIfExists(bidder common.Address, provider common.Address, amount *big.Int) error {
-	return dm.store.IncreaseBalanceIfExists(bidder, provider, amount)
+func (dm *DepositManager) RefundBalanceIfExists(bidder common.Address, provider common.Address, amount *big.Int) error {
+	return dm.store.RefundBalanceIfExists(bidder, provider, amount)
 }
 
-func (dm *DepositManager) DecreaseBalanceIfExists(bidder common.Address, provider common.Address, amount *big.Int) error {
-	return dm.store.DecreaseBalanceIfExists(bidder, provider, amount)
+func (dm *DepositManager) DeductBalanceIfExists(bidder common.Address, provider common.Address, amount *big.Int) error {
+	return dm.store.DeductBalanceIfExists(bidder, provider, amount)
 }

p2p/pkg/depositmanager/store/store.go

@@ -64,7 +64,7 @@ func (s *Store) DeleteBalance(bidder common.Address, provider common.Address) er
 	return s.st.Delete(balanceKey(bidder, provider))
 }
 
-func (s *Store) IncreaseBalanceIfExists(
+func (s *Store) RefundBalanceIfExists(
 	bidder common.Address,
 	provider common.Address,
 	amount *big.Int,
@@ -84,7 +84,7 @@ func (s *Store) IncreaseBalanceIfExists(
 	return s.st.Put(balanceKey(bidder, provider), newAmount.Bytes())
 }
 
-func (s *Store) DecreaseBalanceIfExists(
+func (s *Store) DeductBalanceIfExists(
 	bidder common.Address,
 	provider common.Address,
 	amount *big.Int,

p2p/pkg/depositmanager/store/store_test.go

@@ -70,15 +70,15 @@ func TestStore_GetBalance_NoBalance(t *testing.T) {
 	}
 }
 
-func TestStore_IncreaseBalanceIfExists(t *testing.T) {
+func TestStore_RefundBalanceIfExists(t *testing.T) {
 	st := inmem.New()
 	s := store.New(st)
 
 	bidder := common.HexToAddress("0x123")
 	provider := common.HexToAddress("0x456")
 	amount := big.NewInt(20)
 
-	err := s.IncreaseBalanceIfExists(bidder, provider, amount)
+	err := s.RefundBalanceIfExists(bidder, provider, amount)
 	if err == nil {
 		t.Fatal("expected error, got nil")
 	}
@@ -92,7 +92,7 @@ func TestStore_IncreaseBalanceIfExists(t *testing.T) {
 	}
 
 	increaseAmount := big.NewInt(5)
-	err = s.IncreaseBalanceIfExists(bidder, provider, increaseAmount)
+	err = s.RefundBalanceIfExists(bidder, provider, increaseAmount)
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -107,15 +107,15 @@ func TestStore_IncreaseBalanceIfExists(t *testing.T) {
 	}
 }
 
-func TestStore_DecreaseBalanceIfExists(t *testing.T) {
+func TestStore_DeductBalanceIfExists(t *testing.T) {
 	st := inmem.New()
 	s := store.New(st)
 
 	bidder := common.HexToAddress("0x123")
 	provider := common.HexToAddress("0x456")
 	initialBalance := big.NewInt(20)
 
-	err := s.DecreaseBalanceIfExists(bidder, provider, big.NewInt(10))
+	err := s.DeductBalanceIfExists(bidder, provider, big.NewInt(10))
 	if err == nil {
 		t.Fatal("expected error, got nil")
 	}
@@ -129,7 +129,7 @@ func TestStore_DecreaseBalanceIfExists(t *testing.T) {
 	}
 
 	decreaseAmount := big.NewInt(5)
-	err = s.DecreaseBalanceIfExists(bidder, provider, decreaseAmount)
+	err = s.DeductBalanceIfExists(bidder, provider, decreaseAmount)
 	if err != nil {
 		t.Fatal(err)
 	}

p2p/pkg/preconfirmation/tracker/tracker.go

@@ -98,8 +98,8 @@ type Watcher interface {
 }
 
 type DepositManager interface {
-	IncreaseBalanceIfExists(bidder common.Address, provider common.Address, amount *big.Int) error
-	DecreaseBalanceIfExists(bidder common.Address, provider common.Address, amount *big.Int) error
+	RefundBalanceIfExists(bidder common.Address, provider common.Address, amount *big.Int) error
+	DeductBalanceIfExists(bidder common.Address, provider common.Address, amount *big.Int) error
 }
 
 func NewTracker(
@@ -457,9 +457,9 @@ func (t *Tracker) statusUpdater(
 						} else {
 							status = store.CommitmentStatusStored
 							if t.depositMgr != nil {
-								// Try to decrease cached balance now that commitment was successfully stored
-								if err := t.tryDecreaseCachedBalance(task.commitment); err != nil {
-									t.logger.Warn("failed to decrease cached balance. Bidder is likely withdrawing", "error", err)
+								// Try to deduct cached balance now that commitment was successfully stored
+								if err := t.tryDeductCachedBalance(task.commitment); err != nil {
+									t.logger.Warn("failed to deduct cached balance. Bidder is likely withdrawing", "error", err)
 								}
 							}
 						}
@@ -556,7 +556,7 @@ func (t *Tracker) openCommitments(
 			)
 			if t.depositMgr != nil {
 				// This node isn't the winner, so try to refund relevant cached balance
-				if err := t.tryIncreaseCachedBalance(commitment); err != nil {
+				if err := t.tryRefundCachedBalance(commitment); err != nil {
 					t.logger.Warn("failed to refund cached balance. Bidder is likely withdrawing", "error", err)
 				}
 			}
@@ -800,34 +800,34 @@ func (t *Tracker) generateBidderProof(
 	}
 }
 
-func (t *Tracker) tryIncreaseCachedBalance(
+func (t *Tracker) tryRefundCachedBalance(
 	commitment *store.Commitment,
 ) error {
 	if commitment.BidderAddress == nil || commitment.ProviderAddress == nil || commitment.BidAmount == nil {
 		return fmt.Errorf("nil commitment fields")
 	}
-	if err := t.depositMgr.IncreaseBalanceIfExists(
+	if err := t.depositMgr.RefundBalanceIfExists(
 		*commitment.BidderAddress,
 		common.BytesToAddress(commitment.ProviderAddress),
 		commitment.BidAmount,
 	); err != nil {
-		return fmt.Errorf("failed to increase balance: %w", err)
+		return fmt.Errorf("failed to refund balance: %w", err)
 	}
-	t.logger.Info("increased cached balance from commitment",
+	t.logger.Info("refunded cached balance from commitment",
 		"bidder", commitment.BidderAddress,
 		"provider", common.BytesToAddress(commitment.ProviderAddress),
 		"amount", commitment.BidAmount,
 	)
 	return nil
 }
 
-func (t *Tracker) tryDecreaseCachedBalance(
+func (t *Tracker) tryDeductCachedBalance(
 	commitment *store.Commitment,
 ) error {
 	if commitment.BidderAddress == nil || commitment.ProviderAddress == nil || commitment.BidAmount == nil {
 		return fmt.Errorf("nil commitment fields")
 	}
-	if err := t.depositMgr.DecreaseBalanceIfExists(
+	if err := t.depositMgr.DeductBalanceIfExists(
 		*commitment.BidderAddress,
 		common.BytesToAddress(commitment.ProviderAddress),
 		commitment.BidAmount,