fix(toolshed): address book path resolution

Signed-off-by: Tomás Migone <tomas@edgeandnode.com>

Author: tmigone

packages/toolshed/src/deployments/horizon/index.ts

@@ -19,8 +19,7 @@ export function loadGraphHorizon(addressBookPath: string, chainId: number, provi
 }
 
 export function connectGraphHorizon(chainId: number, signerOrProvider: Signer | Provider, addressBookPath?: string) {
-  addressBookPath =
-    addressBookPath ?? resolveAddressBook(require, '@graphprotocol/address-book', 'horizon/addresses.json')
+  addressBookPath = addressBookPath ?? resolveAddressBook(require, '@graphprotocol/address-book/horizon/addresses.json')
   if (!addressBookPath) {
     throw new Error('Address book path not found')
   }

packages/toolshed/src/deployments/subgraph-service/index.ts

@@ -20,7 +20,7 @@ export function loadSubgraphService(addressBookPath: string, chainId: number, pr
 
 export function connectSubgraphService(chainId: number, signerOrProvider: Signer | Provider, addressBookPath?: string) {
   addressBookPath =
-    addressBookPath ?? resolveAddressBook(require, '@graphprotocol/address-book', 'subgraph-service/addresses.json')
+    addressBookPath ?? resolveAddressBook(require, '@graphprotocol/address-book/subgraph-service/addresses.json')
   if (!addressBookPath) {
     throw new Error('Address book path not found')
   }

packages/toolshed/src/hardhat/hardhat.base.config.ts

@@ -87,18 +87,26 @@ export const networksUserConfig = function (callerRequire: typeof require): Base
         mnemonic: 'myth like bonus scare over problem client lizard pioneer submit female collect',
       },
       deployments: {
-        horizon: resolveAddressBook(callerRequire, '@graphprotocol/horizon', 'addresses-hardhat.json'),
-        subgraphService: resolveAddressBook(callerRequire, '@graphprotocol/subgraph-service', 'addresses-hardhat.json'),
+        horizon: resolveAddressBook(callerRequire, '@graphprotocol/horizon/addresses.json', 'addresses-hardhat.json'),
+        subgraphService: resolveAddressBook(
+          callerRequire,
+          '@graphprotocol/subgraph-service/addresses.json',
+          'addresses-hardhat.json',
+        ),
       },
     },
     localNetwork: {
       chainId: 1337,
       url: LOCAL_NETWORK_RPC,
       deployments: {
-        horizon: resolveAddressBook(callerRequire, '@graphprotocol/horizon', 'addresses-local-network.json'),
+        horizon: resolveAddressBook(
+          callerRequire,
+          '@graphprotocol/horizon/addresses.json',
+          'addresses-local-network.json',
+        ),
         subgraphService: resolveAddressBook(
           callerRequire,
-          '@graphprotocol/subgraph-service',
+          '@graphprotocol/subgraph-service/addresses.json',
           'addresses-local-network.json',
         ),
       },
@@ -110,10 +118,10 @@ export const networksUserConfig = function (callerRequire: typeof require): Base
         enabled: true,
       },
       deployments: {
-        horizon: resolveAddressBook(callerRequire, '@graphprotocol/horizon', 'addresses-localhost.json'),
+        horizon: resolveAddressBook(callerRequire, '@graphprotocol/horizon/addresses.json', 'addresses-localhost.json'),
         subgraphService: resolveAddressBook(
           callerRequire,
-          '@graphprotocol/subgraph-service',
+          '@graphprotocol/subgraph-service/addresses.json',
           'addresses-localhost.json',
         ),
       },
@@ -148,8 +156,8 @@ export const hardhatBaseConfig = function (callerRequire: typeof require): BaseH
     networks: networksUserConfig(callerRequire),
     graph: {
       deployments: {
-        horizon: resolveAddressBook(callerRequire, '@graphprotocol/horizon'),
-        subgraphService: resolveAddressBook(callerRequire, '@graphprotocol/subgraph-service'),
+        horizon: resolveAddressBook(callerRequire, '@graphprotocol/horizon/addresses.json'),
+        subgraphService: resolveAddressBook(callerRequire, '@graphprotocol/subgraph-service/addresses.json'),
       },
     },
     etherscan: etherscanUserConfig,

packages/toolshed/src/lib/resolve.ts

@@ -1,21 +1,47 @@
 import path from 'path'
 
 /**
- * Use to get a resolved path to an address book file wether it exists or not
- * If addresses.json does not exist in the package root, returns undefined
- * @param callerRequire - The require function to use
- * @param packageName - The name of the package to resolve the address book for
- * @param addressBook - The name of the address book file to resolve
- * @returns The resolved path to the address book file
+ * Resolves the absolute path to an address book file relative to an existing file.
+ *
+ * This function uses `require.resolve` (from the caller's context) on the provided
+ * `existingAddressBookPath` to locate a known file (e.g., an existing address book JSON file).
+ * Once located, it returns the absolute path to the desired `addressBookPath`, which is resolved
+ * relative to the directory of the existing file.
+ *
+ * If the existing file cannot be resolved, the function returns `undefined`.
+ *
+ * This is useful when:
+ * - You know the location of one file in a package or module.
+ * - You need the path to another file in the same directory (or nearby), whether or not it exists.
+ *
+ * ## Examples
+ *
+ * ```ts
+ * // Example 1: Resolve a different file in the same folder
+ * // Locates: <node_modules>/@graphprotocol/horizon/addresses.json
+ * // Returns: <node_modules>/@graphprotocol/horizon/addresses-hardhat.json
+ * resolveAddressBook(require, 'addresses.json', 'addresses-hardhat.json')
+ * ```
+ *
+ * ```ts
+ * // Example 2: Resolve the same file you use for lookup
+ * // Locates and returns: <node_modules>/@graphprotocol/address-book/horizon/addresses.json
+ * resolveAddressBook(require, '@graphprotocol/address-book/horizon/addresses.json')
+ * ```
+ *
+ * @param callerRequire - The `require` function from the calling module, used for resolution relative to the caller.
+ * @param existingAddressBookPath - A resolvable path to an existing file (relative to the caller), used as an anchor. Defaults to `"addresses.json"`.
+ * @param addressBookPath - The path (relative to the anchor's directory) to the file you want returned. Defaults to `"addresses.json"`.
+ * @returns The absolute path to the requested file, or `undefined` if the existing file cannot be resolved.
  */
 export function resolveAddressBook(
   callerRequire: typeof require,
-  packageName: string,
-  addressBook?: string,
+  existingAddressBookPath: string = 'addresses.json',
+  addressBookPath: string = 'addresses.json',
 ): string | undefined {
   try {
-    const packageRoot = path.dirname(callerRequire.resolve(`${packageName}/addresses.json`))
-    return path.join(packageRoot, addressBook ?? 'addresses.json')
+    const packageRoot = path.dirname(callerRequire.resolve(`${existingAddressBookPath}`))
+    return path.join(packageRoot, addressBookPath)
   } catch (_) {
     return undefined
   }