Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add possibility to watch single address #633

Merged
merged 1 commit into from
Nov 30, 2023
Merged

Add possibility to watch single address #633

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
227 changes: 157 additions & 70 deletions bitcoincashkit/src/main/kotlin/io/horizontalsystems/bitcoincash/BitcoinCashKit.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ import io.horizontalsystems.bitcoincore.AbstractKit
import io.horizontalsystems.bitcoincore.BitcoinCore
import io.horizontalsystems.bitcoincore.BitcoinCore.SyncMode
import io.horizontalsystems.bitcoincore.BitcoinCoreBuilder
import io.horizontalsystems.bitcoincore.apisync.BiApiTransactionProvider
import io.horizontalsystems.bitcoincore.apisync.BlockHashFetcher
import io.horizontalsystems.bitcoincore.apisync.BlockchainComApi
import io.horizontalsystems.bitcoincore.apisync.HsBlockHashFetcher
Expand All @@ -23,14 +22,18 @@ import io.horizontalsystems.bitcoincore.blocks.validators.BlockValidatorChain
import io.horizontalsystems.bitcoincore.blocks.validators.BlockValidatorSet
import io.horizontalsystems.bitcoincore.blocks.validators.LegacyDifficultyAdjustmentValidator
import io.horizontalsystems.bitcoincore.blocks.validators.ProofOfWorkValidator
import io.horizontalsystems.bitcoincore.core.IApiTransactionProvider
import io.horizontalsystems.bitcoincore.extensions.toReversedByteArray
import io.horizontalsystems.bitcoincore.managers.ApiSyncStateManager
import io.horizontalsystems.bitcoincore.managers.Bip44RestoreKeyConverter
import io.horizontalsystems.bitcoincore.managers.BlockchairCashRestoreKeyConverter
import io.horizontalsystems.bitcoincore.models.Address
import io.horizontalsystems.bitcoincore.models.Checkpoint
import io.horizontalsystems.bitcoincore.models.WatchAddressPublicKey
import io.horizontalsystems.bitcoincore.network.Network
import io.horizontalsystems.bitcoincore.storage.CoreDatabase
import io.horizontalsystems.bitcoincore.storage.Storage
import io.horizontalsystems.bitcoincore.utils.AddressConverterChain
import io.horizontalsystems.bitcoincore.utils.Base58AddressConverter
import io.horizontalsystems.bitcoincore.utils.CashAddressConverter
import io.horizontalsystems.bitcoincore.utils.PaymentAddressParser
Expand Down Expand Up @@ -72,20 +75,20 @@ class BitcoinCashKit : AbstractKit {
words: List<String>,
passphrase: String,
walletId: String,
networkType: NetworkType = NetworkType.MainNet(MainNetBitcoinCash.CoinType.Type145),
peerSize: Int = 10,
syncMode: SyncMode = SyncMode.Api(),
confirmationsThreshold: Int = 6
networkType: NetworkType = defaultNetworkType,
peerSize: Int = defaultPeerSize,
syncMode: SyncMode = defaultSyncMode,
confirmationsThreshold: Int = defaultConfirmationsThreshold
) : this(context, Mnemonic().toSeed(words, passphrase), walletId, networkType, peerSize, syncMode, confirmationsThreshold)

constructor(
context: Context,
seed: ByteArray,
walletId: String,
networkType: NetworkType = NetworkType.MainNet(MainNetBitcoinCash.CoinType.Type145),
peerSize: Int = 10,
syncMode: SyncMode = SyncMode.Api(),
confirmationsThreshold: Int = 6
networkType: NetworkType = defaultNetworkType,
peerSize: Int = defaultPeerSize,
syncMode: SyncMode = defaultSyncMode,
confirmationsThreshold: Int = defaultConfirmationsThreshold
) : this(context, HDExtendedKey(seed, Purpose.BIP44), walletId, networkType, peerSize, syncMode, confirmationsThreshold)

