movehat 0.2.4 → 0.2.5

package/src/runtime.ts

@@ -1,157 +0,0 @@
-import {
-  Account,
-  Aptos,
-  AptosConfig,
-  Ed25519PrivateKey,
-  Network,
-} from "@aptos-labs/ts-sdk";
-import { MovehatRuntime, NetworkInfo } from "./types/runtime.js";
-import { MovehatUserConfig } from "./types/config.js";
-import { loadUserConfig, resolveNetworkConfig } from "./core/config.js";
-import { getContract, MoveContract } from "./core/contract.js";
-import {
-  loadDeployment,
-  getAllDeployments,
-  getDeployedAddress,
-  DeploymentInfo,
-} from "./core/deployments.js";
-import { AccountManager } from "./core/AccountManager.js";
-import { Publisher } from "./core/Publisher.js";
-import type { ChildProcessAdapter } from "./utils/childProcessAdapter.js";
-
-export interface InitRuntimeOptions {
-  network?: string;
-  accountIndex?: number;
-  configOverride?: Partial<MovehatUserConfig>;
-}
-
-/**
- * Initialize the Movehat Runtime Environment.
- *
- * Lower-level construction utility — loads `movehat.config.ts`, resolves
- * the active network, and builds a `MovehatRuntime` bound to it. Used
- * internally by {@link Harness.createLive} (see `harness/Harness.ts`).
- *
- * **External callers should prefer the `Harness.create*` factories**
- * (`Harness.createLocal` / `createFork` / `createLive`) for the Hardhat-
- * style lifecycle + use-after-cleanup safety. `initRuntime` remains
- * exported as a public utility for advanced use cases that need to
- * skip the Harness abstraction (e.g. embedding movehat inside another
- * framework).
- */
-export async function initRuntime(
-  options: InitRuntimeOptions = {}
-): Promise<MovehatRuntime> {
-  // Load user config from movehat.config.ts
-  const userConfig = await loadUserConfig();
-
-  // Apply config override if provided
-  const mergedUserConfig: MovehatUserConfig = options.configOverride
-    ? { ...userConfig, ...options.configOverride }
-    : userConfig;
-
-  // Resolve configuration for selected network
-  const config = await resolveNetworkConfig(mergedUserConfig, options.network);
-
-  // Setup Movement TypeScript SDK client
-  // Movement Network uses custom chain IDs, so we need to use Network.CUSTOM
-  // and let the SDK fetch the actual chainId from the node
-  const aptosConfig = new AptosConfig({
-    network: Network.CUSTOM,
-    fullnode: config.rpc,
-  });
-  const aptos = new Aptos(aptosConfig);
-
-  // Setup accounts using AccountManager
-  const accountIndex = options.accountIndex || 0;
-  const accounts: Account[] = AccountManager.loadAccountsFromConfig(config);
-
-  // Primary account (accounts[0] or selected index)
-  const account = accounts[accountIndex];
-  if (!account) {
-    throw new Error(`Account index ${accountIndex} not found. Only ${accounts.length} accounts configured.`);
-  }
-
-  // Update config.account with derived address
-  config.account = account.accountAddress.toString();
-
-  // Network info
-  const network: NetworkInfo = {
-    name: config.network,
-    rpc: config.rpc,
-  };
-
-  // Helper functions
-  const getContractHelper = (address: string, moduleName: string): MoveContract => {
-    return getContract(aptos, address, moduleName);
-  };
-
-  const deployContract = async (
-    moduleName: string,
-    options?: {
-      packageDir?: string;
-      adapter?: ChildProcessAdapter;
-    }
-  ): Promise<DeploymentInfo> => {
-    // Thin orchestrator; the actual logic lives in core/Publisher.ts.
-    return new Publisher({ adapter: options?.adapter }).deploy({
-      moduleName,
-      config,
-      account,
-      packageDir: options?.packageDir,
-    });
-  };
-
-  const getDeployment = (moduleName: string): DeploymentInfo | null => {
-    return loadDeployment(config.network, moduleName);
-  };
-
-  const getDeployments = (): Record<string, DeploymentInfo> => {
-    return getAllDeployments(config.network);
-  };
-
-  const getDeploymentAddress = (moduleName: string): string | null => {
-    return getDeployedAddress(config.network, moduleName);
-  };
-
-  const createAccount = (): Account => {
-    return AccountManager.createAccount();
-  };
-
-  const getAccountHelper = (privateKeyHex: string): Account => {
-    return AccountManager.loadAccountFromPrivateKey(privateKeyHex);
-  };
-
-  const getAccountByIndex = (index: number): Account => {
-    const acc = accounts[index];
-    if (!acc) {
-      throw new Error(`Account index ${index} out of range. Available accounts: 0-${accounts.length - 1}`);
-    }
-    return acc;
-  };
-
-  const switchNetwork = async (networkName: string): Promise<MovehatRuntime> => {
-    return initRuntime({ ...options, network: networkName });
-  };
-
-  // Build runtime object
-  const runtime: MovehatRuntime = {
-    config,
-    network,
-    aptos,
-    account,
-    accounts,
-    getContract: getContractHelper,
-    deployContract,
-    getDeployment,
-    getDeployments,
-    getDeploymentAddress,
-    createAccount,
-    getAccount: getAccountHelper,
-    getAccountByIndex,
-    switchNetwork,
-  };
-
-  return runtime;
-}
-

