movehat 0.2.0 → 0.2.1

package/src/core/deployments.ts

@@ -50,16 +50,10 @@ export function validateSafeName(name: string, type: "network" | "module"): void
   }
 }
 
-/**
- * Get the deployments directory path
- */
 function getDeploymentsDir(): string {
   return join(process.cwd(), "deployments");
 }
 
-/**
- * Get the network-specific deployments directory
- */
 function getNetworkDeploymentsDir(network: string): string {
   // Validate network name to prevent path traversal
   validateSafeName(network, "network");
@@ -78,9 +72,6 @@ function getNetworkDeploymentsDir(network: string): string {
   return networkDir;
 }
 
-/**
- * Save a deployment
- */
 export function saveDeployment(deployment: DeploymentInfo): void {
   // Validate both network and module name
   validateSafeName(deployment.network, "network");
@@ -103,9 +94,6 @@ export function saveDeployment(deployment: DeploymentInfo): void {
   }
 }
 
-/**
- * Load a deployment
- */
 export function loadDeployment(network: string, moduleName: string): DeploymentInfo | null {
   // Validate both network and module name
   validateSafeName(network, "network");

package/src/fork/__tests__/manager.test.ts

@@ -4,7 +4,7 @@ import { tmpdir } from "node:os";
 import { join } from "node:path";
 
 /**
- * Tests for `ForkManager` (M3.3). Strategy:
+ * Tests for `ForkManager`. Strategy:
  *   - `vi.mock` the upstream `MovementApiClient` (network layer) so
  *     tests stay offline and deterministic.
  *   - Use a REAL `ForkStorage` against a tmpdir (storage is already

package/src/fork/manager.ts

@@ -70,16 +70,12 @@ export class ForkManager {
   ): Promise<void> {
     if (apiKey !== undefined) this.apiKey = apiKey;
 
-    // Create API client (with optional Authorization header)
     this.apiClient = new MovementApiClient(nodeUrl, this.apiKey);
 
-    // Fetch network info
     const ledgerInfo = await this.apiClient.getLedgerInfo();
 
-    // Create fork structure
     this.storage.initialize();
 
-    // Save metadata
     this.metadata = {
       network: networkName,
       nodeUrl,
@@ -110,9 +106,6 @@ export class ForkManager {
     this.apiClient = new MovementApiClient(this.metadata.nodeUrl, this.apiKey);
   }
 
-  /**
-   * Get fork metadata
-   */
   getMetadata(): ForkMetadata {
     if (!this.metadata) {
       this.metadata = this.storage.loadMetadata();
@@ -120,18 +113,12 @@ export class ForkManager {
     return this.metadata;
   }
 
-  /**
-   * Get account state (with lazy loading)
-   */
   async getAccount(address: string): Promise<AccountState> {
-    // Normalize address
     const normalizedAddress = normalizeAddress(address);
 
-    // Check cache first
     let accountState = this.storage.getAccount(normalizedAddress);
 
     if (!accountState) {
-      // Fetch from network
       if (!this.apiClient) {
         throw new Error('Fork not initialized. Call initialize() or load() first.');
       }
@@ -144,7 +131,6 @@ export class ForkManager {
         authenticationKey: accountData.authentication_key,
       };
 
-      // Cache it
       this.storage.saveAccount(normalizedAddress, accountState);
       console.log(`  ✓ Cached account ${normalizedAddress}`);
     }
@@ -152,17 +138,12 @@ export class ForkManager {
     return accountState;
   }
 
-  /**
-   * Get a specific resource (with lazy loading)
-   */
   async getResource(address: string, resourceType: string): Promise<any> {
     const normalizedAddress = normalizeAddress(address);
 
-    // Check cache first
     let resource = this.storage.getResource(normalizedAddress, resourceType);
 
     if (!resource) {
-      // Fetch from network
       if (!this.apiClient) {
         throw new Error('Fork not initialized. Call initialize() or load() first.');
       }
@@ -173,7 +154,6 @@ export class ForkManager {
         const resourceData = await this.apiClient.getAccountResource(normalizedAddress, resourceType);
         resource = resourceData.data;
 
-        // Cache it
         this.storage.saveResource(normalizedAddress, resourceType, resource);
         console.log(`  ✓ Cached resource ${resourceType}`);
       } catch (error) {
@@ -188,16 +168,11 @@ export class ForkManager {
     return resource;
   }
 
-  /**
-   * Get all resources for an account (with lazy loading)
-   */
   async getAllResources(address: string): Promise<Record<string, any>> {
     const normalizedAddress = normalizeAddress(address);
 
-    // Check if we have any cached resources
     let resources = this.storage.getAllResources(normalizedAddress);
 
-    // If no cached resources, fetch all from network
     if (Object.keys(resources).length === 0) {
       if (!this.apiClient) {
         throw new Error('Fork not initialized. Call initialize() or load() first.');
@@ -211,7 +186,6 @@ export class ForkManager {
         resources[resource.type] = resource.data;
       }
 
-      // Cache them
       this.storage.saveAllResources(normalizedAddress, resources);
       console.log(`  ✓ Cached ${Object.keys(resources).length} resources`);
     }
@@ -219,18 +193,13 @@ export class ForkManager {
     return resources;
   }
 
-  /**
-   * Set a resource value (for testing/mocking)
-   */
   async setResource(address: string, resourceType: string, data: unknown): Promise<void> {
     const normalizedAddress = normalizeAddress(address);
     this.storage.saveResource(normalizedAddress, resourceType, data);
     console.log(`  ✓ Updated resource ${resourceType} for ${normalizedAddress}`);
   }
 
-  /**
-   * Fund an account with coins (adds to existing balance)
-   */
+  /** Adds to the existing balance rather than replacing it. */
   async fundAccount(address: string, amount: number, coinType: string = '0x1::aptos_coin::AptosCoin'): Promise<void> {
     const normalizedAddress = normalizeAddress(address);
     const resourceType = `0x1::coin::CoinStore<${coinType}>`;
@@ -250,7 +219,6 @@ export class ForkManager {
         throw error;
       }
 
-      // If doesn't exist, create new one
       coinStore = {
         coin: { value: '0' },
         deposit_events: {
@@ -275,15 +243,12 @@ export class ForkManager {
       };
     }
 
-    // Add to existing balance (instead of replacing it)
     const currentBalance = BigInt(coinStore.coin.value ?? '0');
     const newBalance = currentBalance + BigInt(amount);
     coinStore.coin.value = newBalance.toString();
 
-    // Save
     await this.setResource(normalizedAddress, resourceType, coinStore);
 
-    // Also ensure account exists
     let account = this.storage.getAccount(normalizedAddress);
     if (!account) {
       account = {
@@ -296,9 +261,6 @@ export class ForkManager {
     console.log(`  ✓ Funded ${normalizedAddress} with ${amount} coins`);
   }
 
-  /**
-   * List all accounts in the fork
-   */
   listAccounts(): string[] {
     return this.storage.listAccounts();
   }
@@ -364,11 +326,9 @@ export class ForkManager {
   async getOrCreateAccount(address: string): Promise<AccountState> {
     const normalizedAddress = normalizeAddress(address);
 
-    // Try to get existing account
     try {
       return await this.getAccount(normalizedAddress);
     } catch (error) {
-      // If account doesn't exist, create a minimal one
       const newAccount: AccountState = {
         sequenceNumber: '0',
         authenticationKey: forkAuthKeyPlaceholder(normalizedAddress),

package/src/fork/test.ts

@@ -9,7 +9,6 @@ export interface SnapshotOptions {
   /**
    * Override the child-process adapter. Test-only — production callers
    * leave this undefined so the default spawn-based adapter is used.
-   * Mirrors the M1.3c pattern on `runtime.deployContract`.
    */
   adapter?: ChildProcessAdapter;
 }

package/src/harness/Harness.ts

@@ -36,16 +36,10 @@ interface HarnessInit {
  * a Proxy that synchronously throws {@link HarnessDisposedError} on any
  * post-`cleanup()` call to one of the deployment / script / view methods.
  *
- * Methods `deployCodeObject`, `upgradeCodeObject`, `runViewFunction`,
- * and `runMoveScript` are stubbed in M2.1 — they throw at runtime until
- * M2.2/M2.3 lands. The type surface is complete so callers and docs can
- * be written against it ahead of time.
- *
- * AccountManager note: as of M2.1 the underlying account pool is a
- * process-wide static (see `core/AccountManager.ts`). Two Harness
- * instances in the same process share account labels; this is the same
- * constraint that already governs `setupTestFixture`. A per-Harness pool
- * is a future change.
+ * AccountManager note: the underlying account pool is a process-wide
+ * static (see `core/AccountManager.ts`). Two Harness instances in the
+ * same process share account labels; this is the same constraint that
+ * already governs `setupTestFixture`.
  */
 export class Harness {
   public readonly mode: HarnessMode;
@@ -128,7 +122,7 @@ export class Harness {
    * spawned; transactions are submitted to the configured RPC.
    *
    * @param network - Named network from movehat.config.ts.
-   * @param _faucetUrl - Reserved for M2.2 (auto-fund on networks with a faucet).
+   * @param _faucetUrl - Reserved for future auto-fund support on networks with a faucet.
    */
   static async createLive(network: string, _faucetUrl?: string): Promise<Harness> {
     const runtime = await initRuntime({ network });

package/src/harness/codeObject.ts

@@ -289,8 +289,6 @@ async function executeMovementMoveObject(
     }
 
     // Parse object address (for deploy-object) and txHash (both flows).
-    // No captured fixture exists at M2.2 commit time; M4 integration
-    // tests validate against real CLI output.
     const objectAddress = opts.fixedAddress ?? parseObjectAddress(deployOut);
     const txHash = parseTxHash(deployOut);
 
@@ -361,9 +359,7 @@ async function executeMovementMoveObject(
 /**
  * Extract a code-object address from `movement move deploy-object` stdout.
  *
- * Movement CLI typically emits the address in one of these shapes (none
- * of them captured at M2.2 commit time — patterns are speculative, with
- * M4 integration tests as the validation gate):
+ * Movement CLI typically emits the address in one of these shapes:
  *
  *   - Free text: `Code was successfully deployed to object address 0x…`
  *   - Free text: `Object address: 0x…`

package/src/helpers/setupLocalTesting.ts

@@ -20,8 +20,7 @@ import type { LocalTestOptions } from "../types/config.js";
  * @public The `runtime` and `teardown` fields are the supported surface.
  *         `localNode`, `forkServer`, and `forkManager` are exposed for
  *         escape hatches (e.g. mid-test `forkManager.resetState()`) but
- *         their concrete shapes are considered `@internal` until the M5
- *         TypeDoc pass formalizes the public API.
+ *         their concrete shapes are `@internal`.
  */
 export interface LocalTestingContext {
   runtime: MovehatRuntime;

package/src/index.ts

@@ -18,6 +18,5 @@ export type { ForkMetadata, AccountState, LedgerInfo, AccountData, AccountResour
 // Export custom errors
 export { ModuleAlreadyDeployedError, PostPublishError } from "./errors.js";
 
-// Export Harness (Hardhat-style API — primary public surface from M2 onward)
 export { Harness, HarnessDisposedError } from "./harness/index.js";
 export type { HarnessMode } from "./harness/index.js";

package/src/node/__tests__/LocalNodeManager.test.ts

@@ -13,7 +13,7 @@ import type {
 } from "../../utils/childProcessAdapter.js";
 
 /**
- * Tests for `LocalNodeManager` (M3.3).
+ * Tests for `LocalNodeManager`.
  *
  * Strategy:
  *   - Inject a fake `ChildProcessAdapter` so we control the spawn

package/src/runtime.ts

@@ -93,9 +93,7 @@ export async function initRuntime(
       adapter?: ChildProcessAdapter;
     }
   ): Promise<DeploymentInfo> => {
-    // Thin orchestrator over Publisher (M1.4 / #79). The 250-line closure
-    // body lives in core/Publisher.ts and carries the bug fixes for
-    // #36 / #37 / #38.
+    // Thin orchestrator; the actual logic lives in core/Publisher.ts.
     return new Publisher({ adapter: options?.adapter }).deploy({
       moduleName,
       config,

package/src/templates/scripts/deploy-counter.ts

@@ -3,7 +3,7 @@ import { Harness } from "movehat";
 async function main() {
   console.log("🚀 Deploying Counter contract...\n");
 
-  // Hardhat-style Harness — primary public API since M2.
+  // Hardhat-style Harness — the primary public API.
   // createLive binds to a real running network (testnet / mainnet / a
   // custom one defined in movehat.config.ts). No local process spawned.
   const network = process.env.MOVEHAT_NETWORK ?? "testnet";

package/src/templates/tests/Counter.test.ts

@@ -11,7 +11,7 @@ describe("Counter Contract", () => {
   before(async function () {
     this.timeout(60000); // Allow time for local node startup + deployment
 
-    // Hardhat-style Harness — primary public API since M2.
+    // Hardhat-style Harness — the primary public API.
     // createLocal spins up a Movement local node, funds the labeled
     // accounts from the local faucet, and (via autoDeploy) builds +
     // publishes the named modules so they're ready to use.
@@ -43,7 +43,7 @@ describe("Counter Contract", () => {
       const tx = await counter.call(deployer, "init", []);
       console.log(`   Init transaction: ${tx.hash}`);
 
-      // Read counter value via harness.runViewFunction (new in M2)
+      // Read counter value via harness.runViewFunction
       const [value] = await harness.runViewFunction({
         function: `${counter.moduleAddress}::counter::get`,
         functionArguments: [deployer.accountAddress.toString()],

package/src/types/runtime.ts

@@ -51,7 +51,7 @@ export interface MovehatRuntime {
   getAccountByIndex: (index: number) => Account;
 
   // Network switching — returns a new runtime bound to the requested
-  // network. As of M1.5 there is no module-cached runtime, so callers
-  // must capture and use the returned instance.
+  // network. There is no module-cached runtime, so callers must capture
+  // and use the returned instance.
   switchNetwork: (networkName: string) => Promise<MovehatRuntime>;
 }

package/src/utils/address.ts

@@ -1,10 +1,6 @@
 /**
  * Address normalization helpers shared across the fork code.
  *
- * Two normalization variants live in production today and are preserved here
- * with identical semantics so the in-place migration in M1.2 is behavior-
- * preserving:
- *
  *   - `normalizeAddress`      → lowercase + `0x` + left-pad to 64 hex chars.
  *                                Used by `fork/manager.ts` for storage keys.
  *   - `normalizeAddressShort` → lowercase + `0x`, no padding.

package/src/utils/childProcessAdapter.ts

@@ -99,10 +99,9 @@ class DefaultChildProcessAdapter implements ChildProcessAdapter {
   run(input: RunInput): Promise<RunResult> {
     // Skip the default 5-minute timeout when the caller wires stdio
     // through to the terminal — interactive sessions (mocha, tsx scripts,
-    // `movement move test`, `pnpm install`) routinely exceed 5 minutes and
-    // SIGTERM'ing them silently is a regression vs the direct-spawn code
-    // these callers used before M1.3a. An explicitly-passed `timeoutMs`
-    // is always honored, regardless of `inheritStdio`.
+    // `movement move test`, `pnpm install`) routinely exceed 5 minutes
+    // and SIGTERM'ing them silently would be a regression. An explicit
+    // `timeoutMs` is always honored, regardless of `inheritStdio`.
     const timeoutMs =
       input.timeoutMs ?? (input.inheritStdio ? undefined : DEFAULT_TIMEOUT_MS);