Merge pull request #146 from stacks-network/fix/sbtc-balances-restore

Fix type mismatch in sBTC balance restore feature

Author: BowTiedRadone

citizen.tests.ts

@@ -2,6 +2,7 @@ import fc from "fast-check";
 import {
   buildRendezvousData,
   getContractSource,
+  getSbtcBalancesFromSimnet,
   getTestContractSource,
   groupContractsByEpochFromSimnetPlan,
   issueFirstClassCitizenship,
@@ -366,7 +367,7 @@ describe("Simnet deployment plan operations", () => {
     rmSync(tempDir, { recursive: true, force: true });
   });
 
-  it(`the first-class citizenship simnet has the correct balances for the registered accounts`, async () => {
+  it(`the first-class citizenship simnet has the correct STX balances for the registered accounts`, async () => {
     // Setup
     const tempDir = mkdtempSync(join(tmpdir(), "simnet-test-"));
     cpSync(manifestDir, tempDir, { recursive: true });
@@ -399,4 +400,35 @@ describe("Simnet deployment plan operations", () => {
     // Teardown
     rmSync(tempDir, { recursive: true, force: true });
   });
+
+  it(`the first-class citizenship simnet has the correct sBTC balances for the registered accounts`, async () => {
+    // Setup
+    const tempDir = mkdtempSync(join(tmpdir(), "simnet-test-"));
+    cpSync(manifestDir, tempDir, { recursive: true });
+
+    // Exercise
+    const firstClassSimnet = await issueFirstClassCitizenship(
+      tempDir,
+      join(tempDir, getManifestFileName(tempDir, "counter")),
+      tryParseRemoteDataSettings(
+        join(manifestDir, "Clarinet.toml"),
+        new EventEmitter()
+      ),
+      "counter"
+    );
+
+    // Verify
+    const sbtcBalancesMap = getSbtcBalancesFromSimnet(firstClassSimnet);
+
+    // The expected balance is 0 (number) for all accounts, since the example
+    // Clarinet project does not operate with sBTC.
+    const numAccounts = firstClassSimnet.getAccounts().size;
+    const numZeroBalanceAccounts = Array.from(sbtcBalancesMap.values()).filter(
+      (balance) => balance === 0
+    ).length;
+    expect(numZeroBalanceAccounts).toBe(numAccounts);
+
+    // Teardown
+    rmSync(tempDir, { recursive: true, force: true });
+  });
 });

citizen.ts

@@ -65,26 +65,7 @@ export const issueFirstClassCitizenship = async (
     })
   );
 
-  const sbtcBalancesMap = new Map(
-    simnetAddresses.map((address) => {
-      try {
-        const { result: getBalanceResult } = simnet.callReadOnlyFn(
-          "SM3VDXK3WZZSA84XXFKAFAF15NNZX32CTSG82JFQ4.sbtc-token",
-          "get-balance",
-          [Cl.principal(address)],
-          address
-        );
-
-        // If the previous read-only call works, the user is working with
-        // sBTC. This means we can proceed with restoring sBTC balances.
-        const sbtcBalance = cvToJSON(getBalanceResult).value.value;
-
-        return [address, sbtcBalance];
-      } catch (e) {
-        return [address, 0];
-      }
-    })
-  );
+  const sbtcBalancesMap = getSbtcBalancesFromSimnet(simnet);
 
   await simnet.initEmptySession(remoteDataSettings);
 
@@ -386,6 +367,43 @@ export function scheduleRendezvous(
   return `${targetContractSource}\n\n${context}\n\n${tests}`;
 }
 
+/**
+ * Maps the simnet accounts to their sBTC balances. The function tries to call
+ * the `get-balance` function of the `sbtc-token` contract for each address. If
+ * the call fails, it returns a balance of 0 for that address. The call fails
+ * if the user is not working with sBTC.
+ * @param simnet The simnet instance.
+ * @returns A map of addresses to their sBTC balances.
+ */
+export const getSbtcBalancesFromSimnet = (
+  simnet: Simnet
+): Map<string, number> =>
+  new Map(
+    [...simnet.getAccounts().values()].map((address) => {
+      try {
+        const { result: getBalanceResult } = simnet.callReadOnlyFn(
+          "SM3VDXK3WZZSA84XXFKAFAF15NNZX32CTSG82JFQ4.sbtc-token",
+          "get-balance",
+          [Cl.principal(address)],
+          address
+        );
+
+        // If the previous read-only call works, the user is working with
+        // sBTC. This means we can proceed with restoring sBTC balances.
+        const sbtcBalanceJSON = cvToJSON(getBalanceResult);
+
+        // The `get-balance` function returns a response containing the uint
+        // balance of the address. In the JSON representation, the balance is
+        // represented as a string. We need to parse it to an integer.
+        const sbtcBalance = parseInt(sbtcBalanceJSON.value.value, 10);
+
+        return [address, sbtcBalance];
+      } catch (e) {
+        return [address, 0];
+      }
+    })
+  );
+
 /**
  * Utility function that restores the test wallets' initial sBTC balances in
  * the re-initialized first-class citizenship simnet.