Merge pull request #5 from BowTiedRadone/feat/sbtc-transfer-many

Add STX and sBTC transfer-many extensions

Author: friedger

.github/workflows/tests.yml

@@ -29,9 +29,11 @@ jobs:
           pnpm generate
           pnpm test -- --coverage
 
-      - name: Commit coverage report
+      - name: Normalize lcov.info paths and commit coverage report
         if: github.event_name == 'push'
         run: |
+          # Convert absolute CI paths to relative paths for local compatibility
+          sed -i "s|$(pwd)/||g" lcov.info
           git config user.email "action@github.com"
           git config user.name "GitHub Action"
           git add lcov.info

Clarinet.toml

@@ -8,6 +8,9 @@ cache_dir = './.cache'
 [[project.requirements]]
 contract_id = 'ST3FFRX7C911PZP5RHE148YDVDD9JWVS6FZRA60VS.extension-trait'
 
+[[project.requirements]]
+contract_id = 'SP3FBR2AGK5H9QBDH3EEN6DF8EK8JY7RX8QJ5SVTE.send-many'
+
 [[project.requirements]]
 contract_id = 'SP2PABAF9FTAJYNFZH93XENAJ8FVY99RRM50D2JG9.nft-trait'
 
@@ -43,138 +46,146 @@ contract_id = 'SM3VDXK3WZZSA84XXFKAFAF15NNZX32CTSG82JFQ4.sbtc-token'
 
 [[project.requirements]]
 contract_id = 'SPDBEG5X8XD50SPM1JJH0E5CTXGDV5NJTKAKKR5V.sip013-semi-fungible-token-trait'
+
 [contracts.emergency-rules]
 path = 'contracts/rules/emergency-rules.clar'
 clarity_version = 3
-epoch = 3.1
+epoch = "latest"
+
+[contracts.ext-sponsored-sbtc-transfer]
+path = 'contracts/extensions/ext-sponsored-sbtc-transfer.clar'
+clarity_version = 3
+epoch = "latest"
+
+[contracts.ext-sponsored-sbtc-transfer-many]
+path = 'contracts/extensions/ext-sponsored-sbtc-transfer-many.clar'
+clarity_version = 3
+epoch = "latest"
+
+[contracts.ext-sponsored-sbtc-transfer_test]
+path = 'contracts/extensions/ext-sponsored-sbtc-transfer_test.clar'
+clarity_version = 3
+epoch = "latest"
 
 [contracts.ext-delegate-stx-pox-4]
 path = 'contracts/extensions/ext-delegate-stx-pox-4.clar'
 clarity_version = 3
-epoch = 3.1
+epoch = "latest"
 
 [contracts.ext-delegate-stx-pox-4_flow_test]
 path = 'contracts/extensions/ext-delegate-stx-pox-4_flow_test.clar'
 clarity_version = 3
-epoch = 3.1
+epoch = "latest"
 
 [contracts.ext-sponsored-transfer]
 path = 'contracts/extensions/ext-sponsored-transfer.clar'
 clarity_version = 3
-epoch = 3.1
+epoch = "latest"
+
+[contracts.ext-sponsored-send-many]
+path = 'contracts/extensions/ext-sponsored-send-many.clar'
+clarity_version = 3
+epoch = "latest"
 
 [contracts.ext-unsafe-sip010-transfer]
 path = 'contracts/extensions/ext-unsafe-sip010-transfer.clar'
 clarity_version = 3
-epoch = 3.1
+epoch = "latest"
 
 [contracts.extension-trait]
 path = 'contracts/extension-trait.clar'
 clarity_version = 3
-epoch = 3.1
+epoch = "latest"
 
 [contracts.inactive-observer]
 path = 'contracts/admin/inactive-observer.clar'
 clarity_version = 3
-epoch = 3.1
+epoch = "latest"
 
 [contracts.no-rules]
 path = 'contracts/rules/no-rules.clar'
 clarity_version = 3
-epoch = 3.1
+epoch = "latest"
 
 [contracts.rule-set-trait]
 path = 'contracts/rule-set-trait.clar'
 clarity_version = 3
