SettleMint

import { afterAll, afterEach, beforeAll, describe, expect, setDefaultTimeout, test } from "bun:test"; import { copyFile, rmdir, stat } from "node:fs/promises"; import { join } from "node:path"; import { exists } from "@settlemint/sdk-utils/filesystem"; import { $ } from "bun"; import { NODE_NAME, NODE_NAME_2_WITH_PK, NODE_NAME_3_WITHOUT_PK, PRIVATE_KEY_NODE_2_NAME, PRIVATE_KEY_SMART_CONTRACTS_NAMES, } from "./constants/test-resources"; import { retryCommand } from "./utils/retry-command"; import { forceExitAllCommands, runCommand } from "./utils/run-command"; import { findPrivateKeyByName } from "./utils/test-resources"; const SMART_CONTRACT_SET_NAME = "contracts"; const COMMAND_TEST_SCOPE = __filename; const USE_CASE = "solidity-token-erc20"; const projectDir = join(__dirname, SMART_CONTRACT_SET_NAME); setDefaultTimeout(15 * 60_000); async function cleanup() { try { if (await exists(projectDir)) { await rmdir(projectDir, { recursive: true }); } } catch (err) { console.log("Failed to delete project dir", err); } } beforeAll(cleanup); afterAll(cleanup); afterEach(() => { forceExitAllCommands(COMMAND_TEST_SCOPE); }); describe("Setup a smart contract set using the SDK", () => { test("Create a smart contract set and install packages", async () => { const { output } = await runCommand( COMMAND_TEST_SCOPE, ["smart-contract-set", "create", "--project-name", SMART_CONTRACT_SET_NAME, "--use-case", USE_CASE], { cwd: __dirname }, ).result; expect((await stat(projectDir)).isDirectory()).toBeTrue(); expect(output).toInclude("Your smart contract set is ready to go!"); await $`bun install --save-text-lockfile`.cwd(projectDir); if (await exists(join(__dirname, "../.env"))) { await copyFile(join(__dirname, "../.env"), join(projectDir, ".env")); } if (await exists(join(__dirname, "../.env.local"))) { await copyFile(join(__dirname, "../.env.local"), join(projectDir, ".env.local")); } }); test("Foundry - Build smart contract set", async () => { const { output } = await runCommand(COMMAND_TEST_SCOPE, ["scs", "foundry", "build", "--optimize"], { cwd: projectDir, }).result; expect(output).toInclude("Compiler run successful"); }); test("Foundry - Format smart contract set", async () => { const { output } = await runCommand(COMMAND_TEST_SCOPE, ["scs", "foundry", "format", "--check"], { cwd: projectDir, }).result; expect(output).toInclude("Smart contracts formatted successfully"); }); test("Foundry - Start local anvil network", (done) => { const { result, kill } = runCommand(COMMAND_TEST_SCOPE, ["scs", "foundry", "network", "--block-time", "5"], { cwd: projectDir, }); result .then(({ output }) => { expect(output).toInclude("Listening on 127.0.0.1:8545"); done(); }) .catch((err: $.ShellError) => { expect(err).toBeUndefined(); done(); }); setTimeout(() => { kill(); }, 3_000); }); test("Foundry - Test smart contract set", async () => { const { output } = await runCommand(COMMAND_TEST_SCOPE, ["scs", "foundry", "test", "--fail-fast"], { cwd: projectDir, }).result; expect(output).toInclude("[PASS]"); expect(output).not.toInclude("[FAIL]"); expect(output).toInclude("Suite result: ok."); }); test("Hardhat - Build smart contract set", async () => { const { output } = await runCommand(COMMAND_TEST_SCOPE, ["scs", "hardhat", "build", "--quiet"], { cwd: projectDir }) .result; expect(output).toMatch(/.*Compiled [0-9]+ Solidity files successfully.*/); }); test("Hardhat - Test smart contract set", async () => { const { output } = await runCommand(COMMAND_TEST_SCOPE, ["scs", "hardhat", "test", "--no-compile"], { cwd: projectDir, }).result; expect(output).toInclude("0 passing"); }); test("Hardhat - Deploy smart contract set (local)", (done) => { const { result, kill } = runCommand(COMMAND_TEST_SCOPE, ["scs", "hardhat", "network", "--port", "8545"], { cwd: projectDir, }); let isDeployed = false; result .then(() => { expect(isDeployed).toBeTrue(); done(); }) .catch(() => { expect(isDeployed).toBeTrue(); done(); }); setTimeout(async () => { const { output: deployOutput } = await runCommand(COMMAND_TEST_SCOPE, ["scs", "hardhat", "deploy", "local"], { cwd: projectDir, }).result; expect(deployOutput).toInclude("successfully deployed 🚀"); const { output: outputReset } = await runCommand( COMMAND_TEST_SCOPE, ["scs", "hardhat", "deploy", "local", "--reset", "--deployment-id", "test-local"], { cwd: projectDir, }, ).result; expect(outputReset).toInclude("successfully deployed 🚀"); isDeployed = true; kill(); }, 3_000); }); test("Hardhat - Deploy smart contract set (remote)", async () => { let deployRetries = 0; await retryCommand(async () => { const privateKey = await findPrivateKeyByName(PRIVATE_KEY_SMART_CONTRACTS_NAMES[deployRetries]!); deployRetries++; const deployCommand = runCommand( COMMAND_TEST_SCOPE, ["scs", "hardhat", "deploy", "remote", "--default-sender", privateKey?.address!, "--accept-defaults"], { cwd: projectDir, }, ); // Confirm deployment const onDeployOutput = (message: string) => { if (message.includes("Confirm deploy")) { deployCommand.stdin.cork(); deployCommand.stdin.write("y"); deployCommand.stdin.uncork(); } }; deployCommand.stdout.on("data", onDeployOutput); const { output: deployOutput } = await deployCommand.result; deployCommand.stdout.off("data", onDeployOutput); expect(deployOutput).toInclude("successfully deployed 🚀"); expect(deployOutput).not.toInclude("Error reading hardhat.config.ts"); }); let resetRetries = 0; await retryCommand(async () => { const privateKey = await findPrivateKeyByName(PRIVATE_KEY_SMART_CONTRACTS_NAMES[resetRetries]!); resetRetries++; const resetCommand = runCommand( COMMAND_TEST_SCOPE, [ "scs", "hardhat", "deploy", "remote", "--reset", "-m", "ignition/modules/main.ts", "--default-sender", privateKey?.address!, "--accept-defaults", ], { cwd: projectDir, }, ); // Confirm deployment and reset const onResetOutput = (message: string) => { if (message.includes("Confirm deploy") || message.includes("Confirm reset")) { resetCommand.stdin.cork(); resetCommand.stdin.write("y"); resetCommand.stdin.uncork(); } }; resetCommand.stdout.on("data", onResetOutput); const { output: outputReset } = await resetCommand.result; resetCommand.stdout.off("data", onResetOutput); expect(outputReset).toInclude("successfully deployed 🚀"); expect(outputReset).not.toInclude("Error reading hardhat.config.ts"); }); }); test("Hardhat - Select node and private key for deploying smart contract set (remote)", async () => { await retryCommand(async () => { const resetCommand = runCommand(COMMAND_TEST_SCOPE, ["scs", "hardhat", "deploy", "remote", "--reset"], { cwd: projectDir, env: { CI: "false", // To disable auto accept in CI }, }); const nodeListCapture: string[] = []; const privateKeyCapture: string[] = []; const onResetOutput = (message: string) => { if (message.includes("Which blockchain node do you want to connect to?")) { nodeListCapture.push(message); resetCommand.stdin.cork(); resetCommand.stdin.write("\n"); // Selects the default option - env.SETTLEMINT_BLOCKCHAIN_NODE resetCommand.stdin.uncork(); } if (message.includes("Which private key do you want to deploy from?")) { privateKeyCapture.push(message); resetCommand.stdin.cork(); resetCommand.stdin.write("\n"); // Selects the one and only private key activated on env.SETTLEMINT_BLOCKCHAIN_NODE - PRIVATE_KEY_SMART_CONTRACTS_NAME resetCommand.stdin.uncork(); } if (message.includes("Confirm deploy") || message.includes("Confirm reset")) { resetCommand.stdin.cork(); resetCommand.stdin.write("n"); // No need to deploy again resetCommand.stdin.uncork(); } }; resetCommand.stdout.on("data", onResetOutput); await resetCommand.result; resetCommand.stdout.off("data", onResetOutput); const nodeListString = nodeListCapture.join("\n"); expect(nodeListString).toContain(NODE_NAME); expect(nodeListString).toContain(NODE_NAME_2_WITH_PK); expect(nodeListString).not.toContain(NODE_NAME_3_WITHOUT_PK); const privateKeyString = privateKeyCapture.join("\n"); for (const privateKeyName of PRIVATE_KEY_SMART_CONTRACTS_NAMES) { expect(privateKeyString).toContain(privateKeyName); } expect(privateKeyString).not.toContain(PRIVATE_KEY_NODE_2_NAME); }); }); });