Add Bitcoin refund account property to stake msg

Also leave a `TODO` not to revisit the message structure before the launch.
thesis · Jan 16, 2024 · 2dfe62e · 2dfe62e
1 parent 5701214
commit 2dfe62e
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 4 deletions.
diff --git a/sdk/src/modules/staking/stake-initialization.ts b/sdk/src/modules/staking/stake-initialization.ts
@@ -72,12 +72,20 @@ class StakeInitialization {
       verifyingContract: this.#contracts.depositor.getChainIdentifier(),
     }
 
+    // TODO: revisit the message structure before the launch.
     const types: Types = {
-      Stake: [{ name: "receiver", type: "address" }],
+      Stake: [
+        { name: "receiver", type: "address" },
+        { name: "bitcoinRecoveryAddress", type: "string" },
+      ],
     }
 
     const message: Message = {
       receiver: this.#receiver.identifierHex,
+      // TODO: Make sure we can to pass the refund public key hash in this form.
+      bitcoinRecoveryAddress: this.#deposit
+        .getReceipt()
+        .refundPublicKeyHash.toPrefixedString(),
     }
 
     return { domain, types, message }

diff --git a/sdk/test/modules/staking.test.ts b/sdk/test/modules/staking.test.ts
@@ -127,6 +127,12 @@ describe("Staking", () => {
     })
 
     describe("StakeInitialization", () => {
+      const { depositReceipt } = stakingInitializationData
+
+      beforeAll(() => {
+        mockedDeposit.getReceipt.mockReturnValue(depositReceipt)
+      })
+
       describe("getDepositAddress", () => {
         it("should return bitcoin deposit address", async () => {
           expect(await result.getBitcoinAddress()).toBe(mockedDepositBTCAddress)
@@ -155,10 +161,15 @@ describe("Staking", () => {
                 verifyingContract: contracts.depositor.getChainIdentifier(),
               },
               {
-                Stake: [{ name: "receiver", type: "address" }],
+                Stake: [
+                  { name: "receiver", type: "address" },
+                  { name: "bitcoinRecoveryAddress", type: "string" },
+                ],
               },
               {
                 receiver: receiver.identifierHex,
+                bitcoinRecoveryAddress:
+                  depositReceipt.refundPublicKeyHash.toPrefixedString(),
               },
             )
           })
@@ -220,7 +231,6 @@ describe("Staking", () => {
           describe("when bitcoin deposit address has utxos", () => {
             const {
               fundingUtxos,
-              depositReceipt,
               bitcoinRawTx,
               bitcoinRawTxVectors,
               mockedInitializeTxHash: mockedTxHash,
@@ -230,7 +240,6 @@ describe("Staking", () => {
 
             beforeAll(async () => {
               mockedDeposit.detectFunding.mockResolvedValue(fundingUtxos)
-              mockedDeposit.getReceipt.mockReturnValue(depositReceipt)
               spyOnExtractBitcoinRawTxVectors = jest
                 .spyOn(TBTCModule, "extractBitcoinRawTxVectors")
                 .mockReturnValue(bitcoinRawTxVectors)