fix: update action contracts formatting to match other contracts

Also updates error codes in prep for new extension, groups action errors with action proposals.

Author: whoabuddy

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

@@ -1,10 +1,26 @@
+;; title: aibtc-action-configure-timed-vault-dao
+;; version: 1.0.0
+;; summary: A predefined action to configure the DAO timed vaults.
+
+;; 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))
 
-(define-constant CFG_MESSAGE "Executed Action Proposal: Updated configuration in <%= it.dao_token_name %> timed vault extension")
+;; template variables
+;;
+
+(define-constant CFG_MESSAGE "Executed Action Proposal: Updated configuration in DAO timed vault extension")
+
+;; public functions
+;;
 
 (define-public (callback (sender principal) (memo (buff 34))) (ok true))
 
@@ -49,8 +65,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-configure-timed-vault-sbtc.clar

@@ -1,8 +1,12 @@
+;; title: aibtc-action-configure-timed-vault-sbtc
+;; version: 1.0.0
+;; summary: A predefined action to configure the BTC timed vaults.
+
 (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))
+(define-constant ERR_NOT_DAO_OR_EXTENSION (err u1100))
+(define-constant ERR_INVALID_PARAMS (err u1101))
 
 (define-constant CFG_MESSAGE "Executed Action Proposal: Updated configuration in BTC timed vault extension")
 
@@ -51,6 +55,6 @@
 
 (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-configure-timed-vault-stx.clar

@@ -1,8 +1,12 @@
+;; title: aibtc-action-configure-timed-vault-stx
+;; version: 1.0.0
+;; summary: A predefined action to configure the STX timed vaults.
+
 (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))
+(define-constant ERR_NOT_DAO_OR_EXTENSION (err u1100))
+(define-constant ERR_INVALID_PARAMS (err u1101))
 
 (define-constant CFG_MESSAGE "Executed Action Proposal: Updated configuration in STX timed vault extension")
 
@@ -51,6 +55,6 @@
 
 (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-dao-add-resource.clar

@@ -1,11 +1,27 @@
+;; title: aibtc-action-pmt-dao-add-resource
+;; version: 1.0.0
+;; summary: A predefined action to add 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: Added a resource in the DAO 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/aibtc-operating-fund.clar

@@ -1,25 +1,32 @@
 ;; title: aibtc-operating-fund
 ;; version: 2.0.0
-;; summary: TBD
+;; summary: An operations fund for the dao with a 2% allocation of the total supply.
 
+;; TODO - remove notes
 ;; this contract receives 2% of total supply at launch
 ;; this contract can receive DAO token, sBTC or STX from treasury
 ;; this contract can fund a timed vault when initialized
 
 ;; traits
 ;;
+
 (impl-trait .aibtc-dao-traits-v3.extension)
 (impl-trait .aibtc-dao-traits-v3.operating-fund)
 
+(use-trait ft-trait 'SP3FBR2AGK5H9QBDH3EEN6DF8EK8JY7RX8QJ5SVTE.sip-010-trait-ft-standard.sip-010-trait)
+
 ;; constants
 ;;
 
+;; contract details
 (define-constant DEPLOYED_BURN_BLOCK burn-block-height)
 (define-constant DEPLOYED_STACKS_BLOCK stacks-block-height)
 (define-constant SELF (as-contract tx-sender))
 
 ;; error messages
 (define-constant ERR_NOT_DAO_OR_EXTENSION (err u9000)) ;; TBD/check
+(define-constant ERR_UNKNOWN_ASSET (err u9001))
+(define-constant ERR_FETCHING_ASSET (err u9002))
 
 ;; template variables
 ;;
@@ -31,9 +38,7 @@
 ;; public functions
 ;;
 
-(define-public (callback (sender principal) (memo (buff 34)))
-  (ok true)
-)
+(define-public (callback (sender principal) (memo (buff 34))) (ok true))
 
 ;; read only functions
 ;;

contracts/dao/extensions/aibtc-treasury.clar

@@ -4,16 +4,16 @@
 
 ;; traits
 ;;
+
 (impl-trait .aibtc-dao-traits-v3.extension)
 (impl-trait .aibtc-dao-traits-v3.treasury)
 
 (use-trait ft-trait 'SP3FBR2AGK5H9QBDH3EEN6DF8EK8JY7RX8QJ5SVTE.sip-010-trait-ft-standard.sip-010-trait)
-(use-trait nft-trait 'SP2PABAF9FTAJYNFZH93XENAJ8FVY99RRM50D2JG9.nft-trait.nft-trait)
 
 ;; constants
 ;;
 
-;; contract names
+;; contract details
 (define-constant DEPLOYED_BURN_BLOCK burn-block-height)
 (define-constant DEPLOYED_STACKS_BLOCK stacks-block-height)
 (define-constant SELF (as-contract tx-sender))
@@ -59,9 +59,7 @@
 ;; public functions
 ;;
 
-(define-public (callback (sender principal) (memo (buff 34)))
-  (ok true)
-)
+(define-public (callback (sender principal) (memo (buff 34))) (ok true))
 
 ;; add or update an asset to the allowed list
 (define-public (allow-asset (token principal) (enabled bool))

tests/error-codes.ts

@@ -41,7 +41,7 @@ export enum ActionProposalsV2ErrCode {
 }
 
 export enum ActionErrCode {
-  ERR_UNAUTHORIZED = 10001,
+  ERR_UNAUTHORIZED = 1100,
   ERR_INVALID_PARAMS,
 }
 
@@ -113,7 +113,9 @@ export enum PaymentProcessorErrCode {
 
 export enum TreasuryErrCode {
   ERR_NOT_DAO_OR_EXTENSION = 6000,
-  ERR_UNKNOWN_ASSSET,
+  ERR_UNKNOWN_ASSET,
+  ERR_FETCHING_ASSET,
+  ERR_PERIOD_ALREADY_CLAIMED,
 }
 
 export enum TokenOwnerErrCode {
@@ -127,6 +129,19 @@ export enum DaoCharterErrCode {
   ERR_CHARTER_TOO_LONG,
 }
 
+export enum UserAgentAccountErrCode {
+  ERR_UNAUTHORIZED = 9000,
+  ERR_UNKNOWN_ASSET,
+  ERR_OPERATION_FAILED,
+  ERR_BUY_SELL_NOT_ALLOWED,
+}
+
+export enum OperatingFundErrCode {
+  ERR_NOT_DAO_OR_EXTENSION = 10000,
+  ERR_UNKNOWN_ASSET,
+  ERR_FETCHING_ASSET,
+}
+
 export enum TokenFaktoryErrCode {
   ERR_NOT_AUTHORIZED = 401,
   ERR_NOT_OWNER,
@@ -141,10 +156,3 @@ export enum TokenFaktoryDexErrCode {
   ERR_FETCHING_SELL_INFO,
   ERR_TOKEN_NOT_AUTH = 401,
 }
-
-export enum UserAgentAccountErrCode {
-  ERR_UNAUTHORIZED = 9000,
-  ERR_UNKNOWN_ASSET,
-  ERR_OPERATION_FAILED,
-  ERR_BUY_SELL_NOT_ALLOWED,
-}