Feature/redeemable alert (#305)

* Redeem alert

* Fix alert view

* Add validations to redeem alert

* Code style

Author: valentunn

app/src/main/java/jp/co/soramitsu/app/root/navigation/Navigator.kt

@@ -50,6 +50,8 @@ import jp.co.soramitsu.feature_staking_impl.presentation.staking.controller.conf
 import jp.co.soramitsu.feature_staking_impl.presentation.staking.main.model.StakingStoryModel
 import jp.co.soramitsu.feature_staking_impl.presentation.staking.rebond.confirm.ConfirmRebondFragment
 import jp.co.soramitsu.feature_staking_impl.presentation.staking.rebond.confirm.ConfirmRebondPayload
+import jp.co.soramitsu.feature_staking_impl.presentation.staking.redeem.RedeemFragment
+import jp.co.soramitsu.feature_staking_impl.presentation.staking.redeem.RedeemPayload
 import jp.co.soramitsu.feature_staking_impl.presentation.staking.rewardDestination.confirm.ConfirmRewardDestinationFragment
 import jp.co.soramitsu.feature_staking_impl.presentation.staking.rewardDestination.confirm.parcel.ConfirmRewardDestinationPayload
 import jp.co.soramitsu.feature_staking_impl.presentation.staking.unbond.confirm.ConfirmUnbondFragment
@@ -218,8 +220,8 @@ class Navigator :
         navController?.navigate(R.id.action_selectUnbondFragment_to_confirmUnbondFragment, ConfirmUnbondFragment.getBundle(payload))
     }
 