package/src/templates/.env.example

@@ -1,9 +0,0 @@
-# Private Key (used for all networks - Hardhat-style)
-# This is your wallet's private key that will be used to deploy and interact with contracts
-PRIVATE_KEY=your_private_key_here
-
-# Optional: Override RPC URL (useful for custom endpoints)
-# MOVEMENT_RPC_URL=https://custom-testnet.movementnetwork.xyz/v1
-
-# Optional: Override default network from config
-# MH_DEFAULT_NETWORK=testnet

package/src/templates/.mocharc.json

@@ -1,8 +0,0 @@
-{
-  "node-option": ["import=tsx"],
-  "extensions": ["ts"],
-  "spec": ["tests/**/*.test.ts"],
-  "timeout": 30000,
-  "color": true,
-  "reporter": "spec"
-}

package/src/templates/.vscode/settings.json

@@ -1,11 +0,0 @@
-{
-  "typescript.tsdk": "node_modules/typescript/lib",
-  "typescript.enablePromptUseWorkspaceTsdk": true,
-  "files.exclude": {
-    "**/.git": true,
-    "**/.DS_Store": true
-  },
-  "search.exclude": {
-    "**/node_modules": true
-  }
-}

package/src/templates/README.md

@@ -1,146 +0,0 @@
-# {{projectName}}
-
-A Move smart contract project built with Movehat.
-
-## Prerequisites
-
-**Required:**
-- **Node.js v18+** - [Download](https://nodejs.org/)
-- **Movement CLI** - **REQUIRED** for compiling contracts
-
-  Install: [Movement CLI Installation Guide](https://docs.movementnetwork.xyz/devs/movementCLI)
-
-  Verify: `movement --version`
-
-**IMPORTANT:** Without Movement CLI, compilation will fail!
-
-## Getting Started
-
-### 1. Install dependencies
-
-```bash
-npm install
-```
-
-### 2. Configure environment
-
-Copy `.env.example` to `.env` and fill in your credentials:
-
-```bash
-cp .env.example .env
-```
-
-Edit `.env`:
-```
-PRIVATE_KEY=your_private_key_here
-```
-
-### 3. Compile contracts
-
-```bash
-npm run compile
-```
-
-**How it works:**
-- Movehat automatically detects named addresses from your Move files
-- No need to manually configure addresses in `Move.toml`
-- Just add any new `.move` file and it will compile automatically (like Hardhat!)
-
-### 4. Run tests
-
-```bash
-npm test
-```
-
-When you run `npm test`, you'll see an **interactive menu**:
-
-```
-? What tests do you want to run?
-❯ Move unit tests (fast, no node required)
-  TypeScript integration tests (starts local node)
-  All tests (Move + TypeScript)
-```
-
-**Two types of tests available:**
-
-1. **Move Unit Tests** (`move/sources/Counter.move` in `#[test]` blocks)
-   - Written in Move with `#[test]` annotations
-   - Test internal logic and business rules
-   - Ultra-fast execution (milliseconds)
-   - Run with: `npm run test:move` or `movehat test --move`
-
-2. **TypeScript Integration Tests** (`tests/Counter.test.ts`)
-   - Written in TypeScript on a **local Movement blockchain**
-   - Automatically starts a local node, funds accounts, and deploys contracts
-   - Runs real transactions (not simulation!)
-   - Just like Hardhat - zero manual setup
-   - Run with: `npm run test:ts` or `movehat test --ts`
-
-**Commands:**
-- `npm test` - Interactive menu to choose test type
-- `npm run test:move` or `movehat test --move` - Only Move unit tests (fast)
-- `npm run test:ts` or `movehat test --ts` - Only TypeScript integration tests
-- `movehat test --all` - Both Move + TypeScript tests
-- `npm run test:watch` or `movehat test --watch` - TypeScript tests in watch mode
-
-### 5. Deploy (optional)
-
-```bash
-npx movehat run scripts/deploy-counter.ts
-```
-
-## Project Structure
-
-```
-{{PROJECT_NAME}}/
-├── move/                   # Move smart contracts
-│   ├── sources/
-│   │   └── Counter.move
-│   └── Move.toml
-├── scripts/                # Deployment scripts
-│   └── deploy-counter.ts
-├── tests/                  # Integration tests
-│   └── Counter.test.ts
-├── movehat.config.ts       # Movehat configuration
-└── .env                    # Environment variables (git-ignored)
-```
-
-## Available Commands
-
-- `npm run compile` - Compile Move contracts (auto-detects addresses)
-- `npm test` - Run integration tests
-- `npm run test:watch` - Run tests in watch mode
-- `npx movehat run scripts/deploy-counter.ts` - Deploy and initialize counter
-
-## How Named Addresses Work
-
-Movehat automatically detects named addresses from your Move code:
-
-```move
-module counter::counter {  // ← "counter" is auto-detected
-  // ...
-}
-```
-
-- **For development:** Movehat uses temp addresses (`0xcafe`) automatically
-- **For production:** Specify real addresses in `movehat.config.ts`
-
-**Adding new contracts:**
-1. Create `move/sources/MyContract.move`
-2. Write: `module mycontract::mycontract { ... }`
-3. Run `npm run compile`
-4. It just works! (like Hardhat)
-
-## Troubleshooting
-
-| Error | Solution |
-|-------|----------|
-| `movement: command not found` | Install Movement CLI (see Prerequisites) |
-| `Cannot find package 'dotenv'` | Run `npm install` |
-| Compilation failed | Ensure Movement CLI is installed: `movement --version` |
-
-## Learn More
-
-- [Movement Documentation](https://docs.movementnetwork.xyz)
-- [Move Language Book](https://move-language.github.io/move/)
-- [Movehat GitHub](https://github.com/gilbertsahumada/movehat)

package/src/templates/gitignore

@@ -1,22 +0,0 @@
-# Dependencies
-node_modules/
-
-# Build outputs
-move/build/
-dist/
-
-# Environment
-.env
-.env.local
-
-# IDE
-.vscode/
-.idea/
-
-# OS
-.DS_Store
-Thumbs.db
-
-# Movehat
-.movehat/
-deployments/

package/src/templates/move/Move.toml

@@ -1,19 +0,0 @@
-[package]
-name = "{{movePackageName}}"
-version = "1.0.0"
-authors = []
-
-[addresses]
-counter = "_"
-
-[dev-addresses]
-# Dev addresses for testing (used with movement move test --dev)
-# These addresses are temporary and used for local development/testing only
-counter = "0xcafe"
-
-[dependencies.AptosFramework]
-git = "https://github.com/movementlabsxyz/aptos-core.git"
-rev = "movement"
-subdir = "aptos-move/framework/aptos-framework"
-
-[dev-dependencies]

package/src/templates/move/sources/Counter.move

@@ -1,96 +0,0 @@
-module counter::counter {
-    use std::signer;
-    use aptos_framework::event;
-    use aptos_framework::account;
-
-    /// Error code for counter overflow
-    const E_OVERFLOW: u64 = 1;
-    /// Error code for counter not initialized
-    const E_NOT_INITIALIZED: u64 = 2;
-    /// Maximum value for u64
-    const U64_MAX: u64 = 18446744073709551615;
-
-    struct Counter has key {
-        value: u64,
-        increment_events: event::EventHandle<IncrementEvent>,
-    }
-
-    struct IncrementEvent has drop, store {
-        old_value: u64,
-        new_value: u64,
-    }
-
-    public entry fun init(account: &signer) {
-        let account_addr = signer::address_of(account);
-        
-        if (!exists<Counter>(account_addr)) {
-            move_to(account, Counter {
-                value: 0,
-                increment_events: account::new_event_handle<IncrementEvent>(account),
-            });
-        }
-    }
-
-    public entry fun increment(account: &signer) acquires Counter {
-        let account_addr = signer::address_of(account);
-
-        // Auto-init: create Counter if it doesn't exist yet. Defense in
-        // depth so the module stays usable even if a caller skips the
-        // dedicated `init` entry function.
-        if (!exists<Counter>(account_addr)) {
-            move_to(account, Counter {
-                value: 0,
-                increment_events: account::new_event_handle<IncrementEvent>(account),
-            });
-        };
-
-        let counter = borrow_global_mut<Counter>(account_addr);
-        let old_value = counter.value;
-        assert!(old_value < U64_MAX, E_OVERFLOW);
-        counter.value = old_value + 1;
-
-        event::emit_event(&mut counter.increment_events, IncrementEvent {
-            old_value,
-            new_value: counter.value,
-        });
-    }
-
-    #[view]
-    public fun get(addr: address): u64 acquires Counter {
-        assert!(exists<Counter>(addr), E_NOT_INITIALIZED);
-        borrow_global<Counter>(addr).value
-    }
-
-    #[test(account = @0x1)]
-    public fun test_increment(account: &signer) acquires Counter {
-        let addr = signer::address_of(account);
-        aptos_framework::account::create_account_for_test(addr);
-
-        init(account);
-        assert!(get(addr) == 0, 0);
-
-        increment(account);
-        assert!(get(addr) == 1, 1);
-
-        increment(account);
-        assert!(get(addr) == 2, 2);
-    }
-
-    // Regression guard: increment must auto-create the Counter resource
-    // when called against a never-initialized account. Locks the
-    // defense-in-depth behavior so a future refactor can't accidentally
-    // remove it.
-    #[test(account = @0x2)]
-    public fun test_increment_auto_inits(account: &signer) acquires Counter {
-        let addr = signer::address_of(account);
-        aptos_framework::account::create_account_for_test(addr);
-
-        // Skip init entirely — increment must create the resource.
-        increment(account);
-        assert!(get(addr) == 1, 0);
-
-        // Idempotent: a second increment uses the now-existing resource.
-        increment(account);
-        assert!(get(addr) == 2, 1);
-    }
-}

package/src/templates/movehat.config.ts

@@ -1,57 +0,0 @@
-// Movehat configuration.
-//
-// Movehat's primary public API is the Hardhat-style `Harness` class
-// (see scripts/deploy-counter.ts and tests/Counter.test.ts in this
-// template). The `Harness.create*` factories read this file via
-// `loadUserConfig` to resolve the active network + accounts.
-//
-// The `setupTestFixture()` helper also reads the same shape and
-// remains supported as a lighter-weight alternative to Harness.
-
-import dotenv from "dotenv";
-dotenv.config();
-
-export default {
-  // Default network to use when no --network flag is provided
-  // "testnet" = Movement testnet (public, auto-generates test accounts)
-  // "mainnet" = Movement mainnet (requires PRIVATE_KEY in .env)
-  // "local" = Fork server running on localhost:8080
-  defaultNetwork: "testnet",
-
-  // Network configurations
-  networks: {
-    // Movement Testnet - Public test network (recommended for development)
-    // Auto-generates test accounts - no local setup required
-    // Perfect for running tests with transaction simulation
-    testnet: {
-      url: process.env.MOVEMENT_RPC_URL || "https://testnet.movementnetwork.xyz/v1",
-      chainId: "testnet",
-    },
-    // Movement Mainnet - Production network
-    // REQUIRES PRIVATE_KEY in .env - uses real MOVE tokens
-    mainnet: {
-      url: "https://mainnet.movementnetwork.xyz/v1",
-      chainId: "mainnet",
-    },
-    // Local fork server (requires: movehat fork serve)
-    // Useful for testing against a snapshot of real network state
-    local: {
-      url: "http://localhost:8080/v1",
-      chainId: "local",
-    },
-  },
-
-  // Global accounts configuration (Hardhat-style)
-  // Uses PRIVATE_KEY from .env by default
-  // You can also specify accounts here directly:
-  // accounts: ["0x1234..."],
-  accounts: process.env.PRIVATE_KEY ? [process.env.PRIVATE_KEY] : [],
-
-  // Global settings
-  moveDir: "./move",
-
-  // Named addresses (can be overridden per-network in network config)
-  namedAddresses: {
-    // Example: counter: "0x1234...",
-  },
-};

package/src/templates/package.json

@@ -1,27 +0,0 @@
-{
-  "name": "{{projectName}}",
-  "version": "1.0.0",
-  "type": "module",
-  "scripts": {
-    "test": "movehat test",
-    "test:move": "movehat test:move",
-    "test:ts": "movehat test:ts",
-    "test:watch": "movehat test:ts --watch",
-    "deploy": "movehat run scripts/deploy-counter.ts"
-  },
-  "dependencies": {
-    "movehat": "latest",
-    "@aptos-labs/ts-sdk": "^5.1.5",
-    "dotenv": "^17.2.3",
-    "got": "^11.8.6"
-  },
-  "devDependencies": {
-    "@types/chai": "^5.2.3",
-    "@types/mocha": "^10.0.10",
-    "@types/node": "^24.10.1",
-    "chai": "^6.2.1",
-    "mocha": "^11.7.5",
-    "tsx": "^4.7.0",
-    "typescript": "^5.9.3"
-  }
-}

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

@@ -1,66 +0,0 @@
-import { Harness } from "movehat";
-
-async function main() {
-  console.log("🚀 Deploying Counter contract...\n");
-
-  // 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";
-  const harness = await Harness.createLive(network);
-  try {
-    console.log(`✅ Runtime initialized on ${harness.runtime.network.name}`);
-    console.log(`   Account: ${harness.runtime.account.accountAddress.toString()}`);
-    console.log(`   RPC: ${harness.runtime.network.rpc}\n`);
-
-    // Deploy as a code object via `movement move deploy-object`. If the
-    // Move.toml's named address differs from the module identifier
-    // (e.g. `module my_pkg::counter` with `[addresses] my_pkg = "_"`),
-    // pass `addressName: "my_pkg"` in addition to `moduleName: "counter"`.
-    //
-    // To redeploy an existing record, set MH_CLI_REDEPLOY=true.
-    const deployment = await harness.deployCodeObject({
-      moduleName: "counter",
-    });
-
-    console.log(`\n✅ Module deployed at: ${deployment.address}::counter`);
-    if (deployment.txHash) {
-      console.log(`   Transaction: ${deployment.txHash}`);
-    }
-
-    // Interact with the freshly deployed module via the runtime helper.
-    const counter = harness.runtime.getContract(deployment.address, "counter");
-
-    // Counter is a Move resource — it must be created explicitly per
-    // account before any method that reads or mutates it. The dedicated
-    // `init` entry function does this once per signer. (The module also
-    // auto-inits inside `increment` as defense in depth, so this call is
-    // technically optional today, but kept for pedagogy: real-world Move
-    // modules usually require an explicit init step.)
-    console.log("\n🔧 Initializing counter resource for this account...");
-    const initTx = await counter.call(harness.runtime.account, "init", []);
-    console.log(`   Init tx: ${initTx.hash}`);
-
-    console.log("\n📝 Incrementing counter...");
-    const txResult = await counter.call(harness.runtime.account, "increment", []);
-    console.log(`✅ Transaction hash: ${txResult.hash}`);
-
-    // Use harness.runViewFunction directly when you have a fully
-    // qualified function id; counter.view<T>(...) is the shorter form.
-    const [value] = await harness.runViewFunction({
-      function: `${deployment.address}::counter::get`,
-      functionArguments: [harness.runtime.account.accountAddress.toString()],
-    });
-    console.log(`\n📊 Counter value: ${value}`);
-  } finally {
-    // Always release the Harness — cleanup() is idempotent and safe to
-    // call on a `createLive` instance even though no local process was
-    // spawned (it just flips the use-after-cleanup poison flag).
-    await harness.cleanup();
-  }
-}
-
-main().catch((error) => {
-  console.error("❌ Deployment failed:", error?.message || error);
-  process.exit(1);
-});