-epoch = 3.1
+epoch = "latest"
 
 [contracts.smart-wallet-with-rules]
 path = 'contracts/smart-wallet-with-rules.clar'
 clarity_version = 3
-epoch = 3.1
+epoch = "latest"
 
 [contracts.smart-wallet-standard]
 path = 'contracts/smart-wallet-standard.clar'
 clarity_version = 3
-epoch = 3.1
+epoch = "latest"
 
 [contracts.smart-wallet-standard-2]
 path = 'contracts/smart-wallet-standard.clar'
 clarity_version = 3
-epoch = 3.1
+epoch = "latest"
 
 [contracts.smart-wallet-group]
 path = 'contracts/smart-wallet-group.clar'
 clarity_version = 3
-epoch = 3.1
+epoch = "latest"
 
 [contracts.smart-wallet-group_test]
 path = 'contracts/smart-wallet-group_test.clar'
 clarity_version = 3
-epoch = 3.1
+epoch = "latest"
 
 [contracts.smart-wallet-standard_test]
 path = 'contracts/smart-wallet-standard_test.clar'
 clarity_version = 3
-epoch = 3.1
-
+epoch = "latest"
 
 [contracts.smart-wallet-endpoint]
 path = 'contracts/smart-wallet-endpoint.clar'
 clarity_version = 3
-epoch = 3.1
+epoch = "latest"
 
 [contracts.smart-wallet-trait]
 path = 'contracts/smart-wallet-trait.clar'
 clarity_version = 3
-epoch = 3.1
-
+epoch = "latest"
 
 [contracts.smart-wallet-with-rules-trait]
 path = 'contracts/smart-wallet-with-rules-trait.clar'
 clarity_version = 3
-epoch = 3.1
+epoch = "latest"
 
 [contracts.standard-rules]
 path = 'contracts/rules/standard-rules.clar'
 clarity_version = 3
-epoch = 3.1
+epoch = "latest"
 
 [contracts.ext-test]
 path = 'contracts/tests/ext-test.clar'
 clarity_version = 3
-epoch = 3.1
-
-[contracts.ext-sponsored-sbtc-transfer]
-path = 'contracts/extensions/ext-sponsored-sbtc-transfer.clar'
-clarity_version = 3
-epoch = 3.1
-
-[contracts.ext-sponsored-sbtc-transfer_test]
-path = 'contracts/extensions/ext-sponsored-sbtc-transfer_test.clar'
-clarity_version = 3
-epoch = 3.1
-
+epoch = "latest"
 
 [contracts.csw-registry]
 path = 'contracts/csw-registry.clar'
 clarity_version = 3
-epoch = 3.1
+epoch = "latest"
 
 [contracts.csw-registry_test]
 path = 'contracts/csw-registry_test.clar'
 clarity_version = 3
-epoch = 3.1
+epoch = "latest"
 
 [contracts.dummy-csw]
 path = 'contracts/tests/dummy-csw.clar'
 clarity_version = 3
-epoch = 3.1
+epoch = "latest"
 
 [contracts.dummy-csw-2]
 path = 'contracts/tests/dummy-csw.clar'
 clarity_version = 3
-epoch = 3.1
+epoch = "latest"
 
 [repl.analysis]
 passes = ['check_checker']

README.md

