forge-pack 0.1.0 → 0.2.0

package/README.md

@@ -0,0 +1,88 @@
+# forge-pack
+
+Generate self-contained Solidity deployer libraries from [Forge](https://book.getfoundry.sh/) build artifacts.
+
+`forge-pack` reads your compiled contract JSON, resolves library dependencies, and outputs a single `.sol` file containing a deployer library with `deploy()`, `deploy2()` (CREATE2), and `initcode()` functions — ready to use in scripts or tests.
+
+## Usage
+
+The package does not require installation, you can directly use `npx`/`pnpx` to run it:
+
+```bash
+npx forge-pack@latest <contract-name>
+```
+
+## CLI Usage
+
+```
+forge-pack <ContractName> [options]
+```
+
+### Options
+
+| Flag               | Description                                | Default       |
+| ------------------ | ------------------------------------------ | ------------- |
+| `--out <dir>`      | Forge output directory                     | `./out`       |
+| `--output <dir>`   | Where to write the deployer `.sol` file    | `./deployers` |
+| `--build`          | Run `forge build` before reading artifacts | `false`       |
+| `--pragma <range>` | Solidity pragma for generated file         | `>=0.8.0`     |
+| `-h, --help`       | Show help message                          | —             |
+
+### Example
+
+```bash
+# Generate a deployer for MyToken
+forge-pack MyToken
+
+# Build first, then generate with a specific pragma
+forge-pack MyToken --build --pragma "^0.8.20"
+
+# Use a custom output directory
+forge-pack MyToken --output src/deployers
+```
+
+This produces a file like `deployers/MyTokenDeployer.sol`:
+
+```solidity
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity >=0.8.0;
+
+library MyTokenDeployer {
+    function deploy(string memory name, string memory symbol) internal returns (address deployed) { ... }
+    function deploy2(bytes32 salt, string memory name, string memory symbol) internal returns (address deployed) { ... }
+    function initcode(string memory name, string memory symbol) internal pure returns (bytes memory) { ... }
+}
+```
+
+Constructor parameters are automatically extracted from the ABI. Struct types used in constructor arguments get their definitions included in the generated file.
+
+## Library Dependencies
+
+If your contract links against external libraries, `forge-pack` resolves them recursively in topological order and generates inline deployment helpers. The deployer handles deploying libraries before the main contract, so the output remains self-contained.
+
+## Programmatic API
+
+```typescript
+import { findArtifact, parseArtifact, generateDeployer, resolveLibraries } from "forge-pack";
+
+const artifactPath = findArtifact("MyToken", "./out");
+const parsed = parseArtifact(artifactPath, "MyToken");
+
+const libraries = resolveLibraries(parsed.linkReferences, "./out");
+const solidity = generateDeployer(parsed, { pragma: ">=0.8.0", libraries });
+```
+
+### Exports
+
+**Functions:**
+
+- `findArtifact(contractName, outDir, options?)` — Locate a contract artifact in the Forge output directory
+- `parseArtifact(artifactPath, contractName)` — Parse a Forge artifact JSON into a structured object
+- `resolveLibraries(linkReferences, outDir)` — Recursively resolve library dependencies in deploy order
+- `generateDeployer(parsed, options?)` — Generate Solidity deployer library source code
+
+**Types:** `ParsedArtifact`, `LinkReference`, `LinkReferences`, `AbiParam`, `AbiEntry`, `FindArtifactOptions`, `ResolvedLibrary`, `GenerateDeployerOptions`
+
+## License
+
+MIT

package/dist/cli.d.mts

@@ -0,0 +1 @@
+export { };

package/dist/{cli.js → cli.mjs}

@@ -1,5 +1,4 @@
-#!/usr/bin/env node
-import { i as resolveLibraries, n as generateDeployer, r as parseArtifact, t as findArtifact } from "./pack-A6vKuf56.js";
+import { i as resolveLibraries, n as generateDeployer, r as parseArtifact, t as findArtifact } from "./pack-Be_7Cz7w.mjs";
 import { parseArgs } from "node:util";
 import { execSync } from "node:child_process";
 import { mkdirSync, writeFileSync } from "node:fs";

package/dist/{index.js → index.mjs}

@@ -1,3 +1,3 @@
-import { i as resolveLibraries, n as generateDeployer, r as parseArtifact, t as findArtifact } from "./pack-A6vKuf56.js";
+import { i as resolveLibraries, n as generateDeployer, r as parseArtifact, t as findArtifact } from "./pack-Be_7Cz7w.mjs";
 
 export { findArtifact, generateDeployer, parseArtifact, resolveLibraries };

package/package.json

@@ -1,17 +1,17 @@
 {
   "name": "forge-pack",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Generate self-contained Solidity deployer files from Forge build artifacts",
   "type": "module",
   "bin": {
-    "forge-pack": "./dist/cli.js"
+    "forge-pack": "./dist/cli.mjs"
   },
-  "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
+  "main": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
   "exports": {
     ".": {
-      "import": "./dist/index.js",
-      "types": "./dist/index.d.ts"
+      "import": "./dist/index.mjs",
+      "types": "./dist/index.d.mts"
     }
   },
   "files": [
@@ -24,10 +24,17 @@
     "deployer",
     "bytecode"
   ],
-  "author": "",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/akshatmittal/forge-pack.git"
+  },
+  "author": "Akshat Mittal <hi@akshatmittal.com>",
   "license": "MIT",
   "devDependencies": {
-    "tsdown": "^0.12.5",
+    "@changesets/changelog-github": "^0.5.2",
+    "@changesets/cli": "^2.29.8",
+    "@changesets/config": "^3.1.2",
+    "tsdown": "^0.20.3",
     "typescript": "^5.8.3",
     "@types/node": "^24.10.13"
   },
@@ -35,7 +42,10 @@
     "access": "public"
   },
   "scripts": {
-    "build": "tsdown && node -e \"const fs=require('fs'),p=require('path'),d='dist';fs.readdirSync(d).filter(f=>f.startsWith('index-')&&f.endsWith('.d.ts')).forEach(f=>{fs.copyFileSync(p.join(d,f),p.join(d,'index.d.ts'))});const c=fs.readFileSync(p.join(d,'cli.js'),'utf8');fs.writeFileSync(p.join(d,'cli.js'),'#!/usr/bin/env node\\n'+c)\"",
-    "dev": "tsdown --watch"
+    "build": "tsdown",
+    "dev": "tsdown --watch",
+    "changeset": "changeset",
+    "version": "changeset version",
+    "release": "changeset publish"
   }
 }

