v1.7.24: Add function to reclaim funds

build.gradle.kts

@@ -49,7 +49,7 @@ allprojects {
 }
 
 group = "exchange.dydx.abacus"
-version = "1.6.54"
+version = "1.6.55"
 
 repositories {
     google()

src/commonMain/kotlin/exchange.dydx.abacus/protocols/PublicProtocols.kt

@@ -162,9 +162,10 @@ enum class TransactionType(val rawValue: String) {
     Deposit("deposit"),
     Withdraw("withdraw"),
     SubaccountTransfer("subaccountTransfer"),
+    ReclaimChildSubaccountFunds("reclaimChildSubaccountFunds"),
     Faucet("faucet"),
-    simulateWithdraw("simulateWithdraw"),
-    simulateTransferNativeToken("simulateTransferNativeToken"),
+    SimulateWithdraw("simulateWithdraw"),
+    SimulateTransferNativeToken("simulateTransferNativeToken"),
     SendNobleIBC("sendNobleIBC"),
     WithdrawToNobleIBC("withdrawToNobleIBC"),
     CctpWithdraw("cctpWithdraw"),

src/commonMain/kotlin/exchange.dydx.abacus/state/manager/V4StateManagerAdaptor+Transfer.kt

@@ -214,7 +214,7 @@ internal fun V4StateManagerAdaptor.simulateWithdrawal(
     val payload = withdrawPayloadJson()
 
     transaction(
-        TransactionType.simulateWithdraw,
+        TransactionType.SimulateWithdraw,
         payload,
     ) { response ->
         val error = parseTransactionResponse(response)
@@ -243,7 +243,7 @@ internal fun V4StateManagerAdaptor.simulateTransferNativeToken(
     val payload = transferNativeTokenPayloadJson()
 
     transaction(
-        TransactionType.simulateTransferNativeToken,
+        TransactionType.SimulateTransferNativeToken,
         payload,
     ) { response ->
         val error = parseTransactionResponse(response)

src/commonMain/kotlin/exchange.dydx.abacus/state/v2/supervisor/OnboardingSupervisor.kt

@@ -464,7 +464,7 @@ internal class OnboardingSupervisor(
         val payload = withdrawPayloadJson(subaccountNumber)
 
         helper.transaction(
-            TransactionType.simulateWithdraw,
+            TransactionType.SimulateWithdraw,
             payload,
         ) { response ->
             val error = helper.parseTransactionResponse(response)
@@ -495,7 +495,7 @@ internal class OnboardingSupervisor(
         val payload = transferNativeTokenPayloadJson(subaccountNumber)
 
         helper.transaction(
-            TransactionType.simulateTransferNativeToken,
+            TransactionType.SimulateTransferNativeToken,
             payload,
         ) { response ->
             val error = helper.parseTransactionResponse(response)

src/commonMain/kotlin/exchange.dydx.abacus/state/v2/supervisor/SubaccountSupervisor.kt

@@ -8,6 +8,7 @@ import exchange.dydx.abacus.output.input.OrderType
 import exchange.dydx.abacus.output.input.TradeInputGoodUntil
 import exchange.dydx.abacus.output.input.TriggerOrder
 import exchange.dydx.abacus.protocols.AnalyticsEvent
+import exchange.dydx.abacus.protocols.LocalTimerProtocol
 import exchange.dydx.abacus.protocols.ThreadingType
 import exchange.dydx.abacus.protocols.TransactionCallback
 import exchange.dydx.abacus.protocols.TransactionType
@@ -40,6 +41,7 @@ import exchange.dydx.abacus.state.model.TradingStateMachine
 import exchange.dydx.abacus.state.model.TriggerOrdersInputField
 import exchange.dydx.abacus.state.model.closePosition
 import exchange.dydx.abacus.state.model.findOrder
+import exchange.dydx.abacus.state.model.historicalFundings
 import exchange.dydx.abacus.state.model.historicalPnl
 import exchange.dydx.abacus.state.model.orderCanceled
 import exchange.dydx.abacus.state.model.receivedBatchSubaccountsChanges
@@ -54,10 +56,12 @@ import exchange.dydx.abacus.utils.GoodTil
 import exchange.dydx.abacus.utils.IList
 import exchange.dydx.abacus.utils.IMap
 import exchange.dydx.abacus.utils.IMutableList
+import exchange.dydx.abacus.utils.Logger
 import exchange.dydx.abacus.utils.MAX_SUBACCOUNT_NUMBER
 import exchange.dydx.abacus.utils.NUM_PARENT_SUBACCOUNTS
 import exchange.dydx.abacus.utils.ParsingHelper
 import exchange.dydx.abacus.utils.SHORT_TERM_ORDER_DURATION
+import exchange.dydx.abacus.utils.ServerTime
 import exchange.dydx.abacus.utils.iMapOf
 import exchange.dydx.abacus.utils.mutable
 import exchange.dydx.abacus.utils.values
@@ -280,6 +284,8 @@ internal class SubaccountSupervisor(
             channel,
             subaccountChannelParams(accountAddress, subaccountNumber),
         )
+
+        pollReclaimUnutilizedFunds()
     }
 
     private fun subaccountChannelParams(
@@ -1296,6 +1302,79 @@ internal class SubaccountSupervisor(
         }
     }
 
+    /**
+     * @description Loop through all subaccounts to find childSubaccounts that have funds but no open positions or orders. Initiate a transfer to parentSubaccount.
+     */
+    private fun reclaimUnutilizedFundsFromChildSubaccounts() {
+        val subaccounts = stateMachine.state?.account?.subaccounts ?: return
+
+        val subaccountQuoteBalanceMap = subaccounts.mapValues { subaccount ->
+            // If the subaccount is the parentSubaccount, skip
+            if (subaccount.value.subaccountNumber == subaccountNumber) {
+                return@mapValues 0.0
+            }
+
+            val openPositions = subaccount.value.openPositions
+            val openOrders = subaccount.value.orders?.filter { order ->
+                val status = helper.parser.asString(order.status)
+                status == "OPEN"
+            }
+            val quoteBalance = subaccount.value.quoteBalance?.current ?: 0.0
+
+            // Only return a quoteBalance if the subaccount has no open positions or orders
+            if (openPositions.isNullOrEmpty() && openOrders.isNullOrEmpty() && quoteBalance > 0.0) {
+                quoteBalance
+            } else {
+                0.0
+            }
+        }.filter {
+            it.value > 0.0
+        }
+
+        subaccountQuoteBalanceMap.forEach {
+            val childSubaccountNumber = it.key.toInt()
+            val amountToTransfer = it.value.toString()
+
+            val transferPayload = HumanReadableSubaccountTransferPayload(
+                childSubaccountNumber,
+                amountToTransfer,
+                accountAddress,
+                subaccountNumber,
+            )
+
+            val transferPayloadString = Json.encodeToString(transferPayload)
+
+            helper.transaction(TransactionType.ReclaimChildSubaccountFunds, transferPayloadString) { response ->
+                val error = parseTransactionResponse(response)
+                if (error != null) {
+                    Logger.e { "Unutilized funds from $childSubaccountNumber transfer error: $error" }
+                }
+            }
+        }
+    }
+
+    private var reclaimUnutilizedFundsTimer: LocalTimerProtocol? = null
+        set(value) {
+            if (field !== value) {
+                field?.cancel()
+                field = value
+            }
+        }
+
+    private fun pollReclaimUnutilizedFunds() {
+        reclaimUnutilizedFundsTimer = null
+        helper.ioImplementations.threading?.async(ThreadingType.main) {
+            this.reclaimUnutilizedFundsTimer = helper.ioImplementations.timer?.schedule(
+                (10.seconds).inWholeSeconds.toDouble(),
+                null,
+            ) {
+                reclaimUnutilizedFundsFromChildSubaccounts()
+                pollReclaimUnutilizedFunds()
+                false
+            }
+        }
+    }
+
     override fun updateNotifications() {
         val notifications = notificationsProvider.buildNotifications(stateMachine, subaccountNumber)
         consolidateNotifications(notifications)

v4_abacus.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |spec|
     spec.name                     = 'v4_abacus'
-    spec.version                  = '1.6.54'
+    spec.version                  = '1.6.55'
     spec.homepage                 = 'https://github.com/dydxprotocol/v4-abacus'
     spec.source                   = { :http=> ''}
     spec.authors                  = ''