@@ -26,3 +26,11 @@ pnpm install
 pnpm generate
 pnpm test
 ```
+
+To visualize the project coverage:
+
+```bash
+genhtml lcov.info --output-directory coverage-html --title "CSW Locker Contracts Coverage" --show-details --legend
+cd coverage-html/
+npx http-server . -p 8080
+```

contracts/extensions/ext-sponsored-sbtc-transfer-many.clar

@@ -0,0 +1,78 @@
+;; title: ext-sbtc-transfer-many
+;; version: 1.0
+;; summary: Transfers SBTC tokens to many recipients using custom tuple format.
+;; description: Optimized for buffer size.
+
+(define-constant ERR_TRANSFER_INDEX_PREFIX u1000)
+
+(define-constant err-invalid-payload (err u500))
+
+;; Uses compressed tuple format to fit more recipients within buffer limits.
+;;
+;; Max recipients:
+;; - 41 standard principals
+;; - 11 contract principals
+(define-private (sbtc-transfer-many-custom (recipients (list 200 {
+  a: uint,
+  r: principal,
+})))
+  (fold sbtc-transfer-many-iter recipients (ok u0))
+)
+
+(define-private (sbtc-transfer-many-iter
+    (individual-transfer {
+      a: uint,
+      r: principal,
+    })
+    (result (response uint uint))
+  )
+  (match result
+    index (begin
+      (unwrap!
+        (sbtc-transfer (get a individual-transfer) tx-sender
+          (get r individual-transfer)
+        )
+        (err (+ ERR_TRANSFER_INDEX_PREFIX index))
+      )
+      (ok (+ index u1))
+    )
+    err-index (err err-index)
+  )
+)
+
+(define-private (sbtc-transfer
+    (amount uint)
+    (from principal)
+    (to principal)
+  )
+  (contract-call? 'SM3VDXK3WZZSA84XXFKAFAF15NNZX32CTSG82JFQ4.sbtc-token transfer
+    amount from to none
+  )
+)
+
+(define-public (call (payload (buff 2048)))
+  (let ((details (unwrap!
+      (from-consensus-buff? {
+        recipients: (list
+          200
+          {
+            a: uint,
+            r: principal,
+          }
+        ),
+        fees: uint,
+      }
+        payload
+      )
+      err-invalid-payload
+    )))
+    (try! (sbtc-transfer-many-custom (get recipients details)))
+    (match tx-sponsor?
+      spnsr (let ((fees (get fees details)))
+        (and (> fees u0) (try! (sbtc-transfer fees tx-sender spnsr)))
+      )
+      true
+    )
+    (ok true)
+  )
+)

contracts/extensions/ext-sponsored-send-many.clar

@@ -0,0 +1,38 @@
+;; title: ext-sbtc-transfer-many
+;; version: 1.0
+;; summary: Transfers SBTC tokens to many recipients
+;; description:
+
+(define-constant err-invalid-payload (err u500))
+
+(define-private (send-many (recipients (list 200 {
+  ustx: uint,
+  to: principal,
+})))
+  (contract-call? 'SP3FBR2AGK5H9QBDH3EEN6DF8EK8JY7RX8QJ5SVTE.send-many send-many recipients)
+)
+
+(define-public (call (payload (buff 2048)))
+  (let ((details (unwrap!
+      (from-consensus-buff? {
+        recipients: (list
+          200
+          {
+            ustx: uint,
+            to: principal,
+          }
+        ),
+        fees: uint,
+      }
+        payload
+      )
+      err-invalid-payload
+    )))
+    (try! (send-many (get recipients details)))
+    (match tx-sponsor?
+      spnsr (try! (stx-transfer? (get fees details) tx-sender spnsr))
+      true
+    )
+    (ok true)
+  )
+)

contracts/smart-wallet-endpoint.clar

@@ -20,6 +20,18 @@
   )
 )
 
+(define-public (stx-send-many-sponsored (sm <wallet-trait>) (details {
+  recipients: (list 11 {
+    ustx: uint,
+    to: principal,
+  }),
+  fees: uint,
+}))
+  (contract-call? sm extension-call .ext-sponsored-send-many
+    (unwrap! (to-consensus-buff? details) err-invalid-payload)
+  )
+)
+
 (define-public (sbtc-transfer-sponsored
     (sm <wallet-trait>)
     (details {
@@ -33,6 +45,23 @@
   )
 )
 
+(define-public (sbtc-transfer-many-sponsored
+    (sm <wallet-trait>)
+    (details {
+      recipients: (list 11 {
+        ;; Amount in sats.
+        a: uint,
+        ;; Recipient address.
+        r: principal,
+      }),
+      fees: uint,
+    })
+  )
+  (contract-call? sm extension-call .ext-sponsored-sbtc-transfer-many
+    (unwrap! (to-consensus-buff? details) err-invalid-payload)
+  )
+)
+
 (define-public (transfer-unsafe-sip-010-token
     (sm <wallet-trait>)
     (details {