Version 0.1.22

Author: nikerzetic-aflabs

coston/FtsoV2Interface.sol

@@ -21,22 +21,46 @@ interface FtsoV2Interface {
         FeedData body;
     }
 
+    /// Feed id change structure
+    struct FeedIdChange {
+        bytes21 oldFeedId;
+        bytes21 newFeedId;
+    }
+
+    /// Event emitted when a feed id is changed (e.g. feed renamed).
+    event FeedIdChanged(bytes21 indexed oldFeedId, bytes21 indexed newFeedId);
+
     /**
-     * Returns stored data of a feed.
-     * A fee (calculated by the FeeCalculator contract) may need to be paid.
-     * @param _index The index of the feed, corresponding to feed id in
-     * the FastUpdatesConfiguration contract.
-     * @return _value The value for the requested feed.
-     * @return _decimals The decimal places for the requested feed.
-     * @return _timestamp The timestamp of the last update.
+     * Returns the FTSO protocol id.
      */
-    function getFeedByIndex(uint256 _index)
-        external payable
-        returns (
-            uint256 _value,
-            int8 _decimals,
-            uint64 _timestamp
-        );
+    function getFtsoProtocolId() external view returns (uint256);
+
+    /**
+     * Returns the list of supported feed ids (currently active feed ids).
+     * To get the list of all available feed ids, combine with `getFeedIdChanges()`.
+     * @return _feedIds The list of supported feed ids.
+     */
+    function getSupportedFeedIds() external view returns (bytes21[] memory _feedIds);
+
+    /**
+     * Returns the list of feed id changes.
+     * @return _feedIdChanges The list of changed feed id pairs (old and new feed id).
+     */
+    function getFeedIdChanges() external view returns (FeedIdChange[] memory _feedIdChanges);
+
+    /**
+     * Calculates the fee for fetching a feed.
+     * @param _feedId The id of the feed.
+     * @return _fee The fee for fetching the feed.
+     */
+    function calculateFeeById(bytes21 _feedId) external view returns (uint256 _fee);
+
+    /**
+     * Calculates the fee for fetching feeds.
+     * @param _feedIds The list of feed ids.
+     * @return _fee The fee for fetching the feeds.
+     */
+    function calculateFeeByIds(bytes21[] memory _feedIds) external view returns (uint256 _fee);
 
     /**
      * Returns stored data of a feed.
@@ -54,23 +78,6 @@ interface FtsoV2Interface {
             uint64 _timestamp
         );
 
-    /**
-     * Returns stored data of each feed.
-     * A fee (calculated by the FeeCalculator contract) may need to be paid.
-     * @param _indices Indices of the feeds, corresponding to feed ids in
-     * the FastUpdatesConfiguration contract.
-     * @return _values The list of values for the requested feeds.
-     * @return _decimals The list of decimal places for the requested feeds.
-     * @return _timestamp The timestamp of the last update.
-     */
-    function getFeedsByIndex(uint256[] calldata _indices)
-        external payable
-        returns (
-            uint256[] memory _values,
-            int8[] memory _decimals,
-            uint64 _timestamp
-        );
-
     /**
      * Returns stored data of each feed.
      * A fee (calculated by the FeeCalculator contract) may need to be paid.
@@ -79,31 +86,14 @@ interface FtsoV2Interface {
      * @return _decimals The list of decimal places for the requested feeds.
      * @return _timestamp The timestamp of the last update.
      */
-    function getFeedsById(bytes21[] calldata _feedIds)
+    function getFeedsById(bytes21[] memory _feedIds)
         external payable
         returns (
             uint256[] memory _values,
             int8[] memory _decimals,
             uint64 _timestamp
         );
 
-    /**
-     * Returns value in wei and timestamp of a feed.
-     * A fee (calculated by the FeeCalculator contract) may need to be paid.
-     * @param _index The index of the feed, corresponding to feed id in
-     * the FastUpdatesConfiguration contract.
-     * @return _value The value for the requested feed in wei (i.e. with 18 decimal places).
-     * @return _timestamp The timestamp of the last update.
-     */
-    function getFeedByIndexInWei(
-        uint256 _index
-    )
-        external payable
-        returns (
-            uint256 _value,
-            uint64 _timestamp
-        );
-
     /**
      * Returns value in wei and timestamp of a feed.
      * A fee (calculated by the FeeCalculator contract) may need to be paid.
@@ -118,51 +108,23 @@ interface FtsoV2Interface {
             uint64 _timestamp
         );
 
-    /** Returns value in wei of each feed and a timestamp.
-     * For some feeds, a fee (calculated by the FeeCalculator contract) may need to be paid.
-     * @param _indices Indices of the feeds, corresponding to feed ids in
-     * the FastUpdatesConfiguration contract.
-     * @return _values The list of values for the requested feeds in wei (i.e. with 18 decimal places).
-     * @return _timestamp The timestamp of the last update.
-     */
-    function getFeedsByIndexInWei(uint256[] calldata _indices)
-        external payable
-        returns (
-            uint256[] memory _values,
-            uint64 _timestamp
-        );
-
     /** Returns value of each feed and a timestamp.
      * For some feeds, a fee (calculated by the FeeCalculator contract) may need to be paid.
      * @param _feedIds Ids of the feeds.
      * @return _values The list of values for the requested feeds in wei (i.e. with 18 decimal places).
      * @return _timestamp The timestamp of the last update.
      */
