Load local networks configuration from local path and default home #3

nkuba · 2021-07-21T21:25:34Z

In this PR we update the possibility to load networks configuration from three places at the same time:

specified localNetworksConfig file,
networks configuration in hardhat project config file,
default user home networks configuration file ~/.hardhat/networks.json.

Conflicts resolution

Conflicts will be resolved in the following order:

Local networks specific config file (based on localNetworksConfig property).
Project networks specific configuration.
Default local network configuration (~/.hardhat/networks.json).

Relative path support

Added support of relative paths that will be resolved based on Hardhat's project root directory hardhatConfig.paths.root.

File does not exist

If the localNetworksConfig path is configured and the file doesn't exist it will throw an error.
If the ~/.hardhat/networks.json file does not exist nothing will happen.

`LocalNetworksConfig` interface

LocalNetworksConfig interface was updated to reflect what was already described in README.md: make properties optional. Also, the types for the properties were changed to the ones used by hardhat for user config NetworksUserConfig and NetworkUserConfig as these types contain optional properties.

With this change, a user will be able to define their configuration file with type import, like in the example:

import { LocalNetworksConfig } from "hardhat-local-networks-config-plugin"

const config: LocalNetworksConfig = {
  networks: {
    ropsten: {
      url: "http://localhost:8567",
      accounts: ["0x1234567890"],
    },
  },
}

module.exports = config

Tests

We added more tests and made the test fixtures more consistent to reduce confusion.

It is expected that configuration for networks can be available under `~/.hardhat/networks.json` which is a default path. Additionally to this path user can also configure `localNetworksConfig` path in the project configuration. The code was refactored in preparation to change the order of how configs are resolved and overwritten. With this change the order remains the same: 1. Project network specific configuration 2. Local network specific configuration 3. Local default network configuration (`~/.hardhat/networks.json`)

This commit contains same updates to test fixtures to make them more consistent and easier to follow. 1. `test/helpers/fixtures/local/hardhat.config` were renamed as the previous name was confusing, the files contain network configuration specific for the plugin, not the whole hardhat config. 2. Created separate configuration for a default `test/helpers/fixtures/homedir/.hardhat/networks.json` configuration file that reflects the one placed in user home directory and used for testing. 3. Extracted common network configuration for hardhat project config file. 4. Made the three configurations (home, project and local) more consistent and aligned.

Modfied useEnvironment function to expect the name and resolve the path as it's common.

Order in which networks configuration are read can be updated thanks to the change in 7c26b2b. As the default config is read separately from local config we assume that user want to use specific external configuration file over the configuration specified in project configuration. The new order is: 1. Local network specific configuration (`localNetworksConfig`). 2. Project network specific configuration. 3. Default local network configuration (`~/.hardhat/networks.json`).

The path that is provided in localNetworksConfig can be a relative path that is resolved based on the project root dir.

The LocalNetworksConfig interface was changed in two ways: 1. `networks` and `defaultConfig` properties are optional, this was mentioned already in README.md. 2. Types were changed to `NetworksUserConfig` and `NetworkUserConfig`, as this are the correct types that are configurable by an user. The types got optional properties. Added `LocalNetworksConfigInternal` that extends `LocalNetworksConfig`. The difference is that both properties are required. This type is used internally when we read the config.

Added two cases: 1. The config file that the localNetworksConfig path points to can be empty. 2. The project config may not contain `networks` property.

A pacakge @types/mock-os is not avialble so we can't iinstall it to use import.

pumpurum2 · 2021-11-06T15:18:34Z

@facuspagnuolo @nkuba hello, will this PR merged?
At least relative path support is very desirable for me

nkuba · 2021-11-06T18:45:51Z

@facuspagnuolo @nkuba hello, will this PR merged?

At least relative path support is very desirable for me

I hope it will get merged 🤞

facuspagnuolo · 2021-11-09T02:15:24Z

@facuspagnuolo @nkuba hello, will this PR merged?

At least relative path support is very desirable for me

I hope it will get merged 🤞

I promise to merge it this week, sorry for the late reply guys!

facuspagnuolo

Thanks for suggesting this change, left some comments we should fix before merging.

facuspagnuolo · 2021-11-09T19:51:30Z

src/index.ts

 }

