fix: outline key parts of redemption contract

Clarinet.toml

@@ -134,6 +134,11 @@ path = "contracts/extensions/ccd010-core-v2-adapter.clar"
 [contracts.ccd011-stacking-payouts]
 path = "contracts/extensions/ccd011-stacking-payouts.clar"
 
+[contracts.ccd012-redemption-mia]
+path = "contracts/extensions/ccd012-redemption-mia.clar"
+clarity_version = 2
+epoch = 2.4
+
 [contracts.ccip012-bootstrap]
 path = "contracts/proposals/ccip012-bootstrap.clar"
 

contracts/extensions/ccd012-redemption-mia.clar

@@ -0,0 +1,128 @@
+;; Title: CCD012 - CityCoin Redemption (MIA)
+;; Version: 1.0.0
+;; Summary: A redemption extension that allows users to redeem CityCoins for a portion of the city treasury.
+;; Description: An extension that provides the ability to claim a portion of the city treasury in exchange for CityCoins.
+
+;; TRAITS
+
+(impl-trait .extension-trait.extension-trait)
+
+;; CONSTANTS
+
+(define-constant ERR_UNAUTHORIZED (err u12000))
+(define-constant ERR_PANIC (err u12001))
+(define-constant ERR_GETTING_TOTAL_SUPPLY (err u12002))
+(define-constant ERR_GETTING_REDEMPTION_BALANCE (err u12003))
+(define-constant ERR_ALREADY_ENABLED (err u12004))
+(define-constant ERR_NOT_ENABLED (err u12005))
+(define-constant ERR_BALANCE_NOT_FOUND (err u12006))
+
+;; DATA VARS
+
+(define-data-var redemptionsEnabled bool false)
+(define-data-var blockHeight uint u0)
+(define-data-var totalSupply uint u0)
+(define-data-var contractBalance uint u0)
+(define-data-var redemptionRatio uint u0)
+
+;; PUBLIC FUNCTIONS
+
+(define-public (is-dao-or-extension)
+  (ok (asserts! (or (is-eq tx-sender .base-dao)
+    (contract-call? .base-dao is-extension contract-caller)) ERR_UNAUTHORIZED
+  ))
+)
+
+(define-public (callback (sender principal) (memo (buff 34)))
+  (ok true)
+)
+
+;; initialize contract after deployment to start redemptions
+(define-public (initialize-redemptions)
+  (let
+    (
+      ;; MAINNET: TODO
+      (miaTotalSupply (unwrap! (contract-call? .miamicoin-token-v2 get-total-supply) ERR_PANIC))
+      (miaRedemptionBalance (as-contract (stx-get-balance tx-sender)))
+    )
+    ;; check if sender is DAO or extension
+    (try! (is-dao-or-extension))
+    ;; check that total supply is greater than 0
+    (asserts! (> miaTotalSupply u0) ERR_GETTING_TOTAL_SUPPLY)
+    ;; check that redemption balance is greater than 0
+    (asserts! (> miaRedemptionBalance u0) ERR_GETTING_REDEMPTION_BALANCE)
+    ;; check if redemptions are already enabled
+    (asserts! (not (var-get redemptionsEnabled)) ERR_ALREADY_ENABLED)
+    ;; record current block height
+    (var-set blockHeight block-height)
+    ;; record total supply at block height
+    (var-set totalSupply miaTotalSupply)
+    ;; record contract balance at block height
+    (var-set contractBalance miaRedemptionBalance)
+    ;; calculate redemption ratio
+    (var-set redemptionRatio (/ miaRedemptionBalance miaTotalSupply))
+    ;; set redemptionsEnabled to true, can only run once
+    (ok (var-set redemptionsEnabled true))
+  )
+)
+
+(define-public (redeem-mia)
+  (let
+    (
+      (balanceV2 (unwrap! (contract-call? .miamicoin-token-v2 get-balance tx-sender) ERR_BALANCE_NOT_FOUND))
+      (redemptionAmount (unwrap! (get-redemption-amount balanceV2) ERR_PANIC)) ;; TODO: more specific err?
+      (userAddress tx-sender)
+    )
+    ;; check if redemptions are enabled
+    (asserts! (var-get redemptionsEnabled) ERR_NOT_ENABLED)
+    ;; burn MIA
+    (try! (contract-call? .miamicoin-token-v2 burn balanceV2 tx-sender))
+    ;; transfer STX
+    (try! (as-contract (stx-transfer? redemptionAmount tx-sender userAddress)))
+    (ok true)
+  )
+)
+
+;; READ ONLY FUNCTIONS
+
+(define-read-only (is-redemption-enabled)
+  (var-get redemptionsEnabled)
+)
+
+(define-read-only (get-redemption-block-height)
+  (var-get blockHeight)
+)
+
+(define-read-only (get-redemption-total-supply)
+  (var-get totalSupply)
+)
+
+(define-read-only (get-redemption-contract-balance)
+  (var-get contractBalance)
+)
+
+(define-read-only (get-redemption-ratio)
+  (var-get redemptionRatio)
+)
+
+;; aggregate all exposed vars above
+(define-read-only (get-redemption-info)
+  {
+    redemptionsEnabled: (var-get redemptionsEnabled),
+    blockHeight: (var-get blockHeight),
+    totalSupply: (var-get totalSupply),
+    contractBalance: (var-get contractBalance),
+    redemptionRatio: (var-get redemptionRatio)
+  }
+)
+
+(define-read-only (get-redemption-amount (balance uint))
+  (begin
+    (asserts! (var-get redemptionsEnabled) none)
+    (some (* balance (var-get redemptionRatio)))
+  )
+)
+
+;; TODO: read-only that returns all post conditions in one call
+
+;; PRIVATE FUNCTIONS