fix: print events for important functions

Author: hstove

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

@@ -1,5 +1,5 @@
 import { project, accounts } from '../clarigen-types'; // where your [types.output] was specified
-import { CoreNodeEventType, projectFactory } from '@clarigen/core';
+import { CoreNodeEventType, cvToValue, projectFactory } from '@clarigen/core';
 import { filterEvents, rov, txErr, txOk } from '@clarigen/test';
 import { test, expect } from 'vitest';
 
@@ -85,8 +85,10 @@ test('updated recipient can claim', () => {
   const receipt = txOk(contract.claim(), accounts.wallet_1.address);
   expect(receipt.value).toBe(constants.INITIAL_MINT_IMMEDIATE_AMOUNT);
 
-  expect(receipt.events.length).toBe(1);
-  const [event] = filterEvents(receipt.events, CoreNodeEventType.StxTransferEvent);
+  expect(receipt.events.length).toBe(2);
+  const stxTransferEvents = filterEvents(receipt.events, CoreNodeEventType.StxTransferEvent);
+  expect(stxTransferEvents.length).toBe(1);
+  const [event] = stxTransferEvents;
   expect(event.data.amount).toBe(`${constants.INITIAL_MINT_IMMEDIATE_AMOUNT}`);
   expect(event.data.recipient).toBe(accounts.wallet_1.address);
   expect(event.data.sender).toBe(contract.identifier);
@@ -287,4 +289,32 @@ test('calculating claimable amount at invalid block height returns 0', () => {
   mintInitial();
   const deployBlockHeight = rov(contract.getDeployBlockHeight());
   expect(rov(contract.calcClaimableAmount(deployBlockHeight - 1n))).toBe(0n);
-});
+});
+
+test('print events are emitted when updating recipient', () => {
+  const receipt = txOk(contract.updateRecipient(accounts.wallet_1.address), accounts.deployer.address);
+  expect(receipt.events.length).toBe(1);
+  const [event] = filterEvents(receipt.events, CoreNodeEventType.ContractEvent);
+  const printData = cvToValue<{
+    topic: string;
+    oldRecipient: string;
+    newRecipient: string;
+  }>(event.data.value);
+  expect(printData.topic).toBe('update-recipient');
+  expect(printData.oldRecipient).toBe(accounts.deployer.address);
+  expect(printData.newRecipient).toBe(accounts.wallet_1.address);
+});
+
+test('print events are emitted when claiming', () => {
+  mintInitial();
+  const receipt = txOk(contract.claim(), accounts.deployer.address);
+  const [event] = filterEvents(receipt.events, CoreNodeEventType.ContractEvent);
+  const printData = cvToValue<{
+    topic: string;
+    claimable: string;
+    recipient: string;
+  }>(event.data.value);
+  expect(printData.topic).toBe('claim');
+  expect(printData.claimable).toBe(constants.INITIAL_MINT_IMMEDIATE_AMOUNT);
+  expect(printData.recipient).toBe(accounts.deployer.address);
+});

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

@@ -35,9 +35,19 @@
 ;;
 ;; Returns `true` if the recipient was updated.
 (define-public (update-recipient (new-recipient principal)) (begin
-    (try! (validate-caller))
-    (var-set recipient new-recipient)
-    (ok true)
+    (let
+        (
+            (old-recipient (var-get recipient))
+        )
+        (try! (validate-caller))
+        (var-set recipient new-recipient)
+        (print {
+            topic: "update-recipient",
+            old-recipient: old-recipient,
+            new-recipient: new-recipient,
+        })
+        (ok true)
+    )
 ))
 
 ;; Transfer all currently withdrawable STX (vested + extra) to `recipient`.
@@ -51,6 +61,11 @@
         (asserts! (> claimable u0) (err ERR_NOTHING_TO_CLAIM))
 
         (try! (as-contract (stx-transfer? claimable tx-sender (var-get recipient))))
+        (print {
+            topic: "claim",
+            claimable: claimable,
+            recipient: (var-get recipient),
+        })
         (ok claimable)
     )
 )