movehat 0.0.1-alpha.0

package/src/templates/.mocharc.json

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

package/src/templates/README.md

@@ -0,0 +1,92 @@
+# {{PROJECT_NAME}}
+
+A Move smart contract project built with Movehat.
+
+## Prerequisites
+
+- Node.js v18+
+- [Movement CLI](https://docs.movementnetwork.xyz/devs/movementCLI)
+
+## 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`:
+```
+MH_PRIVATE_KEY=your_private_key_here
+MH_ACCOUNT=your_account_address_here
+MH_NETWORK=testnet
+```
+
+### 3. Update Move.toml
+
+Edit `move/Move.toml` and set the `counter` address to your account address:
+
+```toml
+[addresses]
+counter = "0xYOUR_ACCOUNT_ADDRESS"
+```
+
+### 4. Compile contracts
+
+```bash
+npm run compile
+```
+
+### 5. Deploy
+
+```bash
+npx tsx scripts/deploy-counter.ts
+```
+
+Or use the Movement CLI directly:
+```bash
+movement move publish --package-dir ./move --profile default --assume-yes
+```
+
+### 6. Run tests
+
+```bash
+npm test
+```
+
+## 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
+- `npm test` - Run integration tests
+- `npm run test:watch` - Run tests in watch mode
+- `npx tsx scripts/deploy-counter.ts` - Deploy and initialize counter
+
+## Learn More
+
+- [Movement Documentation](https://docs.movementnetwork.xyz)
+- [Aptos Move Book](https://move-language.github.io/move/)
+- [Movehat GitHub](https://github.com/gilbertsahumada/movehat)

package/src/templates/move/Counter.move

@@ -0,0 +1,64 @@
+module counter::counter {
+    use std::signer;
+    use aptos_framework::event;
+    use aptos_framework::account;
+
+    struct Counter has key {
+        value: u64,
+        increment_events: event::EventHandle<IncrementEvent>,
+    }
+
+    struct IncrementEvent has drop, store {
+        old_value: u64,
+        new_value: u64,
+    }
+
+    /// Initialize counter for an account
+    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),
+            });
+        }
+    }
+
+    /// Increment the counter
+    public entry fun increment(account: &signer) acquires Counter {
+        let account_addr = signer::address_of(account);
+        assert!(exists<Counter>(account_addr), 1);
+        
+        let counter = borrow_global_mut<Counter>(account_addr);
+        let old_value = counter.value;
+        counter.value = old_value + 1;
+        
+        event::emit_event(&mut counter.increment_events, IncrementEvent {
+            old_value,
+            new_value: counter.value,
+        });
+    }
+
+    /// Get counter value
+    #[view]
+    public fun get(addr: address): u64 acquires Counter {
+        assert!(exists<Counter>(addr), 1);
+        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);
+    }
+}

package/src/templates/move/Move.toml

@@ -0,0 +1,16 @@
+[package]
+name = "{{PROJECT_NAME}}"
+version = "1.0.0"
+authors = []
+
+[addresses]
+counter = "_"
+
+[dev-addresses]
+
+[dependencies.AptosFramework]
+git = "https://github.com/movementlabsxyz/aptos-core.git"
+rev = "movement"
+subdir = "aptos-move/framework/aptos-framework"
+
+[dev-dependencies]

package/src/templates/movehat.config.ts

