style: Standardize formatting for action contracts

Author: whoabuddy

contracts/dao/extensions/actions/aibtc-action-configure-timed-vault-sbtc.clar

@@ -2,14 +2,26 @@
 ;; version: 1.0.0
 ;; summary: A predefined action to configure the BTC timed vaults.
 
+;; traits
+;;
+
 (impl-trait .aibtc-dao-traits-v3.extension)
 (impl-trait .aibtc-dao-traits-v3.action)
 
+;; constants
+;;
+
 (define-constant ERR_NOT_DAO_OR_EXTENSION (err u1100))
 (define-constant ERR_INVALID_PARAMS (err u1101))
 
+;; template variables
+;;
+
 (define-constant CFG_MESSAGE "Executed Action Proposal: Updated configuration in BTC timed vault extension")
 
+;; public functions
+;;
+
 (define-public (callback (sender principal) (memo (buff 34))) (ok true))
 
 (define-public (run (parameters (buff 2048)))
@@ -53,6 +65,9 @@
   )
 )
 
+;; private functions
+;;
+
 (define-private (is-dao-or-extension)
   (ok (asserts! (or (is-eq tx-sender .aibtc-base-dao)
     (contract-call? .aibtc-base-dao is-extension contract-caller)) ERR_NOT_DAO_OR_EXTENSION

contracts/dao/extensions/actions/aibtc-action-configure-timed-vault-stx.clar

@@ -2,14 +2,26 @@
 ;; version: 1.0.0
 ;; summary: A predefined action to configure the STX timed vaults.
 
+;; traits
+;;
+
 (impl-trait .aibtc-dao-traits-v3.extension)
 (impl-trait .aibtc-dao-traits-v3.action)
 
+;; constants
+;;
+
 (define-constant ERR_NOT_DAO_OR_EXTENSION (err u1100))
 (define-constant ERR_INVALID_PARAMS (err u1101))
 
+;; template variables
+;;
+
 (define-constant CFG_MESSAGE "Executed Action Proposal: Updated configuration in STX timed vault extension")
 
+;; public functions
+;;
+
 (define-public (callback (sender principal) (memo (buff 34))) (ok true))
 
 (define-public (run (parameters (buff 2048)))
@@ -53,6 +65,9 @@
   )
 )
 
+;; private functions
+;;
+
 (define-private (is-dao-or-extension)
   (ok (asserts! (or (is-eq tx-sender .aibtc-base-dao)
     (contract-call? .aibtc-base-dao is-extension contract-caller)) ERR_NOT_DAO_OR_EXTENSION

contracts/dao/extensions/actions/aibtc-action-pmt-dao-toggle-resource.clar

@@ -1,11 +1,27 @@
+;; title: aibtc-action-pmt-dao-toggle-resource
+;; version: 1.0.0
+;; summary: A predefined action to toggle a resource in the DAO payment processor extension.
+
+;; traits
+;;
+
 (impl-trait .aibtc-dao-traits-v3.extension)
 (impl-trait .aibtc-dao-traits-v3.action)
 
-(define-constant ERR_UNAUTHORIZED (err u10001))
-(define-constant ERR_INVALID_PARAMS (err u10002))
+;; constants
+;;
+
+(define-constant ERR_NOT_DAO_OR_EXTENSION (err u1100))
+(define-constant ERR_INVALID_PARAMS (err u1101))
+
+;; template variables
+;;
 
 (define-constant CFG_MESSAGE "Executed Action Proposal: Toggled resource status by name in the DAO payment processor extension")
 
+;; public functions
+;;
+
 (define-public (callback (sender principal) (memo (buff 34))) (ok true))
 
 (define-public (run (parameters (buff 2048)))
@@ -19,8 +35,11 @@
   )
 )
 
+;; private functions
+;;
+
 (define-private (is-dao-or-extension)
   (ok (asserts! (or (is-eq tx-sender .aibtc-base-dao)
-    (contract-call? .aibtc-base-dao is-extension contract-caller)) ERR_UNAUTHORIZED
+    (contract-call? .aibtc-base-dao is-extension contract-caller)) ERR_NOT_DAO_OR_EXTENSION
   ))
 )

contracts/dao/extensions/actions/aibtc-action-pmt-sbtc-add-resource.clar

@@ -1,11 +1,27 @@
+;; title: aibtc-action-pmt-sbtc-add-resource
+;; version: 1.0.0
+;; summary: A predefined action to add a resource in the BTC payment processor extension.
+
+;; traits
+;;
+
 (impl-trait .aibtc-dao-traits-v3.extension)
 (impl-trait .aibtc-dao-traits-v3.action)
 
-(define-constant ERR_UNAUTHORIZED (err u10001))
-(define-constant ERR_INVALID_PARAMS (err u10002))
+;; constants
+;;
+
+(define-constant ERR_NOT_DAO_OR_EXTENSION (err u1100))
+(define-constant ERR_INVALID_PARAMS (err u1101))
+
+;; template variables
+;;
 
 (define-constant CFG_MESSAGE "Executed Action Proposal: Added a resource in the BTC payment processor extension")
 
+;; public functions
+;;
+
 (define-public (callback (sender principal) (memo (buff 34))) (ok true))
 
 (define-public (run (parameters (buff 2048)))
@@ -22,8 +38,11 @@
   )
 )
 
+;; private functions
+;;
+
 (define-private (is-dao-or-extension)
   (ok (asserts! (or (is-eq tx-sender .aibtc-base-dao)
-    (contract-call? .aibtc-base-dao is-extension contract-caller)) ERR_UNAUTHORIZED
+    (contract-call? .aibtc-base-dao is-extension contract-caller)) ERR_NOT_DAO_OR_EXTENSION
   ))
 )

contracts/dao/extensions/actions/aibtc-action-pmt-sbtc-toggle-resource.clar

@@ -1,11 +1,27 @@
+;; title: aibtc-action-pmt-sbtc-toggle-resource
+;; version: 1.0.0
+;; summary: A predefined action to toggle a resource in the BTC payment processor extension.
+
+;; traits
+;;
+
 (impl-trait .aibtc-dao-traits-v3.extension)
 (impl-trait .aibtc-dao-traits-v3.action)
 
-(define-constant ERR_UNAUTHORIZED (err u10001))
-(define-constant ERR_INVALID_PARAMS (err u10002))
+;; constants
+;;
+
+(define-constant ERR_NOT_DAO_OR_EXTENSION (err u1100))
+(define-constant ERR_INVALID_PARAMS (err u1101))
+
+;; template variables
+;;
 
 (define-constant CFG_MESSAGE "Executed Action Proposal: Toggled resource status by name in the BTC payment processor extension")
 
+;; public functions
+;;
+
 (define-public (callback (sender principal) (memo (buff 34))) (ok true))
 
 (define-public (run (parameters (buff 2048)))
@@ -19,8 +35,11 @@
   )
 )
 
