@breeztech/breez-sdk-spark-react-native 0.7.8 → 0.7.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@breeztech/breez-sdk-spark-react-native",
-  "version": "0.7.8",
+  "version": "0.7.9",
   "description": "React Native bindings for the Breez SDK - Nodeless (Spark Implementation)",
   "source": "./src/index.tsx",
   "main": "./lib/commonjs/index.js",
@@ -197,7 +197,7 @@
     "version": "0.49.0"
   },
   "checksums": {
-    "android": "1ac814191145dccff603f0bd383977c0fee6b5067f701f004a9020046abf9a53",
-    "ios": "95e4566a2a0125aa05fd5ad14e2c0c1f4cacef39f24172cc6e64c366e50d21cb"
+    "android": "8f33be4b59faaf6b75b4e1e3e7f7ba6d904194ca9a871c8c4687c28c2a8715f3",
+    "ios": "79bfb921d48c8ea3f0435fbd67850eff56408a4b643961b540282a98822b216f"
   }
 }

package/src/generated/breez_sdk_spark-ffi.ts

@@ -247,7 +247,7 @@ interface NativeModuleInterface {
     ptr: bigint,
     id: Uint8Array
   ): bigint;
-  ubrn_uniffi_breez_sdk_spark_fn_method_externalsigner_generate_random_key(
+  ubrn_uniffi_breez_sdk_spark_fn_method_externalsigner_generate_random_secret(
     ptr: bigint
   ): bigint;
   ubrn_uniffi_breez_sdk_spark_fn_method_externalsigner_static_deposit_secret_encrypted(
@@ -759,7 +759,7 @@ interface NativeModuleInterface {
   ubrn_uniffi_breez_sdk_spark_checksum_method_externalsigner_hmac_sha256(): number;
   ubrn_uniffi_breez_sdk_spark_checksum_method_externalsigner_generate_random_signing_commitment(): number;
   ubrn_uniffi_breez_sdk_spark_checksum_method_externalsigner_get_public_key_for_node(): number;
-  ubrn_uniffi_breez_sdk_spark_checksum_method_externalsigner_generate_random_key(): number;
+  ubrn_uniffi_breez_sdk_spark_checksum_method_externalsigner_generate_random_secret(): number;
   ubrn_uniffi_breez_sdk_spark_checksum_method_externalsigner_static_deposit_secret_encrypted(): number;
   ubrn_uniffi_breez_sdk_spark_checksum_method_externalsigner_static_deposit_secret(): number;
   ubrn_uniffi_breez_sdk_spark_checksum_method_externalsigner_static_deposit_signing_key(): number;
@@ -1383,7 +1383,7 @@ export type UniffiVTableCallbackInterfaceExternalSigner = {
   hmacSha256: UniffiCallbackInterfaceExternalSignerMethod7;
   generateRandomSigningCommitment: UniffiCallbackInterfaceExternalSignerMethod8;
   getPublicKeyForNode: UniffiCallbackInterfaceExternalSignerMethod9;
-  generateRandomKey: UniffiCallbackInterfaceExternalSignerMethod10;
+  generateRandomSecret: UniffiCallbackInterfaceExternalSignerMethod10;
   staticDepositSecretEncrypted: UniffiCallbackInterfaceExternalSignerMethod11;
   staticDepositSecret: UniffiCallbackInterfaceExternalSignerMethod12;
   staticDepositSigningKey: UniffiCallbackInterfaceExternalSignerMethod13;

package/src/generated/breez_sdk_spark.ts

@@ -21201,29 +21201,42 @@ export interface ExternalSigner {
    * * `id` - The tree node identifier
    *
    * # Returns
-   * The public key for the node, or an error string
+   * The public key for the node, or a `SignerError`
    */
   getPublicKeyForNode(
     id: ExternalTreeNodeId,
     asyncOpts_?: { signal: AbortSignal }
   ): /*throws*/ Promise<PublicKeyBytes>;
   /**
-   * Generates a random secret.
+   * Generates a random secret that is encrypted and known only to the signer.
+   *
+   * This method creates a new random secret and returns it in encrypted form.
+   * The plaintext secret never leaves the signer boundary, providing a secure way
+   * to create secrets that can be referenced in subsequent operations without
+   * exposing them.
+   *
+   * This is conceptually similar to Spark's key derivation system where secrets
+   * are represented by opaque references (like tree node IDs or Random) rather than raw values.
+   * The encrypted secret can be passed to other signer methods that need to operate
+   * on it, while keeping the actual secret material protected within the signer.
    *
    * # Returns
-   * A randomly generated secret source, or an error string
+   * An encrypted secret that can be used in subsequent signer operations,
+   * or a `SignerError` if generation fails.
+   *
+   * See also: [Key Derivation System](https://docs.spark.money/wallets/spark-signer#the-keyderivation-system)
    */
-  generateRandomKey(asyncOpts_?: {
+  generateRandomSecret(asyncOpts_?: {
     signal: AbortSignal;
-  }): /*throws*/ Promise<ExternalSecretSource>;
+  }): /*throws*/ Promise<ExternalEncryptedSecret>;
   /**
    * Gets an encrypted static deposit secret by index.
    *
    * # Arguments
-   * * `index` - The index of the static deposit key
+   * * `index` - The index of the static deposit secret
    *
    * # Returns
-   * The encrypted secret source, or an error string
+   * The encrypted secret, or a `SignerError`
    *
    * This is the encrypted version of: [JavaScript `getStaticDepositSecretKey`](https://docs.spark.money/wallets/spark-signer#get-static-deposit-secret-key)
    */
@@ -21235,10 +21248,10 @@ export interface ExternalSigner {
    * Gets a static deposit secret by index.
    *
    * # Arguments
-   * * `index` - The index of the static deposit key
+   * * `index` - The index of the static deposit secret
    *
    * # Returns
-   * The 32-byte secret, or an error string
+   * The 32-byte secret, or a `SignerError`
    *
    * See also: [JavaScript `getStaticDepositSecretKey`](https://docs.spark.money/wallets/spark-signer#get-static-deposit-secret-key)
    */
@@ -21247,13 +21260,13 @@ export interface ExternalSigner {
     asyncOpts_?: { signal: AbortSignal }
   ): /*throws*/ Promise<SecretBytes>;
   /**
-   * Gets a static deposit public key by index.
+   * Gets a static deposit signing public key by index.
    *
    * # Arguments
-   * * `index` - The index of the static deposit key
+   * * `index` - The index of the static deposit public signing key
    *
    * # Returns
-   * The 33-byte public key, or an error string
+   * The 33-byte public key, or a `SignerError`
    *
    * See also: [JavaScript `getStaticDepositSigningKey`](https://docs.spark.money/wallets/spark-signer#get-static-deposit-signing-key)
    */
@@ -21265,11 +21278,11 @@ export interface ExternalSigner {
    * Subtracts one secret from another.
    *
    * # Arguments
-   * * `signing_key` - The first secret source
-   * * `new_signing_key` - The second secret source to subtract
+   * * `signing_key` - The first secret
+   * * `new_signing_key` - The second secret to subtract
    *
    * # Returns
-   * The resulting secret source, or an error string
+   * The resulting secret, or a `SignerError`
    *
    * See also: [JavaScript `subtractSplitAndEncrypt`](https://docs.spark.money/wallets/spark-signer#subtract,-split,-and-encrypt)
    * (this method provides the subtraction step of that higher-level operation)
@@ -21288,7 +21301,7 @@ export interface ExternalSigner {
    * * `num_shares` - Total number of shares to create
    *
    * # Returns
-   * Vector of verifiable secret shares, or an error string
+   * Vector of verifiable secret shares, or a `SignerError`
    *
    * See also: [JavaScript `splitSecretWithProofs`](https://docs.spark.money/wallets/spark-signer#split-secret-with-proofs)
    */
@@ -21306,7 +21319,7 @@ export interface ExternalSigner {
    * * `receiver_public_key` - The receiver's 33-byte public key
    *
    * # Returns
-   * Encrypted data for the receiver, or an error string
+   * Encrypted data for the receiver, or a `SignerError`
    */
   encryptSecretForReceiver(
     encryptedSecret: ExternalEncryptedSecret,
@@ -21314,13 +21327,15 @@ export interface ExternalSigner {
     asyncOpts_?: { signal: AbortSignal }
   ): /*throws*/ Promise<ArrayBuffer>;
   /**
-   * Gets the public key from a secret source.
+   * Gets the public key from a secret.
    *
    * # Arguments
-   * * `secret` - The secret source
+   * * `secret` - The secret
    *
    * # Returns
-   * The corresponding 33-byte public key, or an error string
+   * The corresponding 33-byte public key, or a `SignerError`
+   *
+   * See also: [JavaScript `getPublicKeyFromDerivation`](https://docs.spark.money/wallets/spark-signer#get-public-key-from-derivation)
    */
   publicKeyFromSecret(
     secret: ExternalSecretSource,
@@ -21333,7 +21348,7 @@ export interface ExternalSigner {
    * * `request` - The Frost signing request
    *
    * # Returns
-   * A signature share, or an error string
+   * A signature share, or a `SignerError`
    *
    * See also: [JavaScript `signFrost`](https://docs.spark.money/wallets/spark-signer#frost-signing)
    */
@@ -21348,7 +21363,7 @@ export interface ExternalSigner {
    * * `request` - The Frost aggregation request
    *
    * # Returns
-   * The aggregated Frost signature, or an error string
+   * The aggregated Frost signature, or a `SignerError`
    *
    * See also: [JavaScript `aggregateFrost`](https://docs.spark.money/wallets/spark-signer#aggregate-frost-signatures)
    */
@@ -21824,7 +21839,7 @@ export class ExternalSignerImpl
    * * `id` - The tree node identifier
    *
    * # Returns
-   * The public key for the node, or an error string
+   * The public key for the node, or a `SignerError`
    */
   public async getPublicKeyForNode(
     id: ExternalTreeNodeId,
@@ -21866,20 +21881,33 @@ export class ExternalSignerImpl
   }
 
   /**
-   * Generates a random secret.
+   * Generates a random secret that is encrypted and known only to the signer.
+   *
+   * This method creates a new random secret and returns it in encrypted form.
+   * The plaintext secret never leaves the signer boundary, providing a secure way
+   * to create secrets that can be referenced in subsequent operations without
+   * exposing them.
+   *
+   * This is conceptually similar to Spark's key derivation system where secrets
+   * are represented by opaque references (like tree node IDs or Random) rather than raw values.
+   * The encrypted secret can be passed to other signer methods that need to operate
+   * on it, while keeping the actual secret material protected within the signer.
    *
    * # Returns
-   * A randomly generated secret source, or an error string
+   * An encrypted secret that can be used in subsequent signer operations,
+   * or a `SignerError` if generation fails.
+   *
+   * See also: [Key Derivation System](https://docs.spark.money/wallets/spark-signer#the-keyderivation-system)
    */
-  public async generateRandomKey(asyncOpts_?: {
+  public async generateRandomSecret(asyncOpts_?: {
     signal: AbortSignal;
-  }): Promise<ExternalSecretSource> /*throws*/ {
+  }): Promise<ExternalEncryptedSecret> /*throws*/ {
     const __stack = uniffiIsDebug ? new Error().stack : undefined;
     try {
       return await uniffiRustCallAsync(
         /*rustCaller:*/ uniffiCaller,
         /*rustFutureFunc:*/ () => {
-          return nativeModule().ubrn_uniffi_breez_sdk_spark_fn_method_externalsigner_generate_random_key(
+          return nativeModule().ubrn_uniffi_breez_sdk_spark_fn_method_externalsigner_generate_random_secret(
             uniffiTypeExternalSignerImplObjectFactory.clonePointer(this)
           );
         },
@@ -21891,8 +21919,8 @@ export class ExternalSignerImpl
           .ubrn_ffi_breez_sdk_spark_rust_future_complete_rust_buffer,
         /*freeFunc:*/ nativeModule()
           .ubrn_ffi_breez_sdk_spark_rust_future_free_rust_buffer,
-        /*liftFunc:*/ FfiConverterTypeExternalSecretSource.lift.bind(
-          FfiConverterTypeExternalSecretSource
+        /*liftFunc:*/ FfiConverterTypeExternalEncryptedSecret.lift.bind(
+          FfiConverterTypeExternalEncryptedSecret
         ),
         /*liftString:*/ FfiConverterString.lift,
         /*asyncOpts:*/ asyncOpts_,
@@ -21912,10 +21940,10 @@ export class ExternalSignerImpl
    * Gets an encrypted static deposit secret by index.
    *
    * # Arguments
-   * * `index` - The index of the static deposit key
+   * * `index` - The index of the static deposit secret
    *
    * # Returns
-   * The encrypted secret source, or an error string
+   * The encrypted secret, or a `SignerError`
    *
    * This is the encrypted version of: [JavaScript `getStaticDepositSecretKey`](https://docs.spark.money/wallets/spark-signer#get-static-deposit-secret-key)
    */
@@ -21962,10 +21990,10 @@ export class ExternalSignerImpl
    * Gets a static deposit secret by index.
    *
    * # Arguments
-   * * `index` - The index of the static deposit key
+   * * `index` - The index of the static deposit secret
    *
    * # Returns
-   * The 32-byte secret, or an error string
+   * The 32-byte secret, or a `SignerError`
    *
    * See also: [JavaScript `getStaticDepositSecretKey`](https://docs.spark.money/wallets/spark-signer#get-static-deposit-secret-key)
    */
@@ -22009,13 +22037,13 @@ export class ExternalSignerImpl
   }
 
   /**
-   * Gets a static deposit public key by index.
+   * Gets a static deposit signing public key by index.
    *
    * # Arguments
-   * * `index` - The index of the static deposit key
+   * * `index` - The index of the static deposit public signing key
    *
    * # Returns
-   * The 33-byte public key, or an error string
+   * The 33-byte public key, or a `SignerError`
    *
    * See also: [JavaScript `getStaticDepositSigningKey`](https://docs.spark.money/wallets/spark-signer#get-static-deposit-signing-key)
    */
@@ -22062,11 +22090,11 @@ export class ExternalSignerImpl
    * Subtracts one secret from another.
    *
    * # Arguments
-   * * `signing_key` - The first secret source
-   * * `new_signing_key` - The second secret source to subtract
+   * * `signing_key` - The first secret
+   * * `new_signing_key` - The second secret to subtract
    *
    * # Returns
-   * The resulting secret source, or an error string
+   * The resulting secret, or a `SignerError`
    *
    * See also: [JavaScript `subtractSplitAndEncrypt`](https://docs.spark.money/wallets/spark-signer#subtract,-split,-and-encrypt)
    * (this method provides the subtraction step of that higher-level operation)
@@ -22121,7 +22149,7 @@ export class ExternalSignerImpl
    * * `num_shares` - Total number of shares to create
    *
    * # Returns
-   * Vector of verifiable secret shares, or an error string
+   * Vector of verifiable secret shares, or a `SignerError`
    *
    * See also: [JavaScript `splitSecretWithProofs`](https://docs.spark.money/wallets/spark-signer#split-secret-with-proofs)
    */
@@ -22176,7 +22204,7 @@ export class ExternalSignerImpl
    * * `receiver_public_key` - The receiver's 33-byte public key
    *
    * # Returns
-   * Encrypted data for the receiver, or an error string
+   * Encrypted data for the receiver, or a `SignerError`
    */
   public async encryptSecretForReceiver(
     encryptedSecret: ExternalEncryptedSecret,
@@ -22220,13 +22248,15 @@ export class ExternalSignerImpl
   }
 
   /**
-   * Gets the public key from a secret source.
+   * Gets the public key from a secret.
    *
    * # Arguments
-   * * `secret` - The secret source
+   * * `secret` - The secret
    *
    * # Returns
-   * The corresponding 33-byte public key, or an error string
+   * The corresponding 33-byte public key, or a `SignerError`
+   *
+   * See also: [JavaScript `getPublicKeyFromDerivation`](https://docs.spark.money/wallets/spark-signer#get-public-key-from-derivation)
    */
   public async publicKeyFromSecret(
     secret: ExternalSecretSource,
@@ -22274,7 +22304,7 @@ export class ExternalSignerImpl
    * * `request` - The Frost signing request
    *
    * # Returns
-   * A signature share, or an error string
+   * A signature share, or a `SignerError`
    *
    * See also: [JavaScript `signFrost`](https://docs.spark.money/wallets/spark-signer#frost-signing)
    */
@@ -22324,7 +22354,7 @@ export class ExternalSignerImpl
    * * `request` - The Frost aggregation request
    *
    * # Returns
-   * The aggregated Frost signature, or an error string
+   * The aggregated Frost signature, or a `SignerError`
    *
    * See also: [JavaScript `aggregateFrost`](https://docs.spark.money/wallets/spark-signer#aggregate-frost-signatures)
    */
@@ -22915,23 +22945,23 @@ const uniffiCallbackInterfaceExternalSigner: {
       );
       return UniffiResult.success(uniffiForeignFuture);
     },
-    generateRandomKey: (
+    generateRandomSecret: (
       uniffiHandle: bigint,
       uniffiFutureCallback: UniffiForeignFutureCompleteRustBuffer,
       uniffiCallbackData: bigint
     ) => {
       const uniffiMakeCall = async (
         signal: AbortSignal
-      ): Promise<ExternalSecretSource> => {
+      ): Promise<ExternalEncryptedSecret> => {
         const jsCallback = FfiConverterTypeExternalSigner.lift(uniffiHandle);
-        return await jsCallback.generateRandomKey({ signal });
+        return await jsCallback.generateRandomSecret({ signal });
       };
-      const uniffiHandleSuccess = (returnValue: ExternalSecretSource) => {
+      const uniffiHandleSuccess = (returnValue: ExternalEncryptedSecret) => {
         uniffiFutureCallback(
           uniffiCallbackData,
           /* UniffiForeignFutureStructRustBuffer */ {
             returnValue:
-              FfiConverterTypeExternalSecretSource.lower(returnValue),
+              FfiConverterTypeExternalEncryptedSecret.lower(returnValue),
             callStatus: uniffiCaller.createCallStatus(),
           }
         );
@@ -28795,23 +28825,23 @@ function uniffiEnsureInitialized() {
   }
   if (
     nativeModule().ubrn_uniffi_breez_sdk_spark_checksum_method_externalsigner_get_public_key_for_node() !==
-    62425
+    37434
   ) {
     throw new UniffiInternalError.ApiChecksumMismatch(
       'uniffi_breez_sdk_spark_checksum_method_externalsigner_get_public_key_for_node'
     );
   }
   if (
-    nativeModule().ubrn_uniffi_breez_sdk_spark_checksum_method_externalsigner_generate_random_key() !==
-    63908
+    nativeModule().ubrn_uniffi_breez_sdk_spark_checksum_method_externalsigner_generate_random_secret() !==
+    26114
   ) {
     throw new UniffiInternalError.ApiChecksumMismatch(
-      'uniffi_breez_sdk_spark_checksum_method_externalsigner_generate_random_key'
+      'uniffi_breez_sdk_spark_checksum_method_externalsigner_generate_random_secret'
     );
   }
   if (
     nativeModule().ubrn_uniffi_breez_sdk_spark_checksum_method_externalsigner_static_deposit_secret_encrypted() !==
-    64635
+    38925
   ) {
     throw new UniffiInternalError.ApiChecksumMismatch(
       'uniffi_breez_sdk_spark_checksum_method_externalsigner_static_deposit_secret_encrypted'
@@ -28819,7 +28849,7 @@ function uniffiEnsureInitialized() {
   }
   if (
     nativeModule().ubrn_uniffi_breez_sdk_spark_checksum_method_externalsigner_static_deposit_secret() !==
-    35967
+    45280
   ) {
     throw new UniffiInternalError.ApiChecksumMismatch(
       'uniffi_breez_sdk_spark_checksum_method_externalsigner_static_deposit_secret'
@@ -28827,7 +28857,7 @@ function uniffiEnsureInitialized() {
   }
   if (
     nativeModule().ubrn_uniffi_breez_sdk_spark_checksum_method_externalsigner_static_deposit_signing_key() !==
-    15562
+    62519
   ) {
     throw new UniffiInternalError.ApiChecksumMismatch(
       'uniffi_breez_sdk_spark_checksum_method_externalsigner_static_deposit_signing_key'
@@ -28835,7 +28865,7 @@ function uniffiEnsureInitialized() {
   }
   if (
     nativeModule().ubrn_uniffi_breez_sdk_spark_checksum_method_externalsigner_subtract_secrets() !==
-    43864
+    51106
   ) {
     throw new UniffiInternalError.ApiChecksumMismatch(
       'uniffi_breez_sdk_spark_checksum_method_externalsigner_subtract_secrets'
@@ -28843,7 +28873,7 @@ function uniffiEnsureInitialized() {
   }
   if (
     nativeModule().ubrn_uniffi_breez_sdk_spark_checksum_method_externalsigner_split_secret_with_proofs() !==
-    6228
+    19489
   ) {
     throw new UniffiInternalError.ApiChecksumMismatch(
       'uniffi_breez_sdk_spark_checksum_method_externalsigner_split_secret_with_proofs'
@@ -28851,7 +28881,7 @@ function uniffiEnsureInitialized() {
   }
   if (
     nativeModule().ubrn_uniffi_breez_sdk_spark_checksum_method_externalsigner_encrypt_secret_for_receiver() !==
-    61924
+    51627
   ) {
     throw new UniffiInternalError.ApiChecksumMismatch(
       'uniffi_breez_sdk_spark_checksum_method_externalsigner_encrypt_secret_for_receiver'
@@ -28859,7 +28889,7 @@ function uniffiEnsureInitialized() {
   }
   if (
     nativeModule().ubrn_uniffi_breez_sdk_spark_checksum_method_externalsigner_public_key_from_secret() !==
-    27909
+    53055
   ) {
     throw new UniffiInternalError.ApiChecksumMismatch(
       'uniffi_breez_sdk_spark_checksum_method_externalsigner_public_key_from_secret'
@@ -28867,7 +28897,7 @@ function uniffiEnsureInitialized() {
   }
   if (
     nativeModule().ubrn_uniffi_breez_sdk_spark_checksum_method_externalsigner_sign_frost() !==
-    2993
+    20635
   ) {
     throw new UniffiInternalError.ApiChecksumMismatch(
       'uniffi_breez_sdk_spark_checksum_method_externalsigner_sign_frost'
@@ -28875,7 +28905,7 @@ function uniffiEnsureInitialized() {
   }
   if (
     nativeModule().ubrn_uniffi_breez_sdk_spark_checksum_method_externalsigner_aggregate_frost() !==
-    27769
+    53544
   ) {
     throw new UniffiInternalError.ApiChecksumMismatch(
       'uniffi_breez_sdk_spark_checksum_method_externalsigner_aggregate_frost'