From 865587e52075b80cc2c84240f98f99b00d4a3d91 Mon Sep 17 00:00:00 2001
From: Rafal Czajkowski <rafal.czajkowski@keep.network>
Date: Fri, 14 Jul 2023 14:22:25 +0200
Subject: [PATCH] Add comment in `BridgeActivity` interface

Point out that `activityKey` stores the redemption key for redemption
and deposit key for deposit.
---
 src/threshold-ts/tbtc/index.ts | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/src/threshold-ts/tbtc/index.ts b/src/threshold-ts/tbtc/index.ts
index 4ad7e6566..b47573d9c 100644
--- a/src/threshold-ts/tbtc/index.ts
+++ b/src/threshold-ts/tbtc/index.ts
@@ -69,6 +69,9 @@ export interface BridgeActivity {
   status: BridgeActivityStatus
   txHash: string
   amount: string
+  /**
+   * Stores the deposit key for deposit and redemption key for redemption.
+   */
   activityKey: string
   additionalData?: unknown
   blockNumber: number