fix: improve comment for calc-claimable-amount

hstove · hstove · commit 7c9e90ae29d7 · 2025-07-18T07:25:04.000-07:00
diff --git a/stackslib/src/chainstate/stacks/boot/sip-031.clar b/stackslib/src/chainstate/stacks/boot/sip-031.clar
@@ -116,7 +116,9 @@
   )
 )
 
-;; Returns the amount of STX that is claimable from the vested balance at `burn-height`
+;; Returns the amount of STX that is claimable from the vested balance at `burn-height`.
+;; Note that this function takes into account the current STX balance
+;; of this contract, which may change by `burn-height`.
 (define-read-only (calc-claimable-amount (burn-height uint))
   (if (< burn-height DEPLOY_BLOCK_HEIGHT)
     u0

Original file line number	Diff line number	Diff line change
`@@ -116,7 +116,9 @@`
`116`	`116`	`)`
`117`	`117`	`)`
`118`	`118`
`119`		-;; Returns the amount of STX that is claimable from the vested balance at `burn-height`
	`119`	+;; Returns the amount of STX that is claimable from the vested balance at `burn-height`.
	`120`	`+;; Note that this function takes into account the current STX balance`
	`121`	+;; of this contract, which may change by `burn-height`.
`120`	`122`	`(define-read-only (calc-claimable-amount (burn-height uint))`
`121`	`123`	`(if (< burn-height DEPLOY_BLOCK_HEIGHT)`
`122`	`124`	`u0`