fix(docs): correct the calls in the smart contract

swarna1101 · swarna1101 · commit eeead49075fc · 2025-01-14T12:28:15.000+05:30
diff --git a/docs/ftso/solidity-reference/FtsoV2Interface.md b/docs/ftso/solidity-reference/FtsoV2Interface.md
@@ -7,14 +7,14 @@ description: Primary interface for interacting with FTSOv2.
 import Remix from "@site/src/components/remix";
 import CodeBlock from "@theme/CodeBlock";
 import FTSOV2FeedById from "!!raw-loader!/examples/developer-hub-solidity/FTSOV2FeedById.sol";
-import FTSOV2FeedByIdWei from "!!raw-loader!/examples/developer-hub-solidity/FTSOV2FeedByIdWei.sol";
+//import FTSOV2FeedByIdWei from "!!raw-loader!/examples/developer-hub-solidity/FTSOV2FeedByIdWei.sol";
 import FTSOV2FeedByIndex from "!!raw-loader!/examples/developer-hub-solidity/FTSOV2FeedByIndex.sol";
-import FTSOV2FeedByIndexWei from "!!raw-loader!/examples/developer-hub-solidity/FTSOV2FeedByIndexWei.sol";
-import FTSOV2FeedByIdIndex from "!!raw-loader!/examples/developer-hub-solidity/FTSOV2FeedByIdIndex.sol";
+//import FTSOV2FeedByIndexWei from "!!raw-loader!/examples/developer-hub-solidity/FTSOV2FeedByIndexWei.sol";
+//import FTSOV2FeedByIdIndex from "!!raw-loader!/examples/developer-hub-solidity/FTSOV2FeedByIdIndex.sol";
 import FTSOV2FeedsById from "!!raw-loader!/examples/developer-hub-solidity/FTSOV2FeedsById.sol";
 import FTSOV2FeedsByIdWei from "!!raw-loader!/examples/developer-hub-solidity/FTSOV2FeedsByIdWei.sol";
-import FTSOV2FeedsByIndex from "!!raw-loader!/examples/developer-hub-solidity/FTSOV2FeedsByIndex.sol";
-import FTSOV2FeedsByIndexWei from "!!raw-loader!/examples/developer-hub-solidity/FTSOV2FeedsByIndexWei.sol";
+//import FTSOV2FeedsByIndex from "!!raw-loader!/examples/developer-hub-solidity/FTSOV2FeedsByIndex.sol";
+//import FTSOV2FeedsByIndexWei from "!!raw-loader!/examples/developer-hub-solidity/FTSOV2FeedsByIndexWei.sol";
 import FTSOV2VerifyProof from "!!raw-loader!/examples/developer-hub-solidity/FTSOV2VerifyProof.sol";
 
 Primary interface for interacting with FTSOv2. This is a long-term support (LTS) interface, designed to ensure continuity even as underlying contracts evolve or protocols migrate to new versions.
