Update Data Streams examples (smartcontractkit#1631)

* Update Data Streams examples

* Edits

* Edits

* Edits

* Comments and eip-3688 info

* reportContextData

* Add storage variable for retrieved price

* Edits and comments

* Edits

* Update stream IDs and verifier addresses

Author: dwightjl

public/samples/DataStreams/StreamsUpkeep.sol

@@ -1,54 +1,43 @@
 // SPDX-License-Identifier: MIT
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.16;
 
-interface StreamsLookupCompatibleInterface {
-    error StreamsLookup(
-        string feedParamKey,
-        string[] feeds,
-        string timeParamKey,
-        uint256 time,
-        bytes extraData
-    );
+import {Common} from "@chainlink/contracts/src/v0.8/libraries/Common.sol";
+import {StreamsLookupCompatibleInterface} from "@chainlink/contracts/src/v0.8/automation/interfaces/StreamsLookupCompatibleInterface.sol";
+import {ILogAutomation, Log} from "@chainlink/contracts/src/v0.8/automation/interfaces/ILogAutomation.sol";
+import {IRewardManager} from "@chainlink/contracts/src/v0.8/llo-feeds/interfaces/IRewardManager.sol";
+import {IVerifierFeeManager} from "@chainlink/contracts/src/v0.8/llo-feeds/interfaces/IVerifierFeeManager.sol";
+import {IERC20} from "@chainlink/contracts/src/v0.8/vendor/openzeppelin-solidity/v4.8.0/contracts/interfaces/IERC20.sol";
 
-    function checkCallback(
-        bytes[] memory values,
-        bytes memory extraData
-    ) external view returns (bool upkeepNeeded, bytes memory performData);
-}
-
-interface ILogAutomation {
-    function checkLog(
-        Log calldata log,
-        bytes memory checkData
-    ) external returns (bool upkeepNeeded, bytes memory performData);
-
-    function performUpkeep(bytes calldata performData) external;
-}
-
-struct Log {
-    uint256 index;
-    uint256 timestamp;
-    bytes32 txHash;
-    uint256 blockNumber;
-    bytes32 blockHash;
-    address source;
-    bytes32[] topics;
-    bytes data;
-}
+/**
+ * THIS IS AN EXAMPLE CONTRACT THAT USES UN-AUDITED CODE FOR DEMONSTRATION PURPOSES.
+ * DO NOT USE THIS CODE IN PRODUCTION.
+ */
 
+// Custom interfaces for IVerifierProxy and IFeeManager
 interface IVerifierProxy {
     function verify(
-        bytes memory signedReport
+        bytes calldata payload,
+        bytes calldata parameterPayload
     ) external payable returns (bytes memory verifierResponse);
+
+    function s_feeManager() external view returns (IVerifierFeeManager);
 }
 
-interface IReportHandler {
-    function handleReport(bytes calldata report) external;
+interface IFeeManager {
+    function getFeeAndReward(
+        address subscriber,
+        bytes memory unverifiedReport,
+        address quoteAddress
+    ) external returns (Common.Asset memory, Common.Asset memory, uint256);
+
+    function i_linkAddress() external view returns (address);
+
+    function i_nativeAddress() external view returns (address);
+
+    function i_rewardManager() external view returns (address);
 }
 
 contract StreamsUpkeep is ILogAutomation, StreamsLookupCompatibleInterface {
-    IVerifierProxy public verifier;
-
     struct BasicReport {
         bytes32 feedId; // The feed ID the report has data for
         uint32 validFromTimestamp; // Earliest timestamp for which price is applicable
@@ -75,100 +64,99 @@ contract StreamsUpkeep is ILogAutomation, StreamsLookupCompatibleInterface {
         address quoteAddress;
     }
 
-    event ReportVerified(BasicReport indexed report);
-    event PriceUpdate(int192 price);
+    event PriceUpdate(int192 indexed price);
+
+    IVerifierProxy public verifier;
+
+    address public FEE_ADDRESS;
+    string public constant DATASTREAMS_FEEDLABEL = "feedIDs";
+    string public constant DATASTREAMS_QUERYLABEL = "timestamp";
+    int192 public last_retrieved_price;
 
-    address public immutable FEE_ADDRESS;
-    string public constant STRING_DATASTREAMS_FEEDLABEL = "feedIDs";
-    string public constant STRING_DATASTREAMS_QUERYLABEL = "timestamp";
-    string[] public feedsHex = [
-        "0x00023496426b520583ae20a66d80484e0fc18544866a5b0bfee15ec771963274"
+    // This example reads the ID for the basic ETH/USD price report on Arbitrum Sepolia.
+    // Find a complete list of IDs at https://docs.chain.link/data-streams/stream-ids
+    string[] public feedIds = [
+        "0x00027bbaff688c906a3e20a34fe951715d1018d262a5b66e38eda027a674cd1b"
     ];
 
-    constructor(address _feeAddress, address _verifier) {
-        verifier = IVerifierProxy(_verifier); //0x2ff010DEbC1297f19579B4246cad07bd24F2488A
-        FEE_ADDRESS = _feeAddress; // 0xe39Ab88f8A4777030A534146A9Ca3B52bd5D43A3 (WETH)
+    constructor(address _verifier) {
+        verifier = IVerifierProxy(_verifier);
     }
 
+    // This function uses revert to convey call information.
+    // See https://eips.ethereum.org/EIPS/eip-3668#rationale for details.
     function checkLog(
         Log calldata log,
         bytes memory
-    ) external view returns (bool upkeepNeeded, bytes memory performData) {
+    ) external returns (bool upkeepNeeded, bytes memory performData) {
         revert StreamsLookup(
-            STRING_DATASTREAMS_FEEDLABEL,
-            feedsHex,
-            STRING_DATASTREAMS_QUERYLABEL,
+            DATASTREAMS_FEEDLABEL,
+            feedIds,
+            DATASTREAMS_QUERYLABEL,
             log.timestamp,
             ""
         );
     }
 
+    // The Data Streams report bytes is passed here.
+    // extraData is context data from feed lookup process.
+    // Your contract may include logic to further process this data.
+    // This method is intended only to be simulated off-chain by Automation.
+    // The data returned will then be passed by Automation into performUpkeep
     function checkCallback(
         bytes[] calldata values,
         bytes calldata extraData
     ) external pure returns (bool, bytes memory) {
         return (true, abi.encode(values, extraData));
     }
 
-    function performUpkeep(bytes calldata performData) external override {
+    // function will be performed on-chain
+    function performUpkeep(bytes calldata performData) external {
+        // Decode the performData bytes passed in by CL Automation.
+        // This contains the data returned by your implementation in checkCallback().
         (bytes[] memory signedReports, bytes memory extraData) = abi.decode(
             performData,
             (bytes[], bytes)
         );
 
-        bytes memory report = signedReports[0];
+        bytes memory unverifiedReport = signedReports[0];
 
-        bytes memory bundledReport = bundleReport(report);
+        (, /* bytes32[3] reportContextData */ bytes memory reportData) = abi
+            .decode(unverifiedReport, (bytes32[3], bytes));
 
-        BasicReport memory unverifiedReport = _getReportData(report);
+        // Report verification fees
+        IFeeManager feeManager = IFeeManager(address(verifier.s_feeManager()));
+        IRewardManager rewardManager = IRewardManager(
+            address(feeManager.i_rewardManager())
+        );
 
-        bytes memory verifiedReportData = verifier.verify{
-            value: unverifiedReport.nativeFee
-        }(bundledReport);
-        BasicReport memory verifiedReport = abi.decode(
-            verifiedReportData,
-            (BasicReport)
+        address feeTokenAddress = feeManager.i_linkAddress();
+        (Common.Asset memory fee, , ) = feeManager.getFeeAndReward(
+            address(this),
+            reportData,
+            feeTokenAddress
         );
 
-        emit PriceUpdate(verifiedReport.price);
-    }
+        // Approve rewardManager to spend this contract's balance in fees
+        IERC20(feeTokenAddress).approve(address(rewardManager), fee.amount);
 
-    function bundleReport(
-        bytes memory report
-    ) internal view returns (bytes memory) {
-        Quote memory quote;
-        quote.quoteAddress = FEE_ADDRESS;
-        (
-            bytes32[3] memory reportContext,
-            bytes memory reportData,
-            bytes32[] memory rs,
-            bytes32[] memory ss,
-            bytes32 raw
-        ) = abi.decode(
-                report,
-                (bytes32[3], bytes, bytes32[], bytes32[], bytes32)
-            );
-        bytes memory bundledReport = abi.encode(
-            reportContext,
-            reportData,
-            rs,
-            ss,
-            raw,
-            abi.encode(quote)
+        // Verify the report
+        bytes memory verifiedReportData = verifier.verify(
+            unverifiedReport,
+            abi.encode(feeTokenAddress)
         );
-        return bundledReport;
-    }
 
-    function _getReportData(
-        bytes memory signedReport
-    ) internal pure returns (BasicReport memory) {
-        (, bytes memory reportData, , , ) = abi.decode(
-            signedReport,
-            (bytes32[3], bytes, bytes32[], bytes32[], bytes32)
+        // Decode verified report data into BasicReport struct
+        BasicReport memory verifiedReport = abi.decode(
+            verifiedReportData,
+            (BasicReport)
         );
 
-        BasicReport memory report = abi.decode(reportData, (BasicReport));
-        return report;
+        // Log price from report
+        emit PriceUpdate(verifiedReport.price);
+
+        // Store the price from the report
+        last_retrieved_price = verifiedReport.price;
     }
 
     fallback() external payable {}

src/features/data-streams/common/gettingStarted.mdx

@@ -26,22 +26,24 @@ Read data from a Data Stream and validate the answer on-chain. This example uses
 
 ## Deploy the Chainlink Automation upkeep
 
-Deploy an upkeep that is enabled to retrieve data from Data Streams. For this example, you will read from the ETH/USD stream with ID `0x00023496426b520583ae20a66d80484e0fc18544866a5b0bfee15ec771963274` on Arbitrum Sepolia. For a complete list of available assets, IDs, and verifier proxy addresses, see the [Stream Identifiers](/data-streams/stream-ids) page.
+Deploy an upkeep that is enabled to retrieve data from Data Streams. For this example, you will read from the ETH/USD stream with ID `0x00027bbaff688c906a3e20a34fe951715d1018d262a5b66e38eda027a674cd1b` on Arbitrum Sepolia. For a complete list of available assets, IDs, and verifier proxy addresses, see the [Stream Identifiers](/data-streams/stream-ids) page.
 
 1. Select the Arbitrum Sepolia network in MetaMask.
 
 1. Open the example upkeep in Remix.
 
    <CodeSample src="samples/DataStreams/StreamsUpkeep.sol" showButtonOnly />
 
-1. Compile the contract.
+1. In the **Solidity Compiler** tab, select the `0.8.16` Solidity compiler and the `StreamsUpkeep` contract.
+
+1. Compile the contract. You can ignore the warning messages for this example.
 
 1. In the **Deploy & Run** tab, select **Injected Provider** as your Environment. For this example, you should be using Arbitrum Sepolia.
 
 1. Deploy the contract with the following constructor variables:
 
    - **FeeAddress (WETH)**: `0xe39Ab88f8A4777030A534146A9Ca3B52bd5D43A3`
-   - **VerifierAddress**: `0xea9B98Be000FBEA7f6e88D08ebe70EbaAD10224c`
+   - **VerifierAddress**: `0x2ff010DEbC1297f19579B4246cad07bd24F2488A`
 
 1. Record the contract address.
 
@@ -87,34 +89,26 @@ Now you can use your emitter contract to emit a log and initiate the upkeep, whi
 
 1. Go to [sepolia.arbiscan.io](https://sepolia.arbiscan.io/).
 
-1. Use the search to find your emitter contract using the address you saved earlier.
-
-1. Click the **Contract** tab to view the contract.
-
-1. Click the **Write Contract** button to find the `emitLog` function.
+1. Under the **Deployed Contracts** list, click the **emitLog** button to run the function and emit a log. MetaMask prompts you to accept the transaction.
 
-1. Click **Connect to Web3** to connect your wallet to Arbiscan. This allows you to run write functions in Arbiscan. MetaMask will prompt you to accept the connection.
+After the transaction is complete, the log is emitted and the upkeep is triggered. You can find the upkeep transaction hash at [Chainlink Automation UI](https://automation.chain.link/arbitrum-sepolia). Check to make sure the transaction is successful.
 
-1. Click the `emitLog` function to expand the function details.
+## View the retrieved price
 
-1. Click the **Write** button to execute the function that will emit the log. MetaMask prompts you to accept the transaction.
+The retrieved price is stored as a variable in the contract and is also emitted in the logs.
 
-After the transaction is complete, the log is emitted and the upkeep is triggered. You can see the retrieved data on your upkeep.
+1. In Remix, go to the **Deploy & Run** tab.
 
-## View the upkeep
+1. Under the **Deployed Contracts**, find the deployed upkeep contract and view the variables.
 
-View the upkeep and check the on-chain verification.
+1. Click the `last_retrieved_price` variable to view the retrieved price.
 
-1. Go to the [Chainlink Automation UI](https://automation.chain.link/arbitrum-sepolia) for Arbitrum Sepolia.
-
-1. On your list of upkeeps, click the upkeep that you crated for this guide. The upkeep details open with a list of upkeeps that were performed. You should see your log triggered upkeep on this list.
-
-1. Click the transaction hash for the upkeep to view the transaction in Arbiscan.
-
-1. On the **Logs** tab for your transaction, you will see that the `performUpkeep` function emitted the price from the verified report.
+Alternatively, you can view the price emitted in the logs for your upkeep transaction. You can find the upkeep transaction hash at [Chainlink Automation UI](https://automation.chain.link/arbitrum-sepolia) and view the logs in the explorer.
 
 ## Examine the code
 
 The example code that you deployed has all of the interfaces and functions required to work with Chainlink Automation as an upkeep contract. It follows a similar flow to the trading flow in the [Architecture](/data-streams#example-trading-flow) documentation, but uses a basic log emitter to simulate the client contract that would initiate a `StreamsLookup`. After the contract receives and verifies the report, `performUpkeep` emits a `PriceUpdate` log message with the price. You could modify this to use the data in a way that works for your specific use case and application.
 
+The code example uses `revert` with `StreamsLookup` to convey call information about what streams to retrieve. See the [eip-3668 rationale](https://eips.ethereum.org/EIPS/eip-3668#rationale) for more information on the use of `revert` in this way.
+
 <CodeSample src="samples/DataStreams/StreamsUpkeep.sol" />

src/features/feeds/components/Tables.tsx

@@ -353,13 +353,7 @@ const StreamsTr = ({ network, proxy, showExtraDetails }) => (
     <td style="width:80%;">
       <div className={tableStyles.assetAddress}>
         <span class="label">ID:</span>
-        <a
-          style="font-size: 0.75em;"
-          class={tableStyles.addressLink}
-          href={network.explorerUrl.replace("%s", proxy.feedId)}
-        >
-          {proxy.feedId}
-        </a>
+        {proxy.feedId}
         <button
           class={clsx(tableStyles.copyBtn, "copy-iconbutton")}
           style={{ height: "16px", width: "16px" }}
@@ -373,7 +367,7 @@ const StreamsTr = ({ network, proxy, showExtraDetails }) => (
         <a
           style="font-size: 0.75em;"
           class={tableStyles.addressLink}
-          href={network.explorerUrl.replace("%s", proxy.proxyAddress)}
+          href={network.explorerUrl.replace("%s", "0xea9B98Be000FBEA7f6e88D08ebe70EbaAD10224c")}
         >
           0x2ff010DEbC1297f19579B4246cad07bd24F2488A
         </a>