You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
103 lines
3.9 KiB
103 lines
3.9 KiB
package cash.z.ecc.android.sdk.internal.transaction
|
|
|
|
import cash.z.ecc.android.sdk.db.entity.ConfirmedTransaction
|
|
import cash.z.ecc.android.sdk.db.entity.EncodedTransaction
|
|
import cash.z.ecc.android.sdk.model.BlockHeight
|
|
import cash.z.ecc.android.sdk.type.UnifiedAddressAccount
|
|
import kotlinx.coroutines.flow.Flow
|
|
|
|
/**
|
|
* Repository of wallet transactions, providing an agnostic interface to the underlying information.
|
|
*/
|
|
interface TransactionRepository {
|
|
|
|
/**
|
|
* The last height scanned by this repository.
|
|
*
|
|
* @return the last height scanned by this repository.
|
|
*/
|
|
suspend fun lastScannedHeight(): BlockHeight
|
|
|
|
/**
|
|
* The height of the first block in this repository. This is typically the checkpoint that was
|
|
* used to initialize this wallet. If we overwrite this block, it breaks our ability to spend
|
|
* funds.
|
|
*/
|
|
suspend fun firstScannedHeight(): BlockHeight
|
|
|
|
/**
|
|
* Returns true when this repository has been initialized and seeded with the initial checkpoint.
|
|
*
|
|
* @return true when this repository has been initialized and seeded with the initial checkpoint.
|
|
*/
|
|
suspend fun isInitialized(): Boolean
|
|
|
|
/**
|
|
* Find the encoded transaction associated with the given id.
|
|
*
|
|
* @param txId the id of the transaction to find.
|
|
*
|
|
* @return the transaction or null when it cannot be found.
|
|
*/
|
|
suspend fun findEncodedTransactionById(txId: Long): EncodedTransaction?
|
|
|
|
/**
|
|
* Find all the newly scanned transactions in the given range, including transactions (like
|
|
* change or those only identified by nullifiers) which should not appear in the UI. This method
|
|
* is intended for use after a scan, in order to collect all the transactions that were
|
|
* discovered and then enhance them with additional details. It returns a list to signal that
|
|
* the intention is not to add them to a recyclerview or otherwise show in the UI.
|
|
*
|
|
* @param blockHeightRange the range of blocks to check for transactions.
|
|
*
|
|
* @return a list of transactions that were mined in the given range, inclusive.
|
|
*/
|
|
suspend fun findNewTransactions(blockHeightRange: ClosedRange<BlockHeight>): List<ConfirmedTransaction>
|
|
|
|
/**
|
|
* Find the mined height that matches the given raw tx_id in bytes. This is useful for matching
|
|
* a pending transaction with one that we've decrypted from the blockchain.
|
|
*
|
|
* @param rawTransactionId the id of the transaction to find.
|
|
*
|
|
* @return the mined height of the given transaction, if it is known to this wallet.
|
|
*/
|
|
suspend fun findMinedHeight(rawTransactionId: ByteArray): BlockHeight?
|
|
|
|
suspend fun findMatchingTransactionId(rawTransactionId: ByteArray): Long?
|
|
|
|
/**
|
|
* Provides a way for other components to signal that the underlying data has been modified.
|
|
*/
|
|
fun invalidate()
|
|
|
|
/**
|
|
* When a transaction has been cancelled by the user, we need a bridge to clean it up from the
|
|
* dataDb. This function will safely remove everything related to that transaction in the right
|
|
* order to satisfy foreign key constraints, even if cascading isn't setup in the DB.
|
|
*
|
|
* @return true when an unmined transaction was found and then successfully removed
|
|
*/
|
|
suspend fun cleanupCancelledTx(rawTransactionId: ByteArray): Boolean
|
|
|
|
suspend fun deleteExpired(lastScannedHeight: BlockHeight): Int
|
|
|
|
suspend fun count(): Int
|
|
|
|
suspend fun getAccount(accountId: Int): UnifiedAddressAccount?
|
|
|
|
suspend fun getAccountCount(): Int
|
|
|
|
//
|
|
// Transactions
|
|
//
|
|
|
|
/** A flow of all the inbound confirmed transactions */
|
|
val receivedTransactions: Flow<List<ConfirmedTransaction>>
|
|
|
|
/** A flow of all the outbound confirmed transactions */
|
|
val sentTransactions: Flow<List<ConfirmedTransaction>>
|
|
|
|
/** A flow of all the inbound and outbound confirmed transactions */
|
|
val allTransactions: Flow<List<ConfirmedTransaction>>
|
|
}
|
|
|