@@ -0,0 +1,37 @@
+import dotenv from "dotenv";
+dotenv.config();
+
+export default {
+  // Default network to use when no --network flag is provided
+  defaultNetwork: "testnet",
+
+  // Network configurations
+  networks: {
+    testnet: {
+      url: process.env.MOVEMENT_RPC_URL || "https://testnet.movementnetwork.xyz/v1",
+      chainId: "testnet",
+    },
+    mainnet: {
+      url: "https://mainnet.movementnetwork.xyz/v1",
+      chainId: "mainnet",
+    },
+    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

@@ -0,0 +1,24 @@
+{
+  "name": "{{projectName}}",
+  "version": "1.0.0",
+  "type": "module",
+  "scripts": {
+    "test": "mocha",
+    "test:watch": "mocha --watch",
+    "deploy": "movehat run scripts/deploy-counter.ts"
+  },
+  "dependencies": {
+    "movehat": "^0.0.1-alpha.0",
+    "@aptos-labs/ts-sdk": "^5.1.5",
+    "dotenv": "^17.2.3"
+  },
+  "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

@@ -0,0 +1,48 @@
+import { getMovehat, ModuleAlreadyDeployedError } from "movehat";
+
+async function main() {
+  console.log("🚀 Deploying Counter contract...\n");
+
+  // Get the Movehat Runtime Environment
+  const mh = await getMovehat();
+
+  console.log(`✅ Runtime initialized`);
+  console.log(`   Account: ${mh.account.accountAddress.toString()}`);
+  console.log(`   Network: ${mh.network.name}`);
+  console.log(`   RPC: ${mh.network.rpc}\n`);
+
+  // Deploy (publish) the module
+  // Automatically checks if already deployed and suggests --redeploy if needed
+  const deployment = await mh.deployContract("counter");
+
+  console.log(`\n✅ Module deployed at: ${deployment.address}::counter`);
+  if (deployment.txHash) {
+    console.log(`   Transaction: ${deployment.txHash}`);
+  }
+
+  // Get contract instance
+  const counter = mh.getContract(deployment.address, "counter");
+
+  // Initialize the counter
+  console.log("\n📝 Initializing counter...");
+  const txResult = await counter.call(mh.account, "init", []);
+
+  console.log(`✅ Transaction hash: ${txResult.hash}`);
+  console.log(`✅ Counter initialized successfully!`);
+
+  // Verify
+  const value = await counter.view<number>("get", [
+    mh.account.accountAddress.toString()
+  ]);
+
+  console.log(`\n📊 Initial counter value: ${value}`);
+}
+
+main().catch((error) => {
+  // ModuleAlreadyDeployedError is already logged with full details by deployContract()
+  // For other errors, show the message
+  if (!(error instanceof ModuleAlreadyDeployedError)) {
+    console.error("❌ Deployment failed:", error?.message || error);
+  }
+  process.exit(1);
+});

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

@@ -0,0 +1,75 @@
+import { describe, it, before, after } from "mocha";
+import { expect } from "chai";
+import { getMovehat, type MovehatRuntime } from "movehat";
+import type { MoveContract } from "movehat/helpers";
+import { assertTransactionSuccess, snapshot } from "movehat/helpers";
+
+describe("Counter Contract", () => {
+  let mh: MovehatRuntime;
+  let counter: MoveContract;
+
+  before(async function () {
+    this.timeout(30000);
+
+    // Initialize Movehat Runtime Environment
+    mh = await getMovehat();
+
+    console.log(`\n✅ Testing on ${mh.network.name}`);
+    console.log(`   Account: ${mh.account.accountAddress.toString()}\n`);
+
+    // Get counter contract instance
+    counter = mh.getContract(
+      mh.account.accountAddress.toString(),
+      "counter"
+    );
+  });
+
+  describe("Counter functionality", () => {
+    it("should initialize counter", async function () {
+      this.timeout(30000);
+
+      const txResult = await counter.call(mh.account, "init", []);
+      assertTransactionSuccess(txResult);
+
+      const value = await counter.view<number>("get", [
+        mh.account.accountAddress.toString()
+      ]);
+
+      expect(value).to.equal(0);
+      console.log(`   ✓ Counter initialized with value: ${value}`);
+    });
+
+    it("should increment counter", async function () {
+      this.timeout(30000);
+
+      const initialValue = await counter.view<number>("get", [
+        mh.account.accountAddress.toString()
+      ]);
+
+      const txResult = await counter.call(mh.account, "increment", []);
+      assertTransactionSuccess(txResult);
+
+      const newValue = await counter.view<number>("get", [
+        mh.account.accountAddress.toString()
+      ]);
+
+      expect(newValue).to.equal(initialValue + 1);
+      console.log(`   ✓ Counter incremented: ${initialValue} → ${newValue}`);
+    });
+  });
+
+  // Optional: Create a snapshot after tests for debugging
+  // Uncomment to enable
+  /*
+  after(async function () {
+    this.timeout(30000);
+
+    const snapshotPath = await snapshot({
+      name: 'counter-test-final'
+    });
+
+    console.log(`\n📸 Snapshot created: ${snapshotPath}`);
+    console.log(`   Use 'aptos move sim view-resource --session ${snapshotPath}' to inspect state\n`);
+  });
+  */
+});

package/src/templates/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "lib": ["ES2022"],
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "resolveJsonModule": true,
+    "outDir": "./dist"
+  },
+  "include": ["tests/**/*", "scripts/**/*", "movehat.config.ts"],
+  "exclude": ["node_modules", "dist", "move"]
+}

package/src/templates/types/movehat.d.ts

@@ -0,0 +1,104 @@
+// Type declarations for movehat package
+// This file is only for IDE support during template development
+// It will NOT be copied to user projects
+
+declare module 'movehat' {
+  import { Aptos, Account } from '@aptos-labs/ts-sdk';
+
+  export interface NetworkInfo {
+    name: string;
+    rpc: string;
+    chainId?: string;
+  }
+
+  export interface MovehatConfig {
+    network: string;
+    rpc: string;
+    privateKey: string;
+    profile: string;
+    moveDir: string;
+    account: string;
+    namedAddresses?: Record<string, string>;
+  }
+
+  export interface DeploymentInfo {
+    address: string;
+    moduleName: string;
+    network: string;
+    deployer: string;
+    timestamp: number;
+    txHash?: string;
+    blockNumber?: string;
+  }
+
+  export interface MovehatRuntime {
+    config: MovehatConfig;
+    network: NetworkInfo;
+    aptos: Aptos;
+    account: Account;
+    accounts: Account[];
+    getContract: (address: string, moduleName: string) => any;
+    deployContract: (
+      moduleName: string,
+      options?: {
+        packageDir?: string;
+      }
+    ) => Promise<DeploymentInfo>;
+    getDeployment: (moduleName: string) => DeploymentInfo | null;
+    getDeployments: () => Record<string, DeploymentInfo>;
+    getDeploymentAddress: (moduleName: string) => string | null;
+    createAccount: () => Account;
+    getAccount: (privateKey: string) => Account;
+    getAccountByIndex: (index: number) => Account;
+    switchNetwork: (networkName: string) => Promise<void>;
+  }
+
+  export function getMovehat(): Promise<MovehatRuntime>;
+  export function initRuntime(configOverride?: Partial<MovehatConfig>): Promise<MovehatRuntime>;
+  export function getRuntime(): MovehatRuntime;
+
+  export const mh: {
+    readonly runtime: MovehatRuntime;
+  };
+}
+
+declare module 'movehat/helpers' {
+  import { Account, Aptos } from '@aptos-labs/ts-sdk';
+
+  export interface TestEnvironment {
+    aptos: Aptos;
+    account: Account;
+    config: any;
+  }
+
+  export class MoveContract {
+    constructor(aptos: Aptos, address: string, moduleName: string);
+    call(sender: Account, functionName: string, args: any[]): Promise<any>;
+    view<T>(functionName: string, args: any[]): Promise<T>;
+  }
+
+  export interface TransactionResult {
+    hash: string;
+    success: boolean;
+  }
+
+  export interface DeploymentInfo {
+    address: string;
+    moduleName: string;
+    network: string;
+    deployer: string;
+    timestamp: number;
+    txHash?: string;
+    blockNumber?: string;
+  }
+
+  export function setupTestEnvironment(): Promise<TestEnvironment>;
+  export function createTestAccount(): Account;
+  export function getContract(aptos: Aptos, address: string, moduleName: string): MoveContract;
+  export function assertTransactionSuccess(result: TransactionResult): void;
+  export function assertTransactionFailed(result: TransactionResult): void;
+  export function saveDeployment(deployment: DeploymentInfo): void;
+  export function loadDeployment(network: string, moduleName: string): DeploymentInfo | null;
+  export function getAllDeployments(network: string): Record<string, DeploymentInfo>;
+  export function getDeployedAddress(network: string, moduleName: string): string | null;
+}

package/src/types/config.ts

@@ -0,0 +1,36 @@
+/**
+ * Configuration for a single network
+ */
+export interface NetworkConfig {
+    url: string;
+    accounts?: string[]; // Optional: if not provided, uses global accounts
+    chainId?: string;
+    profile?: string;
+    namedAddresses?: Record<string, string>;
+}
+
+/**
+ * User configuration (what users write in movehat.config.ts)
+ */
+export interface MovehatUserConfig {
+    defaultNetwork?: string;
+    networks: Record<string, NetworkConfig>;
+    accounts?: string[]; // Global accounts (Hardhat-style)
+    moveDir?: string;
+    namedAddresses?: Record<string, string>;
+}
+
+/**
+ * Resolved configuration (internal use - what runtime uses)
+ */
+export interface MovehatConfig {
+    network: string;              // Active network name
+    rpc: string;                  // RPC endpoint
+    privateKey: string;           // Primary account (accounts[0])
+    allAccounts: string[];        // All accounts for this network
+    profile: string;              // Movement CLI profile
+    moveDir: string;              // Move source directory
+    account: string;              // Account address (derived from privateKey)
+    namedAddresses: Record<string, string>; // Merged named addresses
+    networkConfig: NetworkConfig; // Full network configuration
+}

package/src/types/fork.ts

@@ -0,0 +1,41 @@
+/**
+ * Fork system types for MoveHat
+ */
+
+export interface ForkMetadata {
+  network: string;
+  nodeUrl: string;
+  chainId: number;
+  ledgerVersion: string;
+  timestamp: string;
+  epoch: string;
+  blockHeight: string;
+  createdAt: string;
+}
+
+export interface AccountState {
+  sequenceNumber: string;
+  authenticationKey: string;
+}
+
+export interface LedgerInfo {
+  chain_id: number;
+  epoch: string;
+  ledger_version: string;
+  oldest_ledger_version: string;
+  ledger_timestamp: string;
+  node_role: string;
+  oldest_block_height: string;
+  block_height: string;
+  git_hash?: string;
+}
+
+export interface AccountData {
+  sequence_number: string;
+  authentication_key: string;
+}
+
+export interface AccountResource {
+  type: string;
+  data: any;
+}

package/src/types/runtime.ts

@@ -0,0 +1,49 @@
+import { Aptos, Account } from "@aptos-labs/ts-sdk";
+import { MovehatConfig } from "./config.js";
+import { MoveContract } from "../core/contract.js";
+import { DeploymentInfo } from "../core/deployments.js";
+
+export interface NetworkInfo {
+  name: string;
+  rpc: string;
+  chainId?: string;
+}
+
+export interface MovehatRuntime {
+  // Core configuration
+  config: MovehatConfig;
+
+  // Network information
+  network: NetworkInfo;
+
+  // Aptos client instance
+  aptos: Aptos;
+
+  // Default account from config (accounts[0])
+  account: Account;
+
+  // All accounts for this network
+  accounts: Account[];
+
+  // Helper functions
+  getContract: (address: string, moduleName: string) => MoveContract;
+
+  // Deployment functions
+  deployContract: (
+    moduleName: string,
+    options?: {
+      packageDir?: string;
+    }
+  ) => Promise<DeploymentInfo>;
+  getDeployment: (moduleName: string) => DeploymentInfo | null;
+  getDeployments: () => Record<string, DeploymentInfo>;
+  getDeploymentAddress: (moduleName: string) => string | null;
+
+  // Account management
+  createAccount: () => Account;
+  getAccount: (privateKey: string) => Account;
+  getAccountByIndex: (index: number) => Account;
+
+  // Network switching
+  switchNetwork: (networkName: string) => Promise<void>;
+}