Switch from ZIP 32 account indices to UUID account identifiers

Electric-Coin-Company · Dec 4, 2024 · b00df1e · b00df1e
1 parent a744a67
commit b00df1e
Show file tree

Hide file tree

Showing 20 changed files with 195 additions and 181 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -11,14 +11,16 @@ and this library adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `Synchronizer.walletBalances: StateFlow<Map<Account, AccountBalance>?>` that is replacement for the removed 
   `orchardBalances`, `saplingBalances`, and `transparentBalance`
 
-### Changed 
-- `Synchronizer.orchardBalances`, `Synchronizer.saplingBalances`, and `Synchronizer.transparentBalance` have been 
-  replaced by `Synchronizer.walletBalances` that provides these balances based on `Account` 
+### Changed
+- `Account` data class works with `accountUuid: ByteArray` instead of the previous ZIP 32 account index
+- These functions from `DerivationTool` have been refactored to work with the ZIP 32 account index instead of the
+  `Account` data class: `deriveUnifiedSpendingKey`, `deriveUnifiedAddress`, `deriveArbitraryAccountKey`
 
 ### Removed
 - `Synchronizer.sendToAddress` and `Synchronizer.shieldFunds` have been removed, use 
   `Synchronizer.createProposedTransactions` and `Synchronizer.proposeShielding` instead
 - `Synchronizer.orchardBalances`, `Synchronizer.saplingBalances`, and `Synchronizer.transparentBalance`
+  (use `Synchronizer.walletBalances` instead).
 
 ## [2.2.6] - 2024-11-16
 

diff --git a/backend-lib/Cargo.lock b/backend-lib/Cargo.lock
diff --git a/backend-lib/Cargo.toml b/backend-lib/Cargo.toml
@@ -32,6 +32,7 @@ rayon = "1.7"
 # JNI
 anyhow = "1"
 jni = { version = "0.21", default-features = false }
+uuid = "1"
 
 # Logging
 log-panics = "2.0.0"
@@ -69,3 +70,10 @@ xz2 = { version = "0.1", features = ["static"] }
 name = "zcashwalletsdk"
 path = "src/main/rust/lib.rs"
 crate-type = ["staticlib", "cdylib"]
