movehat 0.2.4 → 0.2.5

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

@@ -1,113 +0,0 @@
-// @ts-nocheck - This is a template file, dependencies are installed in user projects
-import { describe, it, before, after } from "mocha";
-import { expect } from "chai";
-import { Harness, AccountManager } from "movehat";
-
-describe("Counter Contract", () => {
-  let harness;
-  let counter;
-  let deployer, alice, bob;
-
-  before(async function () {
-    this.timeout(60000); // Allow time for local node startup + deployment
-
-    // 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.
-    //
-    // The setupTestFixture helper still works if you prefer the older
-    // pattern; see `import { setupTestFixture } from "movehat/helpers"`.
-    harness = await Harness.createLocal({
-      accountLabels: ["deployer", "alice", "bob"],
-      autoDeploy: ["counter"],
-    });
-
-    const labeled = AccountManager.getLabeledAccounts();
-    deployer = labeled.deployer;
-    alice = labeled.alice;
-    bob = labeled.bob;
-
-    const counterAddr = harness.runtime.getDeploymentAddress("counter");
-    counter = harness.runtime.getContract(counterAddr, "counter");
-
-    console.log(`\n✅ Testing on local blockchain`);
-    console.log(`   Deployer: ${deployer.accountAddress.toString()}`);
-    console.log(`   Alice: ${alice.accountAddress.toString()}`);
-    console.log(`   Bob: ${bob.accountAddress.toString()}\n`);
-  });
-
-  describe("Counter functionality", () => {
-    it("should initialize counter for deployer", async () => {
-      // Initialize counter for deployer (required before get/increment)
-      const tx = await counter.call(deployer, "init", []);
-      console.log(`   Init transaction: ${tx.hash}`);
-
-      // Read counter value via harness.runViewFunction
-      const [value] = await harness.runViewFunction({
-        function: `${counter.moduleAddress}::counter::get`,
-        functionArguments: [deployer.accountAddress.toString()],
-      });
-
-      console.log(`   Counter value: ${value}`);
-      expect(parseInt(value)).to.equal(0);
-    });
-
-    it("should increment counter", async () => {
-      const tx = await counter.call(deployer, "increment", []);
-      console.log(`   Transaction: ${tx.hash}`);
-
-      // counter.view is the shorter form when you already have the contract.
-      const value = await counter.view<string>("get", [
-        deployer.accountAddress.toString(),
-      ]);
-
-      console.log(`   New counter value: ${value}`);
-      expect(parseInt(value)).to.equal(1);
-    });
-
-    it("alice can initialize and increment her counter", async () => {
-      const initTx = await counter.call(alice, "init", []);
-      console.log(`   Alice init transaction: ${initTx.hash}`);
-
-      const tx = await counter.call(alice, "increment", []);
-      console.log(`   Alice's increment transaction: ${tx.hash}`);
-
-      const aliceValue = await counter.view<string>("get", [
-        alice.accountAddress.toString(),
-      ]);
-
-      console.log(`   Alice's counter value: ${aliceValue}`);
-      expect(parseInt(aliceValue)).to.equal(1);
-
-      const deployerValue = await counter.view<string>("get", [
-        deployer.accountAddress.toString(),
-      ]);
-
-      console.log(`   Deployer's counter value: ${deployerValue}`);
-      expect(parseInt(deployerValue)).to.equal(1);
-    });
-
-    it("bob can initialize and increment his counter", async () => {
-      const initTx = await counter.call(bob, "init", []);
-      console.log(`   Bob init transaction: ${initTx.hash}`);
-
-      const tx = await counter.call(bob, "increment", []);
-      console.log(`   Bob's increment transaction: ${tx.hash}`);
-
-      const bobValue = await counter.view<string>("get", [
-        bob.accountAddress.toString(),
-      ]);
-
-      console.log(`   Bob's counter value: ${bobValue}`);
-      expect(parseInt(bobValue)).to.equal(1);
-    });
-  });
-
-  after(async () => {
-    // harness.cleanup() stops the local node and poisons the harness —
-    // any further method call (other than cleanup itself) throws
-    // HarnessDisposedError synchronously.
-    await harness.cleanup();
-  });
-});

