feat: allow config vars in http network url

NomicFoundation · Dec 18, 2024 · ffdb527 · ffdb527
1 parent b48796e
commit ffdb527
Show file tree

Hide file tree

Showing 7 changed files with 28 additions and 21 deletions.
diff --git a/v-next/hardhat/src/internal/builtin-plugins/network-manager/hook-handlers/config.ts b/v-next/hardhat/src/internal/builtin-plugins/network-manager/hook-handlers/config.ts
@@ -113,7 +113,7 @@ export async function resolveUserConfig(
         gas: resolveGasConfig(networkConfig.gas),
         gasMultiplier: networkConfig.gasMultiplier ?? 1,
         gasPrice: resolveGasConfig(networkConfig.gasPrice),
-        url: networkConfig.url,
+        url: resolveConfigurationVariable(networkConfig.url),
         timeout: networkConfig.timeout ?? 20_000,
         httpHeaders: networkConfig.httpHeaders ?? {},
       };

diff --git a/v-next/hardhat/src/internal/builtin-plugins/network-manager/network-manager.ts b/v-next/hardhat/src/internal/builtin-plugins/network-manager/network-manager.ts
@@ -180,7 +180,7 @@ export class NetworkManagerImplementation implements NetworkManager {
       }
 
       return HttpProvider.create({
-        url: resolvedNetworkConfig.url,
+        url: await resolvedNetworkConfig.url.getUrl(),
         networkName: resolvedNetworkName,
         extraHeaders: resolvedNetworkConfig.httpHeaders,
         timeout: resolvedNetworkConfig.timeout,

diff --git a/v-next/hardhat/src/internal/builtin-plugins/network-manager/type-extensions/config.ts b/v-next/hardhat/src/internal/builtin-plugins/network-manager/type-extensions/config.ts
@@ -22,7 +22,7 @@ declare module "../../../../types/config.js" {
     gasPrice?: GasUserConfig;
 
     // HTTP network specific
-    url: string;
+    url: SensitiveString;
     httpHeaders?: Record<string, string>;
     timeout?: number;
   }
@@ -140,7 +140,7 @@ declare module "../../../../types/config.js" {
     gasPrice: GasConfig;
 
     // HTTP network specific
-    url: string;
+    url: ResolvedConfigurationVariable;
     httpHeaders: Record<string, string>;
     timeout: number;
   }

diff --git a/v-next/hardhat/src/internal/builtin-plugins/network-manager/type-validation.ts b/v-next/hardhat/src/internal/builtin-plugins/network-manager/type-validation.ts
@@ -78,7 +78,7 @@ const httpNetworkUserConfigSchema = z.object({
   gasPrice: z.optional(gasUserConfigSchema),
 
   // HTTP network specific
-  url: z.string().url(), // TODO: this should be a sensitiveUrlSchema
+  url: sensitiveUrlSchema,
   httpHeaders: z.optional(z.record(z.string())),
   timeout: z.optional(z.number()),
 });
@@ -177,7 +177,7 @@ const httpNetworkConfigSchema = z.object({
   gasPrice: gasConfigSchema,
 
   // HTTP network specific
-  url: sensitiveUrlSchema,
+  url: resolvedConfigurationVariableSchema,
   httpHeaders: z.record(z.string()),
   timeout: z.number(),
 });

diff --git a/v-next/hardhat/test/internal/builtin-plugins/network-manager/hook-handlers/config.ts b/v-next/hardhat/test/internal/builtin-plugins/network-manager/hook-handlers/config.ts
@@ -465,7 +465,7 @@ describe("network-manager/hook-handlers/config", () => {
         assertValidationErrors(validationErrors, [
           {
             path: ["networks", "localhost", "url"],
-            message: "Required",
+            message: "Expected a URL or a Configuration Variable",
           },
         ]);
       });
@@ -487,7 +487,7 @@ describe("network-manager/hook-handlers/config", () => {
         assertValidationErrors(validationErrors, [
           {
             path: ["networks", "localhost", "url"],
-            message: "Invalid url",
+            message: "Expected a URL or a Configuration Variable",
           },
         ]);
       });
@@ -1202,7 +1202,7 @@ describe("network-manager/hook-handlers/config", () => {
         nextUserConfig: HardhatUserConfig,
         /* eslint-disable-next-line @typescript-eslint/consistent-type-assertions
         -- Cast for simplicity as we won't test this */
-      ) => nextUserConfig as HardhatConfig;
+      ) => nextUserConfig as unknown as HardhatConfig;
 
       const resolvedConfig = await resolveUserConfig(
         extendedConfig,
@@ -1222,7 +1222,7 @@ describe("network-manager/hook-handlers/config", () => {
           gasMultiplier: 1,
           gasPrice: "auto",
           accounts: "remote",
-          url: "http://localhost:8545",
+          url: new FixedValueConfigurationVariable("http://localhost:8545"),
           timeout: 20_000,
           httpHeaders: {},
         },
@@ -1258,7 +1258,7 @@ describe("network-manager/hook-handlers/config", () => {
         nextUserConfig: HardhatUserConfig,
         /* eslint-disable-next-line @typescript-eslint/consistent-type-assertions
         -- Cast for simplicity as we won't test this */
-      ) => nextUserConfig as HardhatConfig;
+      ) => nextUserConfig as unknown as HardhatConfig;
 
       const resolvedConfig = await resolveUserConfig(
         userConfig,
@@ -1268,6 +1268,7 @@ describe("network-manager/hook-handlers/config", () => {
 
       assert.equal(resolvedConfig.defaultChainType, "generic");
       assert.equal(resolvedConfig.defaultNetwork, "myNetwork");
+      assert.equal(resolvedConfig.networks.myNetwork.type, "http");
       assert.deepEqual(resolvedConfig.networks, {
         myNetwork: {
           type: "http",
@@ -1282,7 +1283,7 @@ describe("network-manager/hook-handlers/config", () => {
               "0x000006d4548a3ac17d72b372ae1e416bf65b8ead",
             ),
           ],
-          url: "http://node.myNetwork.com",
+          url: new FixedValueConfigurationVariable("http://node.myNetwork.com"),
           timeout: 10_000,
           httpHeaders: {
             "Content-Type": "application/json",
@@ -1322,7 +1323,7 @@ describe("network-manager/hook-handlers/config", () => {
           nextUserConfig: HardhatUserConfig,
           /* eslint-disable-next-line @typescript-eslint/consistent-type-assertions
           -- Cast for simplicity as we won't test this */
-        ) => nextUserConfig as HardhatConfig;
+        ) => nextUserConfig as unknown as HardhatConfig;
 
         const resolvedConfig = await resolveUserConfig(
           userConfig,
@@ -1353,7 +1354,9 @@ describe("network-manager/hook-handlers/config", () => {
                 "0x000006d4548a3ac17d72b372ae1e416bf65b8ddd",
               ),
             ],
-            url: "http://node.myNetwork.com",
+            url: new FixedValueConfigurationVariable(
+              "http://node.myNetwork.com",
+            ),
             timeout: 10_000,
             httpHeaders: {
               "Content-Type": "application/json",
@@ -1390,7 +1393,7 @@ describe("network-manager/hook-handlers/config", () => {
           nextUserConfig: HardhatUserConfig,
           /* eslint-disable-next-line @typescript-eslint/consistent-type-assertions
           -- Cast for simplicity as we won't test this */
-        ) => nextUserConfig as HardhatConfig;
+        ) => nextUserConfig as unknown as HardhatConfig;
 
         const resolvedConfig = await resolveUserConfig(
           userConfig,
@@ -1414,7 +1417,9 @@ describe("network-manager/hook-handlers/config", () => {
               path: "m/44'/60'/0'/0",
               passphrase: "passphrase",
             },
-            url: "http://node.myNetwork.com",
+            url: new FixedValueConfigurationVariable(
+              "http://node.myNetwork.com",
+            ),
             timeout: 10_000,
             httpHeaders: {
               "Content-Type": "application/json",

diff --git a/v-next/hardhat/test/internal/builtin-plugins/network-manager/network-connection.ts b/v-next/hardhat/test/internal/builtin-plugins/network-manager/network-connection.ts
@@ -6,6 +6,7 @@ import { describe, it } from "node:test";
 
 import { HttpProvider } from "../../../../src/internal/builtin-plugins/network-manager/http-provider.js";
 import { NetworkConnectionImplementation } from "../../../../src/internal/builtin-plugins/network-manager/network-connection.js";
+import { FixedValueConfigurationVariable } from "../../../../src/internal/core/configuration-variables.js";
 
 describe("NetworkConnectionImplementation", () => {
   const localhostNetworkConfig: NetworkConfig = {
@@ -17,7 +18,7 @@ describe("NetworkConnectionImplementation", () => {
     gasMultiplier: 1,
     gasPrice: "auto",
     accounts: [],
-    url: "http://localhost:8545",
+    url: new FixedValueConfigurationVariable("http://localhost:8545"),
     timeout: 20_000,
     httpHeaders: {},
   };
@@ -28,7 +29,7 @@ describe("NetworkConnectionImplementation", () => {
 
       const createProvider = async (): Promise<EthereumProvider> => {
         expectedProvider = await HttpProvider.create({
-          url: localhostNetworkConfig.url,
+          url: await localhostNetworkConfig.url.getUrl(),
           networkName: "localhost",
           extraHeaders: localhostNetworkConfig.httpHeaders,
           timeout: localhostNetworkConfig.timeout,

diff --git a/v-next/hardhat/test/internal/builtin-plugins/network-manager/network-manager.ts b/v-next/hardhat/test/internal/builtin-plugins/network-manager/network-manager.ts
@@ -17,6 +17,7 @@ import { expectTypeOf } from "expect-type";
 import { createHardhatRuntimeEnvironment } from "../../../../src/hre.js";
 import { NetworkManagerImplementation } from "../../../../src/internal/builtin-plugins/network-manager/network-manager.js";
 import { validateNetworkConfig } from "../../../../src/internal/builtin-plugins/network-manager/type-validation.js";
+import { FixedValueConfigurationVariable } from "../../../../src/internal/core/configuration-variables.js";
 
 describe("NetworkManagerImplementation", () => {
   let hre: HardhatRuntimeEnvironment;
@@ -31,7 +32,7 @@ describe("NetworkManagerImplementation", () => {
       gasMultiplier: 1,
       gasPrice: "auto",
       accounts: [],
-      url: "http://localhost:8545",
+      url: new FixedValueConfigurationVariable("http://localhost:8545"),
       timeout: 20_000,
       httpHeaders: {},
     },
@@ -44,7 +45,7 @@ describe("NetworkManagerImplementation", () => {
       gasMultiplier: 1,
       gasPrice: "auto",
       accounts: [],
-      url: "http://node.customNetwork.com",
+      url: new FixedValueConfigurationVariable("http://node.customNetwork.com"),
       timeout: 20_000,
       httpHeaders: {},
     },
@@ -57,7 +58,7 @@ describe("NetworkManagerImplementation", () => {
       gasMultiplier: 1,
       gasPrice: "auto",
       accounts: [],
-      url: "http://node.myNetwork.com",
+      url: new FixedValueConfigurationVariable("http://node.myNetwork.com"),
       timeout: 20_000,
       httpHeaders: {},
     },