+
+[patch.crates-io]
+zcash_address = { git = "https://github.com/zcash/librustzcash", rev = "c33ad67568eb768f5a3ceedf4c607af0f052ef45" }
+zcash_client_backend = { git = "https://github.com/zcash/librustzcash", rev = "c33ad67568eb768f5a3ceedf4c607af0f052ef45" }
+zcash_client_sqlite = { git = "https://github.com/zcash/librustzcash", rev = "c33ad67568eb768f5a3ceedf4c607af0f052ef45" }
+zcash_primitives = { git = "https://github.com/zcash/librustzcash", rev = "c33ad67568eb768f5a3ceedf4c607af0f052ef45" }
+zcash_proofs = { git = "https://github.com/zcash/librustzcash", rev = "c33ad67568eb768f5a3ceedf4c607af0f052ef45" }
diff --git a/backend-lib/src/main/java/cash/z/ecc/android/sdk/internal/Backend.kt b/backend-lib/src/main/java/cash/z/ecc/android/sdk/internal/Backend.kt
@@ -24,7 +24,7 @@ interface Backend {
     suspend fun initBlockMetaDb(): Int
 
     suspend fun proposeTransfer(
-        accountIndex: Int,
+        accountUuid: ByteArray,
         to: String,
         value: Long,
         memo: ByteArray? = null
@@ -35,12 +35,12 @@ interface Backend {
      */
     @Throws(RuntimeException::class)
     suspend fun proposeTransferFromUri(
-        accountIndex: Int,
+        accountUuid: ByteArray,
         uri: String
     ): ProposalUnsafe
 
     suspend fun proposeShielding(
-        accountIndex: Int,
+        accountUuid: ByteArray,
         shieldingThreshold: Long,
         memo: ByteArray? = null,
         transparentReceiver: String? = null
@@ -109,13 +109,13 @@ interface Backend {
     fun isValidTexAddr(addr: String): Boolean
 
     @Throws(RuntimeException::class)
-    suspend fun getCurrentAddress(accountIndex: Int): String
+    suspend fun getCurrentAddress(accountUuid: ByteArray): String
 
     fun getTransparentReceiver(ua: String): String?
 
     fun getSaplingReceiver(ua: String): String?
 
-    suspend fun listTransparentReceivers(accountIndex: Int): List<String>
+    suspend fun listTransparentReceivers(accountUuid: ByteArray): List<String>
 
     fun getBranchIdForHeight(height: Long): Long
 

diff --git a/backend-lib/src/main/java/cash/z/ecc/android/sdk/internal/jni/JniConstants.kt b/backend-lib/src/main/java/cash/z/ecc/android/sdk/internal/jni/JniConstants.kt
@@ -0,0 +1,9 @@
+package cash.z.ecc.android.sdk.internal.jni
+
+import cash.z.ecc.android.sdk.internal.model.JniAccount
+
+/**
+ * The number of bytes in the account UUID parameter. It's used e.g. in [JniAccount.accountUuid], or
+ * [JniUnifiedSpendingKey.accountUuid]
+ */
+const val JNI_ACCOUNT_UUID_BYTES_SIZE = 16
diff --git a/backend-lib/src/main/java/cash/z/ecc/android/sdk/internal/jni/RustBackend.kt b/backend-lib/src/main/java/cash/z/ecc/android/sdk/internal/jni/RustBackend.kt
@@ -114,11 +114,11 @@ class RustBackend private constructor(
             )
         }
 
-    override suspend fun getCurrentAddress(accountIndex: Int) =
+    override suspend fun getCurrentAddress(accountUuid: ByteArray) =
         withContext(SdkDispatchers.DATABASE_IO) {
             getCurrentAddress(
                 dataDbFile.absolutePath,
-                accountIndex,
+                accountUuid,
                 networkId = networkId
             )
         }
@@ -127,11 +127,11 @@ class RustBackend private constructor(
 
     override fun getSaplingReceiver(ua: String) = getSaplingReceiverForUnifiedAddress(ua)
 
-    override suspend fun listTransparentReceivers(accountIndex: Int): List<String> {
+    override suspend fun listTransparentReceivers(accountUuid: ByteArray): List<String> {
         return withContext(SdkDispatchers.DATABASE_IO) {
             listTransparentReceivers(
                 dbDataPath = dataDbFile.absolutePath,
-                accountIndex = accountIndex,
+                accountUuid = accountUuid,
                 networkId = networkId
             ).asList()
         }
@@ -318,22 +318,22 @@ class RustBackend private constructor(
     }
 
     override suspend fun proposeTransferFromUri(
-        accountIndex: Int,
+        accountUuid: ByteArray,
         uri: String
     ): ProposalUnsafe =
         withContext(SdkDispatchers.DATABASE_IO) {
             ProposalUnsafe.parse(
                 proposeTransferFromUri(
                     dataDbFile.absolutePath,
-                    accountIndex,
+                    accountUuid,
                     uri,
                     networkId = networkId,
                 )
             )
         }
 
     override suspend fun proposeTransfer(
-        accountIndex: Int,
+        accountUuid: ByteArray,
         to: String,
         value: Long,
         memo: ByteArray?
@@ -342,7 +342,7 @@ class RustBackend private constructor(
             ProposalUnsafe.parse(
                 proposeTransfer(
                     dataDbFile.absolutePath,
-                    accountIndex,
+                    accountUuid,
                     to,
                     value,
                     memo,
@@ -352,15 +352,15 @@ class RustBackend private constructor(
         }
 
     override suspend fun proposeShielding(
-        accountIndex: Int,
+        accountUuid: ByteArray,
         shieldingThreshold: Long,
         memo: ByteArray?,
         transparentReceiver: String?
     ): ProposalUnsafe? {
         return withContext(SdkDispatchers.DATABASE_IO) {
             proposeShielding(
                 dataDbFile.absolutePath,
-                accountIndex,
+                accountUuid,
                 shieldingThreshold,
                 memo,
                 transparentReceiver,
@@ -510,7 +510,7 @@ class RustBackend private constructor(
         @JvmStatic
         private external fun getCurrentAddress(
             dbDataPath: String,
-            accountIndex: Int,
+            accountUuid: ByteArray,
             networkId: Int
         ): String
 
@@ -523,7 +523,7 @@ class RustBackend private constructor(
         @JvmStatic
         private external fun listTransparentReceivers(
             dbDataPath: String,
-            accountIndex: Int,
+            accountUuid: ByteArray,
             networkId: Int
         ): Array<String>
 
@@ -671,7 +671,7 @@ class RustBackend private constructor(
         @JvmStatic
         private external fun proposeTransferFromUri(
             dbDataPath: String,
-            accountIndex: Int,
+            accountUuid: ByteArray,
             uri: String,
             networkId: Int,
         ): ByteArray
@@ -680,7 +680,7 @@ class RustBackend private constructor(
         @Suppress("LongParameterList")
         private external fun proposeTransfer(
             dbDataPath: String,
-            accountIndex: Int,
+            accountUuid: ByteArray,
             to: String,
             value: Long,
             memo: ByteArray?,
@@ -691,7 +691,7 @@ class RustBackend private constructor(
         @Suppress("LongParameterList")
         private external fun proposeShielding(
             dbDataPath: String,
-            accountIndex: Int,
+            accountUuid: ByteArray,
             shieldingThreshold: Long,
             memo: ByteArray?,
             transparentReceiver: String?,

diff --git a/backend-lib/src/main/java/cash/z/ecc/android/sdk/internal/model/JniAccount.kt b/backend-lib/src/main/java/cash/z/ecc/android/sdk/internal/model/JniAccount.kt
@@ -1,22 +1,23 @@
 package cash.z.ecc.android.sdk.internal.model
 
 import androidx.annotation.Keep
+import cash.z.ecc.android.sdk.internal.jni.JNI_ACCOUNT_UUID_BYTES_SIZE
 
 /**
  * Serves as cross layer (Kotlin, Rust) communication class.
  *
- * @param accountIndex the ZIP 32 account index.
+ * @param accountUuid the "one-way stable" identifier for the account.
  * @param ufvk The account's Unified Full Viewing Key, if any.
  * @throws IllegalArgumentException if the values are inconsistent.
  */
 @Keep
 class JniAccount(
-    val accountIndex: Int,
+    val accountUuid: ByteArray,
     val ufvk: String?,
 ) {
     init {
-        require(accountIndex >= 0) {
-            "Account index must be non-negative"
+        require(accountUuid.size == JNI_ACCOUNT_UUID_BYTES_SIZE) {
+            "Account UUID must be 16 bytes"
         }
     }
 }
diff --git a/backend-lib/src/main/java/cash/z/ecc/android/sdk/internal/model/JniAccountBalance.kt b/backend-lib/src/main/java/cash/z/ecc/android/sdk/internal/model/JniAccountBalance.kt
@@ -25,7 +25,7 @@ import androidx.annotation.Keep
 @Keep
 @Suppress("LongParameterList")
 class JniAccountBalance(
-    val account: Int,
+    val account: ByteArray,
     val saplingVerifiedBalance: Long,
     val saplingChangePending: Long,
     val saplingValuePending: Long,