@rocketh/export 0.10.12 → 0.10.13

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rocketh/export",
-  "version": "0.10.12",
+  "version": "0.10.13",
   "description": "export deployments",
   "publishConfig": {
     "access": "public"
@@ -17,6 +17,9 @@
   "bin": {
     "rocketh-export": "dist/esm/cli.js"
   },
+  "files": [
+    "dist"
+  ],
   "devDependencies": {
     "@types/node": "^20.14.8",
     "abitype": "^1.0.4",

package/.prettierignore

@@ -1,3 +0,0 @@
-dist/
-node_modules/
-package.json

package/.prettierrc

@@ -1,7 +0,0 @@
-{
-	"useTabs": true,
-	"singleQuote": true,
-
-	"printWidth": 120,
-	"bracketSpacing": false
-}

package/CHANGELOG.md

@@ -1,84 +0,0 @@
-# @rocketh/export
-
-## 0.10.12
-
-### Patch Changes
-
-- use tsx
-- Updated dependencies
-  - rocketh@0.10.16
-
-## 0.10.11
-
-### Patch Changes
-
-- Updated dependencies
-  - rocketh@0.10.15
-
-## 0.10.10
-
-### Patch Changes
-
-- allow to export each contract as individual exported field
-
-## 0.10.9
-
-### Patch Changes
-
-- export argsData when exporting bytecode
-
-## 0.10.8
-
-### Patch Changes
-
-- latest dependencies
-- Updated dependencies
-  - rocketh@0.10.14
-
-## 0.10.7
-
-### Patch Changes
-
-- Updated dependencies
-  - rocketh@0.10.13
-
-## 0.10.6
-
-### Patch Changes
-
-- Updated dependencies
-  - rocketh@0.10.12
-
-## 0.10.5
-
-### Patch Changes
-
-- forgot to build
-
-## 0.10.4
-
-### Patch Changes
-
-- chalk do not support cjs
-
-## 0.10.3
-
-### Patch Changes
-
-- Updated dependencies
-  - rocketh@0.10.11
-
-## 0.10.2
-
-### Patch Changes
-
-- Updated dependencies
-  - rocketh@0.10.10
-
-## 0.10.1
-
-### Patch Changes
-
-- use pkgroll and @rocketh namespace
-- Updated dependencies
-  - rocketh@0.10.9

package/src/cli.ts

@@ -1,40 +0,0 @@
-#! /usr/bin/env node
-import {readAndResolveConfig} from 'rocketh';
-import {run} from './index.js';
-import {Command} from 'commander';
-import pkg from '../package.json' with {type: 'json'};
-import {ConfigOptions} from 'rocketh';
-
-const commandName = pkg.name;
-
-const program = new Command();
-program
-	.name(commandName)
-	.description('export deployments to consume elswhere')
-	.version(pkg.version)
-	.option('-d, --deployments <value>', 'folder where deployments are saved')
-	.option('--ts <value>', 'list of filepath where the typescript export will be written, separated by commas')
-	.option('--js <value>', 'list of filepath where the javascript export will be written, separated by commas')
-	.option('--json <value>', 'list of filepath where the json export will be written, separated by commas')
-	.option(
-		'--tsm <value>',
-		'list of filepath where the typescript export with individual export will be written, separated by commas'
-	)
-	.option(
-		'--jsm <value>',
-		'list of filepath where the javascript export  with individual exportwill be written, separated by commas'
-	)
-	.option('-b, --bytecode', 'if set, the bytecode will also be part of the output')
-	.requiredOption('-n, --network <value>', 'network context to use')
-	.parse(process.argv);
-
-const options = program.opts();
-const resolvedConfig = readAndResolveConfig({...(options as ConfigOptions), ignoreMissingRPC: true});
-run(resolvedConfig, {
-	tots: options.ts ? options.ts.split(',') : undefined,
-	tojson: options.json ? options.json.split(',') : undefined,
-	tojs: options.js ? options.js.split(',') : undefined,
-	totsm: options.tsm ? options.tsm.split(',') : undefined,
-	tojsm: options.jsm ? options.jsm.split(',') : undefined,
-	includeBytecode: options.bytecode,
-});

package/src/index.ts

@@ -1,271 +0,0 @@
-import {Abi, Address} from 'abitype';
-import fs from 'node:fs';
-import path from 'node:path';
-
-import {Deployment, ResolvedConfig, chainTypes, getChain, loadDeployments} from 'rocketh';
-
-export interface ContractExport {
-	address: `0x${string}`;
-	abi: Abi;
-	argsData?: string;
-	bytecode?: `0x${string}`;
-	// linkedData?: any; TODO
-}
-
-type ChainBlockExplorer = {
-	name: string;
-	url: string;
-	apiUrl?: string | undefined;
-};
-type ChainContract = {
-	address: Address;
-	blockCreated?: number | undefined;
-};
-
-type ChainNativeCurrency = {
-	name: string;
-	/** 2-6 characters long */
-	symbol: string;
-	decimals: number;
-};
-
-type ChainRpcUrls = {
-	http: readonly string[];
-	webSocket?: readonly string[] | undefined;
-};
-
-/**
- * @description Combines members of an intersection into a readable type.
- *
- * @see {@link https://twitter.com/mattpocockuk/status/1622730173446557697?s=20&t=NdpAcmEFXY01xkqU3KO0Mg}
- * @example
- * Prettify<{ a: string } & { b: string } & { c: number, d: bigint }>
- * => { a: string, b: string, c: number, d: bigint }
- */
-type Prettify<T> = {
-	[K in keyof T]: T[K];
-} & {};
-
-export type ChainInfo = {
-	/** ID in number form */
-	id: number;
-	/** Human-readable name */
-	name: string;
-	/** Collection of block explorers */
-	blockExplorers?:
-		| {
-				[key: string]: ChainBlockExplorer;
-				default: ChainBlockExplorer;
-		  }
-		| undefined;
-	/** Collection of contracts */
-	contracts?:
-		| Prettify<
-				{
-					[key: string]: ChainContract | {[sourceId: number]: ChainContract | undefined} | undefined;
-				} & {
-					ensRegistry?: ChainContract | undefined;
-					ensUniversalResolver?: ChainContract | undefined;
-					multicall3?: ChainContract | undefined;
-				}
-		  >
-		| undefined;
-	/** Currency used by chain */
-	nativeCurrency: ChainNativeCurrency;
-	/** Collection of RPC endpoints */
-	rpcUrls: {
-		[key: string]: ChainRpcUrls;
-		default: ChainRpcUrls;
-	};
-	/** Source Chain ID (ie. the L1 chain) */
-	sourceId?: number | undefined;
-	/** Flag for test networks */
-	testnet?: boolean | undefined;
-
-	chainType: 'zksync' | 'op-stack' | 'celo' | 'default';
-
-	// this will bring in the following when reconstructed from the data above
-
-	// /** Custom chain data. */
-	// custom?: any;
-
-	// /**
-	//  * Modifies how chain data structures (ie. Blocks, Transactions, etc)
-	//  * are formatted & typed.
-	//  */
-	// formatters?: any | undefined;
-	// /** Modifies how data (ie. Transactions) is serialized. */
-	// serializers?: any | undefined;
-	// /** Modifies how fees are derived. */
-	// fees?: any | undefined;
-};
-
-export type ExportedDeployments = {
-	chainId: string;
-	genesisHash?: string;
-	chainInfo: ChainInfo;
-	name: string;
-	contracts: {[name: string]: ContractExport};
-};
-
-type Trandformed<O, Value> = {
-	[Property in keyof O]: Value;
-};
-
-function objectMap<V, N, O extends Trandformed<{}, V> = Trandformed<{}, V>>(
-	object: O,
-	mapFn: (v: V) => N
-): Trandformed<O, N> {
-	return Object.keys(object).reduce((result, key) => {
-		(result as any)[key] = mapFn((object as any)[key]);
-		return result;
-	}, {} as Trandformed<O, N>);
-}
-
-export async function run(
-	config: ResolvedConfig,
-	options: {
-		tojs?: string[];
-		tots?: string[];
-		tojson?: string[];
-		totsm?: string[];
-		tojsm?: string[];
-		includeBytecode?: boolean;
-	}
-) {
-	if (!options.tots && !options.tojs && !options.tojson && !options.tojsm && !options.totsm) {
-		console.log(`no filepath to export to are specified`);
-		return;
-	}
-
-	const {deployments, chainId, genesisHash} = loadDeployments(config.deployments, config.network.name);
-
-	if (!deployments || Object.keys(deployments).length === 0) {
-		console.log(`no deployments to export`);
-		return;
-	}
-
-	if (!chainId) {
-		throw new Error(`no chainId found for ${config.network.name}`);
-	}
-
-	const chain = getChain(chainId);
-
-	const chainInfo: ChainInfo = {
-		id: chain.id,
-		name: chain.name,
-		nativeCurrency: chain.nativeCurrency,
-		rpcUrls: chain.rpcUrls,
-		blockExplorers: chain.blockExplorers,
-		chainType: chainTypes[chainId] || 'default',
-		contracts: chain.contracts,
-		sourceId: chain.sourceId,
-		testnet: chain.testnet,
-	};
-
-	const exportData: ExportedDeployments = {
-		chainId,
-		genesisHash,
-		chainInfo,
-		contracts: objectMap<Deployment<Abi>, ContractExport>(deployments, (d) => ({
-			abi: d.abi,
-			address: d.address,
-			linkedData: d.linkedData,
-			bytecode: options.includeBytecode ? d.bytecode : undefined,
-			argsData: options.includeBytecode ? d.argsData : undefined,
-			startBlock: d.receipt?.blockNumber ? parseInt(d.receipt.blockNumber.slice(2), 16) : undefined,
-		})),
-		name: config.network.name,
-	};
-
-	const js = typeof options.tojs === 'string' ? [options.tojs] : options.tojs || [];
-	const ts = typeof options.tots === 'string' ? [options.tots] : options.tots || [];
-	const json = typeof options.tojson === 'string' ? [options.tojson] : options.tojson || [];
-
-	const tsmodule = typeof options.totsm === 'string' ? [options.totsm] : options.totsm || [];
-	const jsmodule = typeof options.tojsm === 'string' ? [options.tojsm] : options.tojsm || [];
-
-	if (ts.length > 0) {
-		const newContent = `export default ${JSON.stringify(exportData, null, 2)} as const;`;
-		for (const tsFile of ts) {
-			const folderPath = path.dirname(tsFile);
-			fs.mkdirSync(folderPath, {recursive: true});
-			fs.writeFileSync(tsFile, newContent);
-		}
-	}
-
-	if (js.length > 0) {
-		const newContent = `export default /** @type {const} **/ (${JSON.stringify(exportData, null, 2)});`;
-		const dtsContent = `export = ${JSON.stringify(exportData, null, 2)} as const;`;
-		for (const jsFile of js) {
-			const folderPath = path.dirname(jsFile);
-			fs.mkdirSync(folderPath, {recursive: true});
-			fs.writeFileSync(jsFile, newContent);
-			fs.writeFileSync(jsFile.replace('.js', '.d.ts'), dtsContent);
-		}
-	}
-
-	if (json.length > 0) {
-		const newContent = JSON.stringify(exportData, null, 2);
-		for (const jsonFile of json) {
-			const folderPath = path.dirname(jsonFile);
-			fs.mkdirSync(folderPath, {recursive: true});
-			fs.writeFileSync(jsonFile, newContent);
-		}
-	}
-
-	if (tsmodule.length > 0) {
-		let newContent = `export const chain = ${JSON.stringify(
-			{
-				chainId: exportData.chainId,
-				genesisHash: exportData.genesisHash,
-				chainInfo: exportData.chainInfo,
-				name: exportData.name,
-			},
-			null,
-			2
-		)} as const;\n`;
-
-		for (const contractName of Object.keys(exportData.contracts)) {
-			newContent += `export const ${contractName} = ${JSON.stringify(
-				(exportData.contracts as any)[contractName],
-				null,
-				2
-			)} as const;`;
-		}
-
-		for (const tsFile of tsmodule) {
-			const folderPath = path.dirname(tsFile);
-			fs.mkdirSync(folderPath, {recursive: true});
-			fs.writeFileSync(tsFile, newContent);
-		}
-	}
-
-	if (jsmodule.length > 0) {
-		// TODO test
-		let newContent = `export const chain = /** @type {const} **/ (${JSON.stringify(
-			{
-				chainId: exportData.chainId,
-				genesisHash: exportData.genesisHash,
-				chainInfo: exportData.chainInfo,
-				name: exportData.name,
-			},
-			null,
-			2
-		)});\n`;
-
-		for (const contractName of Object.keys(exportData.contracts)) {
-			newContent += `export const ${contractName} = /** @type {const} **/ (${JSON.stringify(
-				(exportData.contracts as any)[contractName],
-				null,
-				2
-			)});`;
-		}
-
-		for (const jsFile of jsmodule) {
-			const folderPath = path.dirname(jsFile);
-			fs.mkdirSync(folderPath, {recursive: true});
-			fs.writeFileSync(jsFile, newContent);
-		}
-	}
-}

package/tsconfig.json

@@ -1,18 +0,0 @@
-{
-	"compilerOptions": {
-		"strict": true,
-		"strictNullChecks": true,
-		"target": "ESNext",
-		"module": "NodeNext",
-		"lib": ["ESNext", "dom"],
-		"moduleResolution": "NodeNext",
-		"resolveJsonModule": true,
-		"skipLibCheck": true,
-		"sourceMap": true,
-		"declaration": true,
-		"declarationMap": true,
-		"rootDir": "./src",
-		"outDir": "./dist/esm"
-	},
-	"include": ["src/**/*.ts"]
-}