fresh branch, updated withdrawal, deposits & tests

stacks-network · Nov 7, 2024 · 873329b · 873329b
1 parent 0d52435
commit 873329b
Show file tree

Hide file tree

Showing 6 changed files with 90 additions and 8 deletions.
diff --git a/contracts/contracts/sbtc-deposit.clar b/contracts/contracts/sbtc-deposit.clar
@@ -33,7 +33,8 @@
                                          (amount uint)
                                          (recipient principal)
                                          (burn-hash (buff 32))
-                                         (burn-height uint))
+                                         (burn-height uint)
+                                         (sweep-txid (buff 32)))
     (let 
         (
             (current-signer-data (contract-call? .sbtc-registry get-current-signer-data))
@@ -49,6 +50,9 @@
         ;; Check that txid is the correct length
         (asserts! (is-eq (len txid) txid-length) ERR_TXID_LEN)
 
+        ;; Check that sweep txid is the correct length
+        (asserts! (is-eq (len sweep-txid) txid-length) ERR_TXID_LEN)
+
         ;; Assert that the deposit has not already been completed (no replay)
         (asserts! (is-none replay-fetch) ERR_DEPOSIT_REPLAY)
 
@@ -75,7 +79,7 @@
 ;; This function handles the validation & minting of sBTC by handling multiple (up to 1000) deposits at a time, 
 ;; it then calls into the sbtc-registry contract to update the state of the protocol. 
 (define-public (complete-deposits-wrapper 
-        (deposits (list 650 {txid: (buff 32), vout-index: uint, amount: uint, recipient: principal, burn-hash: (buff 32), burn-height: uint}))
+        (deposits (list 650 {txid: (buff 32), vout-index: uint, amount: uint, recipient: principal, burn-hash: (buff 32), burn-height: uint, sweep-txid: (buff 32)}))
     )
     (begin
         ;; Check that the caller is the current signer principal
@@ -90,11 +94,11 @@
 
 ;; private functions
 ;; #[allow(unchecked_data)]
-(define-private (complete-individual-deposits-helper (deposit {txid: (buff 32), vout-index: uint, amount: uint, recipient: principal, burn-hash: (buff 32), burn-height: uint}) (helper-response (response uint uint)))
+(define-private (complete-individual-deposits-helper (deposit {txid: (buff 32), vout-index: uint, amount: uint, recipient: principal, burn-hash: (buff 32), burn-height: uint, sweep-txid: (buff 32)}) (helper-response (response uint uint)))
     (match helper-response 
         index
             (begin 
-                (try! (unwrap! (complete-deposit-wrapper (get txid deposit) (get vout-index deposit) (get amount deposit) (get recipient deposit) (get burn-hash deposit) (get burn-height deposit)) (err (+ ERR_DEPOSIT_INDEX_PREFIX (+ u10 index)))))
+                (try! (unwrap! (complete-deposit-wrapper (get txid deposit) (get vout-index deposit) (get amount deposit) (get recipient deposit) (get burn-hash deposit) (get burn-height deposit) (get sweep-txid deposit)) (err (+ ERR_DEPOSIT_INDEX_PREFIX (+ u10 index)))))
                 (ok (+ index u1))
             )
         err-response

diff --git a/contracts/contracts/sbtc-withdrawal.clar b/contracts/contracts/sbtc-withdrawal.clar
@@ -147,7 +147,8 @@
                                           (output-index uint)
                                           (fee uint)
                                           (burn-hash (buff 32))
-                                          (burn-height uint))
+                                          (burn-height uint)
+                                          (sweep-txid (buff 32)))
   (let 
     (
       (current-signer-data (contract-call? .sbtc-registry get-current-signer-data))   
@@ -220,7 +221,8 @@
                                       output-index: (optional uint), 
                                       fee: (optional uint),
                                       burn-hash: (buff 32),
-                                      burn-height: uint})))
+                                      burn-height: uint,
+                                      sweep-txid: (optional (buff 32))})))
   (let 
       (
           (current-signer-data (contract-call? .sbtc-registry get-current-signer-data))
@@ -242,7 +244,8 @@
                                                         output-index: (optional uint), 
                                                         fee: (optional uint),
                                                         burn-hash: (buff 32),
-                                                        burn-height: uint}) 
+                                                        burn-height: uint,
+                                                        sweep-txid: (optional (buff 32))}) 
                                                        (helper-response (response uint uint)))
   (match helper-response 
     index
@@ -260,7 +263,7 @@
             (asserts! 
               (and (is-some current-bitcoin-txid) (is-some current-output-index) (is-some current-fee)) 
               (err (+ ERR_WITHDRAWAL_INDEX_PREFIX (+ u10 index))))
-            (unwrap! (accept-withdrawal-request (get request-id withdrawal) (unwrap-panic current-bitcoin-txid) current-signer-bitmap (unwrap-panic current-output-index) (unwrap-panic current-fee) (get burn-hash withdrawal) (get burn-height withdrawal)) (err (+ ERR_WITHDRAWAL_INDEX_PREFIX (+ u10 index))))
+            (unwrap! (accept-withdrawal-request (get request-id withdrawal) (unwrap-panic current-bitcoin-txid) current-signer-bitmap (unwrap-panic current-output-index) (unwrap-panic current-fee) (get burn-hash withdrawal) (get burn-height withdrawal) (unwrap-panic (get sweep-txid withdrawal))) (err (+ ERR_WITHDRAWAL_INDEX_PREFIX (+ u10 index))))
           )
           ;; rejected
           (unwrap! (reject-withdrawal-request (get request-id withdrawal) current-signer-bitmap) (err (+ ERR_WITHDRAWAL_INDEX_PREFIX (+ u10 index))))