package/dist/cli-Dc4X1WbF.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/index.d.ts

@@ -1,68 +0,0 @@
-//#region src/pack.d.ts
-interface LinkReference {
-  start: number;
-  length: number;
-}
-interface LinkReferences {
-  [file: string]: {
-    [lib: string]: LinkReference[];
-  };
-}
-interface AbiParam {
-  name: string;
-  type: string;
-  internalType?: string;
-  components?: AbiParam[];
-  indexed?: boolean;
-}
-interface AbiEntry {
-  type: string;
-  name?: string;
-  inputs?: AbiParam[];
-  outputs?: AbiParam[];
-  stateMutability?: string;
-}
-interface ParsedArtifact {
-  contractName: string;
-  abi: AbiEntry[];
-  bytecode: string;
-  linkReferences: LinkReferences;
-  sourcePath?: string;
-  solcVersion?: string;
-  optimizerRuns?: number;
-  viaIR?: boolean;
-  evmVersion?: string;
-}
-interface FindArtifactOptions {
-  solcVersion?: string;
-}
-/**
- * A library dependency resolved from linkReferences, with its own parsed
- * artifact and the param name used in generated code.
- */
-interface ResolvedLibrary {
-  /** Parameter-style name, e.g. "mathLib" */
-  paramName: string;
-  /** Source file declaring the library, e.g. "src/libs/MathLib.sol" */
-  file: string;
-  /** Library contract name, e.g. "MathLib" */
-  lib: string;
-  /** Parsed artifact for this library */
-  artifact: ParsedArtifact;
-  /** Param names of libraries this library depends on (its own linkReferences) */
-  deps: string[];
-}
-declare function findArtifact(contractName: string, outDir: string, options?: FindArtifactOptions): string;
-declare function parseArtifact(artifactPath: string, contractName: string): ParsedArtifact;
-/**
- * Recursively resolve all library dependencies for a contract's linkReferences.
- * Returns libraries in topological order (deploy-order: leaves first).
- */
-declare function resolveLibraries(linkRefs: LinkReferences, outDir: string): ResolvedLibrary[];
-interface GenerateDeployerOptions {
-  pragma?: string;
-  libraries?: ResolvedLibrary[];
-}
-declare function generateDeployer(parsed: ParsedArtifact, pragmaOrOpts?: string | GenerateDeployerOptions): string;
-//#endregion
-export { type AbiEntry, type AbiParam, type FindArtifactOptions, type GenerateDeployerOptions, type LinkReference, type LinkReferences, type ParsedArtifact, type ResolvedLibrary, findArtifact, generateDeployer, parseArtifact, resolveLibraries };