-    override fun openRedeem() {
-        navController?.navigate(R.id.action_stakingBalanceFragment_to_redeemFragment)
+    override fun openRedeem(payload: RedeemPayload) {
+        navController?.navigate(R.id.action_open_redeemFragment, RedeemFragment.getBundle(payload))
     }
 
     override fun openConfirmRebond(payload: ConfirmRebondPayload) {

app/src/main/res/navigation/main_nav_graph.xml

@@ -551,13 +551,7 @@
             app:popEnterAnim="@anim/fragment_close_enter"
             app:popExitAnim="@anim/fragment_close_exit" />
 
-        <action
-            android:id="@+id/action_stakingBalanceFragment_to_redeemFragment"
-            app:destination="@id/redeemFragment"
-            app:enterAnim="@anim/fragment_open_enter"
-            app:exitAnim="@anim/fragment_open_exit"
-            app:popEnterAnim="@anim/fragment_close_enter"
-            app:popExitAnim="@anim/fragment_close_exit" />
+
         <action
             android:id="@+id/action_stakingBalanceFragment_to_customRebondFragment"
             app:destination="@id/customRebondFragment"
@@ -637,6 +631,14 @@
         android:name="jp.co.soramitsu.feature_staking_impl.presentation.staking.unbond.confirm.ConfirmUnbondFragment"
         android:label="ConfirmUnbondFragment" />
 
+    <action
+        android:id="@+id/action_open_redeemFragment"
+        app:destination="@id/redeemFragment"
+        app:enterAnim="@anim/fragment_open_enter"
+        app:exitAnim="@anim/fragment_open_exit"
+        app:popEnterAnim="@anim/fragment_close_enter"
+        app:popExitAnim="@anim/fragment_close_exit" />
+
     <fragment
         android:id="@+id/redeemFragment"
         android:name="jp.co.soramitsu.feature_staking_impl.presentation.staking.redeem.RedeemFragment"

common/src/main/res/drawable/ic_warning_filled.xml

@@ -0,0 +1,10 @@
+<vector xmlns:android="http://schemas.android.com/apk/res/android"
+    android:width="16dp"
+    android:height="16dp"
+    android:viewportWidth="16"
+    android:viewportHeight="16">
+  <path
+      android:pathData="M1.12,12.5259L7.1199,2.5C7.4975,1.7988 8.5033,1.7988 8.8809,2.5L14.8809,12.5259C15.2396,13.1921 14.7571,14 14.0004,14H2.0004C1.2437,14 0.7612,13.1921 1.12,12.5259ZM7.0004,5H9.0004V9H7.0004V5ZM9.0004,10.5H7.0004V12.5H9.0004V10.5Z"
+      android:fillColor="#FFD600"
+      android:fillType="evenOdd"/>
+</vector>

common/src/main/res/values/strings.xml

@@ -1,5 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <resources>
+    <string name="staking_alert_redeem_title">Redeem unbonded tokens.</string>
+
     <string name="staking_alert_title">Alerts</string>
     <string name="staking_alert_no_alerts_now">Everything is fine now. Alerts will appear here.</string>
     <string name="staking_alert_start_next_era">Your staking will start in the next era.</string>

feature-staking-impl/src/main/java/jp/co/soramitsu/feature_staking_impl/di/StakingFeatureModule.kt

@@ -30,9 +30,9 @@ import jp.co.soramitsu.feature_staking_impl.data.repository.StakingRewardsReposi
 import jp.co.soramitsu.feature_staking_impl.data.repository.SubscanPagedSynchronizer
 import jp.co.soramitsu.feature_staking_impl.data.repository.datasource.StakingRewardsDataSource
 import jp.co.soramitsu.feature_staking_impl.data.repository.datasource.StakingRewardsSubscanDataSourceImpl
-import jp.co.soramitsu.feature_staking_impl.data.repository.datasource.SubqueryStakingRewardsDataSource
 import jp.co.soramitsu.feature_staking_impl.data.repository.datasource.StakingStoriesDataSource
 import jp.co.soramitsu.feature_staking_impl.data.repository.datasource.StakingStoriesDataSourceImpl
+import jp.co.soramitsu.feature_staking_impl.data.repository.datasource.SubqueryStakingRewardsDataSource
 import jp.co.soramitsu.feature_staking_impl.domain.AlertsInteractor
 import jp.co.soramitsu.feature_staking_impl.domain.StakingInteractor
 import jp.co.soramitsu.feature_staking_impl.domain.payout.PayoutInteractor
@@ -149,9 +149,10 @@ class StakingFeatureModule {
     @FeatureScope
     fun provideAlertsInteractor(
         stakingRepository: StakingRepository,
-        stakingConstantsRepository: StakingConstantsRepository
+        stakingConstantsRepository: StakingConstantsRepository,
+        walletRepository: WalletRepository
     ) = AlertsInteractor(
-        stakingRepository, stakingConstantsRepository
+        stakingRepository, stakingConstantsRepository, walletRepository
     )
 
     @Provides

feature-staking-impl/src/main/java/jp/co/soramitsu/feature_staking_impl/domain/Alert.kt

@@ -1,6 +1,12 @@
 package jp.co.soramitsu.feature_staking_impl.domain
 
+import jp.co.soramitsu.feature_wallet_api.domain.model.Token
+import java.math.BigDecimal
+
 sealed class Alert {
+
+    class RedeemTokens(val amount: BigDecimal, val token: Token) : Alert()
+
     object ChangeValidators : Alert()
 
     object Election : Alert()

feature-staking-impl/src/main/java/jp/co/soramitsu/feature_staking_impl/domain/AlertsInteractor.kt

@@ -6,53 +6,71 @@ import jp.co.soramitsu.feature_staking_api.domain.model.Election
 import jp.co.soramitsu.feature_staking_api.domain.model.Exposure
 import jp.co.soramitsu.feature_staking_api.domain.model.StakingState
 import jp.co.soramitsu.feature_staking_impl.data.repository.StakingConstantsRepository
+import jp.co.soramitsu.feature_wallet_api.domain.interfaces.WalletRepository
+import jp.co.soramitsu.feature_wallet_api.domain.model.Asset
+import jp.co.soramitsu.feature_wallet_api.domain.model.Token
 import kotlinx.coroutines.flow.Flow
 import kotlinx.coroutines.flow.combine
 import kotlinx.coroutines.flow.emitAll
 import kotlinx.coroutines.flow.flow
+import java.math.BigDecimal
 
 class AlertsInteractor(
     private val stakingRepository: StakingRepository,
-    private val stakingConstantsRepository: StakingConstantsRepository
+    private val stakingConstantsRepository: StakingConstantsRepository,
+    private val walletRepository: WalletRepository,
 ) {
 
     class AlertContext(
         val election: Election,
         val exposures: Map<String, Exposure>,
         val stakingState: StakingState,
         val maxRewardedNominatorsPerValidator: Int,
+        val asset: Asset
     )
 
     private fun produceElectionAlert(context: AlertContext): Alert? {
         return if (context.election == Election.OPEN) Alert.Election else null
     }
 
-    private fun produceValidatorsAlert(context: AlertContext): Alert? = requireState(context.stakingState) { stashState: StakingState.Stash ->
-        with(context) {
-            Alert.ChangeValidators.takeUnless {
-                isNominationActive(stashState.stashId, exposures.values, maxRewardedNominatorsPerValidator)
+    private fun produceChangeValidatorsAlert(context: AlertContext): Alert? {
+        return requireState(context.stakingState) { nominatorState: StakingState.Stash.Nominator ->
+            with(context) {
+                Alert.ChangeValidators.takeUnless {
+                    isNominationActive(nominatorState.stashId, exposures.values, maxRewardedNominatorsPerValidator)
+                }
             }
         }
     }
 
+    private fun produceRedeemableAlert(context: AlertContext): Alert? = requireState(context.stakingState) { _: StakingState.Stash ->
+        with(context.asset) {
+            if (redeemable > BigDecimal.ZERO) Alert.RedeemTokens(redeemable, token) else null
+        }
+    }
+
     private val alertProducers = listOf(
         ::produceElectionAlert,
-        ::produceValidatorsAlert
+        ::produceChangeValidatorsAlert,
+        ::produceRedeemableAlert
     )
 
     fun getAlertsFlow(stakingState: StakingState): Flow<List<Alert>> = flow {
         val networkType = stakingState.accountAddress.networkType()
+        val token = Token.Type.fromNetworkType(networkType)
         val maxRewardedNominatorsPerValidator = stakingConstantsRepository.maxRewardedNominatorPerValidator()
 
         val alertsFlow = combine(
             stakingRepository.electionFlow(networkType),
-            stakingRepository.electedExposuresInActiveEra
-        ) { electionStatus, changeValidators ->
+            stakingRepository.electedExposuresInActiveEra,
+            walletRepository.assetFlow(stakingState.accountAddress, token)
+        ) { electionStatus, changeValidators, asset ->
 
-            val context = AlertContext(electionStatus, changeValidators, stakingState, maxRewardedNominatorsPerValidator)
+            val context = AlertContext(electionStatus, changeValidators, stakingState, maxRewardedNominatorsPerValidator, asset)
 
             alertProducers.mapNotNull { it.invoke(context) }
         }
+
         emitAll(alertsFlow)
     }
 

feature-staking-impl/src/main/java/jp/co/soramitsu/feature_staking_impl/presentation/StakingRouter.kt

@@ -6,6 +6,7 @@ import jp.co.soramitsu.feature_staking_impl.presentation.staking.bond.confirm.Co
 import jp.co.soramitsu.feature_staking_impl.presentation.staking.controller.confirm.ConfirmSetControllerPayload
 import jp.co.soramitsu.feature_staking_impl.presentation.staking.main.model.StakingStoryModel
 import jp.co.soramitsu.feature_staking_impl.presentation.staking.rebond.confirm.ConfirmRebondPayload
+import jp.co.soramitsu.feature_staking_impl.presentation.staking.redeem.RedeemPayload
 import jp.co.soramitsu.feature_staking_impl.presentation.staking.rewardDestination.confirm.parcel.ConfirmRewardDestinationPayload
 import jp.co.soramitsu.feature_staking_impl.presentation.staking.unbond.confirm.ConfirmUnbondPayload
 import jp.co.soramitsu.feature_staking_impl.presentation.validators.parcel.ValidatorDetailsParcelModel
@@ -46,7 +47,7 @@ interface StakingRouter {
 
     fun openConfirmUnbond(payload: ConfirmUnbondPayload)
 
-    fun openRedeem()
+    fun openRedeem(payload: RedeemPayload)
 
     fun openConfirmRebond(payload: ConfirmRebondPayload)
 

feature-staking-impl/src/main/java/jp/co/soramitsu/feature_staking_impl/presentation/staking/alerts/AlertsAdapter.kt

@@ -6,11 +6,17 @@ import androidx.recyclerview.widget.DiffUtil
 import androidx.recyclerview.widget.ListAdapter
 import androidx.recyclerview.widget.RecyclerView
 import jp.co.soramitsu.common.utils.inflateChild
+import jp.co.soramitsu.common.utils.makeGone
 import jp.co.soramitsu.common.utils.makeVisible
+import jp.co.soramitsu.common.utils.setVisible
 import jp.co.soramitsu.feature_staking_impl.R
 import jp.co.soramitsu.feature_staking_impl.presentation.staking.alerts.model.AlertModel
 import kotlinx.android.extensions.LayoutContainer
-import kotlinx.android.synthetic.main.item_alert.view.*
+import kotlinx.android.synthetic.main.item_alert.view.alertItemDivider
+import kotlinx.android.synthetic.main.item_alert.view.alertItemGoToFlowIcon
+import kotlinx.android.synthetic.main.item_alert.view.alertItemMessage
+import kotlinx.android.synthetic.main.item_alert.view.alertItemTitle
+import kotlinx.android.synthetic.main.item_alert.view.imageView
 
 class AlertsAdapter : ListAdapter<AlertModel, AlertsAdapter.AlertViewHolder>(AlertDiffCallback()) {
 
@@ -21,21 +27,30 @@ class AlertsAdapter : ListAdapter<AlertModel, AlertsAdapter.AlertViewHolder>(Ale
     }
 
     override fun onBindViewHolder(holder: AlertViewHolder, position: Int) {
+        val isLast = position == itemCount - 1
+
         val item = getItem(position)
 
-        holder.bind(item)
+        holder.bind(item, isLast)
     }
 
     class AlertViewHolder(override val containerView: View) : RecyclerView.ViewHolder(containerView), LayoutContainer {
-        fun bind(alert: AlertModel) = with(containerView) {
+        fun bind(alert: AlertModel, isLast: Boolean) = with(containerView) {
             imageView.setImageResource(alert.icon)
-            alertItemTitle.setText(alert.title)
-            alertItemMessage.setText(alert.extraMessage)
+            alertItemTitle.text = alert.title
+            alertItemMessage.text = alert.extraMessage
 
             if (alert.type is AlertModel.Type.CallToAction) {
                 alertItemGoToFlowIcon.makeVisible()
-                setOnClickListener(alert.type.action)
+
+                setOnClickListener {
+                    alert.type.action()
+                }
+            } else {
+                alertItemGoToFlowIcon.makeGone()
             }
+
+            alertItemDivider.setVisible(isLast.not())
         }
     }
 }

feature-staking-impl/src/main/java/jp/co/soramitsu/feature_staking_impl/presentation/staking/alerts/model/AlertModel.kt

@@ -1,18 +1,16 @@
 package jp.co.soramitsu.feature_staking_impl.presentation.staking.alerts.model
 
-import android.view.View
 import androidx.annotation.DrawableRes
-import androidx.annotation.StringRes
 
 class AlertModel(
     @DrawableRes val icon: Int,
-    @StringRes val title: Int,
-    @StringRes val extraMessage: Int,
+    val title: String,
+    val extraMessage: String,
     val type: Type
 ) {
     sealed class Type {
         object Warning : Type()
 
-        class CallToAction(val action: (View) -> Unit) : Type()
+        class CallToAction(val action: () -> Unit) : Type()
     }
 }