rocketh 0.15.0-testing.7 → 0.15.0-testing.8

package/src/{environment/types.ts → types.ts}

@@ -9,10 +9,287 @@ import {
 	EIP1193WalletProvider,
 } from 'eip-1193';
 import type {Address, Chain, DeployContractParameters} from 'viem';
-import {ConfigOverrides, DeterministicDeploymentInfo} from '../executor/index.js';
-import {ProgressIndicator} from '../internal/logging.js';
-import {TransactionHashTracker} from './providers/TransactionHashTracker.js';
-import {ChainInfo} from '../executor/types.js';
+import {TransactionHashTracker} from './environment/providers/TransactionHashTracker.js';
+import {ProgressIndicator} from './internal/logging.js';
+
+export type DeployScriptFunction<
+	NamedAccounts extends UnresolvedUnknownNamedAccounts = UnresolvedUnknownNamedAccounts,
+	Data extends UnresolvedNetworkSpecificData = UnresolvedNetworkSpecificData,
+	ArgumentsTypes = undefined,
+	Deployments extends UnknownDeployments = UnknownDeployments,
+	Extra extends Record<string, unknown> = Record<string, unknown>
+> = (env: Environment<NamedAccounts, Data, Deployments, Extra>, args?: ArgumentsTypes) => Promise<void | boolean>;
+
+export interface DeployScriptModule<
+	NamedAccounts extends UnresolvedUnknownNamedAccounts = UnresolvedUnknownNamedAccounts,
+	Data extends UnresolvedNetworkSpecificData = UnresolvedNetworkSpecificData,
+	ArgumentsTypes = undefined,
+	Deployments extends UnknownDeployments = UnknownDeployments,
+	Extra extends Record<string, unknown> = Record<string, unknown>
+> {
+	(env: Environment<NamedAccounts, Data, Deployments, Extra>, args?: ArgumentsTypes): Promise<void | boolean>;
+	tags?: string[];
+	dependencies?: string[];
+	runAtTheEnd?: boolean;
+	id?: string;
+}
+
+export type ScriptCallback<
+	NamedAccounts extends UnresolvedUnknownNamedAccounts = UnresolvedUnknownNamedAccounts,
+	Data extends UnresolvedNetworkSpecificData = UnresolvedNetworkSpecificData,
+	Deployments extends UnknownDeployments = UnknownDeployments,
+	Extra extends Record<string, unknown> = Record<string, unknown>
+> = (env: Environment<NamedAccounts, Data, Deployments, Extra>) => Promise<void>;
+
+/**
+ * Utility type to extract the return value from a higher-order function
+ * For functions of type (firstParam: T) => (...args: any[]) => V or (firstParam: T) => V
+ */
+export type ExtractReturnFunction<T> = T extends (first: any) => infer Return ? Return : never;
+
+/**
+ * Utility type to transform an object of higher-order functions by extracting their return types
+ * This handles both regular functions and getter functions
+ */
+export type CurriedFunctions<T> = {
+	[K in keyof T]: ExtractReturnFunction<T[K]>;
+};
+
+/**
+ * Type for the enhanced environment proxy that includes both the original environment
+ * and the curried functions
+ */
+export type EnhancedEnvironment<
+	NamedAccounts extends UnresolvedUnknownNamedAccounts = UnresolvedUnknownNamedAccounts,
+	Data extends UnresolvedNetworkSpecificData = UnresolvedNetworkSpecificData,
+	Deployments extends UnknownDeployments = UnknownDeployments,
+	Extensions extends Record<
+		string,
+		(env: Environment<NamedAccounts, Data, Deployments>, ...args: any[]) => any
+	> = Record<string, (env: Environment<NamedAccounts, Data, Deployments>, ...args: any[]) => any>,
+	Extra extends Record<string, unknown> = Record<string, unknown>
+> = Environment<NamedAccounts, Data, Deployments, Extra> & CurriedFunctions<Extensions>;
+
+/**
+ * Type for a deploy script function that receives an enhanced environment
+ */
+export type EnhancedDeployScriptFunction<
+	NamedAccounts extends UnresolvedUnknownNamedAccounts = UnresolvedUnknownNamedAccounts,
+	Data extends UnresolvedNetworkSpecificData = UnresolvedNetworkSpecificData,
+	ArgumentsTypes = undefined,
+	Deployments extends UnknownDeployments = UnknownDeployments,
+	Functions extends Record<
+		string,
+		(env: Environment<NamedAccounts, Data, Deployments>, ...args: any[]) => any
+	> = Record<string, (env: Environment<NamedAccounts, Data, Deployments>, ...args: any[]) => any>,
+	Extra extends Record<string, unknown> = Record<string, unknown>
+> = (
+	env: EnhancedEnvironment<NamedAccounts, Data, Deployments, Functions, Extra>,
+	args?: ArgumentsTypes
+) => Promise<void | boolean>;
+
+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';
+
+	genesisHash?: string;
+
+	properties?: Record<string, JSONTypePlusBigInt>;
+
+	// 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 NamedAccountExecuteFunction<
+	NamedAccounts extends UnresolvedUnknownNamedAccounts = UnresolvedUnknownNamedAccounts,
+	Data extends UnresolvedNetworkSpecificData = UnresolvedNetworkSpecificData
+> = <ArgumentsType = undefined, Deployments extends UnknownDeployments = UnknownDeployments>(
+	callback: DeployScriptFunction<NamedAccounts, Data, ArgumentsType, Deployments>,
+	options: {tags?: string[]; dependencies?: string[]; id?: string}
+) => DeployScriptModule<NamedAccounts, Data, ArgumentsType, Deployments>;
+
+export interface UntypedRequestArguments {
+	readonly method: string;
+	readonly params?: readonly unknown[] | object;
+}
+export type UntypedEIP1193Provider = {
+	request(requestArguments: UntypedRequestArguments): Promise<unknown>;
+};
+
+export type ConfigOverrides = {
+	deployments?: string;
+	scripts?: string | string[];
+};
+
+export type Create2DeterministicDeploymentInfo = {
+	factory: `0x${string}`;
+	deployer: `0x${string}`;
+	funding: string;
+	signedTx: `0x${string}`;
+};
+
+export type Create3DeterministicDeploymentInfo = {
+	salt?: `0x${string}`;
+	factory: `0x${string}`;
+	bytecode: `0x${string}`;
+	proxyBytecode: `0x${string}`;
+};
+
+export type DeterministicDeploymentInfo =
+	| Create2DeterministicDeploymentInfo
+	| {
+			create2?: Create2DeterministicDeploymentInfo;
+			create3?: Create3DeterministicDeploymentInfo;
+	  };
+
+export type ChainUserConfig = {
+	rpcUrl?: string;
+	tags?: string[];
+	deterministicDeployment?: DeterministicDeploymentInfo;
+	info?: ChainInfo;
+	pollingInterval?: number;
+	properties?: Record<string, JSONTypePlusBigInt>;
+};
+
+export type ChainConfig = {
+	rpcUrl: string;
+	tags: string[];
+	deterministicDeployment: DeterministicDeploymentInfo;
+	info: ChainInfo;
+	pollingInterval: number;
+	properties: Record<string, JSONTypePlusBigInt>;
+};
+
+export type DeploymentTargetConfig = {
+	chainId: number;
+	scripts?: string | string[];
+	overrides: Omit<ChainUserConfig, 'info'>;
+};
+
+export type Chains = {
+	[idOrName: number | string]: ChainUserConfig;
+};
+
+export type SignerProtocolFunction = (protocolString: string) => Promise<Signer>;
+export type SignerProtocol = {
+	getSigner: SignerProtocolFunction;
+};
+
+export type UserConfig<
+	NamedAccounts extends UnresolvedUnknownNamedAccounts = UnresolvedUnknownNamedAccounts,
+	Data extends UnresolvedNetworkSpecificData = UnresolvedNetworkSpecificData
+> = {
+	targets?: {[name: string]: DeploymentTargetConfig};
+	chains?: Chains;
+	deployments?: string;
+	scripts?: string | string[];
+	accounts?: NamedAccounts;
+	data?: Data;
+	signerProtocols?: Record<string, SignerProtocolFunction>;
+	defaultPollingInterval?: number;
+};
+
+export type ResolvedUserConfig<
+	NamedAccounts extends UnresolvedUnknownNamedAccounts = UnresolvedUnknownNamedAccounts,
+	Data extends UnresolvedNetworkSpecificData = UnresolvedNetworkSpecificData
+> = UserConfig & {
+	deployments: string;
+	scripts: string[];
+	defaultPollingInterval: number;
+};
+
+export type ExecutionParams<Extra extends Record<string, unknown> = Record<string, unknown>> = {
+	target?: string | {fork: string};
+	tags?: string[];
+	saveDeployments?: boolean;
+	askBeforeProceeding?: boolean;
+	reportGasUse?: boolean;
+	defaultPollingInterval?: number;
+	extra?: Extra;
+	logLevel?: number;
+	provider?: EIP1193ProviderWithoutEvents;
+	config?: ConfigOverrides;
+};
 
 export type {Abi, AbiConstructor, AbiError, AbiEvent, AbiFallback, AbiFunction, AbiReceive};
 export type Libraries = {readonly [libraryName: string]: EIP1193Account};
