Getting FTSO Data Feeds#

1. Create a new folder and move into it.
2. Initialize a new npm project and install dependencies:

   npm init
   npm install hardhat@2.20.1 @nomicfoundation/hardhat-toolbox @flarenetwork/flare-periphery-contracts
   

   If you intend to test as explained in the following steps, be aware that an open issue with Hardhat prevents using versions higher than 2.20.1.
3. Create a new Hardhat project (More information in the Hardhat setup guide):

   npx hardhat init
   

4. You will not be using the sample project, therefore:
   • Remove contracts/Lock.sol
   • Remove test/Lock.js
5. Edit hardhat.config.js to specify the correct EVM version. Make sure you include the highlighted lines:
   hardhat.config.js

   require("@nomicfoundation/hardhat-toolbox");
   
   /** @type import('hardhat/config').HardhatUserConfig */
   module.exports = {
       solidity: {
           compilers: [{
               version: "0.8.17",
               settings: {
                   evmVersion: "london"
               },
           }],
       }
   };
   

6. Copy the Solidity code above into a new file called GettingDataFeeds.sol in the contracts folder.
7. Compile with:

   npx hardhat compile
   

Testing smart contracts before deploying them is typically performed by forking the network or by using mock contracts. These instructions quickly show you how to use the former.

1. Build the Hardhat project following the previous instructions.
2. Include network information in the hardhat.config.js file. Make sure you include the highlighted lines:
   hardhat.config.js

   require("@nomicfoundation/hardhat-toolbox");
   
   /** @type import('hardhat/config').HardhatUserConfig */
   module.exports = {
       solidity: {
           compilers: [{
               version: "0.8.17",
               settings: {
                   evmVersion: "london"
               },
           }],
       },
       networks: {
           hardhat: {
               forking: {
                   url: 'https://flare-api.flare.network/ext/bc/C/rpc',
               },
           },
       },
   };
   

3. Copy the code below into a new file called TestGettingDataFeeds.js in the test folder.
   TestGettingDataFeeds.js

   const { expect } = require("chai");
   
   describe("GettingDataFeeds", async function () {
       let contract;
       beforeEach(async function () {
           contract = await ethers.deployContract("GettingDataFeeds");
       });
       it("Should return sensible values", async function () {
           const res = await contract.getTokenPriceWei("BTC");
   
           expect(res._timestamp).to.greaterThan(1695817332);
           expect(res._decimals).to.within(0, 18);
           expect(res._price).to.within(0, 1000000 * 10 ** Number(res._decimals));
       });
   });
   

4. Run the test with:

   npx hardhat test
   

1. If you don't have Foundry installed, follow the instructions for your operating system in the Foundry's Installation guide.
2. Create a new Foundry project:

   forge init <PROJECT_NAME>
   

   This command creates a new directory called <PROJECT_NAME>. Use a name that suits your needs.
3. Move into the project's directory:

   cd <PROJECT_NAME>
   

4. Install dependencies with:

   forge install flare-foundation/flare-foundry-periphery-package
   

5. Remove the sample project that Foundry created for you, as you do not need it:
   • Remove src/Counter.sol
   • Remove test/Counter.t.sol
6. Copy the Solidity code above into a new file called GettingDataFeeds.sol in the src folder.
7. Open the foundry.toml file, and add the following lines at the end:

   evm_version = "london"
   remappings = [ "@flarenetwork/flare-periphery-contracts/=lib/flare-foundry-periphery-package/src/"]
   

8. Compile with:

   forge build
   

Testing smart contracts before deploying them is typically performed by forking the network or by using mock contracts. These instructions quickly show you how to use the former.

1. Build the Foundry project following the previous instructions.
2. Copy the code below into a new file called GettingDataFeeds.t.sol in the test folder.
   GettingDataFeeds.t.sol

   // SPDX-License-Identifier: MIT
   pragma solidity ^0.8.0;
   
   // Import dependencies
   import "forge-std/Test.sol";
   import "../src/GettingDataFeeds.sol";
   
   // Test Contract
   contract TestGettingDataFeeds is Test {
   
       string private constant FLARE_RPC =
           "https://flare-api.flare.network/ext/bc/C/rpc";
       uint256 private flareFork;
   
       function setUp() public {
           flareFork = vm.createFork(FLARE_RPC);
       }
   
       function testSimplePrice() public {
           vm.selectFork(flareFork);
           GettingDataFeeds datafeeds = new GettingDataFeeds();
   
           (uint256 _price, uint256 _timestamp, uint256 _decimals) =
               datafeeds.getTokenPriceWei("BTC");
   
           assertGt(_timestamp, 1695817332,
               "Timestamp expected to be greater than a known past block");
           assertGe(_decimals, 0,
               "Number of decimals expected to be >= 0");
           assertLe(_decimals, 18,
               "Number of decimals expected to be <= 18");
           assertGt(_price, 0,
               "Price expected to be > 0");
           assertLt(_price, 1000000 * 10 ** _decimals,
               "Price expected to be < 1'000'000");
       }
   }
   

3. Run the test with:

   forge test -vv