/**
Expand All @@ -102,54 +105,127 @@ class BitcoinCashKit : AbstractKit {
context: Context,
extendedKey: HDExtendedKey,
walletId: String,
networkType: NetworkType,
peerSize: Int = 10,
syncMode: SyncMode = SyncMode.Api(),
confirmationsThreshold: Int = 6
networkType: NetworkType = defaultNetworkType,
peerSize: Int = defaultPeerSize,
syncMode: SyncMode = defaultSyncMode,
confirmationsThreshold: Int = defaultConfirmationsThreshold
) {
val database = CoreDatabase.getInstance(context, getDatabaseName(networkType, walletId, syncMode))
val storage = Storage(database)
network = network(networkType)

bitcoinCore = bitcoinCore(
context = context,
extendedKey = extendedKey,
watchAddressPublicKey = null,
networkType = networkType,
network = network,
walletId = walletId,
syncMode = syncMode,
peerSize = peerSize,
confirmationsThreshold = confirmationsThreshold
)
}

network = when (networkType) {
is NetworkType.MainNet -> MainNetBitcoinCash(networkType.coinType)
NetworkType.TestNet -> TestNetBitcoinCash()
}
/**
* @constructor Creates and initializes the BitcoinKit
* @param context The Android context
* @param watchAddress address for watching in read-only mode
* @param walletId an arbitrary ID of type String.
* @param networkType The network type. The default is MainNet.
* @param peerSize The # of peer-nodes required. The default is 10 peers.
* @param syncMode How the kit syncs with the blockchain. The default is SyncMode.Api().
* @param confirmationsThreshold How many confirmations required to be considered confirmed. The default is 6 confirmations.
*/
constructor(
context: Context,
watchAddress: String,
walletId: String,
networkType: NetworkType = defaultNetworkType,
peerSize: Int = defaultPeerSize,
syncMode: SyncMode = defaultSyncMode,
confirmationsThreshold: Int = defaultConfirmationsThreshold
) {
network = network(networkType)

val address = parseAddress(watchAddress, network)
val watchAddressPublicKey = WatchAddressPublicKey(address.lockingScriptPayload, address.scriptType)

bitcoinCore = bitcoinCore(
context = context,
extendedKey = null,
watchAddressPublicKey = watchAddressPublicKey,
networkType = networkType,
network = network,
walletId = walletId,
syncMode = syncMode,
peerSize = peerSize,
confirmationsThreshold = confirmationsThreshold
)
}

