add custom proxy support

README.md

@@ -57,7 +57,7 @@ const config: HardhatUserConfig = {
 export default config;
 ```
 
-`contractName` property is optional and only needed if configuration includes multiple instances of one contract
+`contractName` property is optional and only needed if configuration contract key is not the same as contract name
 
 **note**: dependant contract must be located above
 
@@ -73,9 +73,7 @@ npx hardhat deploy-bundle --no-compile true
 
 ## Configuration
 
-By default, hardhat-sol-bundler supports only deployment runtime accessability.
-
-- To deploy only modified contracts, add `lockFile` property to deployment
+- To deploy only modified contracts, add `lockFile` property to deployment:
 
 ```ts
 const deployment = {
@@ -86,7 +84,24 @@ const deployment = {
 };
 ```
 
-- To verify deployed contracts during runtime.
+- To deploy contract as a proxy:
+
+```ts
+import { SupportedProxies } from "@dgma/hardhat-sol-bundler";
+
+const deployment = {
+  lockFile: "deployment-lock.json",
+  config: {
+    TestContract: {
+      proxy: {
+        type: SupportedProxies.CUSTOM
+      }
+    }
+  },
+};
+```
+
+- To verify deployed contracts during runtime:
 
 ```ts
 // no need @nomicfoundation/hardhat-verify if you use @nomicfoundation/hardhat-toolbox

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dgma/hardhat-sol-bundler",
-  "version": "0.5.0",
+  "version": "0.5.1",
   "description": "Declarative deployment tool for smart contracts",
   "main": "src/index.js",
   "types": "src/index.d.ts",

src/deploy/constants.ts

@@ -1,4 +1,5 @@
 export const SupportedProxies = {
   TRANSPARENT: "transparent",
   UUPS: "uups",
+  CUSTOM: "custom",
 } as const;

src/deploy/deploy.ts

@@ -7,7 +7,6 @@ import {
   type IGlobalState,
   type IDeployingContractState,
   type ProxyUnsafeAllow,
-  type ProxyType,
 } from "./types";
 import {
   getDeployment,
@@ -18,13 +17,16 @@ import {
 
 type ContractState = stateFabric.IState<IDeployingContractState>;
 type GlobalState = stateFabric.IState<IGlobalState>;
+type ClassicProxyTypes =
+  | typeof SupportedProxies.TRANSPARENT
+  | typeof SupportedProxies.UUPS;
 
 async function deployOrUpdateClassic(
   hre: HardhatRuntimeEnvironment,
   state: GlobalState,
   contractState: ContractState,
   unsafeAllow: ProxyUnsafeAllow[],
-  kind: ProxyType = SupportedProxies.TRANSPARENT,
+  kind: ClassicProxyTypes = SupportedProxies.TRANSPARENT,
 ) {
   const contractLockData = state.value().ctx[contractState.value().key];
   const factory = contractState.value().factory!;
@@ -54,7 +56,6 @@ async function deployOrUpdateClassic(
   contractState.update((prevState) => ({
     ...prevState,
     contract,
-    proxy: SupportedProxies.TRANSPARENT,
   }));
 }