taler-typescript-core

commit 2566fb8008d1bac70d210187ba61f2081f8c93a0
parent 92db7a8a68009d8e6cd184068b382e34b9a9c232
Author: Florian Dold <florian@dold.me>
Date:   Tue,  3 Jun 2025 14:26:41 +0200

wallet-core: return txState when creating deposit group, deprecate depositGroupId

Diffstat:
M
packages/taler-util/src/types-taler-wallet.ts
 | 
22
++++++++++++++++++++--
M
packages/taler-wallet-core/src/deposits.ts
 | 
1
+

2 files changed, 21 insertions(+), 2 deletions(-)
diff --git a/packages/taler-util/src/types-taler-wallet.ts b/packages/taler-util/src/types-taler-wallet.ts
@@ -56,7 +56,7 @@ import {
   TemplateParams,
   WithdrawalOperationStatusFlag,
   canonicalizeBaseUrl,
-  codecForEddsaPrivateKey
+  codecForEddsaPrivateKey,
 } from "./index.js";
 import { PaytoString, codecForPaytoString } from "./payto.js";
 import { QrCodeSpec } from "./qr.js";
@@ -98,6 +98,7 @@ import { BackupRecovery } from "./types-taler-sync.js";
 import {
   TransactionMajorState,
   TransactionMinorState,
+  TransactionState,
   TransactionStateWildcard,
 } from "./types-taler-wallet-transactions.js";
 
@@ -2815,9 +2816,26 @@ export const codecForCreateDepositGroupRequest =
       .property("testingFixedPriv", codecOptional(codecForString()))
       .build("CreateDepositGroupRequest");
 
+/**
+ * Response to a createDepositGroup request.
+ */
 export interface CreateDepositGroupResponse {
-  depositGroupId: string;
+  /**
+   * Transaction ID of the newly created deposit transaction.
+   */
   transactionId: TransactionIdStr;
+
+  /**
+   * Current state of the new deposit transaction.
+   * Returned as a performance optimization, so that the UI
+   * doesn't have to do a separate getTransactionById.
+   */
+  txState: TransactionState;
+
+  /**
+   * @deprecated 2025-06-03, use transactionId instead.
+   */
+  depositGroupId: string;
 }
 
 export interface TxIdResponse {
diff --git a/packages/taler-wallet-core/src/deposits.ts b/packages/taler-wallet-core/src/deposits.ts
@@ -2347,6 +2347,7 @@ export async function createDepositGroup(
   return {
     depositGroupId,
     transactionId,
+    txState: newTxState,
   };
 }