-    function getFeedsByIdInWei(bytes21[] calldata _feedIds)
+    function getFeedsByIdInWei(bytes21[] memory _feedIds)
         external payable
         returns (
             uint256[] memory _values,
             uint64 _timestamp
         );
 
-    /**
-     * Returns the index of a feed.
-     * @param _feedId The feed id.
-     * @return _index The index of the feed.
-     */
-    function getFeedIndex(bytes21 _feedId) external view returns (uint256 _index);
-
-    /**
-     * Returns the feed id at a given index. Removed (unused) feed index will return bytes21(0).
-     * @param _index The index.
-     * @return _feedId The feed id.
-     */
-    function getFeedId(uint256 _index) external view returns (bytes21 _feedId);
-
     /**
      * Checks if the feed data is valid (i.e. is part of the confirmed Merkle tree).
      * @param _feedData Structure containing data about the feed (FeedData structure) and Merkle proof.
      * @return true if the feed data is valid.
      */
     function verifyFeedData(FeedDataWithProof calldata _feedData) external view returns (bool);
-}
+}

coston/IFdcVerification.sol

@@ -7,6 +7,7 @@ import "./IConfirmedBlockHeightExistsVerification.sol";
 import "./IEVMTransactionVerification.sol";
 import "./IPaymentVerification.sol";
 import "./IReferencedPaymentNonexistenceVerification.sol";
+import "./IWeb2JsonVerification.sol";
 
 
 /**
@@ -18,5 +19,6 @@ interface IFdcVerification is
     IConfirmedBlockHeightExistsVerification,
     IEVMTransactionVerification,
     IPaymentVerification,
-    IReferencedPaymentNonexistenceVerification
+    IReferencedPaymentNonexistenceVerification,
+    IWeb2JsonVerification
 { }

coston/IWeb2Json.sol

@@ -0,0 +1,91 @@
+// SPDX-License-Identifier: MIT
+pragma solidity >=0.7.6 <0.9;
+
+/**
+ * @custom:name IWeb2Json
+ * @custom:supported WEB2
+ * @author Flare
+ * @notice An attestation request that fetches JSON data from the given URL,
+ * applies a jq filter to transform the returned result, and returns the structured data as ABI encoded data.
+ * @custom:verification  Data is fetched from an URL `url`. The received data is then processed with jq as
+ * the `postProcessJq` states. The structure of the final JSON is written in the `abiSignature`.
+ *
+ * The response contains an abi encoding of the final data.
+ * @custom:lut `0xffffffffffffffff`
+ * @custom:lut-limit `0xffffffffffffffff`
+ */
+interface IWeb2Json {
+    /**
+     * @notice Toplevel request
+     * @param attestationType ID of the attestation type.
+     * @param sourceId ID of the data source.
+     * @param messageIntegrityCode `MessageIntegrityCode` that is derived from the expected response.
+     * @param requestBody Data defining the request. Type (struct) and interpretation is determined
+     * by the `attestationType`.
+     */
+    struct Request {
+        bytes32 attestationType;
+        bytes32 sourceId;
+        bytes32 messageIntegrityCode;
+        RequestBody requestBody;
+    }
+
+    /**
+     * @notice Toplevel response
+     * @param attestationType Extracted from the request.
+     * @param sourceId Extracted from the request.
+     * @param votingRound The ID of the State Connector round in which the request was considered.
+     * @param lowestUsedTimestamp The lowest timestamp used to generate the response.
+     * @param requestBody Extracted from the request.
+     * @param responseBody Data defining the response. The verification rules for the construction
+     * of the response body and the type are defined per specific `attestationType`.
+     */
+    struct Response {
+        bytes32 attestationType;
+        bytes32 sourceId;
+        uint64 votingRound;
+        uint64 lowestUsedTimestamp;
+        RequestBody requestBody;
+        ResponseBody responseBody;
+    }
+
+    /**
+     * @notice Toplevel proof
+     * @param merkleProof Merkle proof corresponding to the attestation response.
+     * @param data Attestation response.
+     */
+    struct Proof {
+        bytes32[] merkleProof;
+        Response data;
+    }
+
+    /**
+     * @notice Request body for Web2Json attestation type
+     * @param url URL of the data source
+     * @param httpMethod HTTP method to be used to fetch from URL source.
+     * Supported methods: GET, POST, PUT, PATCH, DELETE.
+     * @param headers Headers to be included to fetch from URL source. Use `{}` if no headers are needed.
+     * @param queryParams Query parameters to be included to fetch from URL source.
+     * Use `{}` if no query parameters are needed.
+     * @param body Request body to be included to fetch from URL source. Use '{}' if no request body is required.
+     * @param postProcessJq jq filter used to post-process the JSON response from the URL.
+     * @param abiSignature ABI signature of the struct used to encode the data after jq post-processing.
+     */
+    struct RequestBody {
+        string url;
+        string httpMethod;
+        string headers;
+        string queryParams;
+        string body;
+        string postProcessJq;
+        string abiSignature;
+    }
+
+    /**
+     * @notice Response body for Web2Json attestation type
+     * @param abiEncodedData Raw binary data encoded to match the function parameters in ABI.
+     */
+    struct ResponseBody {
+        bytes abiEncodedData;
+    }
+}

coston/IWeb2JsonVerification.sol

@@ -0,0 +1,8 @@
+// SPDX-License-Identifier: MIT
+pragma solidity >=0.7.6 <0.9;
+
+import "./IWeb2Json.sol";
+
+interface IWeb2JsonVerification {
+    function verifyJsonApi(IWeb2Json.Proof calldata _proof) external view returns (bool _proved);
+}