4.0 KiB
Troubleshooting Migrations
Upcoming Migrating to Version 1.3.0-beta18 from 1.3.0-beta19
Various APIs that have always been considered private have been moved into a new package called internal. While this should not be a breaking change, clients that might have relied on these internal classes should stop doing so. If necessary, these calls can be migrated by changing the import to the new internal package name.
A number of methods have been converted to suspending functions, because they were performing slow or blocking calls (e.g. disk IO) internally. This is a breaking change.
Migrating to Version 1.3.* from 1.2.*
The biggest breaking changes in 1.3 that inspired incrementing the minor version number was simplifying down to one "network aware" library rather than two separate libraries, each dedicated to either testnet or mainnet. This greatly simplifies the gradle configuration and has lots of other benefits. Wallets can now set a network with code similar to the following:
// Simple example
val network: ZcashNetwork = if (testMode) ZcashNetwork.Testnet else ZcashNetwork.Mainnet
// Dependency Injection example
@Provides @Singleton fun provideNetwork(): ZcashNetwork = ZcashNetwork.Mainnet
1.3 also adds a runtime check for wallets that are accessing properties before the synchronizer has started. By introducing a prepare step, we are now able to catch these errors proactively rather than allowing them to turn into subtle bugs that only surface later. We found this when code was accessing properties before database migrations completed, causing undefined results. Developers do not need to make any changes to enable these checks, they happen automatically and result in detailed error messages.
| Error | Issue | Fix |
|---|---|---|
| No value passed for parameter 'network' | Many functions are now network-aware | pass an instance of ZcashNetwork, which is typically set during initialization |
| Unresolved reference: validate | The validate package was removed |
instead of cash.z.ecc.android.sdk.validate.AddressTypeimport cash.z.ecc.android.sdk.type.AddressType |
| Unresolved reference: WalletBalance | WalletBalance was moved out of CompactBlockProcessor and up to the type package |
instead of cash.z.ecc.android.sdk.CompactBlockProcessor.WalletBalanceimport cash.z.ecc.android.sdk.type.WalletBalance |
| Unresolved reference: server | This was replaced by setNetwork |
instead of config.server(host, port)use config.setNetwork(network, host, port) |
| Unresolved reference: balances | 3 types of balances are now exposed | change balances to saplingBalances |
| Unresolved reference: latestBalance | There are now multiple balance types so this convenience function was removed in favor of forcing wallets to think about which balances they want to show. | In most cases, just use synchronizer.saplingBalances.value directly, instead |
| Type mismatch: inferred type is String but ZcashNetwork was expected | This function is now network aware | use Initializer.erase(context, network, alias) |
| Type mismatch: inferred type is Int? but ZcashNetwork was expected | This function is now network aware | use WalletBirthdayTool.loadNearest(context, network, height) instead |
| None of the following functions can be called with the arguments supplied: public open fun deriveShieldedAddress(seed: ByteArray, network: ZcashNetwork, accountIndex: Int = ...): String defined in cash.z.ecc.android.sdk.tool.DerivationTool.Companion public open fun deriveShieldedAddress(viewingKey: String, network: ZcashNetwork): String defined in cash.z.ecc.android.sdk.tool.DerivationTool.Companion |
This function is now network aware | use deriveShieldedAddress(seed, network) |