zec
/
zcash-android-wallet
mirror of https://github.com/zcash/zcash-android-wallet.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Fix: Users can now upgrade from seed only wallets without a restore. 

Previously, wallets would crash before launching because only the seed was stored. Now, the wallet works with only viewkeys so these older wallets need to store that value at least once. This does that and also adds troubleshooting code to try and find any similar edge cases and report on whether this work around corrected the issue. For internal use only, of course.
This commit is contained in:
Kevin Gorham 2020-12-19 10:27:12 -05:00
parent 8ab188cdf0
commit b45ced18ba
No known key found for this signature in database
GPG Key ID: CCA55602DF49FC38
2 changed files with 66 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
app/src/main/java/cash/z/ecc/android/ext/Extensions.kt
View File

@ -20,6 +20,14 @@ inline fun <R> tryWithWarning(message: String = "", block: () -> R): R? {
}
}
inline fun <E : Throwable, R> failWith(specificErrorType: E, block: () -> R): R {
return try {
block()
} catch (error: Throwable) {
throw specificErrorType
}
}
inline fun Fragment.locale(): Locale = context?.locale() ?: Locale.getDefault()
inline fun Context.locale(): Locale {

65
app/src/main/java/cash/z/ecc/android/ui/setup/WalletSetupViewModel.kt
View File

@ -1,9 +1,12 @@
package cash.z.ecc.android.ui.setup
import android.content.Context
import androidx.lifecycle.ViewModel
import cash.z.ecc.android.ZcashWalletApp
import cash.z.ecc.android.ext.Const
import cash.z.ecc.android.ext.failWith
import cash.z.ecc.android.feedback.Feedback
import cash.z.ecc.android.feedback.Report
import cash.z.ecc.android.lockbox.LockBox
import cash.z.ecc.android.sdk.Initializer
import cash.z.ecc.android.sdk.exception.InitializerException
@ -12,6 +15,7 @@ import cash.z.ecc.android.sdk.tool.DerivationTool
import cash.z.ecc.android.sdk.tool.WalletBirthdayTool
import cash.z.ecc.android.ui.setup.WalletSetupViewModel.WalletSetupState.*
import cash.z.ecc.kotlin.mnemonic.Mnemonics
import com.bugsnag.android.Bugsnag
import kotlinx.coroutines.Dispatchers.IO
import kotlinx.coroutines.flow.Flow
import kotlinx.coroutines.flow.flow
@ -78,16 +82,60 @@ class WalletSetupViewModel @Inject constructor() : ViewModel() {
return ZcashWalletApp.component.initializerSubcomponent().create(config).initializer()
}
private fun loadConfig() = Initializer.Builder { builder ->
/**
* Build a config object by loading in the viewingKey, birthday and server info which is already
* known by this point.
*/
private suspend fun loadConfig(): Initializer.Config {
val vk = lockBox.getCharsUtf8(Const.Backup.VIEWING_KEY)?.let { String(it) }
?: throw InitializerException.MissingViewingKeyException
val birthdayHeight = loadBirthdayHeight()
?: throw InitializerException.MissingBirthdayException
?: onMissingViewingKey()
val birthdayHeight = loadBirthdayHeight() ?: onMissingBirthday()
val host = prefs[Const.Pref.SERVER_HOST] ?: Const.Default.Server.HOST
val port = prefs[Const.Pref.SERVER_PORT] ?: Const.Default.Server.PORT
builder.import(vk, birthdayHeight, host, port)
return Initializer.Config { it.importWallet(vk, birthdayHeight, host, port) }
}
// TODO: delete this function in the next release
private suspend fun onMissingViewingKey(): String {
// add some temporary logic to help us troubleshoot this problem.
ZcashWalletApp.instance.getSharedPreferences("SecurePreferences", Context.MODE_PRIVATE)
.all.map { it.key }.joinToString().let { keyNames ->
Const.Backup.VIEWING_KEY.let { missingKey ->
// is there a typo or change in how the value is labelled?
Bugsnag.leaveBreadcrumb("$missingKey not found in keySet: $keyNames")
// for troubleshooting purposes, let's see if we CAN derive the vk from the seed in these situations
var recoveryViewingKey: String? = null
var ableToLoadSeed = false
try {
val seed = lockBox.getBytes(Const.Backup.SEED)!!
ableToLoadSeed = true
recoveryViewingKey = DerivationTool.deriveViewingKeys(seed)[0]
} catch (t: Throwable) {
Bugsnag.leaveBreadcrumb("Failed while trying to recover VK due to: $t")
}
// this will happen during rare upgrade scenarios when the user migrates from a seed-only wallet to this vk-based version
if (recoveryViewingKey != null) {
storeViewingKey(recoveryViewingKey)
return recoveryViewingKey
} else {
feedback.report(
Report.Issue.MissingViewkey(
ableToLoadSeed,
missingKey,
keyNames,
lockBox.getCharsUtf8(Const.Backup.VIEWING_KEY) != null
)
)
}
throw InitializerException.MissingViewingKeyException
}
}
}
private fun onMissingBirthday(): Int = failWith(InitializerException.MissingBirthdayException) {
loadNearestBirthday().height
}
private fun loadNearestBirthday(birthdayHeight: Int? = null) =
@ -104,7 +152,10 @@ class WalletSetupViewModel @Inject constructor() : ViewModel() {
* primarily only work with the viewing key and spending key. The seed is only accessed when
* presenting backup information to the user.
*/
private suspend fun storeWallet(seedPhraseChars: CharArray, birthday: WalletBirthdayTool.WalletBirthday) {
private suspend fun storeWallet(
seedPhraseChars: CharArray,
birthday: WalletBirthdayTool.WalletBirthday
) {
check(!lockBox.getBoolean(Const.Backup.HAS_SEED)) {
"Error! Cannot store a seed when one already exists! This would overwrite the" +
" existing seed and could lead to a loss of funds if the user has no backup!"