+;; private functions
+;;
+
 (define-private (is-dao-or-extension)
   (ok (asserts! (or (is-eq tx-sender .aibtc-base-dao)
-    (contract-call? .aibtc-base-dao is-extension contract-caller)) ERR_UNAUTHORIZED
+    (contract-call? .aibtc-base-dao is-extension contract-caller)) ERR_NOT_DAO_OR_EXTENSION
   ))
 )

contracts/dao/extensions/actions/aibtc-action-pmt-stx-add-resource.clar

@@ -1,11 +1,27 @@
+;; title: aibtc-action-pmt-stx-add-resource
+;; version: 1.0.0
+;; summary: A predefined action to add a resource in the STX payment processor extension.
+
+;; traits
+;;
+
 (impl-trait .aibtc-dao-traits-v3.extension)
 (impl-trait .aibtc-dao-traits-v3.action)
 
-(define-constant ERR_UNAUTHORIZED (err u10001))
-(define-constant ERR_INVALID_PARAMS (err u10002))
+;; constants
+;;
+
+(define-constant ERR_NOT_DAO_OR_EXTENSION (err u1100))
+(define-constant ERR_INVALID_PARAMS (err u1101))
+
+;; template variables
+;;
 
 (define-constant CFG_MESSAGE "Executed Action Proposal: Added a resource in the STX payment processor extension")
 
+;; public functions
+;;
+
 (define-public (callback (sender principal) (memo (buff 34))) (ok true))
 
 (define-public (run (parameters (buff 2048)))
@@ -22,8 +38,11 @@
   )
 )
 
+;; private functions
+;;
+
 (define-private (is-dao-or-extension)
   (ok (asserts! (or (is-eq tx-sender .aibtc-base-dao)
-    (contract-call? .aibtc-base-dao is-extension contract-caller)) ERR_UNAUTHORIZED
+    (contract-call? .aibtc-base-dao is-extension contract-caller)) ERR_NOT_DAO_OR_EXTENSION
   ))
 )