diff --git a/contracts/tests/clarigen-types.ts b/contracts/tests/clarigen-types.ts
@@ -503,6 +503,7 @@ export const contracts = {
                 { name: "burn-hash", type: { buffer: { length: 32 } } },
                 { name: "burn-height", type: "uint128" },
                 { name: "recipient", type: "principal" },
+                { name: "sweep-txid", type: { buffer: { length: 32 } } },
                 { name: "txid", type: { buffer: { length: 32 } } },
                 { name: "vout-index", type: "uint128" },
               ],
@@ -522,6 +523,7 @@ export const contracts = {
               burnHash: Uint8Array;
               burnHeight: number | bigint;
               recipient: string;
+              sweepTxid: Uint8Array;
               txid: Uint8Array;
               voutIndex: number | bigint;
             },
@@ -544,6 +546,7 @@ export const contracts = {
           { name: "recipient", type: "principal" },
           { name: "burn-hash", type: { buffer: { length: 32 } } },
           { name: "burn-height", type: "uint128" },
+          { name: "sweep-txid", type: { buffer: { length: 32 } } },
         ],
         outputs: {
           type: {
@@ -561,6 +564,7 @@ export const contracts = {
           recipient: TypedAbiArg<string, "recipient">,
           burnHash: TypedAbiArg<Uint8Array, "burnHash">,
           burnHeight: TypedAbiArg<number | bigint, "burnHeight">,
+          sweepTxid: TypedAbiArg<Uint8Array, "sweepTxid">,
         ],
         Response<Response<boolean, bigint>, bigint>
       >,
@@ -578,6 +582,7 @@ export const contracts = {
                     { name: "burn-hash", type: { buffer: { length: 32 } } },
                     { name: "burn-height", type: "uint128" },
                     { name: "recipient", type: "principal" },
+                    { name: "sweep-txid", type: { buffer: { length: 32 } } },
                     { name: "txid", type: { buffer: { length: 32 } } },
                     { name: "vout-index", type: "uint128" },
                   ],
@@ -596,6 +601,7 @@ export const contracts = {
               burnHash: Uint8Array;
               burnHeight: number | bigint;
               recipient: string;
+              sweepTxid: Uint8Array;
               txid: Uint8Array;
               voutIndex: number | bigint;
             }[],
@@ -1569,6 +1575,10 @@ export const contracts = {
                 { name: "request-id", type: "uint128" },
                 { name: "signer-bitmap", type: "uint128" },
                 { name: "status", type: "bool" },
+                {
+                  name: "sweep-txid",
+                  type: { optional: { buffer: { length: 32 } } },
+                },
               ],
             },
           },
@@ -1590,6 +1600,7 @@ export const contracts = {
               requestId: number | bigint;
               signerBitmap: number | bigint;
               status: boolean;
+              sweepTxid: Uint8Array | null;
             },
             "withdrawal"
           >,
@@ -1611,6 +1622,7 @@ export const contracts = {
           { name: "fee", type: "uint128" },
           { name: "burn-hash", type: { buffer: { length: 32 } } },
           { name: "burn-height", type: "uint128" },
+          { name: "sweep-txid", type: { buffer: { length: 32 } } },
         ],
         outputs: { type: { response: { ok: "bool", error: "uint128" } } },
       } as TypedAbiFunction<
@@ -1622,6 +1634,7 @@ export const contracts = {
           fee: TypedAbiArg<number | bigint, "fee">,
           burnHash: TypedAbiArg<Uint8Array, "burnHash">,
           burnHeight: TypedAbiArg<number | bigint, "burnHeight">,
+          sweepTxid: TypedAbiArg<Uint8Array, "sweepTxid">,
         ],
         Response<boolean, bigint>
       >,
@@ -1646,6 +1659,10 @@ export const contracts = {
                     { name: "request-id", type: "uint128" },
                     { name: "signer-bitmap", type: "uint128" },
                     { name: "status", type: "bool" },
+                    {
+                      name: "sweep-txid",
+                      type: { optional: { buffer: { length: 32 } } },
+                    },
                   ],
                 },
                 length: 600,
@@ -1666,6 +1683,7 @@ export const contracts = {
               requestId: number | bigint;
               signerBitmap: number | bigint;
               status: boolean;
+              sweepTxid: Uint8Array | null;
             }[],
             "withdrawals"
           >,

diff --git a/contracts/tests/sbtc-deposit.test.ts b/contracts/tests/sbtc-deposit.test.ts
@@ -24,6 +24,7 @@ describe("sBTC deposit contract", () => {
           recipient: deployer,
           burnHash,
           burnHeight,
+          sweepTxid: new Uint8Array(32).fill(1),
         }),
         deployer
       );
