@rocketh/router 0.17.9 → 0.17.11

package/README.md

@@ -1 +1,7 @@
-# rocketh-proxy
+# @rocketh/router
+
+Immutable Route-based proxy deployment for rocketh, enabling you to deploy contracts via a router pattern that routes calls to different implementations based on function selectors. Similar to diamond proxies, but with a simpler and more gas-efficient implementation and without introspection.
+
+For full documentation, visit [rocketh.dev](https://rocketh.dev).
+
+For hardhat-deploy documentation, see [rocketh.dev/hardhat-deploy/](https://rocketh.dev/hardhat-deploy/).

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,iBAAiB,CAAC;AACzB,OAAO,EAAC,cAAc,EAAC,MAAM,yBAAyB,CAAC;AAEvD,OAAO,EAAC,IAAI,EAAC,MAAM,YAAY,CAAC;AAChC,OAAO,EAAC,WAAW,EAAC,MAAM,mCAAmC,CAAC;AAC9D,OAAO,EAAC,MAAM,EAA8B,MAAM,iBAAiB,CAAC;AAEpE,MAAM,MAAM,GAAG,IAAI,CAAC,iBAAiB,CAAC,CAAC;AA8BvC,MAAM,UAAU,eAAe,CAC9B,GAAgB;IAOhB,OAAO,KAAK,EACX,IAAY,EACZ,MAA4C,EAC5C,MAAoB,EACpB,OAA6B,EAC5B,EAAE;QACH,IAAI,gBAAgB,GAAG,OAAO,CAAC,CAAC,CAAC,EAAC,aAAa,EAAE,OAAO,CAAC,aAAa,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,EAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAClH,IAAI,gBAAgB,GAAG,OAAO;YAC7B,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,EAAE;gBACb,MAAM,EAAC,SAAS,EAAE,cAAc,EAAE,GAAG,gBAAgB,EAAC,GAAG,OAAO,CAAC;gBACjE,OAAO,gBAAgB,CAAC;YACxB,CAAC,CAAC,CAAC,OAAO,CAAC;YACb,CAAC,CAAC,SAAS,CAAC;QACb,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QAC5B,MAAM,eAAe,GAAoB,EAAE,CAAC;QAE5C,MAAM,SAAS,GAKT,EAAE,CAAC;QACT,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC5B,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACvB,CAAC;QACD,IAAI,OAAO,EAAE,SAAS,EAAE,CAAC;YACxB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBACnD,MAAM,KAAK,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;gBACnC,SAAS,CAAC,IAAI,CAAC,EAAC,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,QAAQ,EAAE,EAAC,GAAG,EAAE,KAAK,EAAC,EAAC,CAAC,CAAC;YAC7D,CAAC;QACF,CAAC;QAED,MAAM,EAAC,QAAQ,EAAE,SAAS,EAAE,aAAa,EAAE,cAAc,EAAC,GAAG,cAAc,CAAC,SAAS,CAAC,CAAC;QACvF,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC5B,MAAM,aAAa,GAAG,MAAM,OAAO,CAClC,GAAG,IAAI,WAAW,KAAK,CAAC,IAAI,QAAQ,EACpC;gBACC,GAAG,MAAM;gBACT,QAAQ,EAAE,KAAK,CAAC,QAAQ;gBACxB,IAAI,EAAE,KAAK,CAAC,IAAiB;aAC7B,EACD,gBAAgB,CAChB,CAAC;YACF,eAAe,CAAC,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QAC7C,CAAC;QAED,MAAM,sBAAsB,GAAG,4CAA6D,CAAC;QAE7F,MAAM,eAAe,GAAoB,EAAE,CAAC;QAC5C,KAAK,MAAM,KAAK,IAAI,QAAQ,EAAE,CAAC;YAC9B,qDAAqD;YACrD,eAAe,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAkB,CAAC,CAAC;QAClG,CAAC;QAED,MAAM,MAAM,GAAG,eAAe,CAAC,IAAI,EAAE,CAAC;QAEtC,IAAI,kBAAkB,GAAG,GAAG,CAAC,SAAS,CAAO,IAAI,CAAC,CAAC;QAEnD,MAAM,WAAW,GAAG;YACnB,sBAAsB;YACtB,eAAe;YACf,MAAM;SACN,CAAC;QAEF,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;QAEnC,MAAM,MAAM,GAAG,MAAM,OAAO,CAC3B,GAAG,IAAI,SAAS,EAChB;YACC,GAAG,MAAM;YACT,QAAQ,EAAE,OAAO,EAAE,cAAc,EAAE,QAAQ,IAAI,WAAW;YAC1D,IAAI,EAAE,CAAC,WAAW,CAAC;SACnB,EACD,gBAAgB,CAChB,CAAC;QAEF,MAAM,CAAC,IAAI,CAAC,sBAAsB,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;QAEpD,IAAI,CAAC,kBAAkB,IAAI,MAAM,CAAC,aAAa,EAAE,CAAC;YACjD,MAAM,EAAC,aAAa,EAAE,GAAG,yBAAyB,EAAC,GAAG,MAAM,CAAC;YAC7D,kBAAkB,GAAG,MAAM,GAAG,CAAC,IAAI,CAAO,IAAI,EAAE;gBAC/C,GAAG,yBAAyB;gBAC5B,GAAG,EAAE,SAA4B;gBACjC,MAAM,EAAE,aAAa;gBACrB,OAAO,EAAE,cAAc;aACvB,CAAC,CAAC;YAEH,MAAM,CAAC,IAAI,CAAC,yBAAyB,IAAI,EAAE,CAAC,CAAC;YAE7C,OAAO,EAAC,GAAG,kBAAkB,EAAE,aAAa,EAAE,IAAI,EAAC,CAAC;QACrD,CAAC;QAED,OAAO,EAAC,GAAG,kBAAkB,EAAE,aAAa,EAAE,KAAK,EAAC,CAAC;IACtD,CAAC,CAAC;AACH,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,iBAAiB,CAAC;AACzB,OAAO,EAAC,cAAc,EAAC,MAAM,yBAAyB,CAAC;AAEvD,OAAO,EAAC,IAAI,EAAC,MAAM,YAAY,CAAC;AAChC,OAAO,EAAC,WAAW,EAAC,MAAM,mCAAmC,CAAC;AAC9D,OAAO,EAAC,MAAM,EAA8B,MAAM,iBAAiB,CAAC;AAEpE,MAAM,MAAM,GAAG,IAAI,CAAC,iBAAiB,CAAC,CAAC;AA8BvC,MAAM,UAAU,eAAe,CAC9B,GAAgB;IAOhB,OAAO,KAAK,EACX,IAAY,EACZ,MAA4C,EAC5C,MAAoB,EACpB,OAA6B,EAC5B,EAAE;QACH,IAAI,gBAAgB,GAAG,OAAO,CAAC,CAAC,CAAC,EAAC,aAAa,EAAE,OAAO,CAAC,aAAa,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,EAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAClH,IAAI,gBAAgB,GAAG,OAAO;YAC7B,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,EAAE;gBACb,MAAM,EAAC,SAAS,EAAE,cAAc,EAAE,GAAG,gBAAgB,EAAC,GAAG,OAAO,CAAC;gBACjE,OAAO,gBAAgB,CAAC;YACzB,CAAC,CAAC,CAAC,OAAO,CAAC;YACZ,CAAC,CAAC,SAAS,CAAC;QACb,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QAC5B,MAAM,eAAe,GAAoB,EAAE,CAAC;QAE5C,MAAM,SAAS,GAKT,EAAE,CAAC;QACT,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC5B,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACvB,CAAC;QACD,IAAI,OAAO,EAAE,SAAS,EAAE,CAAC;YACxB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBACnD,MAAM,KAAK,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;gBACnC,SAAS,CAAC,IAAI,CAAC,EAAC,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,QAAQ,EAAE,EAAC,GAAG,EAAE,KAAK,EAAC,EAAC,CAAC,CAAC;YAC7D,CAAC;QACF,CAAC;QAED,MAAM,EAAC,QAAQ,EAAE,SAAS,EAAE,aAAa,EAAE,cAAc,EAAC,GAAG,cAAc,CAAC,SAAS,CAAC,CAAC;QACvF,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC5B,MAAM,aAAa,GAAG,MAAM,OAAO,CAClC,GAAG,IAAI,WAAW,KAAK,CAAC,IAAI,QAAQ,EACpC;gBACC,GAAG,MAAM;gBACT,QAAQ,EAAE,KAAK,CAAC,QAAQ;gBACxB,IAAI,EAAE,KAAK,CAAC,IAAiB;aAC7B,EACD,gBAAgB,CAChB,CAAC;YACF,eAAe,CAAC,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QAC7C,CAAC;QAED,MAAM,sBAAsB,GAAG,4CAA6D,CAAC;QAE7F,MAAM,eAAe,GAAoB,EAAE,CAAC;QAC5C,KAAK,MAAM,KAAK,IAAI,QAAQ,EAAE,CAAC;YAC9B,qDAAqD;YACrD,eAAe,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAkB,CAAC,CAAC;QAClG,CAAC;QAED,MAAM,MAAM,GAAG,eAAe,CAAC,IAAI,EAAE,CAAC;QAEtC,IAAI,kBAAkB,GAAG,GAAG,CAAC,SAAS,CAAO,IAAI,CAAC,CAAC;QAEnD,MAAM,WAAW,GAAG;YACnB,sBAAsB;YACtB,eAAe;YACf,MAAM;SACN,CAAC;QAEF,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;QAEnC,MAAM,MAAM,GAAG,MAAM,OAAO,CAC3B,GAAG,IAAI,SAAS,EAChB;YACC,GAAG,MAAM;YACT,QAAQ,EAAE,OAAO,EAAE,cAAc,EAAE,QAAQ,IAAI,WAAW;YAC1D,IAAI,EAAE,CAAC,WAAW,CAAC;SACnB,EACD,gBAAgB,CAChB,CAAC;QAEF,MAAM,CAAC,IAAI,CAAC,sBAAsB,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;QAEpD,IAAI,CAAC,kBAAkB,IAAI,MAAM,CAAC,aAAa,EAAE,CAAC;YACjD,MAAM,EAAC,aAAa,EAAE,GAAG,yBAAyB,EAAC,GAAG,MAAM,CAAC;YAC7D,kBAAkB,GAAG,MAAM,GAAG,CAAC,IAAI,CAAO,IAAI,EAAE;gBAC/C,GAAG,yBAAyB;gBAC5B,GAAG,EAAE,SAA4B;gBACjC,MAAM,EAAE,aAAa;gBACrB,OAAO,EAAE,cAAc;aACvB,CAAC,CAAC;YAEH,MAAM,CAAC,IAAI,CAAC,yBAAyB,IAAI,EAAE,CAAC,CAAC;YAE7C,OAAO,EAAC,GAAG,kBAAkB,EAAE,aAAa,EAAE,IAAI,EAAC,CAAC;QACrD,CAAC;QAED,OAAO,EAAC,GAAG,kBAAkB,EAAE,aAAa,EAAE,KAAK,EAAC,CAAC;IACtD,CAAC,CAAC;AACH,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rocketh/router",
-  "version": "0.17.9",
+  "version": "0.17.11",
   "description": "provide router based proxy deployment for rocketh",
   "publishConfig": {
     "access": "public"
@@ -18,19 +18,20 @@
     }
   },
   "files": [
-    "dist"
+    "dist",
+    "src"
   ],
   "dependencies": {
     "abitype": "^1.2.3",
     "eip-1193": "^0.6.5",
     "named-logs": "^0.4.1",
     "solidity-proxy": "^0.4.2",
-    "viem": "^2.44.1",
-    "@rocketh/deploy": "0.17.7",
-    "@rocketh/core": "0.17.7"
+    "viem": "^2.44.4",
+    "@rocketh/core": "0.17.9",
+    "@rocketh/deploy": "0.17.9"
   },
   "devDependencies": {
-    "as-soon": "^0.0.11",
+    "as-soon": "^0.1.4",
     "rimraf": "^6.1.2",
     "typescript": "^5.9.3"
   },

package/src/index.ts

@@ -0,0 +1,142 @@
+import {Abi} from 'abitype';
+import type {Artifact, DeploymentConstruction, Deployment, Environment, DevDoc, UserDoc} from '@rocketh/core/types';
+import '@rocketh/deploy';
+import {mergeArtifacts} from '@rocketh/core/artifacts';
+import {DeployContractParameters} from 'viem';
+import {logs} from 'named-logs';
+import {Router10X60} from 'solidity-proxy/artifacts/index.js';
+import {deploy, DeployOptions, DeployResult} from '@rocketh/deploy';
+
+const logger = logs('@rocketh/router');
+
+export type Route<TAbi extends Abi = Abi> = Omit<
+	DeployContractParameters<TAbi>,
+	'bytecode' | 'account' | 'abi' | 'chain'
+> & {
+	name: string;
+	artifact: Artifact<TAbi>;
+};
+
+export type RouterEnhancedDeploymentConstruction = Omit<
+	DeploymentConstruction<typeof Router10X60.abi>,
+	'artifact' | 'args'
+>;
+
+export type RouterDeployOptions = DeployOptions & {
+	extraABIs?: Abi[];
+	routerContract?: {
+		type: 'custom';
+		artifact: Artifact<typeof Router10X60.abi>;
+	};
+};
+
+export type DeployViaRouterFunction = <TAbi extends Abi>(
+	name: string,
+	params: RouterEnhancedDeploymentConstruction,
+	routes: Route<Abi>[],
+	options?: RouterDeployOptions,
+) => Promise<Deployment<TAbi> & {newlyDeployed: boolean}>;
+
+export function deployViaRouter(
+	env: Environment,
+): <TAbi extends Abi>(
+	name: string,
+	params: RouterEnhancedDeploymentConstruction,
+	routes: Route<Abi>[],
+	options?: RouterDeployOptions,
+) => Promise<DeployResult<TAbi>> {
+	return async <TAbi extends Abi>(
+		name: string,
+		params: RouterEnhancedDeploymentConstruction,
+		routes: Route<Abi>[],
+		options?: RouterDeployOptions,
+	) => {
+		let optionsForRoutes = options ? {deterministic: options.deterministic, libraries: options.libraries} : undefined;
+		let optionsForRouter = options
+			? ((options) => {
+					const {extraABIs, routerContract, ...optionsForRouter} = options;
+					return optionsForRouter;
+				})(options)
+			: undefined;
+		const _deploy = deploy(env);
+		const implementations: `0x${string}`[] = [];
+
+		const namedAbis: {
+			name: string;
+			artifact: Partial<Artifact<Abi>> & {
+				abi: Abi;
+			};
+		}[] = [];
+		for (const route of routes) {
+			namedAbis.push(route);
+		}
+		if (options?.extraABIs) {
+			for (let i = 0; i < options.extraABIs.length; i++) {
+				const extra = options.extraABIs[i];
+				namedAbis.push({name: `extra${i}`, artifact: {abi: extra}});
+			}
+		}
+
+		const {sigJSMap, mergedABI, mergedDevDocs, mergedUserDocs} = mergeArtifacts(namedAbis);
+		for (const route of routes) {
+			const deployedRoute = await _deploy<Abi>(
+				`${name}_Router_${route.name}_Route`,
+				{
+					...params,
+					artifact: route.artifact,
+					args: route.args as unknown[],
+				},
+				optionsForRoutes,
+			);
+			implementations.push(deployedRoute.address);
+		}
+
+		const fallbackImplementation = '0x0000000000000000000000000000000000000000' as `0x${string}`;
+
+		const unorderedSigMap: `0x${string}`[] = [];
+		for (const entry of sigJSMap) {
+			// we add +1 to index as 0 indicate no implementation
+			unorderedSigMap.push((entry[0] + entry[1].index.toString(16).padStart(2, '0')) as `0x${string}`);
+		}
+
+		const sigMap = unorderedSigMap.sort();
+
+		let existingDeployment = env.getOrNull<TAbi>(name);
+
+		const routeParams = {
+			fallbackImplementation,
+			implementations,
+			sigMap,
+		};
+
+		logger.info(`routes`, routeParams);
+
+		const router = await _deploy(
+			`${name}_Router`,
+			{
+				...params,
+				artifact: options?.routerContract?.artifact || Router10X60,
+				args: [routeParams],
+			},
+			optionsForRouter,
+		);
+
+		logger.info(`router deployed at ${router.address}`);
+
+		if (!existingDeployment || router.newlyDeployed) {
+			const {newlyDeployed, ...routerWithoutDeployedFlag} = router;
+			existingDeployment = await env.save<TAbi>(name, {
+				...routerWithoutDeployedFlag,
+				abi: mergedABI as unknown as TAbi,
+				devdoc: mergedDevDocs,
+				userdoc: mergedUserDocs,
+			});
+
+			logger.info(`save with merged ABI: ${name}`);
+
+			return {...existingDeployment, newlyDeployed: true};
+		}
+
+		return {...existingDeployment, newlyDeployed: false};
+	};
+}