contracts/dao/extensions/actions/aibtc-action-pmt-stx-toggle-resource.clar

@@ -1,11 +1,27 @@
+;; title: aibtc-action-pmt-stx-toggle-resource
+;; version: 1.0.0
+;; summary: A predefined action to toggle a resource in the STX payment processor extension.
+
+;; traits
+;;
+
 (impl-trait .aibtc-dao-traits-v3.extension)
 (impl-trait .aibtc-dao-traits-v3.action)
 
-(define-constant ERR_UNAUTHORIZED (err u10001))
-(define-constant ERR_INVALID_PARAMS (err u10002))
+;; constants
+;;
+
+(define-constant ERR_NOT_DAO_OR_EXTENSION (err u1100))
+(define-constant ERR_INVALID_PARAMS (err u1101))
+
+;; template variables
+;;
 
 (define-constant CFG_MESSAGE "Executed Action Proposal: Toggled resource status by name in the STX payment processor extension")
 
+;; public functions
+;;
+
 (define-public (callback (sender principal) (memo (buff 34))) (ok true))
 
 (define-public (run (parameters (buff 2048)))
@@ -19,8 +35,11 @@
   )
 )
 
+;; private functions
+;;
+
 (define-private (is-dao-or-extension)
   (ok (asserts! (or (is-eq tx-sender .aibtc-base-dao)
-    (contract-call? .aibtc-base-dao is-extension contract-caller)) ERR_UNAUTHORIZED
+    (contract-call? .aibtc-base-dao is-extension contract-caller)) ERR_NOT_DAO_OR_EXTENSION
   ))
 )

contracts/dao/extensions/actions/aibtc-action-send-message.clar

@@ -1,8 +1,24 @@
+;; title: aibtc-action-send-message
+;; version: 1.0.0
+;; summary: A predefined action to send a message through the onchain messaging system.
+
+;; traits
+;;
+
 (impl-trait .aibtc-dao-traits-v3.extension)
 (impl-trait .aibtc-dao-traits-v3.action)
 
-(define-constant ERR_UNAUTHORIZED (err u10001))
-(define-constant ERR_INVALID_PARAMS (err u10002))
+;; constants
+;;
+
+(define-constant ERR_NOT_DAO_OR_EXTENSION (err u1100))
+(define-constant ERR_INVALID_PARAMS (err u1101))
+
+;; template variables
+;;
+
+;; public functions
+;;
 
 (define-public (callback (sender principal) (memo (buff 34))) (ok true))
 
@@ -16,8 +32,11 @@
   )
 )
 
+;; private functions
+;;
+
 (define-private (is-dao-or-extension)
   (ok (asserts! (or (is-eq tx-sender .aibtc-base-dao)
-    (contract-call? .aibtc-base-dao is-extension contract-caller)) ERR_UNAUTHORIZED
+    (contract-call? .aibtc-base-dao is-extension contract-caller)) ERR_NOT_DAO_OR_EXTENSION
   ))
 )

contracts/dao/extensions/actions/aibtc-action-treasury-allow-asset.clar

@@ -1,11 +1,27 @@
+;; title: aibtc-action-treasury-allow-asset
+;; version: 1.0.0
+;; summary: A predefined action to allow or enable an asset for use in the treasury.
+
+;; traits
+;;
+
 (impl-trait .aibtc-dao-traits-v3.extension)
 (impl-trait .aibtc-dao-traits-v3.action)
 
-(define-constant ERR_UNAUTHORIZED (err u10001))
-(define-constant ERR_INVALID_PARAMS (err u10002))
+;; constants
+;;
+
+(define-constant ERR_NOT_DAO_OR_EXTENSION (err u1100))
+(define-constant ERR_INVALID_PARAMS (err u1101))
+
+;; template variables
+;;
 
 (define-constant CFG_MESSAGE "Executed Action Proposal: Allowed or enabled asset for use in the treasury") 
 
+;; public functions
+;;
+
 (define-public (callback (sender principal) (memo (buff 34))) (ok true))
 
 (define-public (run (parameters (buff 2048)))
@@ -19,8 +35,11 @@
   )
 )
 
+;; private functions
+;;
+
 (define-private (is-dao-or-extension)
   (ok (asserts! (or (is-eq tx-sender .aibtc-base-dao)
-    (contract-call? .aibtc-base-dao is-extension contract-caller)) ERR_UNAUTHORIZED
+    (contract-call? .aibtc-base-dao is-extension contract-caller)) ERR_NOT_DAO_OR_EXTENSION
   ))
 )