package/src/templates/tsconfig.json

@@ -1,15 +0,0 @@
-{
-  "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

@@ -1,101 +0,0 @@
-// 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<MovehatRuntime>;
-  }
-
-  export function initRuntime(configOverride?: Partial<MovehatConfig>): Promise<MovehatRuntime>;
-}
-
-declare module 'movehat/helpers' {
-  import { Account, Aptos } from '@aptos-labs/ts-sdk';
-
-  export interface TestEnvironment {
-    aptos: Aptos;
-    account: Account;
-    config: import('movehat').MovehatConfig;
-  }
-
-  export class MoveContract {
-    constructor(aptos: Aptos, address: string, moduleName: string);
-    // args: any[] mirrors the runtime declaration — Move entry-function
-    // arguments are heterogeneous primitives validated by the Aptos SDK
-    // at submit time.
-    call(sender: Account, functionName: string, args: any[]): Promise<TransactionResult>;
-    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

@@ -1,83 +0,0 @@
-/**
- * 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
-}
-
-/**
- * Testing mode for local environment
- */
-export type LocalTestingMode = 'local-node' | 'fork';
-
-/**
- * Options for setting up local testing environment
- */
-export interface LocalTestOptions {
-    mode?: LocalTestingMode;            // Testing mode: 'local-node' (full blockchain) or 'fork' (read-only snapshot) (default: 'local-node')
-
-    // Local Node options (when mode='local-node')
-    nodeTestDir?: string;               // Directory for node data (default: .movehat/local-node)
-    nodeForceRestart?: boolean;         // Clean node state and start fresh (default: true)
-    nodeFaucetPort?: number;            // Faucet port for local node (default: 8081)
-    nodeApiPort?: number;               // API/RPC port for local node (default: 8080)
-    nodeReadyPort?: number;             // Ready server port (default: 8070)
-    nodeSilent?: boolean;               // Suppress node output (default: false)
-
-    // Fork options (when mode='fork')
-    forkNetwork?: 'testnet' | 'mainnet' | string;   // Network to fork from (default: 'testnet')
-    /**
-     * RPC URL override used when forking a non-built-in network.
-     * Required when `forkNetwork` is not one of the built-in names
-     * (`'testnet'`, `'mainnet'`). Ignored when a fork already exists
-     * on disk (the saved metadata's nodeUrl is reused).
-     */
-    forkRpcUrl?: string;
-    forkName?: string;                  // Name for the fork (default: 'test-local')
-    forkPort?: number;                  // Fork server port (default: 8080)
-    forkResetState?: boolean;           // Clear fork state before tests (default: true)
-    /**
-     * Optional API key sent as `Authorization: Bearer <key>` on every
-     * outgoing Movement API request made by the fork's
-     * `MovementApiClient`. Use for rate-limited public endpoints or
-     * auth-gated nodes. The key stays in process memory only — not
-     * persisted to the fork's on-disk metadata.
-     */
-    forkApiKey?: string;
-
-    // Common options (both modes)
-    autoFund?: boolean;                 // Auto-fund accounts (default: true)
-    defaultBalance?: number;            // Default balance in octas (default: 100_000_000 = 1 MOVE)
-    autoDeploy?: readonly string[];     // Modules to auto-deploy (accepts readonly arrays)
-    accountLabels?: readonly string[];  // Labels for pre-generated accounts (default: ['deployer', 'alice', 'bob'])
-}

package/src/types/fork.ts

@@ -1,47 +0,0 @@
-/**
- * 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;
-  /**
-   * Move resource payload — structurally a JSON-shaped object whose
-   * schema depends on the resource type (CoinStore, AggregatorSnapshot, etc).
-   * unknown forces callers to narrow before access; the boundary-validation
-   * follow-up of #57 will add per-resource type guards.
-   */
-  data: unknown;
-}

package/src/types/harness.ts

@@ -1,182 +0,0 @@
-import type { DeploymentInfo } from "../core/deployments.js";
-import type { ChildProcessAdapter } from "../utils/childProcessAdapter.js";
-
-/**
- * Options for `harness.deployCodeObject(options)`.
- *
- * Wraps `movement move deploy-object`. The Movement CLI derives the
- * destination object address from the signing account; that address is
- * bound to `moduleName` (passed as `--address-name`) at compile time.
- * Callers retrieve the resulting object address via the returned
- * `CodeObjectInfo.address`.
- */
-export interface DeployCodeObjectOptions {
-  /**
-   * Logical module identifier (the `name` part of `module addr::name`).
-   * Used as the persistence key (`deployments/{network}/{moduleName}.json`)
-   * and as the `name` arg you'd pass to `runtime.getContract(addr, name)`
-   * after deployment.
-   *
-   * If `addressName` is omitted, `moduleName` is also used as the CLI's
-   * `--address-name` flag (correct when the Move.toml's named address
-   * matches the module identifier). For packages where they differ —
-   * e.g. `module hello_blockchain::counter` (named address
-   * `hello_blockchain`, module `counter`) — set `addressName` explicitly.
-   */
-  moduleName: string;
-
-  /**
-   * Move.toml named address that the derived object address binds to
-   * at compile time (the `--address-name` flag of `move deploy-object`).
-   *
-   * Defaults to `moduleName`. Set this when the Move.toml's named
-   * address differs from the on-chain module identifier:
-   *
-   * ```ts
-   * // Move source: `module hello_blockchain::counter`
-   * // Move.toml:   `[addresses] hello_blockchain = "_"`
-   * await harness.deployCodeObject({
-   *   moduleName: "counter",            // for getContract + save key
-   *   addressName: "hello_blockchain",  // for --address-name
-   * });
-   * ```
-   */
-  addressName?: string;
-
-  /**
-   * Extra named-address overrides merged on top of the addresses
-   * auto-detected from `<packageDir>/sources/**.move`. Values here win
-   * for the matching keys; auto-detected names not present here are
-   * still pinned to the deployer address (Publisher convention).
-   */
-  namedAddresses?: Record<string, string>;
-
-  /**
-   * Path to the Move package. Defaults to `config.moveDir` from the
-   * harness's runtime config (usually `./move`).
-   */
-  packageDir?: string;
-
-  /**
-   * Artifact set written into the on-chain package. Mirrors the CLI
-   * flag. Defaults to `'sparse'` (the Movement CLI default).
-   */
-  includedArtifacts?: "none" | "sparse" | "all";
-
-  /**
-   * Test-only override for the child-process adapter. Production callers
-   * leave this undefined so the default spawn-based adapter is used.
-   * @internal
-   */
-  adapter?: ChildProcessAdapter;
-}
-
-/**
- * Options for `harness.upgradeCodeObject(options)`.
- *
- * Wraps `movement move upgrade-object`. The object must already exist
- * on-chain at `objectAddress` and have been deployed previously (typically
- * via `deployCodeObject`).
- */
-export interface UpgradeCodeObjectOptions extends DeployCodeObjectOptions {
-  /** Address of the existing code object to upgrade. Required. */
-  objectAddress: string;
-}
-
-/**
- * Result of `deployCodeObject` / `upgradeCodeObject`.
- *
- * Today this is structurally identical to {@link DeploymentInfo} — the
- * `address` field holds the derived **object address** (the value
- * callers pass to `runtime.getContract(...)` to interact with the
- * modules), and `deployer` is the signing account.
- *
- * The alias exists so future iterations can layer additional fields
- * (e.g. an explicit `kind: 'code-object' | 'publish'` discriminator)
- * without churning every callsite.
- */
-export type CodeObjectInfo = DeploymentInfo;
-
-/**
- * Options for `harness.runViewFunction(options)`.
- *
- * Delegates to the Aptos SDK's `aptos.view(...)` — no CLI invocation,
- * no profile management. Works on `createLocal`, `createFork`, and
- * `createLive` harnesses (view functions are read-only).
- */
-export interface RunViewFunctionOptions {
-  /**
-   * Fully qualified Move function id, e.g. `0xCAFE::counter::get`.
-   */
-  function: string;
-
-  /**
-   * Move type-tag arguments, e.g. `['0x1::aptos_coin::AptosCoin']`.
-   */
-  typeArguments?: string[];
-
-  /**
-   * Move function arguments. SDK-validated at the boundary; pass values
-   * matching the Move function signature (strings for `address`,
-   * numbers / bigints for `u8`-`u256`, booleans, etc.).
-   */
-  functionArguments?: unknown[];
-}
-
-/**
- * Options for `harness.runMoveScript(options)`.
- *
- * Wraps `movement move run-script`. The CLI handles compilation
- * inline when given a `.move` source; the user can also pass a
- * pre-compiled `.mv` bytecode file.
- *
- * Not available on fork-mode harnesses (forks are read-only).
- */
-export interface RunMoveScriptOptions {
-  /**
-   * Path to the Move script. Extension determines the CLI flag:
-   *   - `.move` → `--script-path` (CLI auto-compiles)
-   *   - `.mv` → `--compiled-script-path` (user pre-compiled)
-   * Other extensions throw synchronously before any CLI call.
-   */
-  scriptPath: string;
-
-  /**
-   * CLI-formatted typed arguments. Movement CLI expects each arg
-   * prefixed by its Move type, e.g. `'address:0x1'`, `'u8:42'`,
-   * `'bool:true'`, `'string:hello'`. See
-   * `movement move run-script --help` for the full grammar.
-   */
-  args?: string[];
-
-  /**
-   * Type-tag arguments for generic scripts, e.g.
-   * `['0x1::aptos_coin::AptosCoin']`.
-   */
-  typeArgs?: string[];
-
-  /**
-   * Optional working directory for compilation. Most callers leave
-   * this undefined — the CLI uses the script's parent directory.
-   */
-  packageDir?: string;
-
-  /**
-   * Test-only override for the child-process adapter.
-   * @internal
-   */
-  adapter?: ChildProcessAdapter;
-}
-
-/**
- * Result of `harness.runMoveScript`.
- *
- * Always carries `txHash` (parser throws if it can't extract one).
- * `success` and `vmStatus` are best-effort: parsed from the CLI's
- * JSON `Result` block when present, `undefined` if the parser misses.
- */
-export interface MoveScriptResult {
-  txHash: string;
-  success?: boolean;
-  vmStatus?: string;
-}

package/src/types/runtime.ts

@@ -1,57 +0,0 @@
-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";
-import type { ChildProcessAdapter } from "../utils/childProcessAdapter.js";
-
-export interface NetworkInfo {
-  name: string;
-  rpc: string;
-  chainId?: string;
-}
-
-export interface MovehatRuntime {
-  // Core configuration
-  config: MovehatConfig;
-
-  // Network information
-  network: NetworkInfo;
-
-  // Movement TypeScript SDK 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;
-      /**
-       * Override the child-process adapter. Test-only: production callers
-       * leave this undefined so the default spawn-based adapter is used.
-       */
-      adapter?: ChildProcessAdapter;
-    }
-  ) => 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 — returns a new runtime bound to the requested
-  // network. There is no module-cached runtime, so callers must capture
-  // and use the returned instance.
-  switchNetwork: (networkName: string) => Promise<MovehatRuntime>;
-}