@haneullabs/codegen 0.1.0 → 0.8.2

package/src/cli/commands/generate/impl.ts

@@ -3,16 +3,23 @@
 
 import type { LocalContext } from '../../context.js';
 import { generateFromPackageSummary } from '../../../index.js';
-import { loadConfig } from '../../../config.js';
+import { loadConfig, type GenerateBase, type PackageGenerate } from '../../../config.js';
 import { isValidNamedPackage, isValidHaneulObjectId } from '@haneullabs/haneul/utils';
 import { execSync } from 'node:child_process';
-import { existsSync } from 'node:fs';
+import { existsSync, mkdtempSync } from 'node:fs';
+import { tmpdir } from 'node:os';
+import { join } from 'node:path';
 
 export interface SubdirCommandFlags {
 	outputDir?: string;
 	noPrune?: boolean;
 	noSummaries?: boolean;
 	network?: 'mainnet' | 'testnet';
+	importExtension?: '.js' | '.ts' | 'none';
+	modules?: string[];
+	noTypes?: boolean;
+	noFunctions?: boolean;
+	private?: 'none' | 'entry' | 'all';
 }
 
 export default async function generate(
@@ -31,6 +38,7 @@ export default async function generate(
 							network: flags.network ?? 'testnet',
 							packageName: isValidHaneulObjectId(trimmed) ? trimmed : trimmed.split('/')[1],
 							package: trimmed,
+							packageId: isValidHaneulObjectId(trimmed) ? trimmed : undefined,
 						};
 					} else {
 						return {
@@ -45,8 +53,53 @@ export default async function generate(
 	const generateSummaries =
 		flags.noSummaries === undefined ? config.generateSummaries : !flags.noSummaries;
 
+	const cliPrivate =
+		flags.private !== undefined
+			? flags.private === 'all'
+				? true
+				: flags.private === 'none'
+					? false
+					: 'entry'
+			: undefined;
+
+	const cliGenerate: PackageGenerate | undefined =
+		flags.modules !== undefined ||
+		flags.noTypes !== undefined ||
+		flags.noFunctions !== undefined ||
+		flags.private !== undefined
+			? {
+					...(flags.modules !== undefined && { modules: flags.modules }),
+					...(flags.noTypes !== undefined && { types: !flags.noTypes as boolean }),
+					...(flags.noFunctions !== undefined || flags.private !== undefined
+						? {
+								functions: flags.noFunctions
+									? false
+									: cliPrivate !== undefined
+										? { private: cliPrivate }
+										: true,
+							}
+						: {}),
+				}
+			: undefined;
+
 	for (const pkg of normalizedPackages) {
-		if (generateSummaries && pkg.path) {
+		// Detect on-chain packages: they have 'network' field and no 'path'
+		const isOnChainPackage =
+			('packageId' in pkg && pkg.packageId) || ('network' in pkg && !('path' in pkg));
+
+		// Generate summaries for on-chain packages using --package-id
+		if (isOnChainPackage) {
+			const packageId = 'packageId' in pkg ? pkg.packageId : pkg.package;
+			const tempDir = mkdtempSync(join(tmpdir(), 'haneul-codegen-'));
+			console.log(`Generating summary for on-chain package ${packageId} to ${tempDir}`);
+
+			execSync(`haneul move summary --package-id ${packageId} --output-directory ${tempDir}`, {
+				stdio: 'inherit',
+			});
+
+			// Set the path to use the generated summary directory
+			(pkg as { path?: string }).path = tempDir;
+		} else if (generateSummaries && pkg.path) {
 			if (!existsSync(pkg.path)) {
 				throw new Error(`Package path does not exist: ${pkg.path}`);
 			}
@@ -56,11 +109,46 @@ export default async function generate(
 				stdio: 'inherit',
 			});
 		}
+		const importExtension =
+			flags.importExtension === undefined
+				? config.importExtension
+				: flags.importExtension === 'none'
+					? ''
+					: flags.importExtension;
+
+		const pkgWithOverrides = cliGenerate
+			? {
+					...pkg,
+					generate: {
+						...('generate' in pkg ? pkg.generate : {}),
+						...cliGenerate,
+					},
+				}
+			: pkg;
+
+		// Fold deprecated privateMethods into globalGenerate
+		const globalGenerate: GenerateBase | undefined =
+			config.privateMethods && !config.generate?.functions
+				? {
+						...config.generate,
+						functions: {
+							private:
+								config.privateMethods === 'all'
+									? true
+									: config.privateMethods === 'none'
+										? false
+										: 'entry',
+						},
+					}
+				: config.generate;
+
 		await generateFromPackageSummary({
-			package: pkg,
+			package: pkgWithOverrides,
 			prune: flags.noPrune === undefined ? config.prune : !flags.noPrune,
 			outputDir: flags.outputDir ?? config.output,
-			privateMethods: config.privateMethods,
+			globalGenerate,
+			importExtension,
+			includePhantomTypeParameters: config.includePhantomTypeParameters,
 		});
 	}
 }

package/src/config.ts

@@ -5,6 +5,42 @@ import { isValidNamedPackage, isValidHaneulObjectId } from '@haneullabs/haneul/u
 import { cosmiconfig } from 'cosmiconfig';
 import * as z from 'zod/v4';
 
+export const globalFunctionsOptionSchema = z.union([
+	z.boolean(),
+	z.object({
+		private: z.union([z.boolean(), z.literal('entry')]).optional(),
+	}),
+]);
+
+export const functionsOptionSchema = z.union([
+	z.boolean(),
+	z.array(z.string()),
+	z.object({
+		private: z.union([z.boolean(), z.literal('entry')]).optional(),
+	}),
+]);
+
+export const typesOptionSchema = z.union([z.boolean(), z.array(z.string())]);
+
+export const globalGenerateSchema = z.object({
+	functions: globalFunctionsOptionSchema.optional(),
+	types: z.boolean().optional(),
+});
+
+export const moduleGenerateSchema = z.object({
+	functions: functionsOptionSchema.optional(),
+	types: typesOptionSchema.optional(),
+});
+
+export const packageGenerateSchema = globalGenerateSchema.extend({
+	modules: z
+		.union([
+			z.array(z.string()),
+			z.record(z.string(), z.union([z.literal(true), moduleGenerateSchema])),
+		])
+		.optional(),
+});
+
 export const onChainPackageSchema = z.object({
 	package: z.string().refine((name) => isValidNamedPackage(name) || isValidHaneulObjectId(name), {
 		message: 'Invalid package name or package ID',
@@ -12,32 +48,43 @@ export const onChainPackageSchema = z.object({
 	packageName: z.string(),
 	path: z.never().optional(),
 	network: z.enum(['mainnet', 'testnet']),
+	generate: packageGenerateSchema.optional(),
 });
 
 export const localPackageSchema = z.object({
 	path: z.string(),
 	package: z.string(),
 	packageName: z.string().optional(),
+	generate: packageGenerateSchema.optional(),
 });
 
 export const packageConfigSchema = z.union([onChainPackageSchema, localPackageSchema]);
 
+export const importExtensionSchema = z.union([z.literal('.js'), z.literal('.ts'), z.literal('')]);
+export type ImportExtension = z.infer<typeof importExtensionSchema>;
+
+export type GenerateBase = z.infer<typeof globalGenerateSchema>;
+export type PackageGenerate = z.infer<typeof packageGenerateSchema>;
+export type FunctionsOption = z.infer<typeof functionsOptionSchema>;
+export type TypesOption = z.infer<typeof typesOptionSchema>;
+
 export const configSchema = z.object({
 	output: z.string(),
 	prune: z.boolean().optional().default(true),
 	generateSummaries: z.boolean().optional().default(true),
 	packages: z.array(packageConfigSchema),
-	privateMethods: z
-		.union([z.literal('none'), z.literal('entry'), z.literal('all')])
-		.optional()
-		.default('entry'),
+	generate: globalGenerateSchema.optional(),
+	/** @deprecated Use `generate: { functions: { private: 'entry' } }` instead */
+	privateMethods: z.union([z.literal('none'), z.literal('entry'), z.literal('all')]).optional(),
+	importExtension: importExtensionSchema.optional().default('.js'),
+	includePhantomTypeParameters: z.boolean().optional().default(false),
 });
 
 export type PackageConfig = z.infer<typeof packageConfigSchema>;
 export type HaneulCodegenConfig = z.input<typeof configSchema>;
-export type ParsedHaneulCodegenConfig = z.infer<typeof configSchema>;
+export type ParsedSuiCodegenConfig = z.infer<typeof configSchema>;
 
-export async function loadConfig(): Promise<ParsedHaneulCodegenConfig> {
+export async function loadConfig(): Promise<ParsedSuiCodegenConfig> {
 	const config = await cosmiconfig('haneul-codegen').search();
 
 	if (!config) {
@@ -46,7 +93,8 @@ export async function loadConfig(): Promise<ParsedHaneulCodegenConfig> {
 			packages: [],
 			prune: true,
 			generateSummaries: true,
-			privateMethods: 'entry',
+			importExtension: '.js',
+			includePhantomTypeParameters: false,
 		};
 	}
 

package/src/file-builder.ts

@@ -13,12 +13,25 @@ export class FileBuilder {
 	starImports: Map<string, string> = new Map();
 	protected reservedNames: Set<string> = new Set();
 
-	addImport(module: string, name: string) {
+	addImport(module: string, name: string): string {
 		if (!this.imports.has(module)) {
 			this.imports.set(module, new Set());
 		}
 
+		const isTypeImport = name.startsWith('type ');
+		const baseName = isTypeImport ? name.slice(5) : name;
+
+		if (this.reservedNames.has(baseName)) {
+			const alias = this.getUnusedName(baseName);
+			const aliasedImport = isTypeImport
+				? `type ${baseName} as ${alias}`
+				: `${baseName} as ${alias}`;
+			this.imports.get(module)!.add(aliasedImport);
+			return alias;
+		}
+
 		this.imports.get(module)!.add(name);
+		return baseName;
 	}
 
 	addStarImport(module: string, name: string) {

package/src/generate-utils.ts

@@ -2,16 +2,36 @@
 // SPDX-License-Identifier: Apache-2.0
 
 export const utilsContent = /* ts */ `
-import { bcs, BcsType, TypeTag, TypeTagSerializer, BcsStruct, BcsEnum, BcsTuple } from '@haneullabs/haneul/bcs';
+import {
+	bcs,
+	BcsType,
+	TypeTag,
+	TypeTagSerializer,
+	BcsStruct,
+	BcsEnum,
+	BcsTuple,
+} from '@haneullabs/haneul/bcs';
 import { normalizeHaneulAddress } from '@haneullabs/haneul/utils';
 import { TransactionArgument, isArgument } from '@haneullabs/haneul/transactions';
+import { ClientWithCoreApi, HaneulClientTypes } from '@haneullabs/haneul/client';
 
 const MOVE_STDLIB_ADDRESS = normalizeHaneulAddress('0x1');
 const HANEUL_FRAMEWORK_ADDRESS = normalizeHaneulAddress('0x2');
-const HANEUL_SYSTEM_ADDRESS = normalizeHaneulAddress('0x3');
 
 export type RawTransactionArgument<T> = T | TransactionArgument;
 
+export interface GetOptions<
+	Include extends Omit<HaneulClientTypes.ObjectInclude, 'content'> = {},
+> extends HaneulClientTypes.GetObjectOptions<Include> {
+	client: ClientWithCoreApi;
+}
+
+export interface GetManyOptions<
+	Include extends Omit<HaneulClientTypes.ObjectInclude, 'content'> = {},
+> extends HaneulClientTypes.GetObjectsOptions<Include> {
+	client: ClientWithCoreApi;
+}
+
 export function getPureBcsSchema(typeTag: string | TypeTag): BcsType<any> | null {
 	const parsedTag = typeof typeTag === 'string' ? TypeTagSerializer.parseFromStr(typeTag) : typeTag;
 
@@ -36,7 +56,7 @@ export function getPureBcsSchema(typeTag: string | TypeTag): BcsType<any> | null
 		return type ? bcs.vector(type) : null;
 	} else if ('struct' in parsedTag) {
 		const structTag = parsedTag.struct;
-		const pkg = normalizeHaneulAddress(parsedTag.struct.address);
+		const pkg = normalizeHaneulAddress(structTag.address);
 
 		if (pkg === MOVE_STDLIB_ADDRESS) {
 			if (
@@ -47,12 +67,16 @@ export function getPureBcsSchema(typeTag: string | TypeTag): BcsType<any> | null
 			}
 
 			if (structTag.module === 'option' && structTag.name === 'Option') {
-				const type = getPureBcsSchema(structTag.typeParams[0]!);
+				const type = getPureBcsSchema(structTag.typeParams[0]);
 				return type ? bcs.option(type) : null;
 			}
 		}
 
-		if (pkg === HANEUL_FRAMEWORK_ADDRESS && structTag.module === 'Object' && structTag.name === 'ID') {
+		if (
+			pkg === HANEUL_FRAMEWORK_ADDRESS &&
+			structTag.module === 'object' &&
+			(structTag.name === 'ID' || structTag.name === 'UID')
+		) {
 			return bcs.Address;
 		}
 	}
@@ -60,7 +84,11 @@ export function getPureBcsSchema(typeTag: string | TypeTag): BcsType<any> | null
 	return null;
 }
 
-export function normalizeMoveArguments(args: unknown[] | object, argTypes: string[], parameterNames?: string[]) {
+export function normalizeMoveArguments(
+	args: unknown[] | object,
+	argTypes: readonly (string | null)[],
+	parameterNames?: string[],
+) {
 	const argLen = Array.isArray(args) ? args.length : Object.keys(args).length;
 	if (parameterNames && argLen !== parameterNames.length) {
 		throw new Error(
@@ -72,30 +100,32 @@ export function normalizeMoveArguments(args: unknown[] | object, argTypes: strin
 
 	let index = 0;
 	for (const [i, argType] of argTypes.entries()) {
-		if (argType === \`\${HANEUL_FRAMEWORK_ADDRESS}::deny_list::DenyList\`) {
-			normalizedArgs.push((tx) => tx.object.denyList());
+		if (argType === '0x2::clock::Clock') {
+			normalizedArgs.push((tx) => tx.object.clock());
 			continue;
 		}
 
-		if (argType === \`\${HANEUL_FRAMEWORK_ADDRESS}::random::Random\`) {
+		if (argType === '0x2::random::Random') {
 			normalizedArgs.push((tx) => tx.object.random());
 			continue;
 		}
 
-		if (argType === \`\${HANEUL_FRAMEWORK_ADDRESS}::clock::Clock\`) {
-			normalizedArgs.push((tx) => tx.object.clock());
+		if (argType === '0x2::deny_list::DenyList') {
+			normalizedArgs.push((tx) => tx.object.denyList());
 			continue;
 		}
 
-		if (argType === \`\${HANEUL_SYSTEM_ADDRESS}::haneul_system::HaneulSystemState\`) {
+		if (argType === '0x3::haneul_system::HaneulSystemState') {
 			normalizedArgs.push((tx) => tx.object.system());
 			continue;
 		}
 
-		let arg
+		let arg;
 		if (Array.isArray(args)) {
 			if (index >= args.length) {
-				throw new Error(\`Invalid number of arguments, expected at least \${index + 1}, got \${args.length}\`);
+				throw new Error(
+					\`Invalid number of arguments, expected at least \${index + 1}, got \${args.length}\`,
+				);
 			}
 			arg = args[index];
 		} else {
@@ -117,8 +147,8 @@ export function normalizeMoveArguments(args: unknown[] | object, argTypes: strin
 			continue;
 		}
 
-		const type = argTypes[i]!;
-		const bcsType = getPureBcsSchema(type);
+		const type = argTypes[i];
+		const bcsType = type === null ? null : getPureBcsSchema(type);
 
 		if (bcsType) {
 			const bytes = bcsType.serialize(arg as never);
@@ -138,7 +168,47 @@ export function normalizeMoveArguments(args: unknown[] | object, argTypes: strin
 export class MoveStruct<
 	T extends Record<string, BcsType<any>>,
 	const Name extends string = string,
-> extends BcsStruct<T, Name> {}
+> extends BcsStruct<T, Name> {
+	async get<Include extends Omit<HaneulClientTypes.ObjectInclude, 'content' | 'json'> = {}>({
+		objectId,
+		...options
+	}: GetOptions<Include>): Promise<
+		HaneulClientTypes.Object<Include & { content: true, json: true }> & { json: BcsStruct<T>['$inferType'] }
+	> {
+		const [res] = await this.getMany<Include>({
+			...options,
+			objectIds: [objectId],
+		});
+
+		return res;
+	}
+
+	async getMany<Include extends Omit<HaneulClientTypes.ObjectInclude, 'content' | 'json'> = {}>({
+		client,
+		...options
+	}: GetManyOptions<Include>): Promise<
+		Array<HaneulClientTypes.Object<Include & { content: true, json: true }> & { json: BcsStruct<T>['$inferType'] }>
+	> {
+		const response = (await client.core.getObjects({
+			...options,
+			include: {
+				...options.include,
+				content: true,
+			},
+		})) as HaneulClientTypes.GetObjectsResponse<Include & { content: true }>;
+
+		return response.objects.map((obj) => {
+			if (obj instanceof Error) {
+				throw obj;
+			}
+
+			return {
+				...obj,
+				json: this.parse(obj.content),
+			};
+		});
+	}
+}
 
 export class MoveEnum<
 	T extends Record<string, BcsType<any> | null>,
@@ -146,7 +216,7 @@ export class MoveEnum<
 > extends BcsEnum<T, Name> {}
 
 export class MoveTuple<
-	T extends readonly BcsType<any>[],
+	const T extends readonly BcsType<any>[],
 	const Name extends string,
 > extends BcsTuple<T, Name> {}
 

package/src/index.ts

@@ -1,40 +1,65 @@
 // Copyright (c) Mysten Labs, Inc.
 // SPDX-License-Identifier: Apache-2.0
 
-import { mkdir, readdir, readFile, writeFile } from 'node:fs/promises';
+import { mkdir, readdir, readFile, rm, writeFile } from 'node:fs/promises';
 import { basename, join } from 'node:path';
 import { MoveModuleBuilder } from './move-module-builder.js';
 import { existsSync, statSync } from 'node:fs';
 import { utilsContent } from './generate-utils.js';
 import { parse } from 'toml';
-import type { PackageConfig } from './config.js';
+import type {
+	FunctionsOption,
+	GenerateBase,
+	ImportExtension,
+	PackageConfig,
+	PackageGenerate,
+	TypesOption,
+} from './config.js';
 export { type HaneulCodegenConfig } from './config.js';
 
 export async function generateFromPackageSummary({
 	package: pkg,
 	prune,
 	outputDir,
-	privateMethods,
+	globalGenerate,
+	importExtension = '.js',
+	includePhantomTypeParameters = false,
 }: {
 	package: PackageConfig;
 	prune: boolean;
 	outputDir: string;
-	privateMethods: 'none' | 'entry' | 'all';
+	globalGenerate?: GenerateBase;
+	importExtension?: ImportExtension;
+	includePhantomTypeParameters?: boolean;
 }) {
 	if (!pkg.path) {
-		throw new Error(`On-chain packages are not supported yet (got ${pkg.package})`);
+		throw new Error(`Package path is required (got ${pkg.package})`);
 	}
 
-	const summaryDir = join(pkg.path, 'package_summaries');
+	// Check for on-chain package summary (directly in path) or local package summary (in package_summaries subdirectory)
+	const localSummaryDir = join(pkg.path, 'package_summaries');
+	const isOnChainPackage = existsSync(join(pkg.path, 'root_package_metadata.json'));
+	const summaryDir = isOnChainPackage ? pkg.path : localSummaryDir;
 
-	if (!existsSync(summaryDir)) {
+	if (!existsSync(summaryDir) || !existsSync(join(summaryDir, 'address_mapping.json'))) {
 		throw new Error(`Package summary directory not found: ${summaryDir}`);
 	}
 
 	let packageName = pkg.packageName!;
+	let mainPackageAddress: string | undefined;
 	const mvrNameOrAddress = pkg.package;
 
-	if (!pkg.packageName) {
+	if (isOnChainPackage) {
+		// For on-chain packages, get the main package address from root_package_metadata.json
+		const metadata = JSON.parse(
+			await readFile(join(pkg.path, 'root_package_metadata.json'), 'utf-8'),
+		);
+		mainPackageAddress = metadata.root_package_id;
+		// Use the package name provided or fall back to the full address
+		if (!packageName) {
+			packageName = mainPackageAddress!;
+		}
+	} else if (!pkg.packageName) {
 		try {
 			const packageToml = await readFile(join(pkg.path, 'Move.toml'), 'utf-8');
 			packageName = parse(packageToml).package.name.toLowerCase();
@@ -48,10 +73,6 @@ export async function generateFromPackageSummary({
 		}
 	}
 
-	if (!existsSync(summaryDir)) {
-		throw new Error(`Package summary directory not found: ${summaryDir}`);
-	}
-
 	const addressMappings: Record<string, string> = JSON.parse(
 		await readFile(join(summaryDir, 'address_mapping.json'), 'utf-8'),
 	);
@@ -59,21 +80,35 @@ export async function generateFromPackageSummary({
 	const packages = (await readdir(summaryDir)).filter((file) =>
 		statSync(join(summaryDir, file)).isDirectory(),
 	);
+
+	// For on-chain packages, the main package is identified by the root_package_id
+	// For local packages, it's identified by the packageName
+	const isMainPackage = (pkgDir: string) => {
+		if (isOnChainPackage) {
+			return pkgDir === mainPackageAddress;
+		}
+		return pkgDir === packageName;
+	};
+
 	const modules = (
 		await Promise.all(
-			packages.map(async (pkg) => {
-				const modules = await readdir(join(summaryDir, pkg));
+			packages.map(async (pkgDir) => {
+				const moduleFiles = await readdir(join(summaryDir, pkgDir));
 				return Promise.all(
-					modules.map(async (mod) => ({
-						package: pkg,
-						isMainPackage: pkg === packageName,
-						module: basename(mod, '.json'),
-						builder: await MoveModuleBuilder.fromSummaryFile(
-							join(summaryDir, pkg, mod),
-							addressMappings,
-							pkg === packageName ? mvrNameOrAddress : undefined,
-						),
-					})),
+					moduleFiles
+						.filter((f) => f.endsWith('.json'))
+						.map(async (mod) => ({
+							package: pkgDir,
+							isMainPackage: isMainPackage(pkgDir),
+							module: basename(mod, '.json'),
+							builder: await MoveModuleBuilder.fromSummaryFile(
+								join(summaryDir, pkgDir, mod),
+								addressMappings,
+								isMainPackage(pkgDir) ? mvrNameOrAddress : undefined,
+								importExtension,
+								includePhantomTypeParameters,
+							),
+						})),
 				);
 			}),
 		)
@@ -83,15 +118,40 @@ export async function generateFromPackageSummary({
 		modules.map((mod) => [`${mod.package}::${mod.module}`, mod.builder]),
 	);
 
-	modules.forEach((mod) => {
-		if (mod.isMainPackage || !prune) {
-			mod.builder.includeAllTypes(moduleBuilders);
-			mod.builder.includeAllFunctions({ privateMethods });
+	const packageGenerate: PackageGenerate | undefined = 'generate' in pkg ? pkg.generate : undefined;
+	const pkgModules = packageGenerate?.modules;
+	const pkgTypes: TypesOption = packageGenerate?.types ?? globalGenerate?.types ?? true;
+	const pkgFunctions: FunctionsOption =
+		packageGenerate?.functions ?? globalGenerate?.functions ?? true;
+
+	for (const mod of modules) {
+		if (!mod.isMainPackage && prune) {
+			continue;
 		}
-	});
+
+		const moduleGenerate = !pkgModules
+			? true
+			: Array.isArray(pkgModules)
+				? pkgModules.includes(mod.module) || null
+				: mod.module in pkgModules
+					? pkgModules[mod.module]
+					: null;
+
+		if (!moduleGenerate) continue;
+
+		const types = moduleGenerate === true ? pkgTypes : (moduleGenerate.types ?? false);
+		const functions = moduleGenerate === true ? pkgFunctions : (moduleGenerate.functions ?? false);
+
+		mod.builder.includeTypes(moduleBuilders, types);
+		mod.builder.includeFunctions(functions);
+	}
 
 	await generateUtils({ outputDir });
 
+	// Clean the package output directory to remove stale files from previous runs
+	const packageOutputDir = join(outputDir, packageName);
+	await rm(packageOutputDir, { recursive: true, force: true });
+
 	await Promise.all(
 		modules.map(async (mod) => {
 			if ((mod.isMainPackage || !prune) && mod.builder.hasTypesOrFunctions()) {