-export function getDefaultLocalNetworksConfigPath() {
-  return path.join(getLocalConfigDir(), HARDHAT_NETWORK_CONFIG_FILE)
+export function getDefaultHomeLocalNetworksConfigPath() {


What do you think about?

Suggested change

export function getDefaultHomeLocalNetworksConfigPath() {

export function getHomeNetworksConfigPath() {

facuspagnuolo · 2021-11-09T19:54:23Z

src/utils.ts

+  if (typeof configuredLocalNetworksConfigPath === 'string' && configuredLocalNetworksConfigPath) {
+    const resolvedLocalNetworksConfigPath = untildify(configuredLocalNetworksConfigPath)
+
+      const localNetworksConfigPath = path.isAbsolute(resolvedLocalNetworksConfigPath)


Suggested change

const localNetworksConfigPath = path.isAbsolute(resolvedLocalNetworksConfigPath)

const localNetworksConfigPath = path.isAbsolute(resolvedLocalNetworksConfigPath)

facuspagnuolo · 2021-11-09T20:49:48Z

src/index.ts

 }

 extendConfig((hardhatConfig: HardhatConfig, userConfig: HardhatUserConfig): void => {
-  const localNetworksConfig = readLocalNetworksConfig(userConfig)
+  const homeLocalNetworksConfig = readHomeNetworksConfig()


I find homeLocal a bit redundant, what do you think about distinguishing between the home config (default) and the local (custom) one?

Suggested change

const homeLocalNetworksConfig = readHomeNetworksConfig()

const homeNetworksConfig = readHomeNetworksConfig()

facuspagnuolo · 2021-11-09T20:52:08Z

src/index.ts

+
+  if (localNetworksConfigPath && !fs.existsSync(localNetworksConfigPath)) {
+    throw new HardhatPluginError(
+      `hardhat-local-networks-config-plugin`,


Suggested change

`hardhat-local-networks-config-plugin`,

'hardhat-local-networks-config-plugin',

facuspagnuolo · 2021-11-09T20:58:23Z

src/index.ts

      localNetworksConfig.defaultConfig,
+      userNetworkConfig as object,
      localNetworksConfig.networks[networkName] || {},


This is a bit weird, cause it seems you're prioritizing specific network configs of the local config file over the project's config, but not the default config in the local config file over the project's config.

facuspagnuolo · 2021-11-09T20:58:46Z

src/utils.ts

+
+    return localNetworksConfigPath
+  }
+}


I'd keep this in the index.ts file

nkuba added 9 commits July 21, 2021 23:00

Add tests for default home directory configuration reading

b38edae

Made useEnvironment expect project name

e9657ec

Modfied useEnvironment function to expect the name and resolve the path as it's common.

Support relative paths in configuration

67e7599

The path that is provided in localNetworksConfig can be a relative path that is resolved based on the project root dir.

Add tests to validate empty config and missing networks

f32c5a8

Added two cases: 1. The config file that the localNetworksConfig path points to can be empty. 2. The project config may not contain `networks` property.

Ignore tslint for require('mock-os')

fab21d3

A pacakge @types/mock-os is not avialble so we can't iinstall it to use import.

facuspagnuolo reviewed Nov 9, 2021

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Load local networks configuration from local path and default home #3

Load local networks configuration from local path and default home #3

nkuba commented Jul 21, 2021

pumpurum2 commented Nov 6, 2021

nkuba commented Nov 6, 2021

facuspagnuolo commented Nov 9, 2021

facuspagnuolo left a comment

facuspagnuolo Nov 9, 2021

facuspagnuolo Nov 9, 2021

facuspagnuolo Nov 9, 2021

facuspagnuolo Nov 9, 2021

facuspagnuolo Nov 9, 2021

facuspagnuolo Nov 9, 2021

	export function getDefaultHomeLocalNetworksConfigPath() {
	export function getHomeNetworksConfigPath() {

	const localNetworksConfigPath = path.isAbsolute(resolvedLocalNetworksConfigPath)
	const localNetworksConfigPath = path.isAbsolute(resolvedLocalNetworksConfigPath)

	const homeLocalNetworksConfig = readHomeNetworksConfig()
	const homeNetworksConfig = readHomeNetworksConfig()

	`hardhat-local-networks-config-plugin`,
	'hardhat-local-networks-config-plugin',

Load local networks configuration from local path and default home #3

Are you sure you want to change the base?

Load local networks configuration from local path and default home #3

Conversation

nkuba commented Jul 21, 2021

Conflicts resolution

Relative path support

File does not exist

LocalNetworksConfig interface

Tests

pumpurum2 commented Nov 6, 2021

nkuba commented Nov 6, 2021

facuspagnuolo commented Nov 9, 2021

facuspagnuolo left a comment

Choose a reason for hiding this comment

facuspagnuolo Nov 9, 2021

Choose a reason for hiding this comment

facuspagnuolo Nov 9, 2021

Choose a reason for hiding this comment

facuspagnuolo Nov 9, 2021

Choose a reason for hiding this comment

facuspagnuolo Nov 9, 2021

Choose a reason for hiding this comment

facuspagnuolo Nov 9, 2021

Choose a reason for hiding this comment

facuspagnuolo Nov 9, 2021

Choose a reason for hiding this comment

`LocalNetworksConfig` interface