fix: code review improvements

Author: hstove

contrib/core-contract-tests/tests/clarigen-types.ts

@@ -4586,14 +4586,14 @@ export const contracts = {
         [newRecipient: TypedAbiArg<string, "newRecipient">],
         Response<boolean, bigint>
       >,
-      calcVestedAmount: {
-        name: "calc-vested-amount",
+      calcClaimableAmount: {
+        name: "calc-claimable-amount",
         access: "read_only",
         args: [{ name: "burn-height", type: "uint128" }],
-        outputs: { type: { response: { ok: "uint128", error: "none" } } },
+        outputs: { type: "uint128" },
       } as TypedAbiFunction<
         [burnHeight: TypedAbiArg<number | bigint, "burnHeight">],
-        Response<bigint, null>
+        bigint
       >,
       getDeployBlockHeight: {
         name: "get-deploy-block-height",
@@ -4651,6 +4651,11 @@ export const contracts = {
         type: "uint128",
         access: "constant",
       } as TypedAbiVariable<bigint>,
+      STX_PER_ITERATION: {
+        name: "STX_PER_ITERATION",
+        type: "uint128",
+        access: "constant",
+      } as TypedAbiVariable<bigint>,
       deployBlockHeight: {
         name: "deploy-block-height",
         type: "uint128",
@@ -4675,6 +4680,7 @@ export const contracts = {
       INITIAL_MINT_VESTING_AMOUNT: 100_000_000_000_000n,
       INITIAL_MINT_VESTING_ITERATIONS: 24n,
       INITIAL_MINT_VESTING_ITERATION_BLOCKS: 4_383n,
+      STX_PER_ITERATION: 4_166_666_666_666n,
       deployBlockHeight: 3n,
       recipient: "ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM",
       vestedClaimedAmount: 0n,

contrib/core-contract-tests/tests/sip-031/sip-031.test.ts

@@ -1,6 +1,6 @@
 import { project, accounts } from '../clarigen-types'; // where your [types.output] was specified
 import { CoreNodeEventType, projectFactory } from '@clarigen/core';
-import { filterEvents, rov, rovOk, txErr, txOk } from '@clarigen/test';
+import { filterEvents, rov, txErr, txOk } from '@clarigen/test';
 import { test, expect } from 'vitest';
 
 const contracts = projectFactory(project, 'simnet');
@@ -106,19 +106,19 @@ test('calculating vested amounts at a block height', () => {
     return immediateAmount + vestingAmount;
   }
 
-  expect(rovOk(contract.calcVestedAmount(deployBlockHeight))).toBe(immediateAmount);
+  expect(rov(contract.calcClaimableAmount(deployBlockHeight))).toBe(immediateAmount);
 
   function expectAmount(month: bigint) {
     const burnHeight = deployBlockHeight + month * 4383n;
-    expect(rovOk(contract.calcVestedAmount(burnHeight))).toBe(expectedAmount(burnHeight));
+    expect(rov(contract.calcClaimableAmount(burnHeight))).toBe(expectedAmount(burnHeight));
   }
 
   for (let i = 1n; i < 24n; i++) {
     expectAmount(i);
   }
   // At 24+ months, the entire vesting bucket should be unlocked
-  expect(rovOk(contract.calcVestedAmount(deployBlockHeight + 24n * 4383n))).toBe(initialMintAmount);
-  expect(rovOk(contract.calcVestedAmount(deployBlockHeight + 25n * 4383n))).toBe(initialMintAmount);
+  expect(rov(contract.calcClaimableAmount(deployBlockHeight + 24n * 4383n))).toBe(initialMintAmount);
+  expect(rov(contract.calcClaimableAmount(deployBlockHeight + 25n * 4383n))).toBe(initialMintAmount);
 });
 
 // -----------------------------------------------------------------------------

stackslib/src/chainstate/stacks/boot/sip-031.clar

@@ -16,6 +16,9 @@
 ;; The amount of STX that is vested over the 24 months
 (define-constant INITIAL_MINT_VESTING_AMOUNT (- INITIAL_MINT_AMOUNT INITIAL_MINT_IMMEDIATE_AMOUNT))
 
+;; The amount of STX that is vested per iteration
+(define-constant STX_PER_ITERATION (/ INITIAL_MINT_VESTING_AMOUNT INITIAL_MINT_VESTING_ITERATIONS))
+
 (define-data-var recipient principal tx-sender)
 
 (define-data-var deploy-block-height uint burn-block-height)
@@ -44,29 +47,24 @@
 (define-public (claim)
     (let
         (
-            (balance        (stx-get-balance (as-contract tx-sender)))
-            (burn-height    burn-block-height)
-            (total-vested   (calc-total-vested burn-height))
+            (balance (stx-get-balance (as-contract tx-sender)))
+            (total-vested (calc-total-vested burn-block-height))
             (vested-claimed (var-get vested-claimed-amount))
-            ;; Vested that has not yet been claimed
-            (available-vested (- total-vested vested-claimed))
             ;; Portion of the initial mint that is *still* locked (not yet vested)
             (reserved (- INITIAL_MINT_AMOUNT total-vested))
             ;; Free balance = everything the caller may withdraw right now
             (claimable
                 (if (> balance reserved)
                     (- balance reserved)
                     u0))
-            (vested-to-claim (if (> available-vested claimable) claimable available-vested))
-            (extra-to-claim  (- claimable vested-to-claim))
         )
         (try! (validate-caller))
         (asserts! (> claimable u0) (err ERR_NOTHING_TO_CLAIM))
-        (var-set vested-claimed-amount (+ vested-claimed vested-to-claim))
+        (var-set vested-claimed-amount (+ vested-claimed total-vested))
 
         (try! (as-contract (stx-transfer? claimable tx-sender (var-get recipient))))
         (ok claimable)
-        )
+    )
 )
 
 (define-private (validate-caller)
@@ -79,28 +77,28 @@
     (let
       (
         (diff (- burn-height (var-get deploy-block-height)))
+        ;; Note: this rounds down
         (iterations (/ diff INITIAL_MINT_VESTING_ITERATION_BLOCKS))
-        (stx-per-iteration (/ INITIAL_MINT_VESTING_AMOUNT INITIAL_MINT_VESTING_ITERATIONS))
-        (vesting-multiple (* stx-per-iteration iterations))
+        (vested-multiple (* STX_PER_ITERATION iterations))
 
         ;; If we have completed (or exceeded) the scheduled number of iterations,
         ;; consider the *entire* vesting bucket unlocked.  This avoids leaving a
         ;; tiny remainder caused by integer-division truncation.
-        (vesting-amount (if (>= iterations INITIAL_MINT_VESTING_ITERATIONS)
+        (vested-amount (if (>= iterations INITIAL_MINT_VESTING_ITERATIONS)
                             INITIAL_MINT_VESTING_AMOUNT
-                            vesting-multiple))
-        (total-amount (+ INITIAL_MINT_IMMEDIATE_AMOUNT vesting-amount))
+                            vested-multiple))
+        (total-amount (+ INITIAL_MINT_IMMEDIATE_AMOUNT vested-amount))
       )
       total-amount
     )
 )
 
-;; Returns the amount of STX that is vested at `burn-height`
-(define-read-only (calc-vested-amount (burn-height uint))
+;; Returns the amount of STX that is claimable from the vested balance at `burn-height`
+(define-read-only (calc-claimable-amount (burn-height uint))
     (let
-      (
-        (total-vested (calc-total-vested burn-height))
-      )
-      (ok (- total-vested (var-get vested-claimed-amount)))
+        (
+            (total-vested (calc-total-vested burn-height))
+        )
+        (- total-vested (var-get vested-claimed-amount))
     )
 )