@@ -371,7 +371,7 @@ Checks if the feed data is valid (i.e. is part of the confirmed Merkle tree).
 function verifyFeedData(
     struct FtsoV2Interface.FeedDataWithProof _feedData
 ) external view returns (
-    bool
+bool
 );
 ```
 
@@ -403,11 +403,11 @@ Feed data structure
 
 ```solidity
 struct FeedData {
-  uint32 votingRoundId;
-  bytes21 id;
-  int32 value;
-  uint16 turnoutBIPS;
-  int8 decimals;
+    uint32 votingRoundId;
+    bytes21 id;
+    int32 value;
+    uint16 turnoutBIPS;
+    int8 decimals;
 }
 ```
 
@@ -417,7 +417,7 @@ Feed data with proof structure
 
 ```solidity
 struct FeedDataWithProof {
-  bytes32[] proof;
-  struct FtsoV2Interface.FeedData body;
+    bytes32[] proof;
+    struct FtsoV2Interface.FeedData body;
 }
 ```
diff --git a/examples/developer-hub-solidity/FTSOV2FeedById.sol b/examples/developer-hub-solidity/FTSOV2FeedById.sol
@@ -12,16 +12,8 @@ import {TestFtsoV2Interface} from "@flarenetwork/flare-periphery-contracts/costo
 contract FtsoV2FeedConsumerById {
     TestFtsoV2Interface internal ftsoV2;
     // Example Feed ID for FLR/USD
-    bytes21 public feedId = bytes21(0x01464c522f55534400000000000000000000000000); // FLR/USD
-
-    /**
-     * Constructor initializes the FTSOv2 contract.
-     * The contract registry is used to fetch the FtsoV2 contract address.
-     */
-    constructor() {
-        /* THIS IS A TEST METHOD, in production use: ftsoV2 = ContractRegistry.getFtsoV2(); */
-        ftsoV2 = ContractRegistry.getTestFtsoV2();
-    }
+    bytes21 public feedId =
+    bytes21(0x01464c522f55534400000000000000000000000000); // FLR/USD
 
     /**
      * Get the current value of a specific feed by its ID.
@@ -30,15 +22,15 @@ contract FtsoV2FeedConsumerById {
      * @return _timestamp The timestamp of the last feed update.
      */
     function getFtsoV2FeedValueById()
-        external
-        payable
-        returns (
-            uint256 _feedValue,
-            int8 _decimals,
-            uint64 _timestamp
-        )
+    external
+    payable
+    returns (uint256 _feedValue, int8 _decimals, uint64 _timestamp)
     {
         /* Retrieves the latest value, decimals, and timestamp for the specified feed ID. */
+
+        /* THIS IS A TEST METHOD, in production use: ftsoV2 = ContractRegistry.getFtsoV2(); */
+        ftsoV2 = ContractRegistry.getTestFtsoV2();
+
         return ftsoV2.getFeedById(feedId);
     }
-}
+}
diff --git a/examples/developer-hub-solidity/FTSOV2FeedByIndex.sol b/examples/developer-hub-solidity/FTSOV2FeedByIndex.sol
@@ -14,31 +14,21 @@ contract FtsoV2FeedConsumerByIndex {
     // Example index for a feed (corresponding to a feed id)
     uint256 public feedIndex = 1; // Example: FLR/USD
 
-    /**
-     * Constructor initializes the FTSOv2 contract.
-     * The contract registry is used to fetch the FtsoV2 contract address.
-     */
-    constructor() {
-        /* THIS IS A TEST METHOD, in production use: ftsoV2 = ContractRegistry.getFtsoV2(); */
-        ftsoV2 = ContractRegistry.getTestFtsoV2();
-    }
-
     /**
      * Get the current value of a specific feed by its index.
      * @return _feedValue The latest price value of the feed.
      * @return _decimals The decimal precision of the feed value.
      * @return _timestamp The timestamp of the last feed update.
      */
     function getFtsoV2FeedValueByIndex()
-        external
-        payable
-        returns (
-            uint256 _feedValue,
-            int8 _decimals,
-            uint64 _timestamp
-        )
+    external
+    payable
+    returns (uint256 _feedValue, int8 _decimals, uint64 _timestamp)
     {
+        /* THIS IS A TEST METHOD, in production use: ftsoV2 = ContractRegistry.getFtsoV2(); */
+        ftsoV2 = ContractRegistry.getTestFtsoV2();
+
         /* Retrieves the latest value, decimals, and timestamp for the specified feed index. */
         return ftsoV2.getFeedByIndex(feedIndex);
     }
-}
+}
diff --git a/examples/developer-hub-solidity/FTSOV2FeedsById.sol b/examples/developer-hub-solidity/FTSOV2FeedsById.sol
@@ -13,33 +13,25 @@ contract FtsoV2FeedConsumer {
     TestFtsoV2Interface internal ftsoV2;
     // Feed IDs, see https://dev.flare.network/ftso/feeds for full list
     bytes21[] public feedIds = [
-        bytes21(0x01464c522f55534400000000000000000000000000), // FLR/USD
-        bytes21(0x014254432f55534400000000000000000000000000), // BTC/USD
-        bytes21(0x014554482f55534400000000000000000000000000) // ETH/USD
+    bytes21(0x01464c522f55534400000000000000000000000000), // FLR/USD
+    bytes21(0x014254432f55534400000000000000000000000000), // BTC/USD
+    bytes21(0x014554482f55534400000000000000000000000000) // ETH/USD
     ];
 
-    /**
-     * Constructor initializes the FTSOv2 contract.
-     * The contract registry is used to fetch the FtsoV2 contract address.
-     */
-    constructor() {
-        /* THIS IS A TEST METHOD, in production use: ftsoV2 = ContractRegistry.getFtsoV2(); */
-        ftsoV2 = ContractRegistry.getTestFtsoV2();
-    }
-
     /**
      * Get the current value of the feeds.
      */
     function getFtsoV2CurrentFeedValues()
-        external
-        view
-        returns (
-            uint256[] memory _feedValues,
-            int8[] memory _decimals,
-            uint64 _timestamp
-        )
+    external
+    returns (
+        uint256[] memory _feedValues,
+        int8[] memory _decimals,
+        uint64 _timestamp
+    )
     {
+        /* THIS IS A TEST METHOD, in production use: ftsoV2 = ContractRegistry.getFtsoV2(); */
+        ftsoV2 = ContractRegistry.getTestFtsoV2();
         /* Your custom feed consumption logic. In this example the values are just returned. */
         return ftsoV2.getFeedsById(feedIds);
     }
-}
+}
diff --git a/examples/developer-hub-solidity/FTSOV2FeedsByIdWei.sol b/examples/developer-hub-solidity/FTSOV2FeedsByIdWei.sol
@@ -14,22 +14,17 @@ contract FtsoV2FeedConsumer {
 
     // Feed IDs, see https://dev.flare.network/ftso/feeds for full list
     bytes21[] public feedIds = [
-        bytes21(0x01464c522f55534400000000000000000000000000), // FLR/USD
-        bytes21(0x014254432f55534400000000000000000000000000), // BTC/USD
-        bytes21(0x014554482f55534400000000000000000000000000)  // ETH/USD
+    bytes21(0x01464c522f55534400000000000000000000000000), // FLR/USD
+    bytes21(0x014254432f55534400000000000000000000000000), // BTC/USD
+    bytes21(0x014554482f55534400000000000000000000000000) // ETH/USD
     ];
 
     // Event to log feed values retrieval
-    event FeedValuesRetrieved(bytes21[] indexed feedIds, uint256[] values, uint64 timestamp);
-
-    /**
-     * Constructor initializes the FTSOv2 contract.
-     * The contract registry is used to fetch the FtsoV2 contract address.
-     */
-    constructor() {
-        /* THIS IS A TEST METHOD, in production use: ftsoV2 = ContractRegistry.getFtsoV2(); */
-        ftsoV2 = ContractRegistry.getTestFtsoV2();
-    }
+    event FeedValuesRetrieved(
+        bytes21[] indexed feedIds,
+        uint256[] values,
+        uint64 timestamp
+    );
 
     /**
      * Get the current value of the feeds in wei.
@@ -38,18 +33,19 @@ contract FtsoV2FeedConsumer {
      * @return _values The list of values for the requested feeds in wei.
      * @return _timestamp The timestamp of the last update.
      */
-    function getFeedsByIdInWei(bytes21[] calldata _feedIds)
-        external
-        payable
-        returns (uint256[] memory _values, uint64 _timestamp)
-    {
+    function getFeedsByIdInWei(
+        bytes21[] calldata _feedIds
+    ) external payable returns (uint256[] memory _values, uint64 _timestamp) {
         // Ensure that the length of the feed IDs is non-zero
         require(_feedIds.length > 0, "No feed IDs provided");
 
+        /* THIS IS A TEST METHOD, in production use: ftsoV2 = ContractRegistry.getFtsoV2(); */
+        ftsoV2 = ContractRegistry.getTestFtsoV2();
+
         // Retrieve the feed values and timestamp from the FTSOv2 contract
         (_values, _timestamp) = ftsoV2.getFeedsByIdInWei(_feedIds);
 
         // Emit an event to log the retrieved feed values
         emit FeedValuesRetrieved(_feedIds, _values, _timestamp);
     }
-}
+}
diff --git a/examples/developer-hub-solidity/FtsoV2AnchorFeedConsumer.sol b/examples/developer-hub-solidity/FtsoV2AnchorFeedConsumer.sol
@@ -3,21 +3,24 @@ pragma solidity >=0.8.0 <0.9.0;
 
 import {FtsoV2Interface} from "@flarenetwork/flare-periphery-contracts/coston2/FtsoV2Interface.sol";
 import {ContractRegistry} from "@flarenetwork/flare-periphery-contracts/coston2/ContractRegistry.sol";
+import {TestFtsoV2Interface} from "@flarenetwork/flare-periphery-contracts/coston2/TestFtsoV2Interface.sol";
 
 /**
  * THIS IS AN EXAMPLE CONTRACT.
  * DO NOT USE THIS CODE IN PRODUCTION.
  */
 contract FtsoV2AnchorFeedConsumer {
-    mapping(uint32 => mapping(bytes21 => FtsoV2Interface.FeedData))
-        public provenFeeds;
+    TestFtsoV2Interface internal ftsoV2;
+    mapping(uint32 => mapping(bytes21 => TestFtsoV2Interface.FeedData))
+    public provenFeeds;
 
-    function savePrice(FtsoV2Interface.FeedDataWithProof calldata data) public {
+    function savePrice(
+        TestFtsoV2Interface.FeedDataWithProof calldata data
+    ) public {
+        /* THIS IS A TEST METHOD, in production use: ftsoV2 = ContractRegistry.getFtsoV2(); */
+        ftsoV2 = ContractRegistry.getTestFtsoV2();
         // Step 1: Verify the proof
-        require(
-            ContractRegistry.getFtsoV2().verifyFeedData(data),
-            "Invalid proof"
-        );
+        require(ftsoV2.verifyFeedData(data), "Invalid proof");
         // Step 2: Use the feed data with app specific logic
         // Here the feeds are saved
         provenFeeds[data.body.votingRoundId][data.body.id] = data.body;
diff --git a/examples/developer-hub-solidity/FtsoV2ChangeQuoteFeed.sol b/examples/developer-hub-solidity/FtsoV2ChangeQuoteFeed.sol
@@ -12,15 +12,6 @@ import {TestFtsoV2Interface} from "@flarenetwork/flare-periphery-contracts/costo
 contract FtsoV2ChangeQuoteFeed {
     TestFtsoV2Interface internal ftsoV2;
 
-    /**
-     * Initializing an instance with FtsoV2Interface.
-     * The contract registry is used to fetch the contract address.
-     */
-    constructor() {
-        /* THIS IS A TEST METHOD, in production use: ftsoV2 = ContractRegistry.getFtsoV2(); */
-        ftsoV2 = ContractRegistry.getTestFtsoV2();
-    }
-
     /**
      * @dev Internal function to scale the base feed value to match the decimals of the final feed.
      */
@@ -52,11 +43,13 @@ contract FtsoV2ChangeQuoteFeed {
      */
     function getNewQuoteFeedValue(
         bytes21[] calldata _baseAndQuoteFeedIds
-    ) external view returns (uint256) {
+    ) external returns (uint256) {
         require(
             _baseAndQuoteFeedIds.length == 2,
             "Invalid feed indexes. Please provide exactly two indexes."
         );
+
+        ftsoV2 = ContractRegistry.getTestFtsoV2();
         // Fetch current feeds
         (uint256[] memory feedValues, int8[] memory decimals, ) = ftsoV2
             .getFeedsById(_baseAndQuoteFeedIds);
@@ -92,6 +85,7 @@ contract FtsoV2ChangeQuoteFeed {
             _baseAndQuoteFeedIds.length == 2,
             "Invalid feed indexes. Please provide exactly two indexes."
         );
+
         // Fetch current feeds
         (uint256[] memory feedValues, int8[] memory decimals, ) = ftsoV2
             .getFeedsById(_baseAndQuoteFeedIds);
diff --git a/examples/developer-hub-solidity/FtsoV2FeedConsumer.sol b/examples/developer-hub-solidity/FtsoV2FeedConsumer.sol
@@ -11,24 +11,23 @@ import {TestFtsoV2Interface} from "@flarenetwork/flare-periphery-contracts/costo
  */
 contract FtsoV2FeedConsumer {
     TestFtsoV2Interface internal ftsoV2;
-    
     // Feed IDs, see https://dev.flare.network/ftso/feeds for full list
     bytes21[] public feedIds = [
-        bytes21(0x01464c522f55534400000000000000000000000000), // FLR/USD
-        bytes21(0x014254432f55534400000000000000000000000000), // BTC/USD
-        bytes21(0x014554482f55534400000000000000000000000000) // ETH/USD
+    bytes21(0x01464c522f55534400000000000000000000000000), // FLR/USD
+    bytes21(0x014254432f55534400000000000000000000000000), // BTC/USD
+    bytes21(0x014554482f55534400000000000000000000000000) // ETH/USD
     ];
 
     /**
      * Get the current value of the feeds.
      */
     function getFtsoV2CurrentFeedValues()
-        external
-        returns (
-            uint256[] memory _feedValues,
-            int8[] memory _decimals,
-            uint64 _timestamp
-        )
+    external
+    returns (
+        uint256[] memory _feedValues,
+        int8[] memory _decimals,
+        uint64 _timestamp
+    )
     {
         /* THIS IS A TEST METHOD, in production use: ftsoV2 = ContractRegistry.getFtsoV2(); */
         ftsoV2 = ContractRegistry.getTestFtsoV2();
diff --git a/examples/developer-hub-solidity/FtsoV2MigrationExample.sol b/examples/developer-hub-solidity/FtsoV2MigrationExample.sol