private fun bitcoinCore(
context: Context,
extendedKey: HDExtendedKey?,
watchAddressPublicKey: WatchAddressPublicKey?,
networkType: NetworkType,
network: Network,
walletId: String,
syncMode: SyncMode,
peerSize: Int,
confirmationsThreshold: Int
): BitcoinCore {
val database = CoreDatabase.getInstance(context, getDatabaseName(networkType, walletId, syncMode))
val storage = Storage(database)
val checkpoint = Checkpoint.resolveCheckpoint(syncMode, network, storage)
val apiSyncStateManager = ApiSyncStateManager(storage, network.syncableFromApi && syncMode !is SyncMode.Full)
val apiTransactionProvider = apiTransactionProvider(networkType, syncMode, checkpoint)
val paymentAddressParser = PaymentAddressParser("bitcoincash", removeScheme = false)
val blockValidatorSet = blockValidatorSet(networkType, storage)

val hsBlockHashFetcher = HsBlockHashFetcher("https://api.blocksdecoded.com/v1/blockchains/bitcoin-cash")
val apiTransactionProvider = when (networkType) {
is NetworkType.MainNet -> {
val bitcoinCore = BitcoinCoreBuilder()
.setContext(context)
.setExtendedKey(extendedKey)
.setWatchAddressPublicKey(watchAddressPublicKey)
.setPurpose(Purpose.BIP44)
.setNetwork(network)
.setCheckpoint(checkpoint)
.setPaymentAddressParser(paymentAddressParser)
.setPeerSize(peerSize)
.setSyncMode(syncMode)
.setConfirmationThreshold(confirmationsThreshold)
.setStorage(storage)
.setApiTransactionProvider(apiTransactionProvider)
.setApiSyncStateManager(apiSyncStateManager)
.setBlockValidator(blockValidatorSet)
.build()

if (syncMode is SyncMode.Blockchair) {
val blockchairApi = BlockchairApi(syncMode.key, network.blockchairChainId)
val blockchairBlockHashFetcher = BlockchairBlockHashFetcher(blockchairApi)
val blockHashFetcher = BlockHashFetcher(hsBlockHashFetcher, blockchairBlockHashFetcher, checkpoint.block.height)
// val blockchainComProvider = BlockchainComApi("https://api.haskoin.com/bch/blockchain", blockHashFetcher)
val blockchairProvider = BlockchairTransactionProvider(blockchairApi, blockHashFetcher)
// extending bitcoinCore

// BiApiTransactionProvider(
// restoreProvider = blockchainComProvider,
// syncProvider = blockchairProvider,
// syncStateManager = apiSyncStateManager
// )
blockchairProvider
} else {
BlockchainComApi("https://api.haskoin.com/bch/blockchain", hsBlockHashFetcher)
}
}
val bech32 = CashAddressConverter(network.addressSegwitHrp)
bitcoinCore.prependAddressConverter(bech32)

NetworkType.TestNet -> {
BlockchainComApi(
transactionApiUrl = "https://api.haskoin.com/bchtest/blockchain",
blockHashFetcher = hsBlockHashFetcher
)
}
val restoreKeyConverter = if (syncMode is SyncMode.Blockchair) {
BlockchairCashRestoreKeyConverter(bech32)
} else {
val base58 = Base58AddressConverter(network.addressVersion, network.addressScriptVersion)
Bip44RestoreKeyConverter(base58)
}
bitcoinCore.addRestoreKeyConverter(restoreKeyConverter)

val paymentAddressParser = PaymentAddressParser("bitcoincash", removeScheme = false)
return bitcoinCore
}

private fun parseAddress(address: String, network: Network): Address {
val addressConverter = AddressConverterChain().apply {
prependConverter(CashAddressConverter(network.addressSegwitHrp))
prependConverter(Base58AddressConverter(network.addressVersion, network.addressScriptVersion))
}
return addressConverter.convert(address)
}

private fun blockValidatorSet(
networkType: NetworkType,
storage: Storage
): BlockValidatorSet {
val blockValidatorSet = BlockValidatorSet()
blockValidatorSet.addBlockValidator(ProofOfWorkValidator())

Expand All @@ -171,35 +247,41 @@ class BitcoinCashKit : AbstractKit {
}

blockValidatorSet.addBlockValidator(blockValidatorChain)
return blockValidatorSet
}

bitcoinCore = BitcoinCoreBuilder()
.setContext(context)
.setExtendedKey(extendedKey)
.setPurpose(Purpose.BIP44)
.setNetwork(network)
.setCheckpoint(checkpoint)
.setPaymentAddressParser(paymentAddressParser)
.setPeerSize(peerSize)
.setSyncMode(syncMode)
.setConfirmationThreshold(confirmationsThreshold)
.setStorage(storage)
.setApiTransactionProvider(apiTransactionProvider)
.setApiSyncStateManager(apiSyncStateManager)
.setBlockValidator(blockValidatorSet)
.build()

// extending bitcoinCore
private fun apiTransactionProvider(
networkType: NetworkType,
syncMode: SyncMode,
checkpoint: Checkpoint
): IApiTransactionProvider {
val hsBlockHashFetcher = HsBlockHashFetcher("https://api.blocksdecoded.com/v1/blockchains/bitcoin-cash")
return when (networkType) {
is NetworkType.MainNet -> {

val bech32 = CashAddressConverter(network.addressSegwitHrp)
bitcoinCore.prependAddressConverter(bech32)
if (syncMode is SyncMode.Blockchair) {
val blockchairApi = BlockchairApi(syncMode.key, network.blockchairChainId)
val blockchairBlockHashFetcher = BlockchairBlockHashFetcher(blockchairApi)
val blockHashFetcher = BlockHashFetcher(hsBlockHashFetcher, blockchairBlockHashFetcher, checkpoint.block.height)
val blockchairProvider = BlockchairTransactionProvider(blockchairApi, blockHashFetcher)
blockchairProvider
} else {
BlockchainComApi("https://api.haskoin.com/bch/blockchain", hsBlockHashFetcher)
}
}

val restoreKeyConverter = if (syncMode is SyncMode.Blockchair) {
BlockchairCashRestoreKeyConverter(bech32, network.addressSegwitHrp)
} else {
val base58 = Base58AddressConverter(network.addressVersion, network.addressScriptVersion)
Bip44RestoreKeyConverter(base58)
NetworkType.TestNet -> {
BlockchainComApi(
transactionApiUrl = "https://api.haskoin.com/bchtest/blockchain",
blockHashFetcher = hsBlockHashFetcher
)
}
}
bitcoinCore.addRestoreKeyConverter(restoreKeyConverter)
}

private fun network(networkType: NetworkType) = when (networkType) {
is NetworkType.MainNet -> MainNetBitcoinCash(networkType.coinType)
NetworkType.TestNet -> TestNetBitcoinCash()
}

companion object {
Expand All @@ -214,6 +296,11 @@ class BitcoinCashKit : AbstractKit {
val abcForkBlockHash = "0000000000000000004626ff6e3b936941d341c5932ece4357eeccac44e6d56c".toReversedByteArray()
val bchnChainForkBlockHash = "0000000000000000029e471c41818d24b8b74c911071c4ef0b4a0509f9b5a8ce".toReversedByteArray()

val defaultNetworkType: NetworkType = NetworkType.MainNet(MainNetBitcoinCash.CoinType.Type145)
val defaultSyncMode: SyncMode = SyncMode.Api()
const val defaultPeerSize: Int = 10
const val defaultConfirmationsThreshold: Int = 6

private fun getDatabaseName(networkType: NetworkType, walletId: String, syncMode: SyncMode): String =
"BitcoinCash-${networkType.description}-$walletId-${syncMode.javaClass.simpleName}"

Expand Down
Loading
Loading