@@ -41,6 +42,7 @@ describe("sBTC deposit contract", () => {
           recipient: deployer,
           burnHash,
           burnHeight,
+          sweepTxid: new Uint8Array(32).fill(1),
         }),
         deployer
       );
@@ -60,6 +62,7 @@ describe("sBTC deposit contract", () => {
           recipient: deployer,
           burnHash,
           burnHeight,
+          sweepTxid: new Uint8Array(32).fill(1),
         }),
         deployer
       );
@@ -72,6 +75,7 @@ describe("sBTC deposit contract", () => {
           recipient: deployer,
           burnHash,
           burnHeight,
+          sweepTxid: new Uint8Array(32).fill(1),
         }),
         deployer
       );
@@ -89,6 +93,7 @@ describe("sBTC deposit contract", () => {
           recipient: deployer,
           burnHash,
           burnHeight,
+          sweepTxid: new Uint8Array(32).fill(1),
         }),
         deployer
       );
@@ -102,6 +107,7 @@ describe("sBTC deposit contract", () => {
           recipient: deployer,
           burnHash: new Uint8Array(32).fill(1),
           burnHeight,
+          sweepTxid: new Uint8Array(32).fill(2),
         }),
         deployer
       );
@@ -119,6 +125,7 @@ describe("sBTC deposit contract", () => {
           recipient: deployer,
           burnHash,
           burnHeight,
+          sweepTxid: new Uint8Array(32).fill(1),
         }),
         deployer
       );
@@ -154,6 +161,7 @@ describe("sBTC deposit contract", () => {
           recipient: deployer,
           burnHash,
           burnHeight,
+          sweepTxid: new Uint8Array(32).fill(2),
         }),
         deployer
       );
@@ -184,6 +192,7 @@ describe("sBTC deposit contract", () => {
               recipient: deployer,
               burnHash,
               burnHeight,
+              sweepTxid: new Uint8Array(32).fill(1),
             },
             {
               txid: new Uint8Array(32).fill(1),
@@ -192,6 +201,7 @@ describe("sBTC deposit contract", () => {
               recipient: deployer,
               burnHash,
               burnHeight,
+              sweepTxid: new Uint8Array(32).fill(1),
             },
           ],
           ...getCurrentBurnInfo(),
@@ -214,6 +224,7 @@ describe("sBTC deposit contract", () => {
               recipient: deployer,
               burnHash,
               burnHeight,
+              sweepTxid: new Uint8Array(32).fill(1),
             },
             {
               txid: new Uint8Array(32).fill(1),
@@ -222,6 +233,7 @@ describe("sBTC deposit contract", () => {
               recipient: deployer,
               burnHash,
               burnHeight,
+              sweepTxid: new Uint8Array(32).fill(1),
             },
           ],
           ...getCurrentBurnInfo(),
@@ -244,6 +256,7 @@ describe("sBTC deposit contract", () => {
               recipient: deployer,
               burnHash,
               burnHeight,
+              sweepTxid: new Uint8Array(32).fill(1),
             },
             {
               txid: new Uint8Array(32).fill(1),
@@ -252,6 +265,7 @@ describe("sBTC deposit contract", () => {
               recipient: deployer,
               burnHash,
               burnHeight,
+              sweepTxid: new Uint8Array(32).fill(1),
             },
             {
               txid: new Uint8Array(32).fill(2),
@@ -260,6 +274,7 @@ describe("sBTC deposit contract", () => {
               recipient: alice,
               burnHash,
               burnHeight,
+              sweepTxid: new Uint8Array(32).fill(1),
             },
           ],
           ...getCurrentBurnInfo(),
@@ -282,6 +297,7 @@ describe("sBTC deposit contract", () => {
               recipient: deployer,
               burnHash,
               burnHeight,
+              sweepTxid: new Uint8Array(32).fill(1),
             },
             {
               txid: new Uint8Array(32).fill(1),
@@ -290,6 +306,7 @@ describe("sBTC deposit contract", () => {
               recipient: deployer,
               burnHash,
               burnHeight,
+              sweepTxid: new Uint8Array(32).fill(1),
             },
           ],
           ...getCurrentBurnInfo(),
@@ -317,6 +334,7 @@ describe("optimization tests", () => {
           recipient: deployer,
           burnHash,
           burnHeight,
+          sweepTxid: new Uint8Array(32).fill(1),
         })),
         ...getCurrentBurnInfo(),
       }),

diff --git a/contracts/tests/sbtc-token.test.ts b/contracts/tests/sbtc-token.test.ts
@@ -15,6 +15,7 @@ describe("sBTC token contract", () => {
           recipient: alice,
           burnHash,
           burnHeight,
+          sweepTxid: new Uint8Array(32).fill(0),
         }),
         deployer
       );
@@ -56,6 +57,7 @@ describe("sBTC token contract", () => {
           recipient: alice,
           burnHash,
           burnHeight,
+          sweepTxid: new Uint8Array(32).fill(1),
         }),
         deployer
       );