[R4R] fix account may have currency with zero balance (#679)

* hardfork: fix possible zero currency balance * add change log * fix review suggest
bnb-chain · May 19, 2022 · f21fce1 · f21fce1
1 parent 904bda9
commit f21fce1
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 3 deletions.
diff --git a/CHANGELOG_PENDING.md b/CHANGELOG_PENDING.md
@@ -2,6 +2,7 @@
 ## Develop
 
 BUG FIXES
+* [\#677](https://github.com/binance-chain/node/pull/677) [Dex] fix account may have currency with zero balance 
 
 IMPROVEMENTS
 * [\#672](https://github.com/binance-chain/node/pull/672) [DEX] Change listing rule

diff --git a/app/app.go b/app/app.go
@@ -260,6 +260,7 @@ func SetUpgradeConfig(upgradeConfig *config.UpgradeConfig) {
 	upgrade.Mgr.AddUpgradeHeight(upgrade.FixSignBytesOverflow, upgradeConfig.FixSignBytesOverflowHeight)
 	upgrade.Mgr.AddUpgradeHeight(upgrade.LotSizeOptimization, upgradeConfig.LotSizeUpgradeHeight)
 	upgrade.Mgr.AddUpgradeHeight(upgrade.ListingRuleUpgrade, upgradeConfig.ListingRuleUpgradeHeight)
+	upgrade.Mgr.AddUpgradeHeight(upgrade.FixZeroBalance, upgradeConfig.FixZeroBalanceHeight)
 
 	// register store keys of upgrade
 	upgrade.Mgr.RegisterStoreKeys(upgrade.BEP9, common.TimeLockStoreKey.Name())

diff --git a/app/config/config.go b/app/config/config.go
@@ -65,6 +65,8 @@ FixSignBytesOverflowHeight = {{ .UpgradeConfig.FixSignBytesOverflowHeight }}
 LotSizeUpgradeHeight = {{ .UpgradeConfig.LotSizeUpgradeHeight }}
 # Block height of changing listing rule upgrade
 ListingRuleUpgradeHeight = {{ .UpgradeConfig.ListingRuleUpgradeHeight }}
+# Block height of FixZeroBalanceHeight upgrade
+FixZeroBalanceHeight = {{ .UpgradeConfig.FixZeroBalanceHeight }}
 
 [query]
 # ABCI query interface black list, suggested value: ["custom/gov/proposals", "custom/timelock/timelocks", "custom/atomicSwap/swapcreator", "custom/atomicSwap/swaprecipient"]
@@ -353,6 +355,7 @@ type UpgradeConfig struct {
 	FixSignBytesOverflowHeight int64 `mapstructure:"FixSignBytesOverflowHeight"`
 	LotSizeUpgradeHeight       int64 `mapstructure:"LotSizeUpgradeHeight"`
 	ListingRuleUpgradeHeight   int64 `mapstructure:"ListingRuleUpgradeHeight"`
+	FixZeroBalanceHeight       int64 `mapstructure:"FixZeroBalanceHeight"`
 }
 
 func defaultUpgradeConfig() *UpgradeConfig {
@@ -367,6 +370,7 @@ func defaultUpgradeConfig() *UpgradeConfig {
 		FixSignBytesOverflowHeight: math.MaxInt64,
 		LotSizeUpgradeHeight:       math.MaxInt64,
 		ListingRuleUpgradeHeight:   math.MaxInt64,
+		FixZeroBalanceHeight:       math.MaxInt64,
 	}
 }
 

diff --git a/common/upgrade/upgrade.go b/common/upgrade/upgrade.go
@@ -21,6 +21,7 @@ const (
 	FixSignBytesOverflow = sdk.FixSignBytesOverflow
 	LotSizeOptimization  = "LotSizeOptimization"
 	ListingRuleUpgrade   = "ListingRuleUpgrade" // Remove restriction that only the owner of base asset can list trading pair
+	FixZeroBalance       = "FixZeroBalance"
 )
 
 func UpgradeBEP10(before func(), after func()) {

diff --git a/plugins/dex/order/keeper.go b/plugins/dex/order/keeper.go
@@ -609,9 +609,12 @@ func (kp *Keeper) doTransfer(ctx sdk.Context, tran *Transfer) sdk.Error {
 		panic(errors.New("unlocked tokens cannot cover the expense"))
 	}
 	account.SetLockedCoins(newLocked)
-	account.SetCoins(account.GetCoins().
-		Plus(sdk.Coins{sdk.NewCoin(tran.inAsset, tran.in)}).
-		Plus(sdk.Coins{sdk.NewCoin(tran.outAsset, tran.unlock-tran.out)}))
+	accountCoin := account.GetCoins().
+		Plus(sdk.Coins{sdk.NewCoin(tran.inAsset, tran.in)})
+	if remain := tran.unlock-tran.out; remain > 0 || !sdk.IsUpgrade(upgrade.FixZeroBalance) {
+		accountCoin = accountCoin.Plus(sdk.Coins{sdk.NewCoin(tran.outAsset, remain)})
+	}
+	account.SetCoins(accountCoin)
 
 	kp.am.SetAccount(ctx, account)
 	kp.logger.Debug("Performed Trade Allocation", "account", account, "allocation", tran.String())