Fixes deployment scripts and unit tests

Author: acenolaza

README.md

@@ -111,9 +111,10 @@ The `NETWORK` variable should be set to a chain name as defined by `@api3/contra
 - **`NormalizedApi3ReaderProxyV1`**:
   - `NETWORK`: Target network name.
   - `FEED`: Address of the external data feed (e.g., a Chainlink `AggregatorV2V3Interface` compatible feed).
+  - `DAPP_ID`: The dApp ID to associate with this proxy.
   - Example:
     ```bash
-    NETWORK=polygon FEED=0xExternalFeedAddress pnpm deploy:NormalizedApi3ReaderProxyV1
+    NETWORK=polygon FEED=0xExternalFeedAddress DAPP_ID=YourDappId pnpm deploy:NormalizedApi3ReaderProxyV1
     ```
 
 - **`ProductApi3ReaderProxyV1`**:
@@ -183,13 +184,13 @@ Imagine your dApp requires a USD/ETH price feed with 8 decimal places, but the a
 1.  **Deploy `InverseApi3ReaderProxyV1`**:
     - Input `PROXY`: Address of the ETH/USD `IApi3ReaderProxy` dAPI.
     - Output: An `IApi3ReaderProxy` contract. This deployed instance of `InverseApi3ReaderProxyV1` reads USD/ETH.
-    - Example command: `NETWORK=your_network PROXY=0xAddressOfEthUsdDapi pnpm deploy:InverseApi3ReaderProxyV1`
+    - Example command: `NETWORK=base PROXY=0xAddressOfEthUsdDapi pnpm deploy:InverseApi3ReaderProxyV1`
 
 2.  **Deploy `ScaledApi3FeedProxyV1`**:
     - Input `PROXY`: Address of the `InverseApi3ReaderProxyV1` instance deployed in step 1.
     - Input `DECIMALS`: `8`.
     - Output: An `AggregatorV2V3Interface` contract. This deployed instance of `ScaledApi3FeedProxyV1` reads USD/ETH scaled to 8 decimals.
-    - Example command: `NETWORK=your_network PROXY=0xAddressOfDeployedInverseApi3ReaderProxyV1FromStep1 DECIMALS=8 pnpm deploy:ScaledApi3FeedProxyV1`
+    - Example command: `NETWORK=base PROXY=0xAddressOfDeployedInverseApi3ReaderProxyV1FromStep1 DECIMALS=8 pnpm deploy:ScaledApi3FeedProxyV1`
       _Note: Replace `0xAddressOfDeployedInverseApi3ReaderProxyV1FromStep1` with the actual address obtained from the deployment artifact of step 1._
 
 This pipeline successfully provides the dApp with the required USD/ETH feed at the desired precision and interface.
@@ -229,16 +230,17 @@ To derive the desired uStETH/USD feed and make it compatible with the Api3 ecosy
 1.  **Deploy `NormalizedApi3ReaderProxyV1`**:
     - This step adapts the external uStETH/ETH feed, which implements the `AggregatorV2V3Interface`, to the `IApi3ReaderProxy` interface. A key function of `NormalizedApi3ReaderProxyV1` is to read the `decimals()` from the external feed and automatically scale its value to the 18 decimal places expected by the `IApi3ReaderProxy` interface. For instance, if the uStETH/ETH feed returns its value with a different precision (e.g., 8 or 36 decimals), this proxy will normalize it.
     - Input `FEED`: Address of the external uStETH/ETH `AggregatorV2V3Interface` feed.
+    - Input `DAPP_ID`: The dApp ID to associate with this proxy.
     - Output: An `IApi3ReaderProxy` contract. This deployed instance of `NormalizedApi3ReaderProxyV1` reads uStETH/ETH, with its value normalized to 18 decimals.
-    - Example command: `NETWORK=your_network FEED=0xAddressOfExternal_uStETH_ETH_Feed pnpm deploy:NormalizedApi3ReaderProxyV1`
+    - Example command: `NETWORK=base FEED=0xAddressOfExternal_uStETH_ETH_Feed DAPP_ID=YourDappId pnpm deploy:NormalizedApi3ReaderProxyV1`
 
 2.  **Deploy `ProductApi3ReaderProxyV1` to calculate uStETH/USD**:
     - This step multiplies the normalized uStETH/ETH rate by the ETH/USD rate from the Api3 dAPI.
     - Input `PROXY1`: Address of the `NormalizedApi3ReaderProxyV1` instance deployed in step 1.
     - Input `PROXY2`: Address of the existing ETH/USD `IApi3ReaderProxy` dAPI.
     - Output: An `IApi3ReaderProxy` contract. This deployed instance of `ProductApi3ReaderProxyV1` reads uStETH/USD.
       - Calculation: `(uStETH/ETH) * (ETH/USD) = uStETH/USD`.
-    - Example command: `NETWORK=your_network PROXY1=0xAddressOfDeployedNormalizedApi3ReaderProxyV1FromStep1 PROXY2=0xAddressOfApi3EthUsdDapi pnpm deploy:ProductApi3ReaderProxyV1`
+    - Example command: `NETWORK=base PROXY1=0xAddressOfDeployedNormalizedApi3ReaderProxyV1FromStep1 PROXY2=0xAddressOfApi3EthUsdDapi pnpm deploy:ProductApi3ReaderProxyV1`
       _(Note: Replace `0xAddressOfDeployedNormalizedApi3ReaderProxyV1FromStep1` with the actual address obtained from the deployment artifact of step 1)._
 
 This scenario highlights how `NormalizedApi3ReaderProxyV1` serves as a crucial bridge, enabling dApps to integrate valuable data from external sources (that may not meet Api3 dAPI listing criteria or are simply outside the current offerings) and combine it with trusted Api3 dAPIs using the standard set of combinator tools.

contracts/test/AccessControlRegistry.sol

@@ -0,0 +1,56 @@
+// SPDX-License-Identifier: MIT
+pragma solidity 0.8.27;
+
+import {
+    IApi3ReaderProxyV1
+} from "@api3/contracts/api3-server-v1/proxies/interfaces/IApi3ReaderProxyV1.sol";
+
+/// @title A mock contract for IApi3ReaderProxyV1
+/// @dev This mock implements the minimal functions required for testing the
+/// data-feed-proxy-combinators contracts. Other functions will revert.
+contract MockApi3ReaderProxyV1 is IApi3ReaderProxyV1 {
+    /// @notice The dApp ID of the mock proxy.
+    uint256 public immutable override dappId;
+    /// @notice The mock value to be returned by read().
+    int224 private _value;
+    /// @notice The mock timestamp to be returned by read().
+    uint32 private _timestamp;
+
+    constructor(uint256 dappId_, int224 value_, uint32 timestamp_) {
+        dappId = dappId_;
+        _value = value_;
+        _timestamp = timestamp_;
+    }
+
+    function read() public view override returns (int224, uint32) {
+        return (_value, _timestamp);
+    }
+
+    function update(int224 value, uint32 timestamp) external {
+        _value = value;
+        _timestamp = timestamp;
+    }
+
+    // --- Stubbed functions from IApi3ReaderProxyV1 that are not used by combinators ---
+
+    function initialize(address) external pure override {
+        revert("Mock: Not implemented");
+    }
+
+    function api3ServerV1() external pure override returns (address) {
+        revert("Mock: Not implemented");
+    }
+
+    function api3ServerV1OevExtension()
+        external
+        pure
+        override
+        returns (address)
+    {
+        revert("Mock: Not implemented");
+    }
+
+    function dapiName() external pure override returns (bytes32) {
+        revert("Mock: Not implemented");
+    }
+}

contracts/test/Api3ReaderProxyV1.sol

@@ -1,9 +1,24 @@
 import type { HardhatRuntimeEnvironment } from 'hardhat/types';
+import type { DeploymentsExtension } from 'hardhat-deploy/types';
 
 import { getDeploymentName } from '../src';
+import * as testUtils from '../test/test-utils';
 
 export const CONTRACT_NAME = 'InverseApi3ReaderProxyV1';
 
+const deployMockApi3ReaderProxyV1 = async (deployments: DeploymentsExtension, deployerAddress: string) => {
+  const { address } = await deployments.deploy('MockApi3ReaderProxyV1', {
+    from: deployerAddress,
+    args: [
+      testUtils.generateRandomBytes32(), // A mock dappId
+      '2000000000000000000000', // A mock value (2000e18)
+      Math.floor(Date.now() / 1000), // A mock timestamp
+    ],
+    log: true,
+  });
+  return address;
+};
+
 module.exports = async (hre: HardhatRuntimeEnvironment) => {
   const { getUnnamedAccounts, deployments, ethers, network, run } = hre;
   const { deploy, log } = deployments;
@@ -14,7 +29,11 @@ module.exports = async (hre: HardhatRuntimeEnvironment) => {
   }
   log(`Deployer address: ${deployerAddress}`);
 
-  const proxyAddress = process.env.PROXY;
+  const isLocalNetwork = network.name === 'hardhat' || network.name === 'localhost';
+
+  const proxyAddress = isLocalNetwork
+    ? await deployMockApi3ReaderProxyV1(deployments, deployerAddress)
+    : process.env.PROXY;
   if (!proxyAddress) {
     throw new Error('PROXY environment variable not set. Please provide the address of the proxy contract.');
   }
@@ -23,7 +42,7 @@ module.exports = async (hre: HardhatRuntimeEnvironment) => {
   }
   log(`Proxy address: ${proxyAddress}`);
 
-  const isLocalNetwork = network.name === 'hardhat' || network.name === 'localhost';
+  // TODO: check that proxyAddress returns a dappId
 
   const confirmations = isLocalNetwork ? 1 : 5;
   log(`Deployment confirmations: ${confirmations}`);

contracts/test/Api3ServerV1.sol

@@ -2,18 +2,21 @@ import type { HardhatRuntimeEnvironment } from 'hardhat/types';
 import type { DeploymentsExtension } from 'hardhat-deploy/types';
 
 import { getDeploymentName } from '../src';
+import * as testUtils from '../test/test-utils';
 
 export const CONTRACT_NAME = 'NormalizedApi3ReaderProxyV1';
 
-const deployTestFeed = async (deployments: DeploymentsExtension, deployerAddress: string) => {
-  const { address: scaledApi3FeedProxyV1Address } = await deployments.get('ScaledApi3FeedProxyV1').catch(async () => {
-    return deployments.deploy('ScaledApi3FeedProxyV1', {
-      from: deployerAddress,
-      args: ['0x5b0cf2b36a65a6BB085D501B971e4c102B9Cd473', 8],
-      log: true,
-    });
+const deployMockAggregatorV2V3 = async (deployments: DeploymentsExtension, deployerAddress: string) => {
+  const { address } = await deployments.deploy('MockAggregatorV2V3', {
+    from: deployerAddress,
+    args: [
+      8, // A mock decimals
+      '25000000', // A mock value (0.25e8)
+      Math.floor(Date.now() / 1000), // A mock timestamp
+    ],
+    log: true,
   });
-  return scaledApi3FeedProxyV1Address;
+  return address;
 };
 
 module.exports = async (hre: HardhatRuntimeEnvironment) => {
@@ -26,8 +29,9 @@ module.exports = async (hre: HardhatRuntimeEnvironment) => {
   }
   log(`Deployer address: ${deployerAddress}`);
 
-  const feedAddress =
-    network.name === 'hardhat' ? await deployTestFeed(deployments, deployerAddress) : process.env.FEED;
+  const isLocalNetwork = network.name === 'hardhat' || network.name === 'localhost';
+
+  const feedAddress = isLocalNetwork ? await deployMockAggregatorV2V3(deployments, deployerAddress) : process.env.FEED;
   if (!feedAddress) {
     throw new Error(
       'FEED environment variable not set. Please provide the address of the AggregatorV2V3Interface contract.'
@@ -38,13 +42,20 @@ module.exports = async (hre: HardhatRuntimeEnvironment) => {
   }
   log(`Feed address: ${feedAddress}`);
 
-  const isLocalNetwork = network.name === 'hardhat' || network.name === 'localhost';
+  const dappId = isLocalNetwork ? testUtils.generateRandomBytes32() : process.env.DAPP_ID;
+  if (!dappId) {
+    throw new Error('DAPP_ID environment variable not set. Please provide the dApp ID.');
+  }
+  if (!ethers.isHexString(dappId, 32)) {
+    throw new Error(`Invalid dApp ID provided: ${dappId}`);
+  }
+  log(`dApp ID: ${dappId}`);
 
   const confirmations = isLocalNetwork ? 1 : 5;
   log(`Deployment confirmations: ${confirmations}`);
 
-  const constructorArgs = [feedAddress];
-  const constructorArgTypes = ['address'];
+  const constructorArgs = [feedAddress, dappId];
+  const constructorArgTypes = ['address', 'uint256'];
 
   const deploymentName = getDeploymentName(CONTRACT_NAME, constructorArgTypes, constructorArgs);
   log(`Generated deterministic deployment name for this instance: ${deploymentName}`);

contracts/test/Api3ServerV1OevExtension.sol

@@ -1,9 +1,28 @@
 import type { HardhatRuntimeEnvironment } from 'hardhat/types';
+import type { DeploymentsExtension } from 'hardhat-deploy/types';
 
 import { getDeploymentName } from '../src';
+import * as testUtils from '../test/test-utils';
 
 export const CONTRACT_NAME = 'ProductApi3ReaderProxyV1';
 
+const deployMockApi3ReaderProxyV1 = async (
+  deployments: DeploymentsExtension,
+  deployerAddress: string,
+  dappId: string
+) => {
+  const { address } = await deployments.deploy('MockApi3ReaderProxyV1', {
+    from: deployerAddress,
+    args: [
+      dappId,
+      '2000000000000000000000', // A mock value (2000e18)
+      Math.floor(Date.now() / 1000), // A mock timestamp
+    ],
+    log: true,
+  });
+  return address;
+};
+
 module.exports = async (hre: HardhatRuntimeEnvironment) => {
   const { getUnnamedAccounts, deployments, ethers, network, run } = hre;
   const { deploy, log } = deployments;
@@ -14,7 +33,12 @@ module.exports = async (hre: HardhatRuntimeEnvironment) => {
   }
   log(`Deployer address: ${deployerAddress}`);
 
-  const proxy1Address = process.env.PROXY1;
+  const isLocalNetwork = network.name === 'hardhat' || network.name === 'localhost';
+
+  const dappId = testUtils.generateRandomBytes32();
+  const proxy1Address = isLocalNetwork
+    ? await deployMockApi3ReaderProxyV1(deployments, deployerAddress, dappId)
+    : process.env.PROXY1;
   if (!proxy1Address) {
     throw new Error('PROXY1 environment variable not set. Please provide the address of the first proxy contract.');
   }
@@ -23,7 +47,14 @@ module.exports = async (hre: HardhatRuntimeEnvironment) => {
   }
   log(`Proxy 1 address: ${proxy1Address}`);
 
-  const proxy2Address = process.env.PROXY2;
+  // Sleep for 1 sec when deploying to local network in order to generate a different proxy address
+  if (isLocalNetwork) {
+    await new Promise((resolve) => setTimeout(resolve, 1000));
+  }
+
+  const proxy2Address = isLocalNetwork
+    ? await deployMockApi3ReaderProxyV1(deployments, deployerAddress, dappId)
+    : process.env.PROXY2;
   if (!proxy2Address) {
     throw new Error('PROXY2 environment variable not set. Please provide the address of the second proxy contract.');
   }
@@ -32,8 +63,6 @@ module.exports = async (hre: HardhatRuntimeEnvironment) => {
   }
   log(`Proxy 2 address: ${proxy2Address}`);
 
-  const isLocalNetwork = network.name === 'hardhat' || network.name === 'localhost';
-
   const confirmations = isLocalNetwork ? 1 : 5;
   log(`Deployment confirmations: ${confirmations}`);
 

contracts/test/MockApi3ReaderProxyV1.sol

@@ -2,20 +2,21 @@ import type { HardhatRuntimeEnvironment } from 'hardhat/types';
 import type { DeploymentsExtension } from 'hardhat-deploy/types';
 
 import { getDeploymentName } from '../src';
+import * as testUtils from '../test/test-utils';
 
 export const CONTRACT_NAME = 'ScaledApi3FeedProxyV1';
 
-const deployTestProxy = async (deployments: DeploymentsExtension, deployerAddress: string) => {
-  const { address: inverseApi3ReaderProxyV1Address } = await deployments
-    .get('InverseApi3ReaderProxyV1')
-    .catch(async () => {
-      return deployments.deploy('InverseApi3ReaderProxyV1', {
-        from: deployerAddress,
-        args: ['0x5b0cf2b36a65a6BB085D501B971e4c102B9Cd473'],
-        log: true,
-      });
-    });
-  return inverseApi3ReaderProxyV1Address;
+const deployMockApi3ReaderProxyV1 = async (deployments: DeploymentsExtension, deployerAddress: string) => {
+  const { address } = await deployments.deploy('MockApi3ReaderProxyV1', {
+    from: deployerAddress,
+    args: [
+      testUtils.generateRandomBytes32(), // A mock dappId
+      '2000000000000000000000', // A mock value (2000e18)
+      Math.floor(Date.now() / 1000), // A mock timestamp
+    ],
+    log: true,
+  });
+  return address;
 };
 
 module.exports = async (hre: HardhatRuntimeEnvironment) => {
@@ -34,8 +35,11 @@ module.exports = async (hre: HardhatRuntimeEnvironment) => {
   const decimals = Number.parseInt(process.env.DECIMALS, 10);
   log(`Decimals: ${decimals}`);
 
-  const proxyAddress =
-    network.name === 'hardhat' ? await deployTestProxy(deployments, deployerAddress) : process.env.PROXY;
+  const isLocalNetwork = network.name === 'hardhat' || network.name === 'localhost';
+
+  const proxyAddress = isLocalNetwork
+    ? await deployMockApi3ReaderProxyV1(deployments, deployerAddress)
+    : process.env.PROXY;
   if (!proxyAddress) {
     throw new Error('PROXY environment variable not set. Please provide the address of the Api3ReaderProxy contract.');
   }
@@ -44,8 +48,6 @@ module.exports = async (hre: HardhatRuntimeEnvironment) => {
   }
   log(`Proxy address: ${proxyAddress}`);
 
-  const isLocalNetwork = network.name === 'hardhat' || network.name === 'localhost';
-
   const confirmations = isLocalNetwork ? 1 : 5;
   log(`Deployment confirmations: ${confirmations}`);