713 lines
28 KiB
Kotlin
713 lines
28 KiB
Kotlin
package cash.z.ecc.android.sdk
|
|
|
|
import android.content.Context
|
|
import cash.z.ecc.android.sdk.Synchronizer.Status.DISCONNECTED
|
|
import cash.z.ecc.android.sdk.Synchronizer.Status.ENHANCING
|
|
import cash.z.ecc.android.sdk.Synchronizer.Status.STOPPED
|
|
import cash.z.ecc.android.sdk.Synchronizer.Status.SYNCED
|
|
import cash.z.ecc.android.sdk.Synchronizer.Status.SYNCING
|
|
import cash.z.ecc.android.sdk.block.CompactBlockProcessor
|
|
import cash.z.ecc.android.sdk.block.CompactBlockProcessor.State.Disconnected
|
|
import cash.z.ecc.android.sdk.block.CompactBlockProcessor.State.Enhancing
|
|
import cash.z.ecc.android.sdk.block.CompactBlockProcessor.State.Initialized
|
|
import cash.z.ecc.android.sdk.block.CompactBlockProcessor.State.Stopped
|
|
import cash.z.ecc.android.sdk.block.CompactBlockProcessor.State.Synced
|
|
import cash.z.ecc.android.sdk.block.CompactBlockProcessor.State.Syncing
|
|
import cash.z.ecc.android.sdk.exception.TransactionEncoderException
|
|
import cash.z.ecc.android.sdk.exception.TransactionSubmitException
|
|
import cash.z.ecc.android.sdk.ext.ConsensusBranchId
|
|
import cash.z.ecc.android.sdk.ext.ZcashSdk
|
|
import cash.z.ecc.android.sdk.internal.Backend
|
|
import cash.z.ecc.android.sdk.internal.SaplingParamTool
|
|
import cash.z.ecc.android.sdk.internal.Twig
|
|
import cash.z.ecc.android.sdk.internal.block.CompactBlockDownloader
|
|
import cash.z.ecc.android.sdk.internal.db.DatabaseCoordinator
|
|
import cash.z.ecc.android.sdk.internal.db.derived.DbDerivedDataRepository
|
|
import cash.z.ecc.android.sdk.internal.db.derived.DerivedDataDb
|
|
import cash.z.ecc.android.sdk.internal.ext.isNullOrEmpty
|
|
import cash.z.ecc.android.sdk.internal.ext.toHexReversed
|
|
import cash.z.ecc.android.sdk.internal.ext.tryNull
|
|
import cash.z.ecc.android.sdk.internal.jni.RustBackend
|
|
import cash.z.ecc.android.sdk.internal.model.Checkpoint
|
|
import cash.z.ecc.android.sdk.internal.repository.CompactBlockRepository
|
|
import cash.z.ecc.android.sdk.internal.repository.DerivedDataRepository
|
|
import cash.z.ecc.android.sdk.internal.storage.block.FileCompactBlockRepository
|
|
import cash.z.ecc.android.sdk.internal.transaction.OutboundTransactionManager
|
|
import cash.z.ecc.android.sdk.internal.transaction.OutboundTransactionManagerImpl
|
|
import cash.z.ecc.android.sdk.internal.transaction.TransactionEncoder
|
|
import cash.z.ecc.android.sdk.internal.transaction.TransactionEncoderImpl
|
|
import cash.z.ecc.android.sdk.model.Account
|
|
import cash.z.ecc.android.sdk.model.BlockHeight
|
|
import cash.z.ecc.android.sdk.model.PercentDecimal
|
|
import cash.z.ecc.android.sdk.model.TransactionOverview
|
|
import cash.z.ecc.android.sdk.model.TransactionRecipient
|
|
import cash.z.ecc.android.sdk.model.UnifiedFullViewingKey
|
|
import cash.z.ecc.android.sdk.model.UnifiedSpendingKey
|
|
import cash.z.ecc.android.sdk.model.WalletBalance
|
|
import cash.z.ecc.android.sdk.model.Zatoshi
|
|
import cash.z.ecc.android.sdk.model.ZcashNetwork
|
|
import cash.z.ecc.android.sdk.type.AddressType
|
|
import cash.z.ecc.android.sdk.type.AddressType.Shielded
|
|
import cash.z.ecc.android.sdk.type.AddressType.Transparent
|
|
import cash.z.ecc.android.sdk.type.AddressType.Unified
|
|
import cash.z.ecc.android.sdk.type.ConsensusMatchType
|
|
import co.electriccoin.lightwallet.client.LightWalletClient
|
|
import co.electriccoin.lightwallet.client.model.LightWalletEndpoint
|
|
import co.electriccoin.lightwallet.client.new
|
|
import kotlinx.coroutines.CoroutineExceptionHandler
|
|
import kotlinx.coroutines.CoroutineScope
|
|
import kotlinx.coroutines.Dispatchers
|
|
import kotlinx.coroutines.Job
|
|
import kotlinx.coroutines.SupervisorJob
|
|
import kotlinx.coroutines.cancel
|
|
import kotlinx.coroutines.flow.Flow
|
|
import kotlinx.coroutines.flow.MutableStateFlow
|
|
import kotlinx.coroutines.flow.StateFlow
|
|
import kotlinx.coroutines.flow.asStateFlow
|
|
import kotlinx.coroutines.flow.combine
|
|
import kotlinx.coroutines.flow.filterNotNull
|
|
import kotlinx.coroutines.flow.launchIn
|
|
import kotlinx.coroutines.flow.map
|
|
import kotlinx.coroutines.flow.onEach
|
|
import kotlinx.coroutines.launch
|
|
import java.io.File
|
|
import java.util.concurrent.ConcurrentHashMap
|
|
import kotlin.coroutines.CoroutineContext
|
|
|
|
/**
|
|
* A Synchronizer that attempts to remain operational, despite any number of errors that can occur.
|
|
* It acts as the glue that ties all the pieces of the SDK together. Each component of the SDK is
|
|
* designed for the potential of stand-alone usage but coordinating all the interactions is non-
|
|
* trivial. So the Synchronizer facilitates this, acting as reference that demonstrates how all the
|
|
* pieces can be tied together. Its goal is to allow a developer to focus on their app rather than
|
|
* the nuances of how Zcash works.
|
|
*
|
|
* @property synchronizerKey Identifies the synchronizer's on-disk state
|
|
* @property storage exposes flows of wallet transaction information.
|
|
* @property txManager manages and tracks outbound transactions.
|
|
* @property processor saves the downloaded compact blocks to the cache and then scans those blocks for
|
|
* data related to this wallet.
|
|
*/
|
|
@Suppress("TooManyFunctions")
|
|
class SdkSynchronizer private constructor(
|
|
private val synchronizerKey: SynchronizerKey,
|
|
private val storage: DerivedDataRepository,
|
|
private val txManager: OutboundTransactionManager,
|
|
val processor: CompactBlockProcessor,
|
|
private val backend: Backend
|
|
) : CloseableSynchronizer {
|
|
|
|
companion object {
|
|
private sealed class InstanceState {
|
|
object Active : InstanceState()
|
|
data class ShuttingDown(val job: Job) : InstanceState()
|
|
}
|
|
|
|
private val instances: MutableMap<SynchronizerKey, InstanceState> =
|
|
ConcurrentHashMap<SynchronizerKey, InstanceState>()
|
|
|
|
/**
|
|
* @throws IllegalStateException If multiple instances of synchronizer with the same network+alias are
|
|
* active at the same time. Call `close` to finish one synchronizer before starting another one with the same
|
|
* network+alias.
|
|
*/
|
|
@Suppress("LongParameterList")
|
|
internal suspend fun new(
|
|
zcashNetwork: ZcashNetwork,
|
|
alias: String,
|
|
repository: DerivedDataRepository,
|
|
txManager: OutboundTransactionManager,
|
|
processor: CompactBlockProcessor,
|
|
backend: Backend
|
|
): CloseableSynchronizer {
|
|
val synchronizerKey = SynchronizerKey(zcashNetwork, alias)
|
|
|
|
waitForShutdown(synchronizerKey)
|
|
checkForExistingSynchronizers(synchronizerKey)
|
|
|
|
return SdkSynchronizer(
|
|
synchronizerKey,
|
|
repository,
|
|
txManager,
|
|
processor,
|
|
backend
|
|
).apply {
|
|
instances[synchronizerKey] = InstanceState.Active
|
|
|
|
start()
|
|
}
|
|
}
|
|
|
|
private suspend fun waitForShutdown(synchronizerKey: SynchronizerKey) {
|
|
instances[synchronizerKey]?.let {
|
|
if (it is InstanceState.ShuttingDown) {
|
|
Twig.debug { "Waiting for prior synchronizer instance to shut down" } // $NON-NLS-1$
|
|
it.job.join()
|
|
}
|
|
}
|
|
}
|
|
|
|
private fun checkForExistingSynchronizers(synchronizerKey: SynchronizerKey) {
|
|
check(!instances.containsKey(synchronizerKey)) {
|
|
"Another synchronizer with $synchronizerKey is currently active" // $NON-NLS-1$
|
|
}
|
|
}
|
|
|
|
internal suspend fun erase(
|
|
appContext: Context,
|
|
network: ZcashNetwork,
|
|
alias: String
|
|
): Boolean {
|
|
val key = SynchronizerKey(network, alias)
|
|
|
|
waitForShutdown(key)
|
|
checkForExistingSynchronizers(key)
|
|
|
|
return DatabaseCoordinator.getInstance(appContext).deleteDatabases(network, alias)
|
|
}
|
|
}
|
|
|
|
// pools
|
|
private val _orchardBalances = MutableStateFlow<WalletBalance?>(null)
|
|
private val _saplingBalances = MutableStateFlow<WalletBalance?>(null)
|
|
private val _transparentBalances = MutableStateFlow<WalletBalance?>(null)
|
|
|
|
private val _status = MutableStateFlow<Synchronizer.Status>(DISCONNECTED)
|
|
|
|
var coroutineScope: CoroutineScope = CoroutineScope(SupervisorJob() + Dispatchers.Main)
|
|
|
|
override val orchardBalances = _orchardBalances.asStateFlow()
|
|
override val saplingBalances = _saplingBalances.asStateFlow()
|
|
override val transparentBalances = _transparentBalances.asStateFlow()
|
|
override val transactions
|
|
get() = combine(processor.networkHeight, storage.allTransactions) { networkHeight, allTransactions ->
|
|
val latestBlockHeight = networkHeight ?: storage.lastScannedHeight()
|
|
allTransactions.map { TransactionOverview.new(it, latestBlockHeight) }
|
|
}
|
|
|
|
override val network: ZcashNetwork get() = processor.network
|
|
|
|
/**
|
|
* Indicates the status of this Synchronizer. This implementation basically simplifies the
|
|
* status of the processor to focus only on the high level states that matter most. Whenever the
|
|
* processor is finished scanning, the synchronizer updates transaction and balance info and
|
|
* then emits a [SYNCED] status.
|
|
*/
|
|
override val status = _status.asStateFlow()
|
|
|
|
/**
|
|
* Indicates the download progress of the Synchronizer. When progress reaches `PercentDecimal.ONE_HUNDRED_PERCENT`,
|
|
* that signals that the Synchronizer is in sync with the network. Balances should be considered
|
|
* inaccurate and outbound transactions should be prevented until this sync is complete. It is
|
|
* a simplified version of [processorInfo].
|
|
*/
|
|
override val progress: Flow<PercentDecimal> = processor.progress
|
|
|
|
/**
|
|
* Indicates the latest information about the blocks that have been processed by the SDK. This
|
|
* is very helpful for conveying detailed progress and status to the user.
|
|
*/
|
|
override val processorInfo: Flow<CompactBlockProcessor.ProcessorInfo> = processor.processorInfo
|
|
|
|
/**
|
|
* The latest height seen on the network while processing blocks. This may differ from the
|
|
* latest height scanned and is useful for determining block confirmations and expiration.
|
|
*/
|
|
override val networkHeight: StateFlow<BlockHeight?> = processor.networkHeight
|
|
|
|
//
|
|
// Error Handling
|
|
//
|
|
|
|
/**
|
|
* A callback to invoke whenever an uncaught error is encountered. By definition, the return
|
|
* value of the function is ignored because this error is unrecoverable. The only reason the
|
|
* function has a return value is so that all error handlers work with the same signature which
|
|
* allows one function to handle all errors in simple apps. This callback is not called on the
|
|
* main thread so any UI work would need to switch context to the main thread.
|
|
*/
|
|
override var onCriticalErrorHandler: ((Throwable?) -> Boolean)? = null
|
|
|
|
/**
|
|
* A callback to invoke whenever a processor error is encountered. Returning true signals that
|
|
* the error was handled and a retry attempt should be made, if possible. This callback is not
|
|
* called on the main thread so any UI work would need to switch context to the main thread.
|
|
*/
|
|
override var onProcessorErrorHandler: ((Throwable?) -> Boolean)? = null
|
|
|
|
/**
|
|
* A callback to invoke whenever a server error is encountered while submitting a transaction to
|
|
* lightwalletd. Returning true signals that the error was handled and a retry attempt should be
|
|
* made, if possible. This callback is not called on the main thread so any UI work would need
|
|
* to switch context to the main thread.
|
|
*/
|
|
override var onSubmissionErrorHandler: ((Throwable?) -> Boolean)? = null
|
|
|
|
/**
|
|
* A callback to invoke whenever a processor is not setup correctly. Returning true signals that
|
|
* the invalid setup should be ignored. If no handler is set, then any setup error will result
|
|
* in a critical error. This callback is not called on the main thread so any UI work would need
|
|
* to switch context to the main thread.
|
|
*/
|
|
override var onSetupErrorHandler: ((Throwable?) -> Boolean)? = null
|
|
|
|
/**
|
|
* A callback to invoke whenever a chain error is encountered. These occur whenever the
|
|
* processor detects a missing or non-chain-sequential block (i.e. a reorg).
|
|
*/
|
|
override var onChainErrorHandler: ((errorHeight: BlockHeight, rewindHeight: BlockHeight) -> Any)? = null
|
|
|
|
//
|
|
// Public API
|
|
//
|
|
|
|
/**
|
|
* Convenience function for the latest height. Specifically, this value represents the last
|
|
* height that the synchronizer has observed from the lightwalletd server. Instead of using
|
|
* this, a wallet will more likely want to consume the flow of processor info using
|
|
* [processorInfo].
|
|
*/
|
|
override val latestHeight
|
|
get() = processor.processorInfo.value.networkBlockHeight
|
|
|
|
override val latestBirthdayHeight
|
|
get() = processor.birthdayHeight
|
|
|
|
internal fun start() {
|
|
coroutineScope.onReady()
|
|
}
|
|
|
|
override fun close() {
|
|
// Note that stopping will continue asynchronously. Race conditions with starting a new synchronizer are
|
|
// avoided with a delay during startup.
|
|
|
|
val shutdownJob = coroutineScope.launch {
|
|
Twig.debug { "Stopping synchronizer $synchronizerKey…" }
|
|
processor.stop()
|
|
storage.close()
|
|
}
|
|
|
|
instances[synchronizerKey] = InstanceState.ShuttingDown(shutdownJob)
|
|
|
|
shutdownJob.invokeOnCompletion {
|
|
coroutineScope.cancel()
|
|
_status.value = STOPPED
|
|
Twig.debug { "Synchronizer $synchronizerKey stopped" }
|
|
|
|
instances.remove(synchronizerKey)
|
|
}
|
|
}
|
|
|
|
override suspend fun getNearestRewindHeight(height: BlockHeight): BlockHeight =
|
|
processor.getNearestRewindHeight(height)
|
|
|
|
override suspend fun rewindToNearestHeight(height: BlockHeight, alsoClearBlockCache: Boolean) {
|
|
processor.rewindToNearestHeight(height, alsoClearBlockCache)
|
|
}
|
|
|
|
override suspend fun quickRewind() {
|
|
processor.quickRewind()
|
|
}
|
|
|
|
override fun getMemos(transactionOverview: TransactionOverview): Flow<String> {
|
|
return storage.getNoteIds(transactionOverview.id).map {
|
|
when (transactionOverview.isSentTransaction) {
|
|
true -> {
|
|
backend.getSentMemoAsUtf8(it)
|
|
}
|
|
false -> {
|
|
backend.getReceivedMemoAsUtf8(it)
|
|
}
|
|
}
|
|
}.filterNotNull()
|
|
}
|
|
|
|
override fun getRecipients(transactionOverview: TransactionOverview): Flow<TransactionRecipient> {
|
|
require(transactionOverview.isSentTransaction) { "Recipients can only be queried for sent transactions" }
|
|
|
|
return storage.getRecipients(transactionOverview.id)
|
|
}
|
|
|
|
//
|
|
// Storage APIs
|
|
//
|
|
|
|
// TODO [#682]: turn this section into the data access API. For now, just aggregate all the things that we want
|
|
// to do with the underlying data
|
|
// TODO [#682]: https://github.com/zcash/zcash-android-wallet-sdk/issues/682
|
|
|
|
suspend fun findBlockHash(height: BlockHeight): ByteArray? {
|
|
return storage.findBlockHash(height)
|
|
}
|
|
|
|
suspend fun findBlockHashAsHex(height: BlockHeight): String? {
|
|
return findBlockHash(height)?.toHexReversed()
|
|
}
|
|
|
|
suspend fun getTransactionCount(): Int {
|
|
return storage.getTransactionCount().toInt()
|
|
}
|
|
|
|
fun refreshTransactions() {
|
|
storage.invalidate()
|
|
}
|
|
|
|
//
|
|
// Private API
|
|
//
|
|
|
|
/**
|
|
* Calculate the latest balance, based on the blocks that have been scanned and transmit this
|
|
* information into the flow of [balances].
|
|
*/
|
|
suspend fun refreshAllBalances() {
|
|
refreshSaplingBalance()
|
|
refreshTransparentBalance()
|
|
// TODO [#682]: refresh orchard balance
|
|
// TODO [#682]: https://github.com/zcash/zcash-android-wallet-sdk/issues/682
|
|
Twig.warn { "Warning: Orchard balance does not yet refresh. Only some of the plumbing is in place." }
|
|
}
|
|
|
|
suspend fun refreshSaplingBalance() {
|
|
Twig.debug { "refreshing sapling balance" }
|
|
_saplingBalances.value = processor.getBalanceInfo(Account.DEFAULT)
|
|
}
|
|
|
|
suspend fun refreshTransparentBalance() {
|
|
Twig.debug { "refreshing transparent balance" }
|
|
_transparentBalances.value = processor.getUtxoCacheBalance(getTransparentAddress())
|
|
}
|
|
|
|
suspend fun isValidAddress(address: String): Boolean {
|
|
return !validateAddress(address).isNotValid
|
|
}
|
|
|
|
private fun CoroutineScope.onReady() {
|
|
Twig.debug { "Starting synchronizer…" }
|
|
|
|
// Triggering UTXOs fetch and transparent balance update at the beginning of the block sync right after the app
|
|
// start, as it makes the transparent transactions appearance faster
|
|
launch(CoroutineExceptionHandler(::onCriticalError)) {
|
|
refreshUtxos()
|
|
refreshTransparentBalance()
|
|
refreshTransactions()
|
|
}
|
|
|
|
launch(CoroutineExceptionHandler(::onCriticalError)) {
|
|
var lastScanTime = 0L
|
|
processor.onProcessorErrorListener = ::onProcessorError
|
|
processor.onSetupErrorListener = ::onSetupError
|
|
processor.onChainErrorListener = ::onChainError
|
|
processor.state.onEach {
|
|
when (it) {
|
|
is Synced -> {
|
|
val now = System.currentTimeMillis()
|
|
// do a bit of housekeeping and then report synced status
|
|
onScanComplete(it.syncedRange, now - lastScanTime)
|
|
lastScanTime = now
|
|
SYNCED
|
|
}
|
|
is Stopped -> STOPPED
|
|
is Disconnected -> DISCONNECTED
|
|
is Syncing, Initialized -> SYNCING
|
|
is Enhancing -> ENHANCING
|
|
}.let { synchronizerStatus ->
|
|
// ignore enhancing status for now
|
|
// TODO [#682]: clean this up and handle enhancing gracefully
|
|
// TODO [#682]: https://github.com/zcash/zcash-android-wallet-sdk/issues/682
|
|
if (synchronizerStatus != ENHANCING) _status.value = synchronizerStatus
|
|
}
|
|
}.launchIn(this)
|
|
processor.start()
|
|
Twig.debug { "Completed starting synchronizer" }
|
|
}
|
|
}
|
|
|
|
@Suppress("UNUSED_PARAMETER")
|
|
private fun onCriticalError(unused: CoroutineContext?, error: Throwable) {
|
|
Twig.error(error) { "Critical error occurred" }
|
|
|
|
if (onCriticalErrorHandler == null) {
|
|
Twig.debug {
|
|
"WARNING: a critical error occurred but no callback is registered to be notified " +
|
|
"of critical errors! THIS IS PROBABLY A MISTAKE. To respond to these " +
|
|
"errors (perhaps to update the UI or alert the user) set " +
|
|
"synchronizer.onCriticalErrorHandler to a non-null value."
|
|
}
|
|
|
|
onCriticalErrorHandler?.invoke(error)
|
|
}
|
|
}
|
|
|
|
private fun onProcessorError(error: Throwable): Boolean {
|
|
Twig.debug { "ERROR while processing data: $error" }
|
|
if (onProcessorErrorHandler == null) {
|
|
Twig.debug {
|
|
"WARNING: falling back to the default behavior for processor errors. To add" +
|
|
" custom behavior, set synchronizer.onProcessorErrorHandler to" +
|
|
" a non-null value"
|
|
}
|
|
return true
|
|
}
|
|
return onProcessorErrorHandler?.invoke(error)?.also {
|
|
Twig.debug {
|
|
"processor error handler signaled that we should " +
|
|
"${if (it) "try again" else "abort"}!"
|
|
}
|
|
} == true
|
|
}
|
|
|
|
private fun onSetupError(error: Throwable): Boolean {
|
|
if (onSetupErrorHandler == null) {
|
|
Twig.debug {
|
|
"WARNING: falling back to the default behavior for setup errors. To add custom" +
|
|
" behavior, set synchronizer.onSetupErrorHandler to a non-null value"
|
|
}
|
|
return false
|
|
}
|
|
return onSetupErrorHandler?.invoke(error) == true
|
|
}
|
|
|
|
private fun onChainError(errorHeight: BlockHeight, rewindHeight: BlockHeight) {
|
|
Twig.debug { "Chain error detected at height: $errorHeight. Rewinding to: $rewindHeight" }
|
|
if (onChainErrorHandler == null) {
|
|
Twig.debug {
|
|
"WARNING: a chain error occurred but no callback is registered to be notified of " +
|
|
"chain errors. To respond to these errors (perhaps to update the UI or alert the" +
|
|
" user) set synchronizer.onChainErrorHandler to a non-null value"
|
|
}
|
|
}
|
|
onChainErrorHandler?.invoke(errorHeight, rewindHeight)
|
|
}
|
|
|
|
/**
|
|
* @param elapsedMillis the amount of time that passed since the last scan
|
|
*/
|
|
private suspend fun onScanComplete(scannedRange: ClosedRange<BlockHeight>?, elapsedMillis: Long) {
|
|
// We don't need to update anything if there have been no blocks
|
|
// refresh anyway if:
|
|
// - if it's the first time we finished scanning
|
|
// - if we check for blocks 5 times and find nothing was mined
|
|
@Suppress("MagicNumber")
|
|
val shouldRefresh = !scannedRange.isNullOrEmpty() || elapsedMillis > (ZcashSdk.POLL_INTERVAL * 5)
|
|
val reason = if (scannedRange.isNullOrEmpty()) "it's been a while" else "new blocks were scanned"
|
|
|
|
if (shouldRefresh) {
|
|
Twig.debug { "Triggering utxo refresh since $reason!" }
|
|
refreshUtxos()
|
|
|
|
Twig.debug { "Triggering balance refresh since $reason!" }
|
|
refreshAllBalances()
|
|
|
|
Twig.debug { "Triggering transaction refresh since $reason!" }
|
|
refreshTransactions()
|
|
}
|
|
}
|
|
|
|
//
|
|
// Account management
|
|
//
|
|
|
|
// Not ready to be a public API; internal for testing only
|
|
internal suspend fun createAccount(seed: ByteArray): UnifiedSpendingKey =
|
|
CompactBlockProcessor.createAccount(backend, seed)
|
|
|
|
/**
|
|
* Returns the current Unified Address for this account.
|
|
*/
|
|
override suspend fun getUnifiedAddress(account: Account): String =
|
|
CompactBlockProcessor.getCurrentAddress(backend, account)
|
|
|
|
/**
|
|
* Returns the legacy Sapling address corresponding to the current Unified Address for this account.
|
|
*/
|
|
override suspend fun getSaplingAddress(account: Account): String =
|
|
CompactBlockProcessor.getLegacySaplingAddress(backend, account)
|
|
|
|
/**
|
|
* Returns the legacy transparent address corresponding to the current Unified Address for this account.
|
|
*/
|
|
override suspend fun getTransparentAddress(account: Account): String =
|
|
CompactBlockProcessor.getTransparentAddress(backend, account)
|
|
|
|
@Throws(TransactionEncoderException::class, TransactionSubmitException::class)
|
|
override suspend fun sendToAddress(
|
|
usk: UnifiedSpendingKey,
|
|
amount: Zatoshi,
|
|
toAddress: String,
|
|
memo: String
|
|
): Long {
|
|
val encodedTx = txManager.encode(
|
|
usk,
|
|
amount,
|
|
TransactionRecipient.Address(toAddress),
|
|
memo,
|
|
usk.account
|
|
)
|
|
|
|
if (txManager.submit(encodedTx)) {
|
|
return storage.findMatchingTransactionId(encodedTx.txId.byteArray)!!
|
|
} else {
|
|
throw TransactionSubmitException()
|
|
}
|
|
}
|
|
|
|
@Throws(TransactionEncoderException::class, TransactionSubmitException::class)
|
|
override suspend fun shieldFunds(
|
|
usk: UnifiedSpendingKey,
|
|
memo: String
|
|
): Long {
|
|
Twig.debug { "Initializing shielding transaction" }
|
|
val tAddr = CompactBlockProcessor.getTransparentAddress(backend, usk.account)
|
|
val tBalance = processor.getUtxoCacheBalance(tAddr)
|
|
|
|
val encodedTx = txManager.encode(
|
|
usk,
|
|
tBalance.available,
|
|
TransactionRecipient.Account(usk.account),
|
|
memo,
|
|
usk.account
|
|
)
|
|
|
|
if (txManager.submit(encodedTx)) {
|
|
return storage.findMatchingTransactionId(encodedTx.txId.byteArray)!!
|
|
} else {
|
|
throw TransactionSubmitException()
|
|
}
|
|
}
|
|
|
|
override suspend fun refreshUtxos(account: Account, since: BlockHeight): Int {
|
|
return processor.refreshUtxos(account, since)
|
|
}
|
|
|
|
override suspend fun getTransparentBalance(tAddr: String): WalletBalance {
|
|
return processor.getUtxoCacheBalance(tAddr)
|
|
}
|
|
|
|
override suspend fun isValidShieldedAddr(address: String) =
|
|
txManager.isValidShieldedAddress(address)
|
|
|
|
override suspend fun isValidTransparentAddr(address: String) =
|
|
txManager.isValidTransparentAddress(address)
|
|
|
|
override suspend fun isValidUnifiedAddr(address: String) =
|
|
txManager.isValidUnifiedAddress(address)
|
|
|
|
override suspend fun validateAddress(address: String): AddressType {
|
|
@Suppress("TooGenericExceptionCaught")
|
|
return try {
|
|
if (isValidShieldedAddr(address)) {
|
|
Shielded
|
|
} else if (isValidTransparentAddr(address)) {
|
|
Transparent
|
|
} else if (isValidUnifiedAddr(address)) {
|
|
Unified
|
|
} else {
|
|
AddressType.Invalid("Not a Zcash address")
|
|
}
|
|
} catch (@Suppress("TooGenericExceptionCaught") error: Throwable) {
|
|
AddressType.Invalid(error.message ?: "Invalid")
|
|
}
|
|
}
|
|
|
|
override suspend fun validateConsensusBranch(): ConsensusMatchType {
|
|
val serverBranchId = tryNull { processor.downloader.getServerInfo()?.consensusBranchId }
|
|
val sdkBranchId = tryNull {
|
|
(txManager as OutboundTransactionManagerImpl).encoder.getConsensusBranchId()
|
|
}
|
|
return ConsensusMatchType(
|
|
sdkBranchId?.let { ConsensusBranchId.fromId(it) },
|
|
serverBranchId?.let { ConsensusBranchId.fromHex(it) }
|
|
)
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Provides a way of constructing a synchronizer where dependencies are injected in.
|
|
*
|
|
* See the helper methods for generating default values.
|
|
*/
|
|
internal object DefaultSynchronizerFactory {
|
|
|
|
internal suspend fun defaultBackend(
|
|
network: ZcashNetwork,
|
|
alias: String,
|
|
saplingParamTool: SaplingParamTool,
|
|
coordinator: DatabaseCoordinator
|
|
): Backend {
|
|
return RustBackend.new(
|
|
coordinator.fsBlockDbRoot(network, alias),
|
|
coordinator.dataDbFile(network, alias),
|
|
saplingOutputFile = saplingParamTool.outputParamsFile,
|
|
saplingSpendFile = saplingParamTool.spendParamsFile,
|
|
zcashNetworkId = network.id
|
|
)
|
|
}
|
|
|
|
@Suppress("LongParameterList")
|
|
internal suspend fun defaultDerivedDataRepository(
|
|
context: Context,
|
|
rustBackend: Backend,
|
|
databaseFile: File,
|
|
zcashNetwork: ZcashNetwork,
|
|
checkpoint: Checkpoint,
|
|
seed: ByteArray?,
|
|
viewingKeys: List<UnifiedFullViewingKey>
|
|
): DerivedDataRepository =
|
|
DbDerivedDataRepository(
|
|
DerivedDataDb.new(
|
|
context,
|
|
rustBackend,
|
|
databaseFile,
|
|
zcashNetwork,
|
|
checkpoint,
|
|
seed,
|
|
viewingKeys
|
|
)
|
|
)
|
|
|
|
internal suspend fun defaultCompactBlockRepository(blockCacheRoot: File, backend: Backend): CompactBlockRepository =
|
|
FileCompactBlockRepository.new(
|
|
blockCacheRoot,
|
|
backend
|
|
)
|
|
|
|
fun defaultService(context: Context, lightWalletEndpoint: LightWalletEndpoint): LightWalletClient =
|
|
LightWalletClient.new(context, lightWalletEndpoint)
|
|
|
|
internal fun defaultEncoder(
|
|
backend: Backend,
|
|
saplingParamTool: SaplingParamTool,
|
|
repository: DerivedDataRepository
|
|
): TransactionEncoder = TransactionEncoderImpl(backend, saplingParamTool, repository)
|
|
|
|
fun defaultDownloader(
|
|
service: LightWalletClient,
|
|
blockStore: CompactBlockRepository
|
|
): CompactBlockDownloader = CompactBlockDownloader(service, blockStore)
|
|
|
|
internal fun defaultTxManager(
|
|
encoder: TransactionEncoder,
|
|
service: LightWalletClient
|
|
): OutboundTransactionManager {
|
|
return OutboundTransactionManagerImpl.new(
|
|
encoder,
|
|
service
|
|
)
|
|
}
|
|
|
|
internal fun defaultProcessor(
|
|
backend: Backend,
|
|
downloader: CompactBlockDownloader,
|
|
repository: DerivedDataRepository,
|
|
birthdayHeight: BlockHeight
|
|
): CompactBlockProcessor = CompactBlockProcessor(
|
|
downloader,
|
|
repository,
|
|
backend,
|
|
birthdayHeight
|
|
)
|
|
}
|
|
|
|
internal data class SynchronizerKey(val zcashNetwork: ZcashNetwork, val alias: String)
|