@@ -226,19 +503,6 @@ export type ResolvedNamedSigners<T extends UnknownNamedAccounts> = {
 
 export type UnknownDeploymentsAcrossNetworks = Record<string, UnknownDeployments>;
 
-export type ExecutionParams<Extra extends Record<string, unknown> = Record<string, unknown>> = {
-	target?: string | {fork: string};
-	tags?: string[];
-	saveDeployments?: boolean;
-	askBeforeProceeding?: boolean;
-	reportGasUse?: boolean;
-	defaultPollingInterval?: number;
-	extra?: Extra;
-	logLevel?: number;
-	provider?: EIP1193ProviderWithoutEvents;
-	config: ConfigOverrides;
-};
-
 export type ResolvedExecutionParams<Extra extends Record<string, unknown> = Record<string, unknown>> = {
 	readonly target: {
 		readonly name: string;

package/src/utils/extensions.test.ts

@@ -1,4 +1,4 @@
-import type {Environment} from '../environment/types.js';
+import type {Environment} from '../types.js';
 import {withEnvironment} from './extensions.js';
 
 // Mock environment for testing

package/src/utils/extensions.ts

@@ -3,8 +3,8 @@ import type {
 	UnknownDeployments,
 	UnresolvedNetworkSpecificData,
 	UnresolvedUnknownNamedAccounts,
-} from '../environment/types.js';
-import {CurriedFunctions} from '../executor/types.js';
+	CurriedFunctions,
+} from '../types.js';
 
 /**
  * @param env - The environment object to inject as the first parameter

package/src/executor/types.ts

@@ -1,176 +0,0 @@
-import {Address} from 'abitype';
-import type {
-	Environment,
-	JSONTypePlusBigInt,
-	UnknownDeployments,
-	UnresolvedNetworkSpecificData,
-	UnresolvedUnknownNamedAccounts,
-} from '../environment/types.js';
-
-export type DeployScriptFunction<
-	NamedAccounts extends UnresolvedUnknownNamedAccounts = UnresolvedUnknownNamedAccounts,
-	Data extends UnresolvedNetworkSpecificData = UnresolvedNetworkSpecificData,
-	ArgumentsTypes = undefined,
-	Deployments extends UnknownDeployments = UnknownDeployments,
-	Extra extends Record<string, unknown> = Record<string, unknown>
-> = (env: Environment<NamedAccounts, Data, Deployments, Extra>, args?: ArgumentsTypes) => Promise<void | boolean>;
-
-export interface DeployScriptModule<
-	NamedAccounts extends UnresolvedUnknownNamedAccounts = UnresolvedUnknownNamedAccounts,
-	Data extends UnresolvedNetworkSpecificData = UnresolvedNetworkSpecificData,
-	ArgumentsTypes = undefined,
-	Deployments extends UnknownDeployments = UnknownDeployments,
-	Extra extends Record<string, unknown> = Record<string, unknown>
-> {
-	(env: Environment<NamedAccounts, Data, Deployments, Extra>, args?: ArgumentsTypes): Promise<void | boolean>;
-	tags?: string[];
-	dependencies?: string[];
-	runAtTheEnd?: boolean;
-	id?: string;
-}
-
-export type ScriptCallback<
-	NamedAccounts extends UnresolvedUnknownNamedAccounts = UnresolvedUnknownNamedAccounts,
-	Data extends UnresolvedNetworkSpecificData = UnresolvedNetworkSpecificData,
-	Deployments extends UnknownDeployments = UnknownDeployments,
-	Extra extends Record<string, unknown> = Record<string, unknown>
-> = (env: Environment<NamedAccounts, Data, Deployments, Extra>) => Promise<void>;
-
-/**
- * Utility type to extract the return value from a higher-order function
- * For functions of type (firstParam: T) => (...args: any[]) => V or (firstParam: T) => V
- */
-export type ExtractReturnFunction<T> = T extends (first: any) => infer Return ? Return : never;
-
-/**
- * Utility type to transform an object of higher-order functions by extracting their return types
- * This handles both regular functions and getter functions
- */
-export type CurriedFunctions<T> = {
-	[K in keyof T]: ExtractReturnFunction<T[K]>;
-};
-
-/**
- * Type for the enhanced environment proxy that includes both the original environment
- * and the curried functions
- */
-export type EnhancedEnvironment<
-	NamedAccounts extends UnresolvedUnknownNamedAccounts = UnresolvedUnknownNamedAccounts,
-	Data extends UnresolvedNetworkSpecificData = UnresolvedNetworkSpecificData,
-	Deployments extends UnknownDeployments = UnknownDeployments,
-	Extensions extends Record<
-		string,
-		(env: Environment<NamedAccounts, Data, Deployments>, ...args: any[]) => any
-	> = Record<string, (env: Environment<NamedAccounts, Data, Deployments>, ...args: any[]) => any>,
-	Extra extends Record<string, unknown> = Record<string, unknown>
-> = Environment<NamedAccounts, Data, Deployments, Extra> & CurriedFunctions<Extensions>;
-
-/**
- * Type for a deploy script function that receives an enhanced environment
- */
-export type EnhancedDeployScriptFunction<
-	NamedAccounts extends UnresolvedUnknownNamedAccounts = UnresolvedUnknownNamedAccounts,
-	Data extends UnresolvedNetworkSpecificData = UnresolvedNetworkSpecificData,
-	ArgumentsTypes = undefined,
-	Deployments extends UnknownDeployments = UnknownDeployments,
-	Functions extends Record<
-		string,
-		(env: Environment<NamedAccounts, Data, Deployments>, ...args: any[]) => any
-	> = Record<string, (env: Environment<NamedAccounts, Data, Deployments>, ...args: any[]) => any>,
-	Extra extends Record<string, unknown> = Record<string, unknown>
-> = (
-	env: EnhancedEnvironment<NamedAccounts, Data, Deployments, Functions, Extra>,
-	args?: ArgumentsTypes
-) => Promise<void | boolean>;
-
-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';
-
-	genesisHash?: string;
-
-	properties?: Record<string, JSONTypePlusBigInt>;
-
-	// 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;
-};